babylon.module.d.ts 5.5 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /** @hidden */
  41. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  42. }
  43. /** @hidden */
  44. /** @hidden */
  45. type DeepImmutableObject<T> = {
  46. readonly [K in keyof T]: DeepImmutable<T[K]>;
  47. };
  48. }
  49. declare module "babylonjs/Misc/observable" {
  50. import { Nullable } from "babylonjs/types";
  51. /**
  52. * A class serves as a medium between the observable and its observers
  53. */
  54. export class EventState {
  55. /**
  56. * Create a new EventState
  57. * @param mask defines the mask associated with this state
  58. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  59. * @param target defines the original target of the state
  60. * @param currentTarget defines the current target of the state
  61. */
  62. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  63. /**
  64. * Initialize the current event state
  65. * @param mask defines the mask associated with this state
  66. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67. * @param target defines the original target of the state
  68. * @param currentTarget defines the current target of the state
  69. * @returns the current event state
  70. */
  71. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  72. /**
  73. * An Observer can set this property to true to prevent subsequent observers of being notified
  74. */
  75. skipNextObservers: boolean;
  76. /**
  77. * Get the mask value that were used to trigger the event corresponding to this EventState object
  78. */
  79. mask: number;
  80. /**
  81. * The object that originally notified the event
  82. */
  83. target?: any;
  84. /**
  85. * The current object in the bubbling phase
  86. */
  87. currentTarget?: any;
  88. /**
  89. * This will be populated with the return value of the last function that was executed.
  90. * If it is the first function in the callback chain it will be the event data.
  91. */
  92. lastReturnValue?: any;
  93. }
  94. /**
  95. * Represent an Observer registered to a given Observable object.
  96. */
  97. export class Observer<T> {
  98. /**
  99. * Defines the callback to call when the observer is notified
  100. */
  101. callback: (eventData: T, eventState: EventState) => void;
  102. /**
  103. * Defines the mask of the observer (used to filter notifications)
  104. */
  105. mask: number;
  106. /**
  107. * Defines the current scope used to restore the JS context
  108. */
  109. scope: any;
  110. /** @hidden */
  111. _willBeUnregistered: boolean;
  112. /**
  113. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  114. */
  115. unregisterOnNextCall: boolean;
  116. /**
  117. * Creates a new observer
  118. * @param callback defines the callback to call when the observer is notified
  119. * @param mask defines the mask of the observer (used to filter notifications)
  120. * @param scope defines the current scope used to restore the JS context
  121. */
  122. constructor(
  123. /**
  124. * Defines the callback to call when the observer is notified
  125. */
  126. callback: (eventData: T, eventState: EventState) => void,
  127. /**
  128. * Defines the mask of the observer (used to filter notifications)
  129. */
  130. mask: number,
  131. /**
  132. * Defines the current scope used to restore the JS context
  133. */
  134. scope?: any);
  135. }
  136. /**
  137. * Represent a list of observers registered to multiple Observables object.
  138. */
  139. export class MultiObserver<T> {
  140. private _observers;
  141. private _observables;
  142. /**
  143. * Release associated resources
  144. */
  145. dispose(): void;
  146. /**
  147. * Raise a callback when one of the observable will notify
  148. * @param observables defines a list of observables to watch
  149. * @param callback defines the callback to call on notification
  150. * @param mask defines the mask used to filter notifications
  151. * @param scope defines the current scope used to restore the JS context
  152. * @returns the new MultiObserver
  153. */
  154. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  155. }
  156. /**
  157. * The Observable class is a simple implementation of the Observable pattern.
  158. *
  159. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  160. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  161. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  162. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  163. */
  164. export class Observable<T> {
  165. private _observers;
  166. private _eventState;
  167. private _onObserverAdded;
  168. /**
  169. * Gets the list of observers
  170. */
  171. readonly observers: Array<Observer<T>>;
  172. /**
  173. * Creates a new observable
  174. * @param onObserverAdded defines a callback to call when a new observer is added
  175. */
  176. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  177. /**
  178. * Create a new Observer with the specified callback
  179. * @param callback the callback that will be executed for that Observer
  180. * @param mask the mask used to filter observers
  181. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  182. * @param scope optional scope for the callback to be called from
  183. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  184. * @returns the new observer created for the callback
  185. */
  186. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  187. /**
  188. * Create a new Observer with the specified callback and unregisters after the next notification
  189. * @param callback the callback that will be executed for that Observer
  190. * @returns the new observer created for the callback
  191. */
  192. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  193. /**
  194. * Remove an Observer from the Observable object
  195. * @param observer the instance of the Observer to remove
  196. * @returns false if it doesn't belong to this Observable
  197. */
  198. remove(observer: Nullable<Observer<T>>): boolean;
  199. /**
  200. * Remove a callback from the Observable object
  201. * @param callback the callback to remove
  202. * @param scope optional scope. If used only the callbacks with this scope will be removed
  203. * @returns false if it doesn't belong to this Observable
  204. */
  205. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  206. private _deferUnregister;
  207. private _remove;
  208. /**
  209. * Moves the observable to the top of the observer list making it get called first when notified
  210. * @param observer the observer to move
  211. */
  212. makeObserverTopPriority(observer: Observer<T>): void;
  213. /**
  214. * Moves the observable to the bottom of the observer list making it get called last when notified
  215. * @param observer the observer to move
  216. */
  217. makeObserverBottomPriority(observer: Observer<T>): void;
  218. /**
  219. * Notify all Observers by calling their respective callback with the given data
  220. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  221. * @param eventData defines the data to send to all observers
  222. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  223. * @param target defines the original target of the state
  224. * @param currentTarget defines the current target of the state
  225. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  226. */
  227. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  228. /**
  229. * Calling this will execute each callback, expecting it to be a promise or return a value.
  230. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  231. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  232. * and it is crucial that all callbacks will be executed.
  233. * The order of the callbacks is kept, callbacks are not executed parallel.
  234. *
  235. * @param eventData The data to be sent to each callback
  236. * @param mask is used to filter observers defaults to -1
  237. * @param target defines the callback target (see EventState)
  238. * @param currentTarget defines he current object in the bubbling phase
  239. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  240. */
  241. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  242. /**
  243. * Notify a specific observer
  244. * @param observer defines the observer to notify
  245. * @param eventData defines the data to be sent to each callback
  246. * @param mask is used to filter observers defaults to -1
  247. */
  248. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  249. /**
  250. * Gets a boolean indicating if the observable has at least one observer
  251. * @returns true is the Observable has at least one Observer registered
  252. */
  253. hasObservers(): boolean;
  254. /**
  255. * Clear the list of observers
  256. */
  257. clear(): void;
  258. /**
  259. * Clone the current observable
  260. * @returns a new observable
  261. */
  262. clone(): Observable<T>;
  263. /**
  264. * Does this observable handles observer registered with a given mask
  265. * @param mask defines the mask to be tested
  266. * @return whether or not one observer registered with the given mask is handeled
  267. **/
  268. hasSpecificMask(mask?: number): boolean;
  269. }
  270. }
  271. declare module "babylonjs/Misc/domManagement" {
  272. /**
  273. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  274. * Babylon.js
  275. */
  276. export class DomManagement {
  277. /**
  278. * Checks if the window object exists
  279. * @returns true if the window object exists
  280. */
  281. static IsWindowObjectExist(): boolean;
  282. /**
  283. * Checks if the navigator object exists
  284. * @returns true if the navigator object exists
  285. */
  286. static IsNavigatorAvailable(): boolean;
  287. /**
  288. * Extracts text content from a DOM element hierarchy
  289. * @param element defines the root element
  290. * @returns a string
  291. */
  292. static GetDOMTextContent(element: HTMLElement): string;
  293. }
  294. }
  295. declare module "babylonjs/Misc/logger" {
  296. /**
  297. * Logger used througouht the application to allow configuration of
  298. * the log level required for the messages.
  299. */
  300. export class Logger {
  301. /**
  302. * No log
  303. */
  304. static readonly NoneLogLevel: number;
  305. /**
  306. * Only message logs
  307. */
  308. static readonly MessageLogLevel: number;
  309. /**
  310. * Only warning logs
  311. */
  312. static readonly WarningLogLevel: number;
  313. /**
  314. * Only error logs
  315. */
  316. static readonly ErrorLogLevel: number;
  317. /**
  318. * All logs
  319. */
  320. static readonly AllLogLevel: number;
  321. private static _LogCache;
  322. /**
  323. * Gets a value indicating the number of loading errors
  324. * @ignorenaming
  325. */
  326. static errorsCount: number;
  327. /**
  328. * Callback called when a new log is added
  329. */
  330. static OnNewCacheEntry: (entry: string) => void;
  331. private static _AddLogEntry;
  332. private static _FormatMessage;
  333. private static _LogDisabled;
  334. private static _LogEnabled;
  335. private static _WarnDisabled;
  336. private static _WarnEnabled;
  337. private static _ErrorDisabled;
  338. private static _ErrorEnabled;
  339. /**
  340. * Log a message to the console
  341. */
  342. static Log: (message: string) => void;
  343. /**
  344. * Write a warning message to the console
  345. */
  346. static Warn: (message: string) => void;
  347. /**
  348. * Write an error message to the console
  349. */
  350. static Error: (message: string) => void;
  351. /**
  352. * Gets current log cache (list of logs)
  353. */
  354. static readonly LogCache: string;
  355. /**
  356. * Clears the log cache
  357. */
  358. static ClearLogCache(): void;
  359. /**
  360. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  361. */
  362. static LogLevels: number;
  363. }
  364. }
  365. declare module "babylonjs/Misc/typeStore" {
  366. /** @hidden */
  367. export class _TypeStore {
  368. /** @hidden */
  369. static RegisteredTypes: {
  370. [key: string]: Object;
  371. };
  372. /** @hidden */
  373. static GetClass(fqdn: string): any;
  374. }
  375. }
  376. declare module "babylonjs/Misc/deepCopier" {
  377. /**
  378. * Class containing a set of static utilities functions for deep copy.
  379. */
  380. export class DeepCopier {
  381. /**
  382. * Tries to copy an object by duplicating every property
  383. * @param source defines the source object
  384. * @param destination defines the target object
  385. * @param doNotCopyList defines a list of properties to avoid
  386. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  387. */
  388. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  389. }
  390. }
  391. declare module "babylonjs/Misc/precisionDate" {
  392. /**
  393. * Class containing a set of static utilities functions for precision date
  394. */
  395. export class PrecisionDate {
  396. /**
  397. * Gets either window.performance.now() if supported or Date.now() else
  398. */
  399. static readonly Now: number;
  400. }
  401. }
  402. declare module "babylonjs/Misc/devTools" {
  403. /** @hidden */
  404. export class _DevTools {
  405. static WarnImport(name: string): string;
  406. }
  407. }
  408. declare module "babylonjs/Misc/webRequest" {
  409. /**
  410. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  411. */
  412. export class WebRequest {
  413. private _xhr;
  414. /**
  415. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  416. * i.e. when loading files, where the server/service expects an Authorization header
  417. */
  418. static CustomRequestHeaders: {
  419. [key: string]: string;
  420. };
  421. /**
  422. * Add callback functions in this array to update all the requests before they get sent to the network
  423. */
  424. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  425. private _injectCustomRequestHeaders;
  426. /**
  427. * Gets or sets a function to be called when loading progress changes
  428. */
  429. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  430. /**
  431. * Returns client's state
  432. */
  433. readonly readyState: number;
  434. /**
  435. * Returns client's status
  436. */
  437. readonly status: number;
  438. /**
  439. * Returns client's status as a text
  440. */
  441. readonly statusText: string;
  442. /**
  443. * Returns client's response
  444. */
  445. readonly response: any;
  446. /**
  447. * Returns client's response url
  448. */
  449. readonly responseURL: string;
  450. /**
  451. * Returns client's response as text
  452. */
  453. readonly responseText: string;
  454. /**
  455. * Gets or sets the expected response type
  456. */
  457. responseType: XMLHttpRequestResponseType;
  458. /** @hidden */
  459. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  460. /** @hidden */
  461. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  462. /**
  463. * Cancels any network activity
  464. */
  465. abort(): void;
  466. /**
  467. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  468. * @param body defines an optional request body
  469. */
  470. send(body?: Document | BodyInit | null): void;
  471. /**
  472. * Sets the request method, request URL
  473. * @param method defines the method to use (GET, POST, etc..)
  474. * @param url defines the url to connect with
  475. */
  476. open(method: string, url: string): void;
  477. }
  478. }
  479. declare module "babylonjs/Misc/fileRequest" {
  480. import { Observable } from "babylonjs/Misc/observable";
  481. /**
  482. * File request interface
  483. */
  484. export interface IFileRequest {
  485. /**
  486. * Raised when the request is complete (success or error).
  487. */
  488. onCompleteObservable: Observable<IFileRequest>;
  489. /**
  490. * Aborts the request for a file.
  491. */
  492. abort: () => void;
  493. }
  494. }
  495. declare module "babylonjs/Misc/performanceMonitor" {
  496. /**
  497. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  498. */
  499. export class PerformanceMonitor {
  500. private _enabled;
  501. private _rollingFrameTime;
  502. private _lastFrameTimeMs;
  503. /**
  504. * constructor
  505. * @param frameSampleSize The number of samples required to saturate the sliding window
  506. */
  507. constructor(frameSampleSize?: number);
  508. /**
  509. * Samples current frame
  510. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  511. */
  512. sampleFrame(timeMs?: number): void;
  513. /**
  514. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  515. */
  516. readonly averageFrameTime: number;
  517. /**
  518. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  519. */
  520. readonly averageFrameTimeVariance: number;
  521. /**
  522. * Returns the frame time of the most recent frame
  523. */
  524. readonly instantaneousFrameTime: number;
  525. /**
  526. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  527. */
  528. readonly averageFPS: number;
  529. /**
  530. * Returns the average framerate in frames per second using the most recent frame time
  531. */
  532. readonly instantaneousFPS: number;
  533. /**
  534. * Returns true if enough samples have been taken to completely fill the sliding window
  535. */
  536. readonly isSaturated: boolean;
  537. /**
  538. * Enables contributions to the sliding window sample set
  539. */
  540. enable(): void;
  541. /**
  542. * Disables contributions to the sliding window sample set
  543. * Samples will not be interpolated over the disabled period
  544. */
  545. disable(): void;
  546. /**
  547. * Returns true if sampling is enabled
  548. */
  549. readonly isEnabled: boolean;
  550. /**
  551. * Resets performance monitor
  552. */
  553. reset(): void;
  554. }
  555. /**
  556. * RollingAverage
  557. *
  558. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  559. */
  560. export class RollingAverage {
  561. /**
  562. * Current average
  563. */
  564. average: number;
  565. /**
  566. * Current variance
  567. */
  568. variance: number;
  569. protected _samples: Array<number>;
  570. protected _sampleCount: number;
  571. protected _pos: number;
  572. protected _m2: number;
  573. /**
  574. * constructor
  575. * @param length The number of samples required to saturate the sliding window
  576. */
  577. constructor(length: number);
  578. /**
  579. * Adds a sample to the sample set
  580. * @param v The sample value
  581. */
  582. add(v: number): void;
  583. /**
  584. * Returns previously added values or null if outside of history or outside the sliding window domain
  585. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  586. * @return Value previously recorded with add() or null if outside of range
  587. */
  588. history(i: number): number;
  589. /**
  590. * Returns true if enough samples have been taken to completely fill the sliding window
  591. * @return true if sample-set saturated
  592. */
  593. isSaturated(): boolean;
  594. /**
  595. * Resets the rolling average (equivalent to 0 samples taken so far)
  596. */
  597. reset(): void;
  598. /**
  599. * Wraps a value around the sample range boundaries
  600. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  601. * @return Wrapped position in sample range
  602. */
  603. protected _wrapPosition(i: number): number;
  604. }
  605. }
  606. declare module "babylonjs/Misc/stringDictionary" {
  607. import { Nullable } from "babylonjs/types";
  608. /**
  609. * This class implement a typical dictionary using a string as key and the generic type T as value.
  610. * The underlying implementation relies on an associative array to ensure the best performances.
  611. * The value can be anything including 'null' but except 'undefined'
  612. */
  613. export class StringDictionary<T> {
  614. /**
  615. * This will clear this dictionary and copy the content from the 'source' one.
  616. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  617. * @param source the dictionary to take the content from and copy to this dictionary
  618. */
  619. copyFrom(source: StringDictionary<T>): void;
  620. /**
  621. * Get a value based from its key
  622. * @param key the given key to get the matching value from
  623. * @return the value if found, otherwise undefined is returned
  624. */
  625. get(key: string): T | undefined;
  626. /**
  627. * Get a value from its key or add it if it doesn't exist.
  628. * This method will ensure you that a given key/data will be present in the dictionary.
  629. * @param key the given key to get the matching value from
  630. * @param factory the factory that will create the value if the key is not present in the dictionary.
  631. * The factory will only be invoked if there's no data for the given key.
  632. * @return the value corresponding to the key.
  633. */
  634. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  635. /**
  636. * Get a value from its key if present in the dictionary otherwise add it
  637. * @param key the key to get the value from
  638. * @param val if there's no such key/value pair in the dictionary add it with this value
  639. * @return the value corresponding to the key
  640. */
  641. getOrAdd(key: string, val: T): T;
  642. /**
  643. * Check if there's a given key in the dictionary
  644. * @param key the key to check for
  645. * @return true if the key is present, false otherwise
  646. */
  647. contains(key: string): boolean;
  648. /**
  649. * Add a new key and its corresponding value
  650. * @param key the key to add
  651. * @param value the value corresponding to the key
  652. * @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
  653. */
  654. add(key: string, value: T): boolean;
  655. /**
  656. * Update a specific value associated to a key
  657. * @param key defines the key to use
  658. * @param value defines the value to store
  659. * @returns true if the value was updated (or false if the key was not found)
  660. */
  661. set(key: string, value: T): boolean;
  662. /**
  663. * Get the element of the given key and remove it from the dictionary
  664. * @param key defines the key to search
  665. * @returns the value associated with the key or null if not found
  666. */
  667. getAndRemove(key: string): Nullable<T>;
  668. /**
  669. * Remove a key/value from the dictionary.
  670. * @param key the key to remove
  671. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  672. */
  673. remove(key: string): boolean;
  674. /**
  675. * Clear the whole content of the dictionary
  676. */
  677. clear(): void;
  678. /**
  679. * Gets the current count
  680. */
  681. readonly count: number;
  682. /**
  683. * Execute a callback on each key/val of the dictionary.
  684. * Note that you can remove any element in this dictionary in the callback implementation
  685. * @param callback the callback to execute on a given key/value pair
  686. */
  687. forEach(callback: (key: string, val: T) => void): void;
  688. /**
  689. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  690. * If the callback returns null or undefined the method will iterate to the next key/value pair
  691. * Note that you can remove any element in this dictionary in the callback implementation
  692. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  693. * @returns the first item
  694. */
  695. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  696. private _count;
  697. private _data;
  698. }
  699. }
  700. declare module "babylonjs/Meshes/dataBuffer" {
  701. /**
  702. * Class used to store gfx data (like WebGLBuffer)
  703. */
  704. export class DataBuffer {
  705. /**
  706. * Gets or sets the number of objects referencing this buffer
  707. */
  708. references: number;
  709. /** Gets or sets the size of the underlying buffer */
  710. capacity: number;
  711. /**
  712. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  713. */
  714. is32Bits: boolean;
  715. /**
  716. * Gets the underlying buffer
  717. */
  718. readonly underlyingResource: any;
  719. }
  720. }
  721. declare module "babylonjs/Meshes/buffer" {
  722. import { Nullable, DataArray } from "babylonjs/types";
  723. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  724. /**
  725. * Class used to store data that will be store in GPU memory
  726. */
  727. export class Buffer {
  728. private _engine;
  729. private _buffer;
  730. /** @hidden */
  731. _data: Nullable<DataArray>;
  732. private _updatable;
  733. private _instanced;
  734. /**
  735. * Gets the byte stride.
  736. */
  737. readonly byteStride: number;
  738. /**
  739. * Constructor
  740. * @param engine the engine
  741. * @param data the data to use for this buffer
  742. * @param updatable whether the data is updatable
  743. * @param stride the stride (optional)
  744. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  745. * @param instanced whether the buffer is instanced (optional)
  746. * @param useBytes set to true if the stride in in bytes (optional)
  747. */
  748. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean);
  749. /**
  750. * Create a new VertexBuffer based on the current buffer
  751. * @param kind defines the vertex buffer kind (position, normal, etc.)
  752. * @param offset defines offset in the buffer (0 by default)
  753. * @param size defines the size in floats of attributes (position is 3 for instance)
  754. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  755. * @param instanced defines if the vertex buffer contains indexed data
  756. * @param useBytes defines if the offset and stride are in bytes
  757. * @returns the new vertex buffer
  758. */
  759. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean): VertexBuffer;
  760. /**
  761. * Gets a boolean indicating if the Buffer is updatable?
  762. * @returns true if the buffer is updatable
  763. */
  764. isUpdatable(): boolean;
  765. /**
  766. * Gets current buffer's data
  767. * @returns a DataArray or null
  768. */
  769. getData(): Nullable<DataArray>;
  770. /**
  771. * Gets underlying native buffer
  772. * @returns underlying native buffer
  773. */
  774. getBuffer(): Nullable<DataBuffer>;
  775. /**
  776. * Gets the stride in float32 units (i.e. byte stride / 4).
  777. * May not be an integer if the byte stride is not divisible by 4.
  778. * DEPRECATED. Use byteStride instead.
  779. * @returns the stride in float32 units
  780. */
  781. getStrideSize(): number;
  782. /**
  783. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  784. * @param data defines the data to store
  785. */
  786. create(data?: Nullable<DataArray>): void;
  787. /** @hidden */
  788. _rebuild(): void;
  789. /**
  790. * Update current buffer data
  791. * @param data defines the data to store
  792. */
  793. update(data: DataArray): void;
  794. /**
  795. * Updates the data directly.
  796. * @param data the new data
  797. * @param offset the new offset
  798. * @param vertexCount the vertex count (optional)
  799. * @param useBytes set to true if the offset is in bytes
  800. */
  801. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  802. /**
  803. * Release all resources
  804. */
  805. dispose(): void;
  806. }
  807. /**
  808. * Specialized buffer used to store vertex data
  809. */
  810. export class VertexBuffer {
  811. /** @hidden */
  812. _buffer: Buffer;
  813. private _kind;
  814. private _size;
  815. private _ownsBuffer;
  816. private _instanced;
  817. private _instanceDivisor;
  818. /**
  819. * The byte type.
  820. */
  821. static readonly BYTE: number;
  822. /**
  823. * The unsigned byte type.
  824. */
  825. static readonly UNSIGNED_BYTE: number;
  826. /**
  827. * The short type.
  828. */
  829. static readonly SHORT: number;
  830. /**
  831. * The unsigned short type.
  832. */
  833. static readonly UNSIGNED_SHORT: number;
  834. /**
  835. * The integer type.
  836. */
  837. static readonly INT: number;
  838. /**
  839. * The unsigned integer type.
  840. */
  841. static readonly UNSIGNED_INT: number;
  842. /**
  843. * The float type.
  844. */
  845. static readonly FLOAT: number;
  846. /**
  847. * Gets or sets the instance divisor when in instanced mode
  848. */
  849. instanceDivisor: number;
  850. /**
  851. * Gets the byte stride.
  852. */
  853. readonly byteStride: number;
  854. /**
  855. * Gets the byte offset.
  856. */
  857. readonly byteOffset: number;
  858. /**
  859. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  860. */
  861. readonly normalized: boolean;
  862. /**
  863. * Gets the data type of each component in the array.
  864. */
  865. readonly type: number;
  866. /**
  867. * Constructor
  868. * @param engine the engine
  869. * @param data the data to use for this vertex buffer
  870. * @param kind the vertex buffer kind
  871. * @param updatable whether the data is updatable
  872. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  873. * @param stride the stride (optional)
  874. * @param instanced whether the buffer is instanced (optional)
  875. * @param offset the offset of the data (optional)
  876. * @param size the number of components (optional)
  877. * @param type the type of the component (optional)
  878. * @param normalized whether the data contains normalized data (optional)
  879. * @param useBytes set to true if stride and offset are in bytes (optional)
  880. */
  881. 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);
  882. /** @hidden */
  883. _rebuild(): void;
  884. /**
  885. * Returns the kind of the VertexBuffer (string)
  886. * @returns a string
  887. */
  888. getKind(): string;
  889. /**
  890. * Gets a boolean indicating if the VertexBuffer is updatable?
  891. * @returns true if the buffer is updatable
  892. */
  893. isUpdatable(): boolean;
  894. /**
  895. * Gets current buffer's data
  896. * @returns a DataArray or null
  897. */
  898. getData(): Nullable<DataArray>;
  899. /**
  900. * Gets underlying native buffer
  901. * @returns underlying native buffer
  902. */
  903. getBuffer(): Nullable<DataBuffer>;
  904. /**
  905. * Gets the stride in float32 units (i.e. byte stride / 4).
  906. * May not be an integer if the byte stride is not divisible by 4.
  907. * DEPRECATED. Use byteStride instead.
  908. * @returns the stride in float32 units
  909. */
  910. getStrideSize(): number;
  911. /**
  912. * Returns the offset as a multiple of the type byte length.
  913. * DEPRECATED. Use byteOffset instead.
  914. * @returns the offset in bytes
  915. */
  916. getOffset(): number;
  917. /**
  918. * Returns the number of components per vertex attribute (integer)
  919. * @returns the size in float
  920. */
  921. getSize(): number;
  922. /**
  923. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  924. * @returns true if this buffer is instanced
  925. */
  926. getIsInstanced(): boolean;
  927. /**
  928. * Returns the instancing divisor, zero for non-instanced (integer).
  929. * @returns a number
  930. */
  931. getInstanceDivisor(): number;
  932. /**
  933. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  934. * @param data defines the data to store
  935. */
  936. create(data?: DataArray): void;
  937. /**
  938. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  939. * This function will create a new buffer if the current one is not updatable
  940. * @param data defines the data to store
  941. */
  942. update(data: DataArray): void;
  943. /**
  944. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  945. * Returns the directly updated WebGLBuffer.
  946. * @param data the new data
  947. * @param offset the new offset
  948. * @param useBytes set to true if the offset is in bytes
  949. */
  950. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  951. /**
  952. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  953. */
  954. dispose(): void;
  955. /**
  956. * Enumerates each value of this vertex buffer as numbers.
  957. * @param count the number of values to enumerate
  958. * @param callback the callback function called for each value
  959. */
  960. forEach(count: number, callback: (value: number, index: number) => void): void;
  961. /**
  962. * Positions
  963. */
  964. static readonly PositionKind: string;
  965. /**
  966. * Normals
  967. */
  968. static readonly NormalKind: string;
  969. /**
  970. * Tangents
  971. */
  972. static readonly TangentKind: string;
  973. /**
  974. * Texture coordinates
  975. */
  976. static readonly UVKind: string;
  977. /**
  978. * Texture coordinates 2
  979. */
  980. static readonly UV2Kind: string;
  981. /**
  982. * Texture coordinates 3
  983. */
  984. static readonly UV3Kind: string;
  985. /**
  986. * Texture coordinates 4
  987. */
  988. static readonly UV4Kind: string;
  989. /**
  990. * Texture coordinates 5
  991. */
  992. static readonly UV5Kind: string;
  993. /**
  994. * Texture coordinates 6
  995. */
  996. static readonly UV6Kind: string;
  997. /**
  998. * Colors
  999. */
  1000. static readonly ColorKind: string;
  1001. /**
  1002. * Matrix indices (for bones)
  1003. */
  1004. static readonly MatricesIndicesKind: string;
  1005. /**
  1006. * Matrix weights (for bones)
  1007. */
  1008. static readonly MatricesWeightsKind: string;
  1009. /**
  1010. * Additional matrix indices (for bones)
  1011. */
  1012. static readonly MatricesIndicesExtraKind: string;
  1013. /**
  1014. * Additional matrix weights (for bones)
  1015. */
  1016. static readonly MatricesWeightsExtraKind: string;
  1017. /**
  1018. * Deduces the stride given a kind.
  1019. * @param kind The kind string to deduce
  1020. * @returns The deduced stride
  1021. */
  1022. static DeduceStride(kind: string): number;
  1023. /**
  1024. * Gets the byte length of the given type.
  1025. * @param type the type
  1026. * @returns the number of bytes
  1027. */
  1028. static GetTypeByteLength(type: number): number;
  1029. /**
  1030. * Enumerates each value of the given parameters as numbers.
  1031. * @param data the data to enumerate
  1032. * @param byteOffset the byte offset of the data
  1033. * @param byteStride the byte stride of the data
  1034. * @param componentCount the number of components per element
  1035. * @param componentType the type of the component
  1036. * @param count the number of values to enumerate
  1037. * @param normalized whether the data is normalized
  1038. * @param callback the callback function called for each value
  1039. */
  1040. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  1041. private static _GetFloatValue;
  1042. }
  1043. }
  1044. declare module "babylonjs/Maths/math.scalar" {
  1045. /**
  1046. * Scalar computation library
  1047. */
  1048. export class Scalar {
  1049. /**
  1050. * Two pi constants convenient for computation.
  1051. */
  1052. static TwoPi: number;
  1053. /**
  1054. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1055. * @param a number
  1056. * @param b number
  1057. * @param epsilon (default = 1.401298E-45)
  1058. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1059. */
  1060. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1061. /**
  1062. * Returns a string : the upper case translation of the number i to hexadecimal.
  1063. * @param i number
  1064. * @returns the upper case translation of the number i to hexadecimal.
  1065. */
  1066. static ToHex(i: number): string;
  1067. /**
  1068. * Returns -1 if value is negative and +1 is value is positive.
  1069. * @param value the value
  1070. * @returns the value itself if it's equal to zero.
  1071. */
  1072. static Sign(value: number): number;
  1073. /**
  1074. * Returns the value itself if it's between min and max.
  1075. * Returns min if the value is lower than min.
  1076. * Returns max if the value is greater than max.
  1077. * @param value the value to clmap
  1078. * @param min the min value to clamp to (default: 0)
  1079. * @param max the max value to clamp to (default: 1)
  1080. * @returns the clamped value
  1081. */
  1082. static Clamp(value: number, min?: number, max?: number): number;
  1083. /**
  1084. * the log2 of value.
  1085. * @param value the value to compute log2 of
  1086. * @returns the log2 of value.
  1087. */
  1088. static Log2(value: number): number;
  1089. /**
  1090. * Loops the value, so that it is never larger than length and never smaller than 0.
  1091. *
  1092. * This is similar to the modulo operator but it works with floating point numbers.
  1093. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1094. * With t = 5 and length = 2.5, the result would be 0.0.
  1095. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1096. * @param value the value
  1097. * @param length the length
  1098. * @returns the looped value
  1099. */
  1100. static Repeat(value: number, length: number): number;
  1101. /**
  1102. * Normalize the value between 0.0 and 1.0 using min and max values
  1103. * @param value value to normalize
  1104. * @param min max to normalize between
  1105. * @param max min to normalize between
  1106. * @returns the normalized value
  1107. */
  1108. static Normalize(value: number, min: number, max: number): number;
  1109. /**
  1110. * Denormalize the value from 0.0 and 1.0 using min and max values
  1111. * @param normalized value to denormalize
  1112. * @param min max to denormalize between
  1113. * @param max min to denormalize between
  1114. * @returns the denormalized value
  1115. */
  1116. static Denormalize(normalized: number, min: number, max: number): number;
  1117. /**
  1118. * Calculates the shortest difference between two given angles given in degrees.
  1119. * @param current current angle in degrees
  1120. * @param target target angle in degrees
  1121. * @returns the delta
  1122. */
  1123. static DeltaAngle(current: number, target: number): number;
  1124. /**
  1125. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1126. * @param tx value
  1127. * @param length length
  1128. * @returns The returned value will move back and forth between 0 and length
  1129. */
  1130. static PingPong(tx: number, length: number): number;
  1131. /**
  1132. * Interpolates between min and max with smoothing at the limits.
  1133. *
  1134. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1135. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1136. * @param from from
  1137. * @param to to
  1138. * @param tx value
  1139. * @returns the smooth stepped value
  1140. */
  1141. static SmoothStep(from: number, to: number, tx: number): number;
  1142. /**
  1143. * Moves a value current towards target.
  1144. *
  1145. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1146. * Negative values of maxDelta pushes the value away from target.
  1147. * @param current current value
  1148. * @param target target value
  1149. * @param maxDelta max distance to move
  1150. * @returns resulting value
  1151. */
  1152. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1153. /**
  1154. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1155. *
  1156. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1157. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1158. * @param current current value
  1159. * @param target target value
  1160. * @param maxDelta max distance to move
  1161. * @returns resulting angle
  1162. */
  1163. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1164. /**
  1165. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1166. * @param start start value
  1167. * @param end target value
  1168. * @param amount amount to lerp between
  1169. * @returns the lerped value
  1170. */
  1171. static Lerp(start: number, end: number, amount: number): number;
  1172. /**
  1173. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1174. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1175. * @param start start value
  1176. * @param end target value
  1177. * @param amount amount to lerp between
  1178. * @returns the lerped value
  1179. */
  1180. static LerpAngle(start: number, end: number, amount: number): number;
  1181. /**
  1182. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1183. * @param a start value
  1184. * @param b target value
  1185. * @param value value between a and b
  1186. * @returns the inverseLerp value
  1187. */
  1188. static InverseLerp(a: number, b: number, value: number): number;
  1189. /**
  1190. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1191. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1192. * @param value1 spline value
  1193. * @param tangent1 spline value
  1194. * @param value2 spline value
  1195. * @param tangent2 spline value
  1196. * @param amount input value
  1197. * @returns hermite result
  1198. */
  1199. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1200. /**
  1201. * Returns a random float number between and min and max values
  1202. * @param min min value of random
  1203. * @param max max value of random
  1204. * @returns random value
  1205. */
  1206. static RandomRange(min: number, max: number): number;
  1207. /**
  1208. * This function returns percentage of a number in a given range.
  1209. *
  1210. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1211. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1212. * @param number to convert to percentage
  1213. * @param min min range
  1214. * @param max max range
  1215. * @returns the percentage
  1216. */
  1217. static RangeToPercent(number: number, min: number, max: number): number;
  1218. /**
  1219. * This function returns number that corresponds to the percentage in a given range.
  1220. *
  1221. * PercentToRange(0.34,0,100) will return 34.
  1222. * @param percent to convert to number
  1223. * @param min min range
  1224. * @param max max range
  1225. * @returns the number
  1226. */
  1227. static PercentToRange(percent: number, min: number, max: number): number;
  1228. /**
  1229. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1230. * @param angle The angle to normalize in radian.
  1231. * @return The converted angle.
  1232. */
  1233. static NormalizeRadians(angle: number): number;
  1234. }
  1235. }
  1236. declare module "babylonjs/Maths/math.constants" {
  1237. /**
  1238. * Constant used to convert a value to gamma space
  1239. * @ignorenaming
  1240. */
  1241. export const ToGammaSpace: number;
  1242. /**
  1243. * Constant used to convert a value to linear space
  1244. * @ignorenaming
  1245. */
  1246. export const ToLinearSpace = 2.2;
  1247. /**
  1248. * Constant used to define the minimal number value in Babylon.js
  1249. * @ignorenaming
  1250. */
  1251. let Epsilon: number;
  1252. export { Epsilon };
  1253. }
  1254. declare module "babylonjs/Maths/math.viewport" {
  1255. /**
  1256. * Class used to represent a viewport on screen
  1257. */
  1258. export class Viewport {
  1259. /** viewport left coordinate */
  1260. x: number;
  1261. /** viewport top coordinate */
  1262. y: number;
  1263. /**viewport width */
  1264. width: number;
  1265. /** viewport height */
  1266. height: number;
  1267. /**
  1268. * Creates a Viewport object located at (x, y) and sized (width, height)
  1269. * @param x defines viewport left coordinate
  1270. * @param y defines viewport top coordinate
  1271. * @param width defines the viewport width
  1272. * @param height defines the viewport height
  1273. */
  1274. constructor(
  1275. /** viewport left coordinate */
  1276. x: number,
  1277. /** viewport top coordinate */
  1278. y: number,
  1279. /**viewport width */
  1280. width: number,
  1281. /** viewport height */
  1282. height: number);
  1283. /**
  1284. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1285. * @param renderWidth defines the rendering width
  1286. * @param renderHeight defines the rendering height
  1287. * @returns a new Viewport
  1288. */
  1289. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1290. /**
  1291. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1292. * @param renderWidth defines the rendering width
  1293. * @param renderHeight defines the rendering height
  1294. * @param ref defines the target viewport
  1295. * @returns the current viewport
  1296. */
  1297. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1298. /**
  1299. * Returns a new Viewport copied from the current one
  1300. * @returns a new Viewport
  1301. */
  1302. clone(): Viewport;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/arrayTools" {
  1306. /**
  1307. * Class containing a set of static utilities functions for arrays.
  1308. */
  1309. export class ArrayTools {
  1310. /**
  1311. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1312. * @param size the number of element to construct and put in the array
  1313. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1314. * @returns a new array filled with new objects
  1315. */
  1316. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1317. }
  1318. }
  1319. declare module "babylonjs/Maths/math.like" {
  1320. import { float, int, DeepImmutable } from "babylonjs/types";
  1321. /**
  1322. * @hidden
  1323. */
  1324. export interface IColor4Like {
  1325. r: float;
  1326. g: float;
  1327. b: float;
  1328. a: float;
  1329. }
  1330. /**
  1331. * @hidden
  1332. */
  1333. export interface IColor3Like {
  1334. r: float;
  1335. g: float;
  1336. b: float;
  1337. }
  1338. /**
  1339. * @hidden
  1340. */
  1341. export interface IVector4Like {
  1342. x: float;
  1343. y: float;
  1344. z: float;
  1345. w: float;
  1346. }
  1347. /**
  1348. * @hidden
  1349. */
  1350. export interface IVector3Like {
  1351. x: float;
  1352. y: float;
  1353. z: float;
  1354. }
  1355. /**
  1356. * @hidden
  1357. */
  1358. export interface IVector2Like {
  1359. x: float;
  1360. y: float;
  1361. }
  1362. /**
  1363. * @hidden
  1364. */
  1365. export interface IMatrixLike {
  1366. toArray(): DeepImmutable<Float32Array>;
  1367. updateFlag: int;
  1368. }
  1369. /**
  1370. * @hidden
  1371. */
  1372. export interface IViewportLike {
  1373. x: float;
  1374. y: float;
  1375. width: float;
  1376. height: float;
  1377. }
  1378. /**
  1379. * @hidden
  1380. */
  1381. export interface IPlaneLike {
  1382. normal: IVector3Like;
  1383. d: float;
  1384. normalize(): void;
  1385. }
  1386. }
  1387. declare module "babylonjs/Maths/math.vector" {
  1388. import { Viewport } from "babylonjs/Maths/math.viewport";
  1389. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1390. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1391. /**
  1392. * Class representing a vector containing 2 coordinates
  1393. */
  1394. export class Vector2 {
  1395. /** defines the first coordinate */
  1396. x: number;
  1397. /** defines the second coordinate */
  1398. y: number;
  1399. /**
  1400. * Creates a new Vector2 from the given x and y coordinates
  1401. * @param x defines the first coordinate
  1402. * @param y defines the second coordinate
  1403. */
  1404. constructor(
  1405. /** defines the first coordinate */
  1406. x?: number,
  1407. /** defines the second coordinate */
  1408. y?: number);
  1409. /**
  1410. * Gets a string with the Vector2 coordinates
  1411. * @returns a string with the Vector2 coordinates
  1412. */
  1413. toString(): string;
  1414. /**
  1415. * Gets class name
  1416. * @returns the string "Vector2"
  1417. */
  1418. getClassName(): string;
  1419. /**
  1420. * Gets current vector hash code
  1421. * @returns the Vector2 hash code as a number
  1422. */
  1423. getHashCode(): number;
  1424. /**
  1425. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1426. * @param array defines the source array
  1427. * @param index defines the offset in source array
  1428. * @returns the current Vector2
  1429. */
  1430. toArray(array: FloatArray, index?: number): Vector2;
  1431. /**
  1432. * Copy the current vector to an array
  1433. * @returns a new array with 2 elements: the Vector2 coordinates.
  1434. */
  1435. asArray(): number[];
  1436. /**
  1437. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1438. * @param source defines the source Vector2
  1439. * @returns the current updated Vector2
  1440. */
  1441. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1442. /**
  1443. * Sets the Vector2 coordinates with the given floats
  1444. * @param x defines the first coordinate
  1445. * @param y defines the second coordinate
  1446. * @returns the current updated Vector2
  1447. */
  1448. copyFromFloats(x: number, y: number): Vector2;
  1449. /**
  1450. * Sets the Vector2 coordinates with the given floats
  1451. * @param x defines the first coordinate
  1452. * @param y defines the second coordinate
  1453. * @returns the current updated Vector2
  1454. */
  1455. set(x: number, y: number): Vector2;
  1456. /**
  1457. * Add another vector with the current one
  1458. * @param otherVector defines the other vector
  1459. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1460. */
  1461. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1462. /**
  1463. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  1464. * @param otherVector defines the other vector
  1465. * @param result defines the target vector
  1466. * @returns the unmodified current Vector2
  1467. */
  1468. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1469. /**
  1470. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  1471. * @param otherVector defines the other vector
  1472. * @returns the current updated Vector2
  1473. */
  1474. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1475. /**
  1476. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  1477. * @param otherVector defines the other vector
  1478. * @returns a new Vector2
  1479. */
  1480. addVector3(otherVector: Vector3): Vector2;
  1481. /**
  1482. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  1483. * @param otherVector defines the other vector
  1484. * @returns a new Vector2
  1485. */
  1486. subtract(otherVector: Vector2): Vector2;
  1487. /**
  1488. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  1489. * @param otherVector defines the other vector
  1490. * @param result defines the target vector
  1491. * @returns the unmodified current Vector2
  1492. */
  1493. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1494. /**
  1495. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  1496. * @param otherVector defines the other vector
  1497. * @returns the current updated Vector2
  1498. */
  1499. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1500. /**
  1501. * Multiplies in place the current Vector2 coordinates by the given ones
  1502. * @param otherVector defines the other vector
  1503. * @returns the current updated Vector2
  1504. */
  1505. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1506. /**
  1507. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  1508. * @param otherVector defines the other vector
  1509. * @returns a new Vector2
  1510. */
  1511. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  1512. /**
  1513. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  1514. * @param otherVector defines the other vector
  1515. * @param result defines the target vector
  1516. * @returns the unmodified current Vector2
  1517. */
  1518. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1519. /**
  1520. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  1521. * @param x defines the first coordinate
  1522. * @param y defines the second coordinate
  1523. * @returns a new Vector2
  1524. */
  1525. multiplyByFloats(x: number, y: number): Vector2;
  1526. /**
  1527. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  1528. * @param otherVector defines the other vector
  1529. * @returns a new Vector2
  1530. */
  1531. divide(otherVector: Vector2): Vector2;
  1532. /**
  1533. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  1534. * @param otherVector defines the other vector
  1535. * @param result defines the target vector
  1536. * @returns the unmodified current Vector2
  1537. */
  1538. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1539. /**
  1540. * Divides the current Vector2 coordinates by the given ones
  1541. * @param otherVector defines the other vector
  1542. * @returns the current updated Vector2
  1543. */
  1544. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1545. /**
  1546. * Gets a new Vector2 with current Vector2 negated coordinates
  1547. * @returns a new Vector2
  1548. */
  1549. negate(): Vector2;
  1550. /**
  1551. * Multiply the Vector2 coordinates by scale
  1552. * @param scale defines the scaling factor
  1553. * @returns the current updated Vector2
  1554. */
  1555. scaleInPlace(scale: number): Vector2;
  1556. /**
  1557. * Returns a new Vector2 scaled by "scale" from the current Vector2
  1558. * @param scale defines the scaling factor
  1559. * @returns a new Vector2
  1560. */
  1561. scale(scale: number): Vector2;
  1562. /**
  1563. * Scale the current Vector2 values by a factor to a given Vector2
  1564. * @param scale defines the scale factor
  1565. * @param result defines the Vector2 object where to store the result
  1566. * @returns the unmodified current Vector2
  1567. */
  1568. scaleToRef(scale: number, result: Vector2): Vector2;
  1569. /**
  1570. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  1571. * @param scale defines the scale factor
  1572. * @param result defines the Vector2 object where to store the result
  1573. * @returns the unmodified current Vector2
  1574. */
  1575. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  1576. /**
  1577. * Gets a boolean if two vectors are equals
  1578. * @param otherVector defines the other vector
  1579. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  1580. */
  1581. equals(otherVector: DeepImmutable<Vector2>): boolean;
  1582. /**
  1583. * Gets a boolean if two vectors are equals (using an epsilon value)
  1584. * @param otherVector defines the other vector
  1585. * @param epsilon defines the minimal distance to consider equality
  1586. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  1587. */
  1588. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  1589. /**
  1590. * Gets a new Vector2 from current Vector2 floored values
  1591. * @returns a new Vector2
  1592. */
  1593. floor(): Vector2;
  1594. /**
  1595. * Gets a new Vector2 from current Vector2 floored values
  1596. * @returns a new Vector2
  1597. */
  1598. fract(): Vector2;
  1599. /**
  1600. * Gets the length of the vector
  1601. * @returns the vector length (float)
  1602. */
  1603. length(): number;
  1604. /**
  1605. * Gets the vector squared length
  1606. * @returns the vector squared length (float)
  1607. */
  1608. lengthSquared(): number;
  1609. /**
  1610. * Normalize the vector
  1611. * @returns the current updated Vector2
  1612. */
  1613. normalize(): Vector2;
  1614. /**
  1615. * Gets a new Vector2 copied from the Vector2
  1616. * @returns a new Vector2
  1617. */
  1618. clone(): Vector2;
  1619. /**
  1620. * Gets a new Vector2(0, 0)
  1621. * @returns a new Vector2
  1622. */
  1623. static Zero(): Vector2;
  1624. /**
  1625. * Gets a new Vector2(1, 1)
  1626. * @returns a new Vector2
  1627. */
  1628. static One(): Vector2;
  1629. /**
  1630. * Gets a new Vector2 set from the given index element of the given array
  1631. * @param array defines the data source
  1632. * @param offset defines the offset in the data source
  1633. * @returns a new Vector2
  1634. */
  1635. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  1636. /**
  1637. * Sets "result" from the given index element of the given array
  1638. * @param array defines the data source
  1639. * @param offset defines the offset in the data source
  1640. * @param result defines the target vector
  1641. */
  1642. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  1643. /**
  1644. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  1645. * @param value1 defines 1st point of control
  1646. * @param value2 defines 2nd point of control
  1647. * @param value3 defines 3rd point of control
  1648. * @param value4 defines 4th point of control
  1649. * @param amount defines the interpolation factor
  1650. * @returns a new Vector2
  1651. */
  1652. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  1653. /**
  1654. * 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".
  1655. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  1656. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  1657. * @param value defines the value to clamp
  1658. * @param min defines the lower limit
  1659. * @param max defines the upper limit
  1660. * @returns a new Vector2
  1661. */
  1662. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  1663. /**
  1664. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  1665. * @param value1 defines the 1st control point
  1666. * @param tangent1 defines the outgoing tangent
  1667. * @param value2 defines the 2nd control point
  1668. * @param tangent2 defines the incoming tangent
  1669. * @param amount defines the interpolation factor
  1670. * @returns a new Vector2
  1671. */
  1672. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  1673. /**
  1674. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  1675. * @param start defines the start vector
  1676. * @param end defines the end vector
  1677. * @param amount defines the interpolation factor
  1678. * @returns a new Vector2
  1679. */
  1680. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  1681. /**
  1682. * Gets the dot product of the vector "left" and the vector "right"
  1683. * @param left defines first vector
  1684. * @param right defines second vector
  1685. * @returns the dot product (float)
  1686. */
  1687. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  1688. /**
  1689. * Returns a new Vector2 equal to the normalized given vector
  1690. * @param vector defines the vector to normalize
  1691. * @returns a new Vector2
  1692. */
  1693. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  1694. /**
  1695. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  1696. * @param left defines 1st vector
  1697. * @param right defines 2nd vector
  1698. * @returns a new Vector2
  1699. */
  1700. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  1701. /**
  1702. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  1703. * @param left defines 1st vector
  1704. * @param right defines 2nd vector
  1705. * @returns a new Vector2
  1706. */
  1707. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  1708. /**
  1709. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  1710. * @param vector defines the vector to transform
  1711. * @param transformation defines the matrix to apply
  1712. * @returns a new Vector2
  1713. */
  1714. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  1715. /**
  1716. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  1717. * @param vector defines the vector to transform
  1718. * @param transformation defines the matrix to apply
  1719. * @param result defines the target vector
  1720. */
  1721. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  1722. /**
  1723. * Determines if a given vector is included in a triangle
  1724. * @param p defines the vector to test
  1725. * @param p0 defines 1st triangle point
  1726. * @param p1 defines 2nd triangle point
  1727. * @param p2 defines 3rd triangle point
  1728. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  1729. */
  1730. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  1731. /**
  1732. * Gets the distance between the vectors "value1" and "value2"
  1733. * @param value1 defines first vector
  1734. * @param value2 defines second vector
  1735. * @returns the distance between vectors
  1736. */
  1737. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  1738. /**
  1739. * Returns the squared distance between the vectors "value1" and "value2"
  1740. * @param value1 defines first vector
  1741. * @param value2 defines second vector
  1742. * @returns the squared distance between vectors
  1743. */
  1744. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  1745. /**
  1746. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  1747. * @param value1 defines first vector
  1748. * @param value2 defines second vector
  1749. * @returns a new Vector2
  1750. */
  1751. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  1752. /**
  1753. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  1754. * @param p defines the middle point
  1755. * @param segA defines one point of the segment
  1756. * @param segB defines the other point of the segment
  1757. * @returns the shortest distance
  1758. */
  1759. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  1760. }
  1761. /**
  1762. * Classed used to store (x,y,z) vector representation
  1763. * A Vector3 is the main object used in 3D geometry
  1764. * It can represent etiher the coordinates of a point the space, either a direction
  1765. * Reminder: js uses a left handed forward facing system
  1766. */
  1767. export class Vector3 {
  1768. /**
  1769. * Defines the first coordinates (on X axis)
  1770. */
  1771. x: number;
  1772. /**
  1773. * Defines the second coordinates (on Y axis)
  1774. */
  1775. y: number;
  1776. /**
  1777. * Defines the third coordinates (on Z axis)
  1778. */
  1779. z: number;
  1780. private static _UpReadOnly;
  1781. private static _ZeroReadOnly;
  1782. /**
  1783. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  1784. * @param x defines the first coordinates (on X axis)
  1785. * @param y defines the second coordinates (on Y axis)
  1786. * @param z defines the third coordinates (on Z axis)
  1787. */
  1788. constructor(
  1789. /**
  1790. * Defines the first coordinates (on X axis)
  1791. */
  1792. x?: number,
  1793. /**
  1794. * Defines the second coordinates (on Y axis)
  1795. */
  1796. y?: number,
  1797. /**
  1798. * Defines the third coordinates (on Z axis)
  1799. */
  1800. z?: number);
  1801. /**
  1802. * Creates a string representation of the Vector3
  1803. * @returns a string with the Vector3 coordinates.
  1804. */
  1805. toString(): string;
  1806. /**
  1807. * Gets the class name
  1808. * @returns the string "Vector3"
  1809. */
  1810. getClassName(): string;
  1811. /**
  1812. * Creates the Vector3 hash code
  1813. * @returns a number which tends to be unique between Vector3 instances
  1814. */
  1815. getHashCode(): number;
  1816. /**
  1817. * Creates an array containing three elements : the coordinates of the Vector3
  1818. * @returns a new array of numbers
  1819. */
  1820. asArray(): number[];
  1821. /**
  1822. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  1823. * @param array defines the destination array
  1824. * @param index defines the offset in the destination array
  1825. * @returns the current Vector3
  1826. */
  1827. toArray(array: FloatArray, index?: number): Vector3;
  1828. /**
  1829. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  1830. * @returns a new Quaternion object, computed from the Vector3 coordinates
  1831. */
  1832. toQuaternion(): Quaternion;
  1833. /**
  1834. * Adds the given vector to the current Vector3
  1835. * @param otherVector defines the second operand
  1836. * @returns the current updated Vector3
  1837. */
  1838. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1839. /**
  1840. * Adds the given coordinates to the current Vector3
  1841. * @param x defines the x coordinate of the operand
  1842. * @param y defines the y coordinate of the operand
  1843. * @param z defines the z coordinate of the operand
  1844. * @returns the current updated Vector3
  1845. */
  1846. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  1847. /**
  1848. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  1849. * @param otherVector defines the second operand
  1850. * @returns the resulting Vector3
  1851. */
  1852. add(otherVector: DeepImmutable<Vector3>): Vector3;
  1853. /**
  1854. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  1855. * @param otherVector defines the second operand
  1856. * @param result defines the Vector3 object where to store the result
  1857. * @returns the current Vector3
  1858. */
  1859. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1860. /**
  1861. * Subtract the given vector from the current Vector3
  1862. * @param otherVector defines the second operand
  1863. * @returns the current updated Vector3
  1864. */
  1865. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1866. /**
  1867. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  1868. * @param otherVector defines the second operand
  1869. * @returns the resulting Vector3
  1870. */
  1871. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  1872. /**
  1873. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  1874. * @param otherVector defines the second operand
  1875. * @param result defines the Vector3 object where to store the result
  1876. * @returns the current Vector3
  1877. */
  1878. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1879. /**
  1880. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  1881. * @param x defines the x coordinate of the operand
  1882. * @param y defines the y coordinate of the operand
  1883. * @param z defines the z coordinate of the operand
  1884. * @returns the resulting Vector3
  1885. */
  1886. subtractFromFloats(x: number, y: number, z: number): Vector3;
  1887. /**
  1888. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  1889. * @param x defines the x coordinate of the operand
  1890. * @param y defines the y coordinate of the operand
  1891. * @param z defines the z coordinate of the operand
  1892. * @param result defines the Vector3 object where to store the result
  1893. * @returns the current Vector3
  1894. */
  1895. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  1896. /**
  1897. * Gets a new Vector3 set with the current Vector3 negated coordinates
  1898. * @returns a new Vector3
  1899. */
  1900. negate(): Vector3;
  1901. /**
  1902. * Multiplies the Vector3 coordinates by the float "scale"
  1903. * @param scale defines the multiplier factor
  1904. * @returns the current updated Vector3
  1905. */
  1906. scaleInPlace(scale: number): Vector3;
  1907. /**
  1908. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  1909. * @param scale defines the multiplier factor
  1910. * @returns a new Vector3
  1911. */
  1912. scale(scale: number): Vector3;
  1913. /**
  1914. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  1915. * @param scale defines the multiplier factor
  1916. * @param result defines the Vector3 object where to store the result
  1917. * @returns the current Vector3
  1918. */
  1919. scaleToRef(scale: number, result: Vector3): Vector3;
  1920. /**
  1921. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  1922. * @param scale defines the scale factor
  1923. * @param result defines the Vector3 object where to store the result
  1924. * @returns the unmodified current Vector3
  1925. */
  1926. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  1927. /**
  1928. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  1929. * @param otherVector defines the second operand
  1930. * @returns true if both vectors are equals
  1931. */
  1932. equals(otherVector: DeepImmutable<Vector3>): boolean;
  1933. /**
  1934. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  1935. * @param otherVector defines the second operand
  1936. * @param epsilon defines the minimal distance to define values as equals
  1937. * @returns true if both vectors are distant less than epsilon
  1938. */
  1939. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  1940. /**
  1941. * Returns true if the current Vector3 coordinates equals the given floats
  1942. * @param x defines the x coordinate of the operand
  1943. * @param y defines the y coordinate of the operand
  1944. * @param z defines the z coordinate of the operand
  1945. * @returns true if both vectors are equals
  1946. */
  1947. equalsToFloats(x: number, y: number, z: number): boolean;
  1948. /**
  1949. * Multiplies the current Vector3 coordinates by the given ones
  1950. * @param otherVector defines the second operand
  1951. * @returns the current updated Vector3
  1952. */
  1953. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1954. /**
  1955. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  1956. * @param otherVector defines the second operand
  1957. * @returns the new Vector3
  1958. */
  1959. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  1960. /**
  1961. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  1962. * @param otherVector defines the second operand
  1963. * @param result defines the Vector3 object where to store the result
  1964. * @returns the current Vector3
  1965. */
  1966. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1967. /**
  1968. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  1969. * @param x defines the x coordinate of the operand
  1970. * @param y defines the y coordinate of the operand
  1971. * @param z defines the z coordinate of the operand
  1972. * @returns the new Vector3
  1973. */
  1974. multiplyByFloats(x: number, y: number, z: number): Vector3;
  1975. /**
  1976. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  1977. * @param otherVector defines the second operand
  1978. * @returns the new Vector3
  1979. */
  1980. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  1981. /**
  1982. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  1983. * @param otherVector defines the second operand
  1984. * @param result defines the Vector3 object where to store the result
  1985. * @returns the current Vector3
  1986. */
  1987. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1988. /**
  1989. * Divides the current Vector3 coordinates by the given ones.
  1990. * @param otherVector defines the second operand
  1991. * @returns the current updated Vector3
  1992. */
  1993. divideInPlace(otherVector: Vector3): Vector3;
  1994. /**
  1995. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  1996. * @param other defines the second operand
  1997. * @returns the current updated Vector3
  1998. */
  1999. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2000. /**
  2001. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2002. * @param other defines the second operand
  2003. * @returns the current updated Vector3
  2004. */
  2005. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2006. /**
  2007. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2008. * @param x defines the x coordinate of the operand
  2009. * @param y defines the y coordinate of the operand
  2010. * @param z defines the z coordinate of the operand
  2011. * @returns the current updated Vector3
  2012. */
  2013. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2014. /**
  2015. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2016. * @param x defines the x coordinate of the operand
  2017. * @param y defines the y coordinate of the operand
  2018. * @param z defines the z coordinate of the operand
  2019. * @returns the current updated Vector3
  2020. */
  2021. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2022. /**
  2023. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2024. * Check if is non uniform within a certain amount of decimal places to account for this
  2025. * @param epsilon the amount the values can differ
  2026. * @returns if the the vector is non uniform to a certain number of decimal places
  2027. */
  2028. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2029. /**
  2030. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2031. */
  2032. readonly isNonUniform: boolean;
  2033. /**
  2034. * Gets a new Vector3 from current Vector3 floored values
  2035. * @returns a new Vector3
  2036. */
  2037. floor(): Vector3;
  2038. /**
  2039. * Gets a new Vector3 from current Vector3 floored values
  2040. * @returns a new Vector3
  2041. */
  2042. fract(): Vector3;
  2043. /**
  2044. * Gets the length of the Vector3
  2045. * @returns the length of the Vector3
  2046. */
  2047. length(): number;
  2048. /**
  2049. * Gets the squared length of the Vector3
  2050. * @returns squared length of the Vector3
  2051. */
  2052. lengthSquared(): number;
  2053. /**
  2054. * Normalize the current Vector3.
  2055. * Please note that this is an in place operation.
  2056. * @returns the current updated Vector3
  2057. */
  2058. normalize(): Vector3;
  2059. /**
  2060. * Reorders the x y z properties of the vector in place
  2061. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2062. * @returns the current updated vector
  2063. */
  2064. reorderInPlace(order: string): this;
  2065. /**
  2066. * Rotates the vector around 0,0,0 by a quaternion
  2067. * @param quaternion the rotation quaternion
  2068. * @param result vector to store the result
  2069. * @returns the resulting vector
  2070. */
  2071. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2072. /**
  2073. * Rotates a vector around a given point
  2074. * @param quaternion the rotation quaternion
  2075. * @param point the point to rotate around
  2076. * @param result vector to store the result
  2077. * @returns the resulting vector
  2078. */
  2079. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2080. /**
  2081. * Normalize the current Vector3 with the given input length.
  2082. * Please note that this is an in place operation.
  2083. * @param len the length of the vector
  2084. * @returns the current updated Vector3
  2085. */
  2086. normalizeFromLength(len: number): Vector3;
  2087. /**
  2088. * Normalize the current Vector3 to a new vector
  2089. * @returns the new Vector3
  2090. */
  2091. normalizeToNew(): Vector3;
  2092. /**
  2093. * Normalize the current Vector3 to the reference
  2094. * @param reference define the Vector3 to update
  2095. * @returns the updated Vector3
  2096. */
  2097. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2098. /**
  2099. * Creates a new Vector3 copied from the current Vector3
  2100. * @returns the new Vector3
  2101. */
  2102. clone(): Vector3;
  2103. /**
  2104. * Copies the given vector coordinates to the current Vector3 ones
  2105. * @param source defines the source Vector3
  2106. * @returns the current updated Vector3
  2107. */
  2108. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2109. /**
  2110. * Copies the given floats to the current Vector3 coordinates
  2111. * @param x defines the x coordinate of the operand
  2112. * @param y defines the y coordinate of the operand
  2113. * @param z defines the z coordinate of the operand
  2114. * @returns the current updated Vector3
  2115. */
  2116. copyFromFloats(x: number, y: number, z: number): Vector3;
  2117. /**
  2118. * Copies the given floats to the current Vector3 coordinates
  2119. * @param x defines the x coordinate of the operand
  2120. * @param y defines the y coordinate of the operand
  2121. * @param z defines the z coordinate of the operand
  2122. * @returns the current updated Vector3
  2123. */
  2124. set(x: number, y: number, z: number): Vector3;
  2125. /**
  2126. * Copies the given float to the current Vector3 coordinates
  2127. * @param v defines the x, y and z coordinates of the operand
  2128. * @returns the current updated Vector3
  2129. */
  2130. setAll(v: number): Vector3;
  2131. /**
  2132. * Get the clip factor between two vectors
  2133. * @param vector0 defines the first operand
  2134. * @param vector1 defines the second operand
  2135. * @param axis defines the axis to use
  2136. * @param size defines the size along the axis
  2137. * @returns the clip factor
  2138. */
  2139. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2140. /**
  2141. * Get angle between two vectors
  2142. * @param vector0 angle between vector0 and vector1
  2143. * @param vector1 angle between vector0 and vector1
  2144. * @param normal direction of the normal
  2145. * @return the angle between vector0 and vector1
  2146. */
  2147. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2148. /**
  2149. * Returns a new Vector3 set from the index "offset" of the given array
  2150. * @param array defines the source array
  2151. * @param offset defines the offset in the source array
  2152. * @returns the new Vector3
  2153. */
  2154. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2155. /**
  2156. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2157. * This function is deprecated. Use FromArray instead
  2158. * @param array defines the source array
  2159. * @param offset defines the offset in the source array
  2160. * @returns the new Vector3
  2161. */
  2162. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2163. /**
  2164. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2165. * @param array defines the source array
  2166. * @param offset defines the offset in the source array
  2167. * @param result defines the Vector3 where to store the result
  2168. */
  2169. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2170. /**
  2171. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2172. * This function is deprecated. Use FromArrayToRef instead.
  2173. * @param array defines the source array
  2174. * @param offset defines the offset in the source array
  2175. * @param result defines the Vector3 where to store the result
  2176. */
  2177. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2178. /**
  2179. * Sets the given vector "result" with the given floats.
  2180. * @param x defines the x coordinate of the source
  2181. * @param y defines the y coordinate of the source
  2182. * @param z defines the z coordinate of the source
  2183. * @param result defines the Vector3 where to store the result
  2184. */
  2185. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2186. /**
  2187. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2188. * @returns a new empty Vector3
  2189. */
  2190. static Zero(): Vector3;
  2191. /**
  2192. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2193. * @returns a new unit Vector3
  2194. */
  2195. static One(): Vector3;
  2196. /**
  2197. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2198. * @returns a new up Vector3
  2199. */
  2200. static Up(): Vector3;
  2201. /**
  2202. * Gets a up Vector3 that must not be updated
  2203. */
  2204. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2205. /**
  2206. * Gets a zero Vector3 that must not be updated
  2207. */
  2208. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2209. /**
  2210. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2211. * @returns a new down Vector3
  2212. */
  2213. static Down(): Vector3;
  2214. /**
  2215. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2216. * @returns a new forward Vector3
  2217. */
  2218. static Forward(): Vector3;
  2219. /**
  2220. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2221. * @returns a new forward Vector3
  2222. */
  2223. static Backward(): Vector3;
  2224. /**
  2225. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2226. * @returns a new right Vector3
  2227. */
  2228. static Right(): Vector3;
  2229. /**
  2230. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2231. * @returns a new left Vector3
  2232. */
  2233. static Left(): Vector3;
  2234. /**
  2235. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2236. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2237. * @param vector defines the Vector3 to transform
  2238. * @param transformation defines the transformation matrix
  2239. * @returns the transformed Vector3
  2240. */
  2241. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2242. /**
  2243. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2244. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2245. * @param vector defines the Vector3 to transform
  2246. * @param transformation defines the transformation matrix
  2247. * @param result defines the Vector3 where to store the result
  2248. */
  2249. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2250. /**
  2251. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2252. * This method computes tranformed coordinates only, not transformed direction vectors
  2253. * @param x define the x coordinate of the source vector
  2254. * @param y define the y coordinate of the source vector
  2255. * @param z define the z coordinate of the source vector
  2256. * @param transformation defines the transformation matrix
  2257. * @param result defines the Vector3 where to store the result
  2258. */
  2259. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2260. /**
  2261. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2262. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2263. * @param vector defines the Vector3 to transform
  2264. * @param transformation defines the transformation matrix
  2265. * @returns the new Vector3
  2266. */
  2267. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2268. /**
  2269. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2270. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2271. * @param vector defines the Vector3 to transform
  2272. * @param transformation defines the transformation matrix
  2273. * @param result defines the Vector3 where to store the result
  2274. */
  2275. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2276. /**
  2277. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2278. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2279. * @param x define the x coordinate of the source vector
  2280. * @param y define the y coordinate of the source vector
  2281. * @param z define the z coordinate of the source vector
  2282. * @param transformation defines the transformation matrix
  2283. * @param result defines the Vector3 where to store the result
  2284. */
  2285. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2286. /**
  2287. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2288. * @param value1 defines the first control point
  2289. * @param value2 defines the second control point
  2290. * @param value3 defines the third control point
  2291. * @param value4 defines the fourth control point
  2292. * @param amount defines the amount on the spline to use
  2293. * @returns the new Vector3
  2294. */
  2295. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2296. /**
  2297. * 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"
  2298. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2299. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2300. * @param value defines the current value
  2301. * @param min defines the lower range value
  2302. * @param max defines the upper range value
  2303. * @returns the new Vector3
  2304. */
  2305. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2306. /**
  2307. * 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"
  2308. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2309. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2310. * @param value defines the current value
  2311. * @param min defines the lower range value
  2312. * @param max defines the upper range value
  2313. * @param result defines the Vector3 where to store the result
  2314. */
  2315. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2316. /**
  2317. * Checks if a given vector is inside a specific range
  2318. * @param v defines the vector to test
  2319. * @param min defines the minimum range
  2320. * @param max defines the maximum range
  2321. */
  2322. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2323. /**
  2324. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2325. * @param value1 defines the first control point
  2326. * @param tangent1 defines the first tangent vector
  2327. * @param value2 defines the second control point
  2328. * @param tangent2 defines the second tangent vector
  2329. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2330. * @returns the new Vector3
  2331. */
  2332. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2333. /**
  2334. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2335. * @param start defines the start value
  2336. * @param end defines the end value
  2337. * @param amount max defines amount between both (between 0 and 1)
  2338. * @returns the new Vector3
  2339. */
  2340. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2341. /**
  2342. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2343. * @param start defines the start value
  2344. * @param end defines the end value
  2345. * @param amount max defines amount between both (between 0 and 1)
  2346. * @param result defines the Vector3 where to store the result
  2347. */
  2348. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2349. /**
  2350. * Returns the dot product (float) between the vectors "left" and "right"
  2351. * @param left defines the left operand
  2352. * @param right defines the right operand
  2353. * @returns the dot product
  2354. */
  2355. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2356. /**
  2357. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2358. * The cross product is then orthogonal to both "left" and "right"
  2359. * @param left defines the left operand
  2360. * @param right defines the right operand
  2361. * @returns the cross product
  2362. */
  2363. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2364. /**
  2365. * Sets the given vector "result" with the cross product of "left" and "right"
  2366. * The cross product is then orthogonal to both "left" and "right"
  2367. * @param left defines the left operand
  2368. * @param right defines the right operand
  2369. * @param result defines the Vector3 where to store the result
  2370. */
  2371. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2372. /**
  2373. * Returns a new Vector3 as the normalization of the given vector
  2374. * @param vector defines the Vector3 to normalize
  2375. * @returns the new Vector3
  2376. */
  2377. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2378. /**
  2379. * Sets the given vector "result" with the normalization of the given first vector
  2380. * @param vector defines the Vector3 to normalize
  2381. * @param result defines the Vector3 where to store the result
  2382. */
  2383. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2384. /**
  2385. * Project a Vector3 onto screen space
  2386. * @param vector defines the Vector3 to project
  2387. * @param world defines the world matrix to use
  2388. * @param transform defines the transform (view x projection) matrix to use
  2389. * @param viewport defines the screen viewport to use
  2390. * @returns the new Vector3
  2391. */
  2392. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2393. /** @hidden */
  2394. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2395. /**
  2396. * Unproject from screen space to object space
  2397. * @param source defines the screen space Vector3 to use
  2398. * @param viewportWidth defines the current width of the viewport
  2399. * @param viewportHeight defines the current height of the viewport
  2400. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2401. * @param transform defines the transform (view x projection) matrix to use
  2402. * @returns the new Vector3
  2403. */
  2404. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2405. /**
  2406. * Unproject from screen space to object space
  2407. * @param source defines the screen space Vector3 to use
  2408. * @param viewportWidth defines the current width of the viewport
  2409. * @param viewportHeight defines the current height of the viewport
  2410. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2411. * @param view defines the view matrix to use
  2412. * @param projection defines the projection matrix to use
  2413. * @returns the new Vector3
  2414. */
  2415. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2416. /**
  2417. * Unproject from screen space to object space
  2418. * @param source defines the screen space Vector3 to use
  2419. * @param viewportWidth defines the current width of the viewport
  2420. * @param viewportHeight defines the current height of the viewport
  2421. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2422. * @param view defines the view matrix to use
  2423. * @param projection defines the projection matrix to use
  2424. * @param result defines the Vector3 where to store the result
  2425. */
  2426. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2427. /**
  2428. * Unproject from screen space to object space
  2429. * @param sourceX defines the screen space x coordinate to use
  2430. * @param sourceY defines the screen space y coordinate to use
  2431. * @param sourceZ defines the screen space z coordinate to use
  2432. * @param viewportWidth defines the current width of the viewport
  2433. * @param viewportHeight defines the current height of the viewport
  2434. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2435. * @param view defines the view matrix to use
  2436. * @param projection defines the projection matrix to use
  2437. * @param result defines the Vector3 where to store the result
  2438. */
  2439. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2440. /**
  2441. * Gets the minimal coordinate values between two Vector3
  2442. * @param left defines the first operand
  2443. * @param right defines the second operand
  2444. * @returns the new Vector3
  2445. */
  2446. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2447. /**
  2448. * Gets the maximal coordinate values between two Vector3
  2449. * @param left defines the first operand
  2450. * @param right defines the second operand
  2451. * @returns the new Vector3
  2452. */
  2453. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2454. /**
  2455. * Returns the distance between the vectors "value1" and "value2"
  2456. * @param value1 defines the first operand
  2457. * @param value2 defines the second operand
  2458. * @returns the distance
  2459. */
  2460. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  2461. /**
  2462. * Returns the squared distance between the vectors "value1" and "value2"
  2463. * @param value1 defines the first operand
  2464. * @param value2 defines the second operand
  2465. * @returns the squared distance
  2466. */
  2467. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  2468. /**
  2469. * Returns a new Vector3 located at the center between "value1" and "value2"
  2470. * @param value1 defines the first operand
  2471. * @param value2 defines the second operand
  2472. * @returns the new Vector3
  2473. */
  2474. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  2475. /**
  2476. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  2477. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  2478. * to something in order to rotate it from its local system to the given target system
  2479. * Note: axis1, axis2 and axis3 are normalized during this operation
  2480. * @param axis1 defines the first axis
  2481. * @param axis2 defines the second axis
  2482. * @param axis3 defines the third axis
  2483. * @returns a new Vector3
  2484. */
  2485. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  2486. /**
  2487. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  2488. * @param axis1 defines the first axis
  2489. * @param axis2 defines the second axis
  2490. * @param axis3 defines the third axis
  2491. * @param ref defines the Vector3 where to store the result
  2492. */
  2493. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  2494. }
  2495. /**
  2496. * Vector4 class created for EulerAngle class conversion to Quaternion
  2497. */
  2498. export class Vector4 {
  2499. /** x value of the vector */
  2500. x: number;
  2501. /** y value of the vector */
  2502. y: number;
  2503. /** z value of the vector */
  2504. z: number;
  2505. /** w value of the vector */
  2506. w: number;
  2507. /**
  2508. * Creates a Vector4 object from the given floats.
  2509. * @param x x value of the vector
  2510. * @param y y value of the vector
  2511. * @param z z value of the vector
  2512. * @param w w value of the vector
  2513. */
  2514. constructor(
  2515. /** x value of the vector */
  2516. x: number,
  2517. /** y value of the vector */
  2518. y: number,
  2519. /** z value of the vector */
  2520. z: number,
  2521. /** w value of the vector */
  2522. w: number);
  2523. /**
  2524. * Returns the string with the Vector4 coordinates.
  2525. * @returns a string containing all the vector values
  2526. */
  2527. toString(): string;
  2528. /**
  2529. * Returns the string "Vector4".
  2530. * @returns "Vector4"
  2531. */
  2532. getClassName(): string;
  2533. /**
  2534. * Returns the Vector4 hash code.
  2535. * @returns a unique hash code
  2536. */
  2537. getHashCode(): number;
  2538. /**
  2539. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  2540. * @returns the resulting array
  2541. */
  2542. asArray(): number[];
  2543. /**
  2544. * Populates the given array from the given index with the Vector4 coordinates.
  2545. * @param array array to populate
  2546. * @param index index of the array to start at (default: 0)
  2547. * @returns the Vector4.
  2548. */
  2549. toArray(array: FloatArray, index?: number): Vector4;
  2550. /**
  2551. * Adds the given vector to the current Vector4.
  2552. * @param otherVector the vector to add
  2553. * @returns the updated Vector4.
  2554. */
  2555. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2556. /**
  2557. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  2558. * @param otherVector the vector to add
  2559. * @returns the resulting vector
  2560. */
  2561. add(otherVector: DeepImmutable<Vector4>): Vector4;
  2562. /**
  2563. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  2564. * @param otherVector the vector to add
  2565. * @param result the vector to store the result
  2566. * @returns the current Vector4.
  2567. */
  2568. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2569. /**
  2570. * Subtract in place the given vector from the current Vector4.
  2571. * @param otherVector the vector to subtract
  2572. * @returns the updated Vector4.
  2573. */
  2574. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2575. /**
  2576. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  2577. * @param otherVector the vector to add
  2578. * @returns the new vector with the result
  2579. */
  2580. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  2581. /**
  2582. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  2583. * @param otherVector the vector to subtract
  2584. * @param result the vector to store the result
  2585. * @returns the current Vector4.
  2586. */
  2587. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2588. /**
  2589. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2590. */
  2591. /**
  2592. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2593. * @param x value to subtract
  2594. * @param y value to subtract
  2595. * @param z value to subtract
  2596. * @param w value to subtract
  2597. * @returns new vector containing the result
  2598. */
  2599. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  2600. /**
  2601. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2602. * @param x value to subtract
  2603. * @param y value to subtract
  2604. * @param z value to subtract
  2605. * @param w value to subtract
  2606. * @param result the vector to store the result in
  2607. * @returns the current Vector4.
  2608. */
  2609. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  2610. /**
  2611. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  2612. * @returns a new vector with the negated values
  2613. */
  2614. negate(): Vector4;
  2615. /**
  2616. * Multiplies the current Vector4 coordinates by scale (float).
  2617. * @param scale the number to scale with
  2618. * @returns the updated Vector4.
  2619. */
  2620. scaleInPlace(scale: number): Vector4;
  2621. /**
  2622. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  2623. * @param scale the number to scale with
  2624. * @returns a new vector with the result
  2625. */
  2626. scale(scale: number): Vector4;
  2627. /**
  2628. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  2629. * @param scale the number to scale with
  2630. * @param result a vector to store the result in
  2631. * @returns the current Vector4.
  2632. */
  2633. scaleToRef(scale: number, result: Vector4): Vector4;
  2634. /**
  2635. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  2636. * @param scale defines the scale factor
  2637. * @param result defines the Vector4 object where to store the result
  2638. * @returns the unmodified current Vector4
  2639. */
  2640. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  2641. /**
  2642. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  2643. * @param otherVector the vector to compare against
  2644. * @returns true if they are equal
  2645. */
  2646. equals(otherVector: DeepImmutable<Vector4>): boolean;
  2647. /**
  2648. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  2649. * @param otherVector vector to compare against
  2650. * @param epsilon (Default: very small number)
  2651. * @returns true if they are equal
  2652. */
  2653. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  2654. /**
  2655. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  2656. * @param x x value to compare against
  2657. * @param y y value to compare against
  2658. * @param z z value to compare against
  2659. * @param w w value to compare against
  2660. * @returns true if equal
  2661. */
  2662. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  2663. /**
  2664. * Multiplies in place the current Vector4 by the given one.
  2665. * @param otherVector vector to multiple with
  2666. * @returns the updated Vector4.
  2667. */
  2668. multiplyInPlace(otherVector: Vector4): Vector4;
  2669. /**
  2670. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  2671. * @param otherVector vector to multiple with
  2672. * @returns resulting new vector
  2673. */
  2674. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  2675. /**
  2676. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  2677. * @param otherVector vector to multiple with
  2678. * @param result vector to store the result
  2679. * @returns the current Vector4.
  2680. */
  2681. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2682. /**
  2683. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  2684. * @param x x value multiply with
  2685. * @param y y value multiply with
  2686. * @param z z value multiply with
  2687. * @param w w value multiply with
  2688. * @returns resulting new vector
  2689. */
  2690. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  2691. /**
  2692. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  2693. * @param otherVector vector to devide with
  2694. * @returns resulting new vector
  2695. */
  2696. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  2697. /**
  2698. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  2699. * @param otherVector vector to devide with
  2700. * @param result vector to store the result
  2701. * @returns the current Vector4.
  2702. */
  2703. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2704. /**
  2705. * Divides the current Vector3 coordinates by the given ones.
  2706. * @param otherVector vector to devide with
  2707. * @returns the updated Vector3.
  2708. */
  2709. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2710. /**
  2711. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  2712. * @param other defines the second operand
  2713. * @returns the current updated Vector4
  2714. */
  2715. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  2716. /**
  2717. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  2718. * @param other defines the second operand
  2719. * @returns the current updated Vector4
  2720. */
  2721. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  2722. /**
  2723. * Gets a new Vector4 from current Vector4 floored values
  2724. * @returns a new Vector4
  2725. */
  2726. floor(): Vector4;
  2727. /**
  2728. * Gets a new Vector4 from current Vector3 floored values
  2729. * @returns a new Vector4
  2730. */
  2731. fract(): Vector4;
  2732. /**
  2733. * Returns the Vector4 length (float).
  2734. * @returns the length
  2735. */
  2736. length(): number;
  2737. /**
  2738. * Returns the Vector4 squared length (float).
  2739. * @returns the length squared
  2740. */
  2741. lengthSquared(): number;
  2742. /**
  2743. * Normalizes in place the Vector4.
  2744. * @returns the updated Vector4.
  2745. */
  2746. normalize(): Vector4;
  2747. /**
  2748. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  2749. * @returns this converted to a new vector3
  2750. */
  2751. toVector3(): Vector3;
  2752. /**
  2753. * Returns a new Vector4 copied from the current one.
  2754. * @returns the new cloned vector
  2755. */
  2756. clone(): Vector4;
  2757. /**
  2758. * Updates the current Vector4 with the given one coordinates.
  2759. * @param source the source vector to copy from
  2760. * @returns the updated Vector4.
  2761. */
  2762. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  2763. /**
  2764. * Updates the current Vector4 coordinates with the given floats.
  2765. * @param x float to copy from
  2766. * @param y float to copy from
  2767. * @param z float to copy from
  2768. * @param w float to copy from
  2769. * @returns the updated Vector4.
  2770. */
  2771. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  2772. /**
  2773. * Updates the current Vector4 coordinates with the given floats.
  2774. * @param x float to set from
  2775. * @param y float to set from
  2776. * @param z float to set from
  2777. * @param w float to set from
  2778. * @returns the updated Vector4.
  2779. */
  2780. set(x: number, y: number, z: number, w: number): Vector4;
  2781. /**
  2782. * Copies the given float to the current Vector3 coordinates
  2783. * @param v defines the x, y, z and w coordinates of the operand
  2784. * @returns the current updated Vector3
  2785. */
  2786. setAll(v: number): Vector4;
  2787. /**
  2788. * Returns a new Vector4 set from the starting index of the given array.
  2789. * @param array the array to pull values from
  2790. * @param offset the offset into the array to start at
  2791. * @returns the new vector
  2792. */
  2793. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  2794. /**
  2795. * Updates the given vector "result" from the starting index of the given array.
  2796. * @param array the array to pull values from
  2797. * @param offset the offset into the array to start at
  2798. * @param result the vector to store the result in
  2799. */
  2800. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  2801. /**
  2802. * Updates the given vector "result" from the starting index of the given Float32Array.
  2803. * @param array the array to pull values from
  2804. * @param offset the offset into the array to start at
  2805. * @param result the vector to store the result in
  2806. */
  2807. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  2808. /**
  2809. * Updates the given vector "result" coordinates from the given floats.
  2810. * @param x float to set from
  2811. * @param y float to set from
  2812. * @param z float to set from
  2813. * @param w float to set from
  2814. * @param result the vector to the floats in
  2815. */
  2816. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  2817. /**
  2818. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  2819. * @returns the new vector
  2820. */
  2821. static Zero(): Vector4;
  2822. /**
  2823. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  2824. * @returns the new vector
  2825. */
  2826. static One(): Vector4;
  2827. /**
  2828. * Returns a new normalized Vector4 from the given one.
  2829. * @param vector the vector to normalize
  2830. * @returns the vector
  2831. */
  2832. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  2833. /**
  2834. * Updates the given vector "result" from the normalization of the given one.
  2835. * @param vector the vector to normalize
  2836. * @param result the vector to store the result in
  2837. */
  2838. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  2839. /**
  2840. * Returns a vector with the minimum values from the left and right vectors
  2841. * @param left left vector to minimize
  2842. * @param right right vector to minimize
  2843. * @returns a new vector with the minimum of the left and right vector values
  2844. */
  2845. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  2846. /**
  2847. * Returns a vector with the maximum values from the left and right vectors
  2848. * @param left left vector to maximize
  2849. * @param right right vector to maximize
  2850. * @returns a new vector with the maximum of the left and right vector values
  2851. */
  2852. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  2853. /**
  2854. * Returns the distance (float) between the vectors "value1" and "value2".
  2855. * @param value1 value to calulate the distance between
  2856. * @param value2 value to calulate the distance between
  2857. * @return the distance between the two vectors
  2858. */
  2859. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  2860. /**
  2861. * Returns the squared distance (float) between the vectors "value1" and "value2".
  2862. * @param value1 value to calulate the distance between
  2863. * @param value2 value to calulate the distance between
  2864. * @return the distance between the two vectors squared
  2865. */
  2866. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  2867. /**
  2868. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  2869. * @param value1 value to calulate the center between
  2870. * @param value2 value to calulate the center between
  2871. * @return the center between the two vectors
  2872. */
  2873. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  2874. /**
  2875. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  2876. * This methods computes transformed normalized direction vectors only.
  2877. * @param vector the vector to transform
  2878. * @param transformation the transformation matrix to apply
  2879. * @returns the new vector
  2880. */
  2881. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  2882. /**
  2883. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  2884. * This methods computes transformed normalized direction vectors only.
  2885. * @param vector the vector to transform
  2886. * @param transformation the transformation matrix to apply
  2887. * @param result the vector to store the result in
  2888. */
  2889. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  2890. /**
  2891. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  2892. * This methods computes transformed normalized direction vectors only.
  2893. * @param x value to transform
  2894. * @param y value to transform
  2895. * @param z value to transform
  2896. * @param w value to transform
  2897. * @param transformation the transformation matrix to apply
  2898. * @param result the vector to store the results in
  2899. */
  2900. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  2901. /**
  2902. * Creates a new Vector4 from a Vector3
  2903. * @param source defines the source data
  2904. * @param w defines the 4th component (default is 0)
  2905. * @returns a new Vector4
  2906. */
  2907. static FromVector3(source: Vector3, w?: number): Vector4;
  2908. }
  2909. /**
  2910. * Class used to store quaternion data
  2911. * @see https://en.wikipedia.org/wiki/Quaternion
  2912. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  2913. */
  2914. export class Quaternion {
  2915. /** defines the first component (0 by default) */
  2916. x: number;
  2917. /** defines the second component (0 by default) */
  2918. y: number;
  2919. /** defines the third component (0 by default) */
  2920. z: number;
  2921. /** defines the fourth component (1.0 by default) */
  2922. w: number;
  2923. /**
  2924. * Creates a new Quaternion from the given floats
  2925. * @param x defines the first component (0 by default)
  2926. * @param y defines the second component (0 by default)
  2927. * @param z defines the third component (0 by default)
  2928. * @param w defines the fourth component (1.0 by default)
  2929. */
  2930. constructor(
  2931. /** defines the first component (0 by default) */
  2932. x?: number,
  2933. /** defines the second component (0 by default) */
  2934. y?: number,
  2935. /** defines the third component (0 by default) */
  2936. z?: number,
  2937. /** defines the fourth component (1.0 by default) */
  2938. w?: number);
  2939. /**
  2940. * Gets a string representation for the current quaternion
  2941. * @returns a string with the Quaternion coordinates
  2942. */
  2943. toString(): string;
  2944. /**
  2945. * Gets the class name of the quaternion
  2946. * @returns the string "Quaternion"
  2947. */
  2948. getClassName(): string;
  2949. /**
  2950. * Gets a hash code for this quaternion
  2951. * @returns the quaternion hash code
  2952. */
  2953. getHashCode(): number;
  2954. /**
  2955. * Copy the quaternion to an array
  2956. * @returns a new array populated with 4 elements from the quaternion coordinates
  2957. */
  2958. asArray(): number[];
  2959. /**
  2960. * Check if two quaternions are equals
  2961. * @param otherQuaternion defines the second operand
  2962. * @return true if the current quaternion and the given one coordinates are strictly equals
  2963. */
  2964. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  2965. /**
  2966. * Clone the current quaternion
  2967. * @returns a new quaternion copied from the current one
  2968. */
  2969. clone(): Quaternion;
  2970. /**
  2971. * Copy a quaternion to the current one
  2972. * @param other defines the other quaternion
  2973. * @returns the updated current quaternion
  2974. */
  2975. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  2976. /**
  2977. * Updates the current quaternion with the given float coordinates
  2978. * @param x defines the x coordinate
  2979. * @param y defines the y coordinate
  2980. * @param z defines the z coordinate
  2981. * @param w defines the w coordinate
  2982. * @returns the updated current quaternion
  2983. */
  2984. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  2985. /**
  2986. * Updates the current quaternion from the given float coordinates
  2987. * @param x defines the x coordinate
  2988. * @param y defines the y coordinate
  2989. * @param z defines the z coordinate
  2990. * @param w defines the w coordinate
  2991. * @returns the updated current quaternion
  2992. */
  2993. set(x: number, y: number, z: number, w: number): Quaternion;
  2994. /**
  2995. * Adds two quaternions
  2996. * @param other defines the second operand
  2997. * @returns a new quaternion as the addition result of the given one and the current quaternion
  2998. */
  2999. add(other: DeepImmutable<Quaternion>): Quaternion;
  3000. /**
  3001. * Add a quaternion to the current one
  3002. * @param other defines the quaternion to add
  3003. * @returns the current quaternion
  3004. */
  3005. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3006. /**
  3007. * Subtract two quaternions
  3008. * @param other defines the second operand
  3009. * @returns a new quaternion as the subtraction result of the given one from the current one
  3010. */
  3011. subtract(other: Quaternion): Quaternion;
  3012. /**
  3013. * Multiplies the current quaternion by a scale factor
  3014. * @param value defines the scale factor
  3015. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3016. */
  3017. scale(value: number): Quaternion;
  3018. /**
  3019. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3020. * @param scale defines the scale factor
  3021. * @param result defines the Quaternion object where to store the result
  3022. * @returns the unmodified current quaternion
  3023. */
  3024. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3025. /**
  3026. * Multiplies in place the current quaternion by a scale factor
  3027. * @param value defines the scale factor
  3028. * @returns the current modified quaternion
  3029. */
  3030. scaleInPlace(value: number): Quaternion;
  3031. /**
  3032. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3033. * @param scale defines the scale factor
  3034. * @param result defines the Quaternion object where to store the result
  3035. * @returns the unmodified current quaternion
  3036. */
  3037. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3038. /**
  3039. * Multiplies two quaternions
  3040. * @param q1 defines the second operand
  3041. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3042. */
  3043. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3044. /**
  3045. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3046. * @param q1 defines the second operand
  3047. * @param result defines the target quaternion
  3048. * @returns the current quaternion
  3049. */
  3050. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3051. /**
  3052. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3053. * @param q1 defines the second operand
  3054. * @returns the currentupdated quaternion
  3055. */
  3056. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3057. /**
  3058. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3059. * @param ref defines the target quaternion
  3060. * @returns the current quaternion
  3061. */
  3062. conjugateToRef(ref: Quaternion): Quaternion;
  3063. /**
  3064. * Conjugates in place (1-q) the current quaternion
  3065. * @returns the current updated quaternion
  3066. */
  3067. conjugateInPlace(): Quaternion;
  3068. /**
  3069. * Conjugates in place (1-q) the current quaternion
  3070. * @returns a new quaternion
  3071. */
  3072. conjugate(): Quaternion;
  3073. /**
  3074. * Gets length of current quaternion
  3075. * @returns the quaternion length (float)
  3076. */
  3077. length(): number;
  3078. /**
  3079. * Normalize in place the current quaternion
  3080. * @returns the current updated quaternion
  3081. */
  3082. normalize(): Quaternion;
  3083. /**
  3084. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3085. * @param order is a reserved parameter and is ignore for now
  3086. * @returns a new Vector3 containing the Euler angles
  3087. */
  3088. toEulerAngles(order?: string): Vector3;
  3089. /**
  3090. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3091. * @param result defines the vector which will be filled with the Euler angles
  3092. * @param order is a reserved parameter and is ignore for now
  3093. * @returns the current unchanged quaternion
  3094. */
  3095. toEulerAnglesToRef(result: Vector3): Quaternion;
  3096. /**
  3097. * Updates the given rotation matrix with the current quaternion values
  3098. * @param result defines the target matrix
  3099. * @returns the current unchanged quaternion
  3100. */
  3101. toRotationMatrix(result: Matrix): Quaternion;
  3102. /**
  3103. * Updates the current quaternion from the given rotation matrix values
  3104. * @param matrix defines the source matrix
  3105. * @returns the current updated quaternion
  3106. */
  3107. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3108. /**
  3109. * Creates a new quaternion from a rotation matrix
  3110. * @param matrix defines the source matrix
  3111. * @returns a new quaternion created from the given rotation matrix values
  3112. */
  3113. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3114. /**
  3115. * Updates the given quaternion with the given rotation matrix values
  3116. * @param matrix defines the source matrix
  3117. * @param result defines the target quaternion
  3118. */
  3119. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3120. /**
  3121. * Returns the dot product (float) between the quaternions "left" and "right"
  3122. * @param left defines the left operand
  3123. * @param right defines the right operand
  3124. * @returns the dot product
  3125. */
  3126. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3127. /**
  3128. * Checks if the two quaternions are close to each other
  3129. * @param quat0 defines the first quaternion to check
  3130. * @param quat1 defines the second quaternion to check
  3131. * @returns true if the two quaternions are close to each other
  3132. */
  3133. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3134. /**
  3135. * Creates an empty quaternion
  3136. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3137. */
  3138. static Zero(): Quaternion;
  3139. /**
  3140. * Inverse a given quaternion
  3141. * @param q defines the source quaternion
  3142. * @returns a new quaternion as the inverted current quaternion
  3143. */
  3144. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3145. /**
  3146. * Inverse a given quaternion
  3147. * @param q defines the source quaternion
  3148. * @param result the quaternion the result will be stored in
  3149. * @returns the result quaternion
  3150. */
  3151. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3152. /**
  3153. * Creates an identity quaternion
  3154. * @returns the identity quaternion
  3155. */
  3156. static Identity(): Quaternion;
  3157. /**
  3158. * Gets a boolean indicating if the given quaternion is identity
  3159. * @param quaternion defines the quaternion to check
  3160. * @returns true if the quaternion is identity
  3161. */
  3162. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3163. /**
  3164. * Creates a quaternion from a rotation around an axis
  3165. * @param axis defines the axis to use
  3166. * @param angle defines the angle to use
  3167. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3168. */
  3169. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3170. /**
  3171. * Creates a rotation around an axis and stores it into the given quaternion
  3172. * @param axis defines the axis to use
  3173. * @param angle defines the angle to use
  3174. * @param result defines the target quaternion
  3175. * @returns the target quaternion
  3176. */
  3177. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3178. /**
  3179. * Creates a new quaternion from data stored into an array
  3180. * @param array defines the data source
  3181. * @param offset defines the offset in the source array where the data starts
  3182. * @returns a new quaternion
  3183. */
  3184. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3185. /**
  3186. * Create a quaternion from Euler rotation angles
  3187. * @param x Pitch
  3188. * @param y Yaw
  3189. * @param z Roll
  3190. * @returns the new Quaternion
  3191. */
  3192. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3193. /**
  3194. * Updates a quaternion from Euler rotation angles
  3195. * @param x Pitch
  3196. * @param y Yaw
  3197. * @param z Roll
  3198. * @param result the quaternion to store the result
  3199. * @returns the updated quaternion
  3200. */
  3201. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3202. /**
  3203. * Create a quaternion from Euler rotation vector
  3204. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3205. * @returns the new Quaternion
  3206. */
  3207. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3208. /**
  3209. * Updates a quaternion from Euler rotation vector
  3210. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3211. * @param result the quaternion to store the result
  3212. * @returns the updated quaternion
  3213. */
  3214. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3215. /**
  3216. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3217. * @param yaw defines the rotation around Y axis
  3218. * @param pitch defines the rotation around X axis
  3219. * @param roll defines the rotation around Z axis
  3220. * @returns the new quaternion
  3221. */
  3222. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3223. /**
  3224. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3225. * @param yaw defines the rotation around Y axis
  3226. * @param pitch defines the rotation around X axis
  3227. * @param roll defines the rotation around Z axis
  3228. * @param result defines the target quaternion
  3229. */
  3230. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3231. /**
  3232. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3233. * @param alpha defines the rotation around first axis
  3234. * @param beta defines the rotation around second axis
  3235. * @param gamma defines the rotation around third axis
  3236. * @returns the new quaternion
  3237. */
  3238. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3239. /**
  3240. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3241. * @param alpha defines the rotation around first axis
  3242. * @param beta defines the rotation around second axis
  3243. * @param gamma defines the rotation around third axis
  3244. * @param result defines the target quaternion
  3245. */
  3246. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3247. /**
  3248. * 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)
  3249. * @param axis1 defines the first axis
  3250. * @param axis2 defines the second axis
  3251. * @param axis3 defines the third axis
  3252. * @returns the new quaternion
  3253. */
  3254. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3255. /**
  3256. * 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
  3257. * @param axis1 defines the first axis
  3258. * @param axis2 defines the second axis
  3259. * @param axis3 defines the third axis
  3260. * @param ref defines the target quaternion
  3261. */
  3262. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3263. /**
  3264. * Interpolates between two quaternions
  3265. * @param left defines first quaternion
  3266. * @param right defines second quaternion
  3267. * @param amount defines the gradient to use
  3268. * @returns the new interpolated quaternion
  3269. */
  3270. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3271. /**
  3272. * Interpolates between two quaternions and stores it into a target quaternion
  3273. * @param left defines first quaternion
  3274. * @param right defines second quaternion
  3275. * @param amount defines the gradient to use
  3276. * @param result defines the target quaternion
  3277. */
  3278. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3279. /**
  3280. * Interpolate between two quaternions using Hermite interpolation
  3281. * @param value1 defines first quaternion
  3282. * @param tangent1 defines the incoming tangent
  3283. * @param value2 defines second quaternion
  3284. * @param tangent2 defines the outgoing tangent
  3285. * @param amount defines the target quaternion
  3286. * @returns the new interpolated quaternion
  3287. */
  3288. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3289. }
  3290. /**
  3291. * Class used to store matrix data (4x4)
  3292. */
  3293. export class Matrix {
  3294. private static _updateFlagSeed;
  3295. private static _identityReadOnly;
  3296. private _isIdentity;
  3297. private _isIdentityDirty;
  3298. private _isIdentity3x2;
  3299. private _isIdentity3x2Dirty;
  3300. /**
  3301. * Gets the update flag of the matrix which is an unique number for the matrix.
  3302. * It will be incremented every time the matrix data change.
  3303. * You can use it to speed the comparison between two versions of the same matrix.
  3304. */
  3305. updateFlag: number;
  3306. private readonly _m;
  3307. /**
  3308. * Gets the internal data of the matrix
  3309. */
  3310. readonly m: DeepImmutable<Float32Array>;
  3311. /** @hidden */
  3312. _markAsUpdated(): void;
  3313. /** @hidden */
  3314. private _updateIdentityStatus;
  3315. /**
  3316. * Creates an empty matrix (filled with zeros)
  3317. */
  3318. constructor();
  3319. /**
  3320. * Check if the current matrix is identity
  3321. * @returns true is the matrix is the identity matrix
  3322. */
  3323. isIdentity(): boolean;
  3324. /**
  3325. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3326. * @returns true is the matrix is the identity matrix
  3327. */
  3328. isIdentityAs3x2(): boolean;
  3329. /**
  3330. * Gets the determinant of the matrix
  3331. * @returns the matrix determinant
  3332. */
  3333. determinant(): number;
  3334. /**
  3335. * Returns the matrix as a Float32Array
  3336. * @returns the matrix underlying array
  3337. */
  3338. toArray(): DeepImmutable<Float32Array>;
  3339. /**
  3340. * Returns the matrix as a Float32Array
  3341. * @returns the matrix underlying array.
  3342. */
  3343. asArray(): DeepImmutable<Float32Array>;
  3344. /**
  3345. * Inverts the current matrix in place
  3346. * @returns the current inverted matrix
  3347. */
  3348. invert(): Matrix;
  3349. /**
  3350. * Sets all the matrix elements to zero
  3351. * @returns the current matrix
  3352. */
  3353. reset(): Matrix;
  3354. /**
  3355. * Adds the current matrix with a second one
  3356. * @param other defines the matrix to add
  3357. * @returns a new matrix as the addition of the current matrix and the given one
  3358. */
  3359. add(other: DeepImmutable<Matrix>): Matrix;
  3360. /**
  3361. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3362. * @param other defines the matrix to add
  3363. * @param result defines the target matrix
  3364. * @returns the current matrix
  3365. */
  3366. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3367. /**
  3368. * Adds in place the given matrix to the current matrix
  3369. * @param other defines the second operand
  3370. * @returns the current updated matrix
  3371. */
  3372. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3373. /**
  3374. * Sets the given matrix to the current inverted Matrix
  3375. * @param other defines the target matrix
  3376. * @returns the unmodified current matrix
  3377. */
  3378. invertToRef(other: Matrix): Matrix;
  3379. /**
  3380. * add a value at the specified position in the current Matrix
  3381. * @param index the index of the value within the matrix. between 0 and 15.
  3382. * @param value the value to be added
  3383. * @returns the current updated matrix
  3384. */
  3385. addAtIndex(index: number, value: number): Matrix;
  3386. /**
  3387. * mutiply the specified position in the current Matrix by a value
  3388. * @param index the index of the value within the matrix. between 0 and 15.
  3389. * @param value the value to be added
  3390. * @returns the current updated matrix
  3391. */
  3392. multiplyAtIndex(index: number, value: number): Matrix;
  3393. /**
  3394. * Inserts the translation vector (using 3 floats) in the current matrix
  3395. * @param x defines the 1st component of the translation
  3396. * @param y defines the 2nd component of the translation
  3397. * @param z defines the 3rd component of the translation
  3398. * @returns the current updated matrix
  3399. */
  3400. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3401. /**
  3402. * Adds the translation vector (using 3 floats) in the current matrix
  3403. * @param x defines the 1st component of the translation
  3404. * @param y defines the 2nd component of the translation
  3405. * @param z defines the 3rd component of the translation
  3406. * @returns the current updated matrix
  3407. */
  3408. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3409. /**
  3410. * Inserts the translation vector in the current matrix
  3411. * @param vector3 defines the translation to insert
  3412. * @returns the current updated matrix
  3413. */
  3414. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3415. /**
  3416. * Gets the translation value of the current matrix
  3417. * @returns a new Vector3 as the extracted translation from the matrix
  3418. */
  3419. getTranslation(): Vector3;
  3420. /**
  3421. * Fill a Vector3 with the extracted translation from the matrix
  3422. * @param result defines the Vector3 where to store the translation
  3423. * @returns the current matrix
  3424. */
  3425. getTranslationToRef(result: Vector3): Matrix;
  3426. /**
  3427. * Remove rotation and scaling part from the matrix
  3428. * @returns the updated matrix
  3429. */
  3430. removeRotationAndScaling(): Matrix;
  3431. /**
  3432. * Multiply two matrices
  3433. * @param other defines the second operand
  3434. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3435. */
  3436. multiply(other: DeepImmutable<Matrix>): Matrix;
  3437. /**
  3438. * Copy the current matrix from the given one
  3439. * @param other defines the source matrix
  3440. * @returns the current updated matrix
  3441. */
  3442. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3443. /**
  3444. * Populates the given array from the starting index with the current matrix values
  3445. * @param array defines the target array
  3446. * @param offset defines the offset in the target array where to start storing values
  3447. * @returns the current matrix
  3448. */
  3449. copyToArray(array: Float32Array, offset?: number): Matrix;
  3450. /**
  3451. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3452. * @param other defines the second operand
  3453. * @param result defines the matrix where to store the multiplication
  3454. * @returns the current matrix
  3455. */
  3456. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3457. /**
  3458. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  3459. * @param other defines the second operand
  3460. * @param result defines the array where to store the multiplication
  3461. * @param offset defines the offset in the target array where to start storing values
  3462. * @returns the current matrix
  3463. */
  3464. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  3465. /**
  3466. * Check equality between this matrix and a second one
  3467. * @param value defines the second matrix to compare
  3468. * @returns true is the current matrix and the given one values are strictly equal
  3469. */
  3470. equals(value: DeepImmutable<Matrix>): boolean;
  3471. /**
  3472. * Clone the current matrix
  3473. * @returns a new matrix from the current matrix
  3474. */
  3475. clone(): Matrix;
  3476. /**
  3477. * Returns the name of the current matrix class
  3478. * @returns the string "Matrix"
  3479. */
  3480. getClassName(): string;
  3481. /**
  3482. * Gets the hash code of the current matrix
  3483. * @returns the hash code
  3484. */
  3485. getHashCode(): number;
  3486. /**
  3487. * Decomposes the current Matrix into a translation, rotation and scaling components
  3488. * @param scale defines the scale vector3 given as a reference to update
  3489. * @param rotation defines the rotation quaternion given as a reference to update
  3490. * @param translation defines the translation vector3 given as a reference to update
  3491. * @returns true if operation was successful
  3492. */
  3493. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  3494. /**
  3495. * Gets specific row of the matrix
  3496. * @param index defines the number of the row to get
  3497. * @returns the index-th row of the current matrix as a new Vector4
  3498. */
  3499. getRow(index: number): Nullable<Vector4>;
  3500. /**
  3501. * Sets the index-th row of the current matrix to the vector4 values
  3502. * @param index defines the number of the row to set
  3503. * @param row defines the target vector4
  3504. * @returns the updated current matrix
  3505. */
  3506. setRow(index: number, row: Vector4): Matrix;
  3507. /**
  3508. * Compute the transpose of the matrix
  3509. * @returns the new transposed matrix
  3510. */
  3511. transpose(): Matrix;
  3512. /**
  3513. * Compute the transpose of the matrix and store it in a given matrix
  3514. * @param result defines the target matrix
  3515. * @returns the current matrix
  3516. */
  3517. transposeToRef(result: Matrix): Matrix;
  3518. /**
  3519. * Sets the index-th row of the current matrix with the given 4 x float values
  3520. * @param index defines the row index
  3521. * @param x defines the x component to set
  3522. * @param y defines the y component to set
  3523. * @param z defines the z component to set
  3524. * @param w defines the w component to set
  3525. * @returns the updated current matrix
  3526. */
  3527. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  3528. /**
  3529. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  3530. * @param scale defines the scale factor
  3531. * @returns a new matrix
  3532. */
  3533. scale(scale: number): Matrix;
  3534. /**
  3535. * Scale the current matrix values by a factor to a given result matrix
  3536. * @param scale defines the scale factor
  3537. * @param result defines the matrix to store the result
  3538. * @returns the current matrix
  3539. */
  3540. scaleToRef(scale: number, result: Matrix): Matrix;
  3541. /**
  3542. * Scale the current matrix values by a factor and add the result to a given matrix
  3543. * @param scale defines the scale factor
  3544. * @param result defines the Matrix to store the result
  3545. * @returns the current matrix
  3546. */
  3547. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  3548. /**
  3549. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  3550. * @param ref matrix to store the result
  3551. */
  3552. toNormalMatrix(ref: Matrix): void;
  3553. /**
  3554. * Gets only rotation part of the current matrix
  3555. * @returns a new matrix sets to the extracted rotation matrix from the current one
  3556. */
  3557. getRotationMatrix(): Matrix;
  3558. /**
  3559. * Extracts the rotation matrix from the current one and sets it as the given "result"
  3560. * @param result defines the target matrix to store data to
  3561. * @returns the current matrix
  3562. */
  3563. getRotationMatrixToRef(result: Matrix): Matrix;
  3564. /**
  3565. * Toggles model matrix from being right handed to left handed in place and vice versa
  3566. */
  3567. toggleModelMatrixHandInPlace(): void;
  3568. /**
  3569. * Toggles projection matrix from being right handed to left handed in place and vice versa
  3570. */
  3571. toggleProjectionMatrixHandInPlace(): void;
  3572. /**
  3573. * Creates a matrix from an array
  3574. * @param array defines the source array
  3575. * @param offset defines an offset in the source array
  3576. * @returns a new Matrix set from the starting index of the given array
  3577. */
  3578. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  3579. /**
  3580. * Copy the content of an array into a given matrix
  3581. * @param array defines the source array
  3582. * @param offset defines an offset in the source array
  3583. * @param result defines the target matrix
  3584. */
  3585. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  3586. /**
  3587. * Stores an array into a matrix after having multiplied each component by a given factor
  3588. * @param array defines the source array
  3589. * @param offset defines the offset in the source array
  3590. * @param scale defines the scaling factor
  3591. * @param result defines the target matrix
  3592. */
  3593. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  3594. /**
  3595. * Gets an identity matrix that must not be updated
  3596. */
  3597. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  3598. /**
  3599. * Stores a list of values (16) inside a given matrix
  3600. * @param initialM11 defines 1st value of 1st row
  3601. * @param initialM12 defines 2nd value of 1st row
  3602. * @param initialM13 defines 3rd value of 1st row
  3603. * @param initialM14 defines 4th value of 1st row
  3604. * @param initialM21 defines 1st value of 2nd row
  3605. * @param initialM22 defines 2nd value of 2nd row
  3606. * @param initialM23 defines 3rd value of 2nd row
  3607. * @param initialM24 defines 4th value of 2nd row
  3608. * @param initialM31 defines 1st value of 3rd row
  3609. * @param initialM32 defines 2nd value of 3rd row
  3610. * @param initialM33 defines 3rd value of 3rd row
  3611. * @param initialM34 defines 4th value of 3rd row
  3612. * @param initialM41 defines 1st value of 4th row
  3613. * @param initialM42 defines 2nd value of 4th row
  3614. * @param initialM43 defines 3rd value of 4th row
  3615. * @param initialM44 defines 4th value of 4th row
  3616. * @param result defines the target matrix
  3617. */
  3618. 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;
  3619. /**
  3620. * Creates new matrix from a list of values (16)
  3621. * @param initialM11 defines 1st value of 1st row
  3622. * @param initialM12 defines 2nd value of 1st row
  3623. * @param initialM13 defines 3rd value of 1st row
  3624. * @param initialM14 defines 4th value of 1st row
  3625. * @param initialM21 defines 1st value of 2nd row
  3626. * @param initialM22 defines 2nd value of 2nd row
  3627. * @param initialM23 defines 3rd value of 2nd row
  3628. * @param initialM24 defines 4th value of 2nd row
  3629. * @param initialM31 defines 1st value of 3rd row
  3630. * @param initialM32 defines 2nd value of 3rd row
  3631. * @param initialM33 defines 3rd value of 3rd row
  3632. * @param initialM34 defines 4th value of 3rd row
  3633. * @param initialM41 defines 1st value of 4th row
  3634. * @param initialM42 defines 2nd value of 4th row
  3635. * @param initialM43 defines 3rd value of 4th row
  3636. * @param initialM44 defines 4th value of 4th row
  3637. * @returns the new matrix
  3638. */
  3639. 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;
  3640. /**
  3641. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  3642. * @param scale defines the scale vector3
  3643. * @param rotation defines the rotation quaternion
  3644. * @param translation defines the translation vector3
  3645. * @returns a new matrix
  3646. */
  3647. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  3648. /**
  3649. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  3650. * @param scale defines the scale vector3
  3651. * @param rotation defines the rotation quaternion
  3652. * @param translation defines the translation vector3
  3653. * @param result defines the target matrix
  3654. */
  3655. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  3656. /**
  3657. * Creates a new identity matrix
  3658. * @returns a new identity matrix
  3659. */
  3660. static Identity(): Matrix;
  3661. /**
  3662. * Creates a new identity matrix and stores the result in a given matrix
  3663. * @param result defines the target matrix
  3664. */
  3665. static IdentityToRef(result: Matrix): void;
  3666. /**
  3667. * Creates a new zero matrix
  3668. * @returns a new zero matrix
  3669. */
  3670. static Zero(): Matrix;
  3671. /**
  3672. * Creates a new rotation matrix for "angle" radians around the X axis
  3673. * @param angle defines the angle (in radians) to use
  3674. * @return the new matrix
  3675. */
  3676. static RotationX(angle: number): Matrix;
  3677. /**
  3678. * Creates a new matrix as the invert of a given matrix
  3679. * @param source defines the source matrix
  3680. * @returns the new matrix
  3681. */
  3682. static Invert(source: DeepImmutable<Matrix>): Matrix;
  3683. /**
  3684. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  3685. * @param angle defines the angle (in radians) to use
  3686. * @param result defines the target matrix
  3687. */
  3688. static RotationXToRef(angle: number, result: Matrix): void;
  3689. /**
  3690. * Creates a new rotation matrix for "angle" radians around the Y axis
  3691. * @param angle defines the angle (in radians) to use
  3692. * @return the new matrix
  3693. */
  3694. static RotationY(angle: number): Matrix;
  3695. /**
  3696. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  3697. * @param angle defines the angle (in radians) to use
  3698. * @param result defines the target matrix
  3699. */
  3700. static RotationYToRef(angle: number, result: Matrix): void;
  3701. /**
  3702. * Creates a new rotation matrix for "angle" radians around the Z axis
  3703. * @param angle defines the angle (in radians) to use
  3704. * @return the new matrix
  3705. */
  3706. static RotationZ(angle: number): Matrix;
  3707. /**
  3708. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  3709. * @param angle defines the angle (in radians) to use
  3710. * @param result defines the target matrix
  3711. */
  3712. static RotationZToRef(angle: number, result: Matrix): void;
  3713. /**
  3714. * Creates a new rotation matrix for "angle" radians around the given axis
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle (in radians) to use
  3717. * @return the new matrix
  3718. */
  3719. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  3720. /**
  3721. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  3722. * @param axis defines the axis to use
  3723. * @param angle defines the angle (in radians) to use
  3724. * @param result defines the target matrix
  3725. */
  3726. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  3727. /**
  3728. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  3729. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  3730. * @param from defines the vector to align
  3731. * @param to defines the vector to align to
  3732. * @param result defines the target matrix
  3733. */
  3734. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  3735. /**
  3736. * Creates a rotation matrix
  3737. * @param yaw defines the yaw angle in radians (Y axis)
  3738. * @param pitch defines the pitch angle in radians (X axis)
  3739. * @param roll defines the roll angle in radians (X axis)
  3740. * @returns the new rotation matrix
  3741. */
  3742. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  3743. /**
  3744. * Creates a rotation matrix and stores it in a given matrix
  3745. * @param yaw defines the yaw angle in radians (Y axis)
  3746. * @param pitch defines the pitch angle in radians (X axis)
  3747. * @param roll defines the roll angle in radians (X axis)
  3748. * @param result defines the target matrix
  3749. */
  3750. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  3751. /**
  3752. * Creates a scaling matrix
  3753. * @param x defines the scale factor on X axis
  3754. * @param y defines the scale factor on Y axis
  3755. * @param z defines the scale factor on Z axis
  3756. * @returns the new matrix
  3757. */
  3758. static Scaling(x: number, y: number, z: number): Matrix;
  3759. /**
  3760. * Creates a scaling matrix and stores it in a given matrix
  3761. * @param x defines the scale factor on X axis
  3762. * @param y defines the scale factor on Y axis
  3763. * @param z defines the scale factor on Z axis
  3764. * @param result defines the target matrix
  3765. */
  3766. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  3767. /**
  3768. * Creates a translation matrix
  3769. * @param x defines the translation on X axis
  3770. * @param y defines the translation on Y axis
  3771. * @param z defines the translationon Z axis
  3772. * @returns the new matrix
  3773. */
  3774. static Translation(x: number, y: number, z: number): Matrix;
  3775. /**
  3776. * Creates a translation matrix and stores it in a given matrix
  3777. * @param x defines the translation on X axis
  3778. * @param y defines the translation on Y axis
  3779. * @param z defines the translationon Z axis
  3780. * @param result defines the target matrix
  3781. */
  3782. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  3783. /**
  3784. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  3785. * @param startValue defines the start value
  3786. * @param endValue defines the end value
  3787. * @param gradient defines the gradient factor
  3788. * @returns the new matrix
  3789. */
  3790. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  3791. /**
  3792. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  3793. * @param startValue defines the start value
  3794. * @param endValue defines the end value
  3795. * @param gradient defines the gradient factor
  3796. * @param result defines the Matrix object where to store data
  3797. */
  3798. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  3799. /**
  3800. * Builds a new matrix whose values are computed by:
  3801. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  3802. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  3803. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  3804. * @param startValue defines the first matrix
  3805. * @param endValue defines the second matrix
  3806. * @param gradient defines the gradient between the two matrices
  3807. * @returns the new matrix
  3808. */
  3809. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  3810. /**
  3811. * Update a matrix to values which are computed by:
  3812. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  3813. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  3814. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  3815. * @param startValue defines the first matrix
  3816. * @param endValue defines the second matrix
  3817. * @param gradient defines the gradient between the two matrices
  3818. * @param result defines the target matrix
  3819. */
  3820. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  3821. /**
  3822. * 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"
  3823. * This function works in left handed mode
  3824. * @param eye defines the final position of the entity
  3825. * @param target defines where the entity should look at
  3826. * @param up defines the up vector for the entity
  3827. * @returns the new matrix
  3828. */
  3829. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  3830. /**
  3831. * 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".
  3832. * This function works in left handed mode
  3833. * @param eye defines the final position of the entity
  3834. * @param target defines where the entity should look at
  3835. * @param up defines the up vector for the entity
  3836. * @param result defines the target matrix
  3837. */
  3838. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  3839. /**
  3840. * 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"
  3841. * This function works in right handed mode
  3842. * @param eye defines the final position of the entity
  3843. * @param target defines where the entity should look at
  3844. * @param up defines the up vector for the entity
  3845. * @returns the new matrix
  3846. */
  3847. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  3848. /**
  3849. * 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".
  3850. * This function works in right handed mode
  3851. * @param eye defines the final position of the entity
  3852. * @param target defines where the entity should look at
  3853. * @param up defines the up vector for the entity
  3854. * @param result defines the target matrix
  3855. */
  3856. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  3857. /**
  3858. * Create a left-handed orthographic projection matrix
  3859. * @param width defines the viewport width
  3860. * @param height defines the viewport height
  3861. * @param znear defines the near clip plane
  3862. * @param zfar defines the far clip plane
  3863. * @returns a new matrix as a left-handed orthographic projection matrix
  3864. */
  3865. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  3866. /**
  3867. * Store a left-handed orthographic projection to a given matrix
  3868. * @param width defines the viewport width
  3869. * @param height defines the viewport height
  3870. * @param znear defines the near clip plane
  3871. * @param zfar defines the far clip plane
  3872. * @param result defines the target matrix
  3873. */
  3874. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  3875. /**
  3876. * Create a left-handed orthographic projection matrix
  3877. * @param left defines the viewport left coordinate
  3878. * @param right defines the viewport right coordinate
  3879. * @param bottom defines the viewport bottom coordinate
  3880. * @param top defines the viewport top coordinate
  3881. * @param znear defines the near clip plane
  3882. * @param zfar defines the far clip plane
  3883. * @returns a new matrix as a left-handed orthographic projection matrix
  3884. */
  3885. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  3886. /**
  3887. * Stores a left-handed orthographic projection into a given matrix
  3888. * @param left defines the viewport left coordinate
  3889. * @param right defines the viewport right coordinate
  3890. * @param bottom defines the viewport bottom coordinate
  3891. * @param top defines the viewport top coordinate
  3892. * @param znear defines the near clip plane
  3893. * @param zfar defines the far clip plane
  3894. * @param result defines the target matrix
  3895. */
  3896. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  3897. /**
  3898. * Creates a right-handed orthographic projection matrix
  3899. * @param left defines the viewport left coordinate
  3900. * @param right defines the viewport right coordinate
  3901. * @param bottom defines the viewport bottom coordinate
  3902. * @param top defines the viewport top coordinate
  3903. * @param znear defines the near clip plane
  3904. * @param zfar defines the far clip plane
  3905. * @returns a new matrix as a right-handed orthographic projection matrix
  3906. */
  3907. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  3908. /**
  3909. * Stores a right-handed orthographic projection into a given matrix
  3910. * @param left defines the viewport left coordinate
  3911. * @param right defines the viewport right coordinate
  3912. * @param bottom defines the viewport bottom coordinate
  3913. * @param top defines the viewport top coordinate
  3914. * @param znear defines the near clip plane
  3915. * @param zfar defines the far clip plane
  3916. * @param result defines the target matrix
  3917. */
  3918. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  3919. /**
  3920. * Creates a left-handed perspective projection matrix
  3921. * @param width defines the viewport width
  3922. * @param height defines the viewport height
  3923. * @param znear defines the near clip plane
  3924. * @param zfar defines the far clip plane
  3925. * @returns a new matrix as a left-handed perspective projection matrix
  3926. */
  3927. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  3928. /**
  3929. * Creates a left-handed perspective projection matrix
  3930. * @param fov defines the horizontal field of view
  3931. * @param aspect defines the aspect ratio
  3932. * @param znear defines the near clip plane
  3933. * @param zfar defines the far clip plane
  3934. * @returns a new matrix as a left-handed perspective projection matrix
  3935. */
  3936. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  3937. /**
  3938. * Stores a left-handed perspective projection into a given matrix
  3939. * @param fov defines the horizontal field of view
  3940. * @param aspect defines the aspect ratio
  3941. * @param znear defines the near clip plane
  3942. * @param zfar defines the far clip plane
  3943. * @param result defines the target matrix
  3944. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  3945. */
  3946. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  3947. /**
  3948. * Creates a right-handed perspective projection matrix
  3949. * @param fov defines the horizontal field of view
  3950. * @param aspect defines the aspect ratio
  3951. * @param znear defines the near clip plane
  3952. * @param zfar defines the far clip plane
  3953. * @returns a new matrix as a right-handed perspective projection matrix
  3954. */
  3955. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  3956. /**
  3957. * Stores a right-handed perspective projection into a given matrix
  3958. * @param fov defines the horizontal field of view
  3959. * @param aspect defines the aspect ratio
  3960. * @param znear defines the near clip plane
  3961. * @param zfar defines the far clip plane
  3962. * @param result defines the target matrix
  3963. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  3964. */
  3965. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  3966. /**
  3967. * Stores a perspective projection for WebVR info a given matrix
  3968. * @param fov defines the field of view
  3969. * @param znear defines the near clip plane
  3970. * @param zfar defines the far clip plane
  3971. * @param result defines the target matrix
  3972. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  3973. */
  3974. static PerspectiveFovWebVRToRef(fov: {
  3975. upDegrees: number;
  3976. downDegrees: number;
  3977. leftDegrees: number;
  3978. rightDegrees: number;
  3979. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  3980. /**
  3981. * Computes a complete transformation matrix
  3982. * @param viewport defines the viewport to use
  3983. * @param world defines the world matrix
  3984. * @param view defines the view matrix
  3985. * @param projection defines the projection matrix
  3986. * @param zmin defines the near clip plane
  3987. * @param zmax defines the far clip plane
  3988. * @returns the transformation matrix
  3989. */
  3990. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  3991. /**
  3992. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  3993. * @param matrix defines the matrix to use
  3994. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  3995. */
  3996. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  3997. /**
  3998. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  3999. * @param matrix defines the matrix to use
  4000. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4001. */
  4002. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4003. /**
  4004. * Compute the transpose of a given matrix
  4005. * @param matrix defines the matrix to transpose
  4006. * @returns the new matrix
  4007. */
  4008. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4009. /**
  4010. * Compute the transpose of a matrix and store it in a target matrix
  4011. * @param matrix defines the matrix to transpose
  4012. * @param result defines the target matrix
  4013. */
  4014. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4015. /**
  4016. * Computes a reflection matrix from a plane
  4017. * @param plane defines the reflection plane
  4018. * @returns a new matrix
  4019. */
  4020. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4021. /**
  4022. * Computes a reflection matrix from a plane
  4023. * @param plane defines the reflection plane
  4024. * @param result defines the target matrix
  4025. */
  4026. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4027. /**
  4028. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4029. * @param xaxis defines the value of the 1st axis
  4030. * @param yaxis defines the value of the 2nd axis
  4031. * @param zaxis defines the value of the 3rd axis
  4032. * @param result defines the target matrix
  4033. */
  4034. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4035. /**
  4036. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4037. * @param quat defines the quaternion to use
  4038. * @param result defines the target matrix
  4039. */
  4040. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4041. }
  4042. /**
  4043. * @hidden
  4044. */
  4045. export class TmpVectors {
  4046. static Vector2: Vector2[];
  4047. static Vector3: Vector3[];
  4048. static Vector4: Vector4[];
  4049. static Quaternion: Quaternion[];
  4050. static Matrix: Matrix[];
  4051. }
  4052. }
  4053. declare module "babylonjs/Engines/constants" {
  4054. /** Defines the cross module used constants to avoid circular dependncies */
  4055. export class Constants {
  4056. /** Defines that alpha blending is disabled */
  4057. static readonly ALPHA_DISABLE: number;
  4058. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  4059. static readonly ALPHA_ADD: number;
  4060. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  4061. static readonly ALPHA_COMBINE: number;
  4062. /** Defines that alpha blending to DEST - SRC * DEST */
  4063. static readonly ALPHA_SUBTRACT: number;
  4064. /** Defines that alpha blending to SRC * DEST */
  4065. static readonly ALPHA_MULTIPLY: number;
  4066. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  4067. static readonly ALPHA_MAXIMIZED: number;
  4068. /** Defines that alpha blending to SRC + DEST */
  4069. static readonly ALPHA_ONEONE: number;
  4070. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  4071. static readonly ALPHA_PREMULTIPLIED: number;
  4072. /**
  4073. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  4074. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  4075. */
  4076. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  4077. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  4078. static readonly ALPHA_INTERPOLATE: number;
  4079. /**
  4080. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  4081. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  4082. */
  4083. static readonly ALPHA_SCREENMODE: number;
  4084. /** Defines that the ressource is not delayed*/
  4085. static readonly DELAYLOADSTATE_NONE: number;
  4086. /** Defines that the ressource was successfully delay loaded */
  4087. static readonly DELAYLOADSTATE_LOADED: number;
  4088. /** Defines that the ressource is currently delay loading */
  4089. static readonly DELAYLOADSTATE_LOADING: number;
  4090. /** Defines that the ressource is delayed and has not started loading */
  4091. static readonly DELAYLOADSTATE_NOTLOADED: number;
  4092. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  4093. static readonly NEVER: number;
  4094. /** 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 */
  4095. static readonly ALWAYS: number;
  4096. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  4097. static readonly LESS: number;
  4098. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  4099. static readonly EQUAL: number;
  4100. /** 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 */
  4101. static readonly LEQUAL: number;
  4102. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  4103. static readonly GREATER: number;
  4104. /** 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 */
  4105. static readonly GEQUAL: number;
  4106. /** 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 */
  4107. static readonly NOTEQUAL: number;
  4108. /** Passed to stencilOperation to specify that stencil value must be kept */
  4109. static readonly KEEP: number;
  4110. /** Passed to stencilOperation to specify that stencil value must be replaced */
  4111. static readonly REPLACE: number;
  4112. /** Passed to stencilOperation to specify that stencil value must be incremented */
  4113. static readonly INCR: number;
  4114. /** Passed to stencilOperation to specify that stencil value must be decremented */
  4115. static readonly DECR: number;
  4116. /** Passed to stencilOperation to specify that stencil value must be inverted */
  4117. static readonly INVERT: number;
  4118. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  4119. static readonly INCR_WRAP: number;
  4120. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  4121. static readonly DECR_WRAP: number;
  4122. /** Texture is not repeating outside of 0..1 UVs */
  4123. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  4124. /** Texture is repeating outside of 0..1 UVs */
  4125. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  4126. /** Texture is repeating and mirrored */
  4127. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  4128. /** ALPHA */
  4129. static readonly TEXTUREFORMAT_ALPHA: number;
  4130. /** LUMINANCE */
  4131. static readonly TEXTUREFORMAT_LUMINANCE: number;
  4132. /** LUMINANCE_ALPHA */
  4133. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  4134. /** RGB */
  4135. static readonly TEXTUREFORMAT_RGB: number;
  4136. /** RGBA */
  4137. static readonly TEXTUREFORMAT_RGBA: number;
  4138. /** RED */
  4139. static readonly TEXTUREFORMAT_RED: number;
  4140. /** RED (2nd reference) */
  4141. static readonly TEXTUREFORMAT_R: number;
  4142. /** RG */
  4143. static readonly TEXTUREFORMAT_RG: number;
  4144. /** RED_INTEGER */
  4145. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  4146. /** RED_INTEGER (2nd reference) */
  4147. static readonly TEXTUREFORMAT_R_INTEGER: number;
  4148. /** RG_INTEGER */
  4149. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  4150. /** RGB_INTEGER */
  4151. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  4152. /** RGBA_INTEGER */
  4153. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  4154. /** UNSIGNED_BYTE */
  4155. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  4156. /** UNSIGNED_BYTE (2nd reference) */
  4157. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  4158. /** FLOAT */
  4159. static readonly TEXTURETYPE_FLOAT: number;
  4160. /** HALF_FLOAT */
  4161. static readonly TEXTURETYPE_HALF_FLOAT: number;
  4162. /** BYTE */
  4163. static readonly TEXTURETYPE_BYTE: number;
  4164. /** SHORT */
  4165. static readonly TEXTURETYPE_SHORT: number;
  4166. /** UNSIGNED_SHORT */
  4167. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  4168. /** INT */
  4169. static readonly TEXTURETYPE_INT: number;
  4170. /** UNSIGNED_INT */
  4171. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  4172. /** UNSIGNED_SHORT_4_4_4_4 */
  4173. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  4174. /** UNSIGNED_SHORT_5_5_5_1 */
  4175. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  4176. /** UNSIGNED_SHORT_5_6_5 */
  4177. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  4178. /** UNSIGNED_INT_2_10_10_10_REV */
  4179. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  4180. /** UNSIGNED_INT_24_8 */
  4181. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  4182. /** UNSIGNED_INT_10F_11F_11F_REV */
  4183. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  4184. /** UNSIGNED_INT_5_9_9_9_REV */
  4185. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  4186. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  4187. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  4188. /** nearest is mag = nearest and min = nearest and mip = linear */
  4189. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  4190. /** Bilinear is mag = linear and min = linear and mip = nearest */
  4191. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  4192. /** Trilinear is mag = linear and min = linear and mip = linear */
  4193. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  4194. /** nearest is mag = nearest and min = nearest and mip = linear */
  4195. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  4196. /** Bilinear is mag = linear and min = linear and mip = nearest */
  4197. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  4198. /** Trilinear is mag = linear and min = linear and mip = linear */
  4199. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  4200. /** mag = nearest and min = nearest and mip = nearest */
  4201. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  4202. /** mag = nearest and min = linear and mip = nearest */
  4203. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  4204. /** mag = nearest and min = linear and mip = linear */
  4205. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  4206. /** mag = nearest and min = linear and mip = none */
  4207. static readonly TEXTURE_NEAREST_LINEAR: number;
  4208. /** mag = nearest and min = nearest and mip = none */
  4209. static readonly TEXTURE_NEAREST_NEAREST: number;
  4210. /** mag = linear and min = nearest and mip = nearest */
  4211. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  4212. /** mag = linear and min = nearest and mip = linear */
  4213. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  4214. /** mag = linear and min = linear and mip = none */
  4215. static readonly TEXTURE_LINEAR_LINEAR: number;
  4216. /** mag = linear and min = nearest and mip = none */
  4217. static readonly TEXTURE_LINEAR_NEAREST: number;
  4218. /** Explicit coordinates mode */
  4219. static readonly TEXTURE_EXPLICIT_MODE: number;
  4220. /** Spherical coordinates mode */
  4221. static readonly TEXTURE_SPHERICAL_MODE: number;
  4222. /** Planar coordinates mode */
  4223. static readonly TEXTURE_PLANAR_MODE: number;
  4224. /** Cubic coordinates mode */
  4225. static readonly TEXTURE_CUBIC_MODE: number;
  4226. /** Projection coordinates mode */
  4227. static readonly TEXTURE_PROJECTION_MODE: number;
  4228. /** Skybox coordinates mode */
  4229. static readonly TEXTURE_SKYBOX_MODE: number;
  4230. /** Inverse Cubic coordinates mode */
  4231. static readonly TEXTURE_INVCUBIC_MODE: number;
  4232. /** Equirectangular coordinates mode */
  4233. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  4234. /** Equirectangular Fixed coordinates mode */
  4235. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  4236. /** Equirectangular Fixed Mirrored coordinates mode */
  4237. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  4238. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  4239. static readonly SCALEMODE_FLOOR: number;
  4240. /** Defines that texture rescaling will look for the nearest power of 2 size */
  4241. static readonly SCALEMODE_NEAREST: number;
  4242. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  4243. static readonly SCALEMODE_CEILING: number;
  4244. /**
  4245. * The dirty texture flag value
  4246. */
  4247. static readonly MATERIAL_TextureDirtyFlag: number;
  4248. /**
  4249. * The dirty light flag value
  4250. */
  4251. static readonly MATERIAL_LightDirtyFlag: number;
  4252. /**
  4253. * The dirty fresnel flag value
  4254. */
  4255. static readonly MATERIAL_FresnelDirtyFlag: number;
  4256. /**
  4257. * The dirty attribute flag value
  4258. */
  4259. static readonly MATERIAL_AttributesDirtyFlag: number;
  4260. /**
  4261. * The dirty misc flag value
  4262. */
  4263. static readonly MATERIAL_MiscDirtyFlag: number;
  4264. /**
  4265. * The all dirty flag value
  4266. */
  4267. static readonly MATERIAL_AllDirtyFlag: number;
  4268. /**
  4269. * Returns the triangle fill mode
  4270. */
  4271. static readonly MATERIAL_TriangleFillMode: number;
  4272. /**
  4273. * Returns the wireframe mode
  4274. */
  4275. static readonly MATERIAL_WireFrameFillMode: number;
  4276. /**
  4277. * Returns the point fill mode
  4278. */
  4279. static readonly MATERIAL_PointFillMode: number;
  4280. /**
  4281. * Returns the point list draw mode
  4282. */
  4283. static readonly MATERIAL_PointListDrawMode: number;
  4284. /**
  4285. * Returns the line list draw mode
  4286. */
  4287. static readonly MATERIAL_LineListDrawMode: number;
  4288. /**
  4289. * Returns the line loop draw mode
  4290. */
  4291. static readonly MATERIAL_LineLoopDrawMode: number;
  4292. /**
  4293. * Returns the line strip draw mode
  4294. */
  4295. static readonly MATERIAL_LineStripDrawMode: number;
  4296. /**
  4297. * Returns the triangle strip draw mode
  4298. */
  4299. static readonly MATERIAL_TriangleStripDrawMode: number;
  4300. /**
  4301. * Returns the triangle fan draw mode
  4302. */
  4303. static readonly MATERIAL_TriangleFanDrawMode: number;
  4304. /**
  4305. * Stores the clock-wise side orientation
  4306. */
  4307. static readonly MATERIAL_ClockWiseSideOrientation: number;
  4308. /**
  4309. * Stores the counter clock-wise side orientation
  4310. */
  4311. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  4312. /**
  4313. * Nothing
  4314. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4315. */
  4316. static readonly ACTION_NothingTrigger: number;
  4317. /**
  4318. * On pick
  4319. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4320. */
  4321. static readonly ACTION_OnPickTrigger: number;
  4322. /**
  4323. * On left pick
  4324. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4325. */
  4326. static readonly ACTION_OnLeftPickTrigger: number;
  4327. /**
  4328. * On right pick
  4329. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4330. */
  4331. static readonly ACTION_OnRightPickTrigger: number;
  4332. /**
  4333. * On center pick
  4334. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4335. */
  4336. static readonly ACTION_OnCenterPickTrigger: number;
  4337. /**
  4338. * On pick down
  4339. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4340. */
  4341. static readonly ACTION_OnPickDownTrigger: number;
  4342. /**
  4343. * On double pick
  4344. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4345. */
  4346. static readonly ACTION_OnDoublePickTrigger: number;
  4347. /**
  4348. * On pick up
  4349. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4350. */
  4351. static readonly ACTION_OnPickUpTrigger: number;
  4352. /**
  4353. * On pick out.
  4354. * This trigger will only be raised if you also declared a OnPickDown
  4355. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4356. */
  4357. static readonly ACTION_OnPickOutTrigger: number;
  4358. /**
  4359. * On long press
  4360. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4361. */
  4362. static readonly ACTION_OnLongPressTrigger: number;
  4363. /**
  4364. * On pointer over
  4365. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4366. */
  4367. static readonly ACTION_OnPointerOverTrigger: number;
  4368. /**
  4369. * On pointer out
  4370. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4371. */
  4372. static readonly ACTION_OnPointerOutTrigger: number;
  4373. /**
  4374. * On every frame
  4375. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4376. */
  4377. static readonly ACTION_OnEveryFrameTrigger: number;
  4378. /**
  4379. * On intersection enter
  4380. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4381. */
  4382. static readonly ACTION_OnIntersectionEnterTrigger: number;
  4383. /**
  4384. * On intersection exit
  4385. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4386. */
  4387. static readonly ACTION_OnIntersectionExitTrigger: number;
  4388. /**
  4389. * On key down
  4390. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4391. */
  4392. static readonly ACTION_OnKeyDownTrigger: number;
  4393. /**
  4394. * On key up
  4395. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4396. */
  4397. static readonly ACTION_OnKeyUpTrigger: number;
  4398. /**
  4399. * Billboard mode will only apply to Y axis
  4400. */
  4401. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  4402. /**
  4403. * Billboard mode will apply to all axes
  4404. */
  4405. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  4406. /**
  4407. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  4408. */
  4409. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  4410. /**
  4411. * Gets or sets base Assets URL
  4412. */
  4413. static PARTICLES_BaseAssetsUrl: string;
  4414. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  4415. * Test order :
  4416. * Is the bounding sphere outside the frustum ?
  4417. * If not, are the bounding box vertices outside the frustum ?
  4418. * It not, then the cullable object is in the frustum.
  4419. */
  4420. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  4421. /** Culling strategy : Bounding Sphere Only.
  4422. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  4423. * It's also less accurate than the standard because some not visible objects can still be selected.
  4424. * Test : is the bounding sphere outside the frustum ?
  4425. * If not, then the cullable object is in the frustum.
  4426. */
  4427. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  4428. /** Culling strategy : Optimistic Inclusion.
  4429. * This in an inclusion test first, then the standard exclusion test.
  4430. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  4431. * 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.
  4432. * Anyway, it's as accurate as the standard strategy.
  4433. * Test :
  4434. * Is the cullable object bounding sphere center in the frustum ?
  4435. * If not, apply the default culling strategy.
  4436. */
  4437. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  4438. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  4439. * This in an inclusion test first, then the bounding sphere only exclusion test.
  4440. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  4441. * 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.
  4442. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  4443. * Test :
  4444. * Is the cullable object bounding sphere center in the frustum ?
  4445. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  4446. */
  4447. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  4448. /**
  4449. * No logging while loading
  4450. */
  4451. static readonly SCENELOADER_NO_LOGGING: number;
  4452. /**
  4453. * Minimal logging while loading
  4454. */
  4455. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  4456. /**
  4457. * Summary logging while loading
  4458. */
  4459. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  4460. /**
  4461. * Detailled logging while loading
  4462. */
  4463. static readonly SCENELOADER_DETAILED_LOGGING: number;
  4464. }
  4465. }
  4466. declare module "babylonjs/Engines/IPipelineContext" {
  4467. /**
  4468. * Class used to store and describe the pipeline context associated with an effect
  4469. */
  4470. export interface IPipelineContext {
  4471. /**
  4472. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  4473. */
  4474. isAsync: boolean;
  4475. /**
  4476. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  4477. */
  4478. isReady: boolean;
  4479. /** @hidden */
  4480. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  4481. }
  4482. }
  4483. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  4484. /** @hidden */
  4485. export interface IShaderProcessor {
  4486. attributeProcessor?: (attribute: string) => string;
  4487. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  4488. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  4489. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  4490. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  4491. lineProcessor?: (line: string, isFragment: boolean) => string;
  4492. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  4493. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  4494. }
  4495. }
  4496. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  4497. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  4498. /** @hidden */
  4499. export interface ProcessingOptions {
  4500. defines: string[];
  4501. indexParameters: any;
  4502. isFragment: boolean;
  4503. shouldUseHighPrecisionShader: boolean;
  4504. supportsUniformBuffers: boolean;
  4505. shadersRepository: string;
  4506. includesShadersStore: {
  4507. [key: string]: string;
  4508. };
  4509. processor?: IShaderProcessor;
  4510. version: string;
  4511. platformName: string;
  4512. lookForClosingBracketForUniformBuffer?: boolean;
  4513. }
  4514. }
  4515. declare module "babylonjs/Misc/stringTools" {
  4516. /**
  4517. * Helper to manipulate strings
  4518. */
  4519. export class StringTools {
  4520. /**
  4521. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  4522. * @param str Source string
  4523. * @param suffix Suffix to search for in the source string
  4524. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  4525. */
  4526. static EndsWith(str: string, suffix: string): boolean;
  4527. /**
  4528. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  4529. * @param str Source string
  4530. * @param suffix Suffix to search for in the source string
  4531. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  4532. */
  4533. static StartsWith(str: string, suffix: string): boolean;
  4534. }
  4535. }
  4536. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  4537. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4538. /** @hidden */
  4539. export class ShaderCodeNode {
  4540. line: string;
  4541. children: ShaderCodeNode[];
  4542. additionalDefineKey?: string;
  4543. additionalDefineValue?: string;
  4544. isValid(preprocessors: {
  4545. [key: string]: string;
  4546. }): boolean;
  4547. process(preprocessors: {
  4548. [key: string]: string;
  4549. }, options: ProcessingOptions): string;
  4550. }
  4551. }
  4552. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  4553. /** @hidden */
  4554. export class ShaderCodeCursor {
  4555. private _lines;
  4556. lineIndex: number;
  4557. readonly currentLine: string;
  4558. readonly canRead: boolean;
  4559. lines: string[];
  4560. }
  4561. }
  4562. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  4563. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  4564. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4565. /** @hidden */
  4566. export class ShaderCodeConditionNode extends ShaderCodeNode {
  4567. process(preprocessors: {
  4568. [key: string]: string;
  4569. }, options: ProcessingOptions): string;
  4570. }
  4571. }
  4572. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  4573. /** @hidden */
  4574. export class ShaderDefineExpression {
  4575. isTrue(preprocessors: {
  4576. [key: string]: string;
  4577. }): boolean;
  4578. }
  4579. }
  4580. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  4581. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  4582. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4583. /** @hidden */
  4584. export class ShaderCodeTestNode extends ShaderCodeNode {
  4585. testExpression: ShaderDefineExpression;
  4586. isValid(preprocessors: {
  4587. [key: string]: string;
  4588. }): boolean;
  4589. }
  4590. }
  4591. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  4592. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4593. /** @hidden */
  4594. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  4595. define: string;
  4596. not: boolean;
  4597. constructor(define: string, not?: boolean);
  4598. isTrue(preprocessors: {
  4599. [key: string]: string;
  4600. }): boolean;
  4601. }
  4602. }
  4603. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  4604. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4605. /** @hidden */
  4606. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  4607. leftOperand: ShaderDefineExpression;
  4608. rightOperand: ShaderDefineExpression;
  4609. isTrue(preprocessors: {
  4610. [key: string]: string;
  4611. }): boolean;
  4612. }
  4613. }
  4614. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  4615. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4616. /** @hidden */
  4617. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  4618. leftOperand: ShaderDefineExpression;
  4619. rightOperand: ShaderDefineExpression;
  4620. isTrue(preprocessors: {
  4621. [key: string]: string;
  4622. }): boolean;
  4623. }
  4624. }
  4625. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  4626. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4627. /** @hidden */
  4628. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  4629. define: string;
  4630. operand: string;
  4631. testValue: string;
  4632. constructor(define: string, operand: string, testValue: string);
  4633. isTrue(preprocessors: {
  4634. [key: string]: string;
  4635. }): boolean;
  4636. }
  4637. }
  4638. declare module "babylonjs/Misc/loadFileError" {
  4639. import { WebRequest } from "babylonjs/Misc/webRequest";
  4640. /**
  4641. * @ignore
  4642. * Application error to support additional information when loading a file
  4643. */
  4644. export class LoadFileError extends Error {
  4645. /** defines the optional web request */
  4646. request?: WebRequest | undefined;
  4647. private static _setPrototypeOf;
  4648. /**
  4649. * Creates a new LoadFileError
  4650. * @param message defines the message of the error
  4651. * @param request defines the optional web request
  4652. */
  4653. constructor(message: string,
  4654. /** defines the optional web request */
  4655. request?: WebRequest | undefined);
  4656. }
  4657. }
  4658. declare module "babylonjs/Offline/IOfflineProvider" {
  4659. /**
  4660. * Class used to enable access to offline support
  4661. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  4662. */
  4663. export interface IOfflineProvider {
  4664. /**
  4665. * Gets a boolean indicating if scene must be saved in the database
  4666. */
  4667. enableSceneOffline: boolean;
  4668. /**
  4669. * Gets a boolean indicating if textures must be saved in the database
  4670. */
  4671. enableTexturesOffline: boolean;
  4672. /**
  4673. * Open the offline support and make it available
  4674. * @param successCallback defines the callback to call on success
  4675. * @param errorCallback defines the callback to call on error
  4676. */
  4677. open(successCallback: () => void, errorCallback: () => void): void;
  4678. /**
  4679. * Loads an image from the offline support
  4680. * @param url defines the url to load from
  4681. * @param image defines the target DOM image
  4682. */
  4683. loadImage(url: string, image: HTMLImageElement): void;
  4684. /**
  4685. * Loads a file from offline support
  4686. * @param url defines the URL to load from
  4687. * @param sceneLoaded defines a callback to call on success
  4688. * @param progressCallBack defines a callback to call when progress changed
  4689. * @param errorCallback defines a callback to call on error
  4690. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  4691. */
  4692. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  4693. }
  4694. }
  4695. declare module "babylonjs/Misc/filesInputStore" {
  4696. /**
  4697. * Class used to help managing file picking and drag'n'drop
  4698. * File Storage
  4699. */
  4700. export class FilesInputStore {
  4701. /**
  4702. * List of files ready to be loaded
  4703. */
  4704. static FilesToLoad: {
  4705. [key: string]: File;
  4706. };
  4707. }
  4708. }
  4709. declare module "babylonjs/Misc/retryStrategy" {
  4710. import { WebRequest } from "babylonjs/Misc/webRequest";
  4711. /**
  4712. * Class used to define a retry strategy when error happens while loading assets
  4713. */
  4714. export class RetryStrategy {
  4715. /**
  4716. * Function used to defines an exponential back off strategy
  4717. * @param maxRetries defines the maximum number of retries (3 by default)
  4718. * @param baseInterval defines the interval between retries
  4719. * @returns the strategy function to use
  4720. */
  4721. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  4722. }
  4723. }
  4724. declare module "babylonjs/Misc/fileTools" {
  4725. import { WebRequest } from "babylonjs/Misc/webRequest";
  4726. import { Nullable } from "babylonjs/types";
  4727. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  4728. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  4729. /**
  4730. * @hidden
  4731. */
  4732. export class FileTools {
  4733. /**
  4734. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  4735. */
  4736. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  4737. /**
  4738. * Gets or sets the base URL to use to load assets
  4739. */
  4740. static BaseUrl: string;
  4741. /**
  4742. * Default behaviour for cors in the application.
  4743. * It can be a string if the expected behavior is identical in the entire app.
  4744. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  4745. */
  4746. static CorsBehavior: string | ((url: string | string[]) => string);
  4747. /**
  4748. * Gets or sets a function used to pre-process url before using them to load assets
  4749. */
  4750. static PreprocessUrl: (url: string) => string;
  4751. /**
  4752. * Removes unwanted characters from an url
  4753. * @param url defines the url to clean
  4754. * @returns the cleaned url
  4755. */
  4756. private static _CleanUrl;
  4757. /**
  4758. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  4759. * @param url define the url we are trying
  4760. * @param element define the dom element where to configure the cors policy
  4761. */
  4762. static SetCorsBehavior(url: string | string[], element: {
  4763. crossOrigin: string | null;
  4764. }): void;
  4765. /**
  4766. * Loads an image as an HTMLImageElement.
  4767. * @param input url string, ArrayBuffer, or Blob to load
  4768. * @param onLoad callback called when the image successfully loads
  4769. * @param onError callback called when the image fails to load
  4770. * @param offlineProvider offline provider for caching
  4771. * @returns the HTMLImageElement of the loaded image
  4772. */
  4773. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  4774. /**
  4775. * Loads a file
  4776. * @param fileToLoad defines the file to load
  4777. * @param callback defines the callback to call when data is loaded
  4778. * @param progressCallBack defines the callback to call during loading process
  4779. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  4780. * @returns a file request object
  4781. */
  4782. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  4783. /**
  4784. * Loads a file
  4785. * @param url url string, ArrayBuffer, or Blob to load
  4786. * @param onSuccess callback called when the file successfully loads
  4787. * @param onProgress callback called while file is loading (if the server supports this mode)
  4788. * @param offlineProvider defines the offline provider for caching
  4789. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  4790. * @param onError callback called when the file fails to load
  4791. * @returns a file request object
  4792. */
  4793. 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;
  4794. /**
  4795. * Checks if the loaded document was accessed via `file:`-Protocol.
  4796. * @returns boolean
  4797. */
  4798. static IsFileURL(): boolean;
  4799. }
  4800. }
  4801. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  4802. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4803. /** @hidden */
  4804. export class ShaderProcessor {
  4805. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  4806. private static _ProcessPrecision;
  4807. private static _ExtractOperation;
  4808. private static _BuildSubExpression;
  4809. private static _BuildExpression;
  4810. private static _MoveCursorWithinIf;
  4811. private static _MoveCursor;
  4812. private static _EvaluatePreProcessors;
  4813. private static _PreparePreProcessors;
  4814. private static _ProcessShaderConversion;
  4815. private static _ProcessIncludes;
  4816. }
  4817. }
  4818. declare module "babylonjs/Maths/math.color" {
  4819. import { DeepImmutable, FloatArray } from "babylonjs/types";
  4820. /**
  4821. * Class used to hold a RBG color
  4822. */
  4823. export class Color3 {
  4824. /**
  4825. * Defines the red component (between 0 and 1, default is 0)
  4826. */
  4827. r: number;
  4828. /**
  4829. * Defines the green component (between 0 and 1, default is 0)
  4830. */
  4831. g: number;
  4832. /**
  4833. * Defines the blue component (between 0 and 1, default is 0)
  4834. */
  4835. b: number;
  4836. /**
  4837. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  4838. * @param r defines the red component (between 0 and 1, default is 0)
  4839. * @param g defines the green component (between 0 and 1, default is 0)
  4840. * @param b defines the blue component (between 0 and 1, default is 0)
  4841. */
  4842. constructor(
  4843. /**
  4844. * Defines the red component (between 0 and 1, default is 0)
  4845. */
  4846. r?: number,
  4847. /**
  4848. * Defines the green component (between 0 and 1, default is 0)
  4849. */
  4850. g?: number,
  4851. /**
  4852. * Defines the blue component (between 0 and 1, default is 0)
  4853. */
  4854. b?: number);
  4855. /**
  4856. * Creates a string with the Color3 current values
  4857. * @returns the string representation of the Color3 object
  4858. */
  4859. toString(): string;
  4860. /**
  4861. * Returns the string "Color3"
  4862. * @returns "Color3"
  4863. */
  4864. getClassName(): string;
  4865. /**
  4866. * Compute the Color3 hash code
  4867. * @returns an unique number that can be used to hash Color3 objects
  4868. */
  4869. getHashCode(): number;
  4870. /**
  4871. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  4872. * @param array defines the array where to store the r,g,b components
  4873. * @param index defines an optional index in the target array to define where to start storing values
  4874. * @returns the current Color3 object
  4875. */
  4876. toArray(array: FloatArray, index?: number): Color3;
  4877. /**
  4878. * Returns a new Color4 object from the current Color3 and the given alpha
  4879. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  4880. * @returns a new Color4 object
  4881. */
  4882. toColor4(alpha?: number): Color4;
  4883. /**
  4884. * Returns a new array populated with 3 numeric elements : red, green and blue values
  4885. * @returns the new array
  4886. */
  4887. asArray(): number[];
  4888. /**
  4889. * Returns the luminance value
  4890. * @returns a float value
  4891. */
  4892. toLuminance(): number;
  4893. /**
  4894. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  4895. * @param otherColor defines the second operand
  4896. * @returns the new Color3 object
  4897. */
  4898. multiply(otherColor: DeepImmutable<Color3>): Color3;
  4899. /**
  4900. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  4901. * @param otherColor defines the second operand
  4902. * @param result defines the Color3 object where to store the result
  4903. * @returns the current Color3
  4904. */
  4905. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4906. /**
  4907. * Determines equality between Color3 objects
  4908. * @param otherColor defines the second operand
  4909. * @returns true if the rgb values are equal to the given ones
  4910. */
  4911. equals(otherColor: DeepImmutable<Color3>): boolean;
  4912. /**
  4913. * Determines equality between the current Color3 object and a set of r,b,g values
  4914. * @param r defines the red component to check
  4915. * @param g defines the green component to check
  4916. * @param b defines the blue component to check
  4917. * @returns true if the rgb values are equal to the given ones
  4918. */
  4919. equalsFloats(r: number, g: number, b: number): boolean;
  4920. /**
  4921. * Multiplies in place each rgb value by scale
  4922. * @param scale defines the scaling factor
  4923. * @returns the updated Color3
  4924. */
  4925. scale(scale: number): Color3;
  4926. /**
  4927. * Multiplies the rgb values by scale and stores the result into "result"
  4928. * @param scale defines the scaling factor
  4929. * @param result defines the Color3 object where to store the result
  4930. * @returns the unmodified current Color3
  4931. */
  4932. scaleToRef(scale: number, result: Color3): Color3;
  4933. /**
  4934. * Scale the current Color3 values by a factor and add the result to a given Color3
  4935. * @param scale defines the scale factor
  4936. * @param result defines color to store the result into
  4937. * @returns the unmodified current Color3
  4938. */
  4939. scaleAndAddToRef(scale: number, result: Color3): Color3;
  4940. /**
  4941. * Clamps the rgb values by the min and max values and stores the result into "result"
  4942. * @param min defines minimum clamping value (default is 0)
  4943. * @param max defines maximum clamping value (default is 1)
  4944. * @param result defines color to store the result into
  4945. * @returns the original Color3
  4946. */
  4947. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  4948. /**
  4949. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  4950. * @param otherColor defines the second operand
  4951. * @returns the new Color3
  4952. */
  4953. add(otherColor: DeepImmutable<Color3>): Color3;
  4954. /**
  4955. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  4956. * @param otherColor defines the second operand
  4957. * @param result defines Color3 object to store the result into
  4958. * @returns the unmodified current Color3
  4959. */
  4960. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4961. /**
  4962. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  4963. * @param otherColor defines the second operand
  4964. * @returns the new Color3
  4965. */
  4966. subtract(otherColor: DeepImmutable<Color3>): Color3;
  4967. /**
  4968. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  4969. * @param otherColor defines the second operand
  4970. * @param result defines Color3 object to store the result into
  4971. * @returns the unmodified current Color3
  4972. */
  4973. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4974. /**
  4975. * Copy the current object
  4976. * @returns a new Color3 copied the current one
  4977. */
  4978. clone(): Color3;
  4979. /**
  4980. * Copies the rgb values from the source in the current Color3
  4981. * @param source defines the source Color3 object
  4982. * @returns the updated Color3 object
  4983. */
  4984. copyFrom(source: DeepImmutable<Color3>): Color3;
  4985. /**
  4986. * Updates the Color3 rgb values from the given floats
  4987. * @param r defines the red component to read from
  4988. * @param g defines the green component to read from
  4989. * @param b defines the blue component to read from
  4990. * @returns the current Color3 object
  4991. */
  4992. copyFromFloats(r: number, g: number, b: number): Color3;
  4993. /**
  4994. * Updates the Color3 rgb values from the given floats
  4995. * @param r defines the red component to read from
  4996. * @param g defines the green component to read from
  4997. * @param b defines the blue component to read from
  4998. * @returns the current Color3 object
  4999. */
  5000. set(r: number, g: number, b: number): Color3;
  5001. /**
  5002. * Compute the Color3 hexadecimal code as a string
  5003. * @returns a string containing the hexadecimal representation of the Color3 object
  5004. */
  5005. toHexString(): string;
  5006. /**
  5007. * Computes a new Color3 converted from the current one to linear space
  5008. * @returns a new Color3 object
  5009. */
  5010. toLinearSpace(): Color3;
  5011. /**
  5012. * Converts current color in rgb space to HSV values
  5013. * @returns a new color3 representing the HSV values
  5014. */
  5015. toHSV(): Color3;
  5016. /**
  5017. * Converts current color in rgb space to HSV values
  5018. * @param result defines the Color3 where to store the HSV values
  5019. */
  5020. toHSVToRef(result: Color3): void;
  5021. /**
  5022. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5023. * @param convertedColor defines the Color3 object where to store the linear space version
  5024. * @returns the unmodified Color3
  5025. */
  5026. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5027. /**
  5028. * Computes a new Color3 converted from the current one to gamma space
  5029. * @returns a new Color3 object
  5030. */
  5031. toGammaSpace(): Color3;
  5032. /**
  5033. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5034. * @param convertedColor defines the Color3 object where to store the gamma space version
  5035. * @returns the unmodified Color3
  5036. */
  5037. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5038. private static _BlackReadOnly;
  5039. /**
  5040. * Convert Hue, saturation and value to a Color3 (RGB)
  5041. * @param hue defines the hue
  5042. * @param saturation defines the saturation
  5043. * @param value defines the value
  5044. * @param result defines the Color3 where to store the RGB values
  5045. */
  5046. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5047. /**
  5048. * Creates a new Color3 from the string containing valid hexadecimal values
  5049. * @param hex defines a string containing valid hexadecimal values
  5050. * @returns a new Color3 object
  5051. */
  5052. static FromHexString(hex: string): Color3;
  5053. /**
  5054. * Creates a new Color3 from the starting index of the given array
  5055. * @param array defines the source array
  5056. * @param offset defines an offset in the source array
  5057. * @returns a new Color3 object
  5058. */
  5059. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5060. /**
  5061. * Creates a new Color3 from integer values (< 256)
  5062. * @param r defines the red component to read from (value between 0 and 255)
  5063. * @param g defines the green component to read from (value between 0 and 255)
  5064. * @param b defines the blue component to read from (value between 0 and 255)
  5065. * @returns a new Color3 object
  5066. */
  5067. static FromInts(r: number, g: number, b: number): Color3;
  5068. /**
  5069. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5070. * @param start defines the start Color3 value
  5071. * @param end defines the end Color3 value
  5072. * @param amount defines the gradient value between start and end
  5073. * @returns a new Color3 object
  5074. */
  5075. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5076. /**
  5077. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5078. * @param left defines the start value
  5079. * @param right defines the end value
  5080. * @param amount defines the gradient factor
  5081. * @param result defines the Color3 object where to store the result
  5082. */
  5083. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5084. /**
  5085. * Returns a Color3 value containing a red color
  5086. * @returns a new Color3 object
  5087. */
  5088. static Red(): Color3;
  5089. /**
  5090. * Returns a Color3 value containing a green color
  5091. * @returns a new Color3 object
  5092. */
  5093. static Green(): Color3;
  5094. /**
  5095. * Returns a Color3 value containing a blue color
  5096. * @returns a new Color3 object
  5097. */
  5098. static Blue(): Color3;
  5099. /**
  5100. * Returns a Color3 value containing a black color
  5101. * @returns a new Color3 object
  5102. */
  5103. static Black(): Color3;
  5104. /**
  5105. * Gets a Color3 value containing a black color that must not be updated
  5106. */
  5107. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5108. /**
  5109. * Returns a Color3 value containing a white color
  5110. * @returns a new Color3 object
  5111. */
  5112. static White(): Color3;
  5113. /**
  5114. * Returns a Color3 value containing a purple color
  5115. * @returns a new Color3 object
  5116. */
  5117. static Purple(): Color3;
  5118. /**
  5119. * Returns a Color3 value containing a magenta color
  5120. * @returns a new Color3 object
  5121. */
  5122. static Magenta(): Color3;
  5123. /**
  5124. * Returns a Color3 value containing a yellow color
  5125. * @returns a new Color3 object
  5126. */
  5127. static Yellow(): Color3;
  5128. /**
  5129. * Returns a Color3 value containing a gray color
  5130. * @returns a new Color3 object
  5131. */
  5132. static Gray(): Color3;
  5133. /**
  5134. * Returns a Color3 value containing a teal color
  5135. * @returns a new Color3 object
  5136. */
  5137. static Teal(): Color3;
  5138. /**
  5139. * Returns a Color3 value containing a random color
  5140. * @returns a new Color3 object
  5141. */
  5142. static Random(): Color3;
  5143. }
  5144. /**
  5145. * Class used to hold a RBGA color
  5146. */
  5147. export class Color4 {
  5148. /**
  5149. * Defines the red component (between 0 and 1, default is 0)
  5150. */
  5151. r: number;
  5152. /**
  5153. * Defines the green component (between 0 and 1, default is 0)
  5154. */
  5155. g: number;
  5156. /**
  5157. * Defines the blue component (between 0 and 1, default is 0)
  5158. */
  5159. b: number;
  5160. /**
  5161. * Defines the alpha component (between 0 and 1, default is 1)
  5162. */
  5163. a: number;
  5164. /**
  5165. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5166. * @param r defines the red component (between 0 and 1, default is 0)
  5167. * @param g defines the green component (between 0 and 1, default is 0)
  5168. * @param b defines the blue component (between 0 and 1, default is 0)
  5169. * @param a defines the alpha component (between 0 and 1, default is 1)
  5170. */
  5171. constructor(
  5172. /**
  5173. * Defines the red component (between 0 and 1, default is 0)
  5174. */
  5175. r?: number,
  5176. /**
  5177. * Defines the green component (between 0 and 1, default is 0)
  5178. */
  5179. g?: number,
  5180. /**
  5181. * Defines the blue component (between 0 and 1, default is 0)
  5182. */
  5183. b?: number,
  5184. /**
  5185. * Defines the alpha component (between 0 and 1, default is 1)
  5186. */
  5187. a?: number);
  5188. /**
  5189. * Adds in place the given Color4 values to the current Color4 object
  5190. * @param right defines the second operand
  5191. * @returns the current updated Color4 object
  5192. */
  5193. addInPlace(right: DeepImmutable<Color4>): Color4;
  5194. /**
  5195. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5196. * @returns the new array
  5197. */
  5198. asArray(): number[];
  5199. /**
  5200. * Stores from the starting index in the given array the Color4 successive values
  5201. * @param array defines the array where to store the r,g,b components
  5202. * @param index defines an optional index in the target array to define where to start storing values
  5203. * @returns the current Color4 object
  5204. */
  5205. toArray(array: number[], index?: number): Color4;
  5206. /**
  5207. * Determines equality between Color4 objects
  5208. * @param otherColor defines the second operand
  5209. * @returns true if the rgba values are equal to the given ones
  5210. */
  5211. equals(otherColor: DeepImmutable<Color4>): boolean;
  5212. /**
  5213. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5214. * @param right defines the second operand
  5215. * @returns a new Color4 object
  5216. */
  5217. add(right: DeepImmutable<Color4>): Color4;
  5218. /**
  5219. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5220. * @param right defines the second operand
  5221. * @returns a new Color4 object
  5222. */
  5223. subtract(right: DeepImmutable<Color4>): Color4;
  5224. /**
  5225. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5226. * @param right defines the second operand
  5227. * @param result defines the Color4 object where to store the result
  5228. * @returns the current Color4 object
  5229. */
  5230. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5231. /**
  5232. * Creates a new Color4 with the current Color4 values multiplied by scale
  5233. * @param scale defines the scaling factor to apply
  5234. * @returns a new Color4 object
  5235. */
  5236. scale(scale: number): Color4;
  5237. /**
  5238. * Multiplies the current Color4 values by scale and stores the result in "result"
  5239. * @param scale defines the scaling factor to apply
  5240. * @param result defines the Color4 object where to store the result
  5241. * @returns the current unmodified Color4
  5242. */
  5243. scaleToRef(scale: number, result: Color4): Color4;
  5244. /**
  5245. * Scale the current Color4 values by a factor and add the result to a given Color4
  5246. * @param scale defines the scale factor
  5247. * @param result defines the Color4 object where to store the result
  5248. * @returns the unmodified current Color4
  5249. */
  5250. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5251. /**
  5252. * Clamps the rgb values by the min and max values and stores the result into "result"
  5253. * @param min defines minimum clamping value (default is 0)
  5254. * @param max defines maximum clamping value (default is 1)
  5255. * @param result defines color to store the result into.
  5256. * @returns the cuurent Color4
  5257. */
  5258. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5259. /**
  5260. * Multipy an Color4 value by another and return a new Color4 object
  5261. * @param color defines the Color4 value to multiply by
  5262. * @returns a new Color4 object
  5263. */
  5264. multiply(color: Color4): Color4;
  5265. /**
  5266. * Multipy a Color4 value by another and push the result in a reference value
  5267. * @param color defines the Color4 value to multiply by
  5268. * @param result defines the Color4 to fill the result in
  5269. * @returns the result Color4
  5270. */
  5271. multiplyToRef(color: Color4, result: Color4): Color4;
  5272. /**
  5273. * Creates a string with the Color4 current values
  5274. * @returns the string representation of the Color4 object
  5275. */
  5276. toString(): string;
  5277. /**
  5278. * Returns the string "Color4"
  5279. * @returns "Color4"
  5280. */
  5281. getClassName(): string;
  5282. /**
  5283. * Compute the Color4 hash code
  5284. * @returns an unique number that can be used to hash Color4 objects
  5285. */
  5286. getHashCode(): number;
  5287. /**
  5288. * Creates a new Color4 copied from the current one
  5289. * @returns a new Color4 object
  5290. */
  5291. clone(): Color4;
  5292. /**
  5293. * Copies the given Color4 values into the current one
  5294. * @param source defines the source Color4 object
  5295. * @returns the current updated Color4 object
  5296. */
  5297. copyFrom(source: Color4): Color4;
  5298. /**
  5299. * Copies the given float values into the current one
  5300. * @param r defines the red component to read from
  5301. * @param g defines the green component to read from
  5302. * @param b defines the blue component to read from
  5303. * @param a defines the alpha component to read from
  5304. * @returns the current updated Color4 object
  5305. */
  5306. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5307. /**
  5308. * Copies the given float values into the current one
  5309. * @param r defines the red component to read from
  5310. * @param g defines the green component to read from
  5311. * @param b defines the blue component to read from
  5312. * @param a defines the alpha component to read from
  5313. * @returns the current updated Color4 object
  5314. */
  5315. set(r: number, g: number, b: number, a: number): Color4;
  5316. /**
  5317. * Compute the Color4 hexadecimal code as a string
  5318. * @returns a string containing the hexadecimal representation of the Color4 object
  5319. */
  5320. toHexString(): string;
  5321. /**
  5322. * Computes a new Color4 converted from the current one to linear space
  5323. * @returns a new Color4 object
  5324. */
  5325. toLinearSpace(): Color4;
  5326. /**
  5327. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5328. * @param convertedColor defines the Color4 object where to store the linear space version
  5329. * @returns the unmodified Color4
  5330. */
  5331. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5332. /**
  5333. * Computes a new Color4 converted from the current one to gamma space
  5334. * @returns a new Color4 object
  5335. */
  5336. toGammaSpace(): Color4;
  5337. /**
  5338. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5339. * @param convertedColor defines the Color4 object where to store the gamma space version
  5340. * @returns the unmodified Color4
  5341. */
  5342. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5343. /**
  5344. * Creates a new Color4 from the string containing valid hexadecimal values
  5345. * @param hex defines a string containing valid hexadecimal values
  5346. * @returns a new Color4 object
  5347. */
  5348. static FromHexString(hex: string): Color4;
  5349. /**
  5350. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5351. * @param left defines the start value
  5352. * @param right defines the end value
  5353. * @param amount defines the gradient factor
  5354. * @returns a new Color4 object
  5355. */
  5356. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5357. /**
  5358. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5359. * @param left defines the start value
  5360. * @param right defines the end value
  5361. * @param amount defines the gradient factor
  5362. * @param result defines the Color4 object where to store data
  5363. */
  5364. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5365. /**
  5366. * Creates a new Color4 from a Color3 and an alpha value
  5367. * @param color3 defines the source Color3 to read from
  5368. * @param alpha defines the alpha component (1.0 by default)
  5369. * @returns a new Color4 object
  5370. */
  5371. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5372. /**
  5373. * Creates a new Color4 from the starting index element of the given array
  5374. * @param array defines the source array to read from
  5375. * @param offset defines the offset in the source array
  5376. * @returns a new Color4 object
  5377. */
  5378. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5379. /**
  5380. * Creates a new Color3 from integer values (< 256)
  5381. * @param r defines the red component to read from (value between 0 and 255)
  5382. * @param g defines the green component to read from (value between 0 and 255)
  5383. * @param b defines the blue component to read from (value between 0 and 255)
  5384. * @param a defines the alpha component to read from (value between 0 and 255)
  5385. * @returns a new Color3 object
  5386. */
  5387. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5388. /**
  5389. * Check the content of a given array and convert it to an array containing RGBA data
  5390. * If the original array was already containing count * 4 values then it is returned directly
  5391. * @param colors defines the array to check
  5392. * @param count defines the number of RGBA data to expect
  5393. * @returns an array containing count * 4 values (RGBA)
  5394. */
  5395. static CheckColors4(colors: number[], count: number): number[];
  5396. }
  5397. /**
  5398. * @hidden
  5399. */
  5400. export class TmpColors {
  5401. static Color3: Color3[];
  5402. static Color4: Color4[];
  5403. }
  5404. }
  5405. declare module "babylonjs/Maths/sphericalPolynomial" {
  5406. import { Vector3 } from "babylonjs/Maths/math.vector";
  5407. import { Color3 } from "babylonjs/Maths/math.color";
  5408. /**
  5409. * Class representing spherical harmonics coefficients to the 3rd degree
  5410. */
  5411. export class SphericalHarmonics {
  5412. /**
  5413. * Defines whether or not the harmonics have been prescaled for rendering.
  5414. */
  5415. preScaled: boolean;
  5416. /**
  5417. * The l0,0 coefficients of the spherical harmonics
  5418. */
  5419. l00: Vector3;
  5420. /**
  5421. * The l1,-1 coefficients of the spherical harmonics
  5422. */
  5423. l1_1: Vector3;
  5424. /**
  5425. * The l1,0 coefficients of the spherical harmonics
  5426. */
  5427. l10: Vector3;
  5428. /**
  5429. * The l1,1 coefficients of the spherical harmonics
  5430. */
  5431. l11: Vector3;
  5432. /**
  5433. * The l2,-2 coefficients of the spherical harmonics
  5434. */
  5435. l2_2: Vector3;
  5436. /**
  5437. * The l2,-1 coefficients of the spherical harmonics
  5438. */
  5439. l2_1: Vector3;
  5440. /**
  5441. * The l2,0 coefficients of the spherical harmonics
  5442. */
  5443. l20: Vector3;
  5444. /**
  5445. * The l2,1 coefficients of the spherical harmonics
  5446. */
  5447. l21: Vector3;
  5448. /**
  5449. * The l2,2 coefficients of the spherical harmonics
  5450. */
  5451. l22: Vector3;
  5452. /**
  5453. * Adds a light to the spherical harmonics
  5454. * @param direction the direction of the light
  5455. * @param color the color of the light
  5456. * @param deltaSolidAngle the delta solid angle of the light
  5457. */
  5458. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  5459. /**
  5460. * Scales the spherical harmonics by the given amount
  5461. * @param scale the amount to scale
  5462. */
  5463. scaleInPlace(scale: number): void;
  5464. /**
  5465. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  5466. *
  5467. * ```
  5468. * E_lm = A_l * L_lm
  5469. * ```
  5470. *
  5471. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  5472. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  5473. * the scaling factors are given in equation 9.
  5474. */
  5475. convertIncidentRadianceToIrradiance(): void;
  5476. /**
  5477. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  5478. *
  5479. * ```
  5480. * L = (1/pi) * E * rho
  5481. * ```
  5482. *
  5483. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  5484. */
  5485. convertIrradianceToLambertianRadiance(): void;
  5486. /**
  5487. * Integrates the reconstruction coefficients directly in to the SH preventing further
  5488. * required operations at run time.
  5489. *
  5490. * This is simply done by scaling back the SH with Ylm constants parameter.
  5491. * The trigonometric part being applied by the shader at run time.
  5492. */
  5493. preScaleForRendering(): void;
  5494. /**
  5495. * Constructs a spherical harmonics from an array.
  5496. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  5497. * @returns the spherical harmonics
  5498. */
  5499. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  5500. /**
  5501. * Gets the spherical harmonics from polynomial
  5502. * @param polynomial the spherical polynomial
  5503. * @returns the spherical harmonics
  5504. */
  5505. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  5506. }
  5507. /**
  5508. * Class representing spherical polynomial coefficients to the 3rd degree
  5509. */
  5510. export class SphericalPolynomial {
  5511. private _harmonics;
  5512. /**
  5513. * The spherical harmonics used to create the polynomials.
  5514. */
  5515. readonly preScaledHarmonics: SphericalHarmonics;
  5516. /**
  5517. * The x coefficients of the spherical polynomial
  5518. */
  5519. x: Vector3;
  5520. /**
  5521. * The y coefficients of the spherical polynomial
  5522. */
  5523. y: Vector3;
  5524. /**
  5525. * The z coefficients of the spherical polynomial
  5526. */
  5527. z: Vector3;
  5528. /**
  5529. * The xx coefficients of the spherical polynomial
  5530. */
  5531. xx: Vector3;
  5532. /**
  5533. * The yy coefficients of the spherical polynomial
  5534. */
  5535. yy: Vector3;
  5536. /**
  5537. * The zz coefficients of the spherical polynomial
  5538. */
  5539. zz: Vector3;
  5540. /**
  5541. * The xy coefficients of the spherical polynomial
  5542. */
  5543. xy: Vector3;
  5544. /**
  5545. * The yz coefficients of the spherical polynomial
  5546. */
  5547. yz: Vector3;
  5548. /**
  5549. * The zx coefficients of the spherical polynomial
  5550. */
  5551. zx: Vector3;
  5552. /**
  5553. * Adds an ambient color to the spherical polynomial
  5554. * @param color the color to add
  5555. */
  5556. addAmbient(color: Color3): void;
  5557. /**
  5558. * Scales the spherical polynomial by the given amount
  5559. * @param scale the amount to scale
  5560. */
  5561. scaleInPlace(scale: number): void;
  5562. /**
  5563. * Gets the spherical polynomial from harmonics
  5564. * @param harmonics the spherical harmonics
  5565. * @returns the spherical polynomial
  5566. */
  5567. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  5568. /**
  5569. * Constructs a spherical polynomial from an array.
  5570. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  5571. * @returns the spherical polynomial
  5572. */
  5573. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  5574. }
  5575. }
  5576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  5577. /**
  5578. * Define options used to create a render target texture
  5579. */
  5580. export class RenderTargetCreationOptions {
  5581. /**
  5582. * Specifies is mipmaps must be generated
  5583. */
  5584. generateMipMaps?: boolean;
  5585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  5586. generateDepthBuffer?: boolean;
  5587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  5588. generateStencilBuffer?: boolean;
  5589. /** Defines texture type (int by default) */
  5590. type?: number;
  5591. /** Defines sampling mode (trilinear by default) */
  5592. samplingMode?: number;
  5593. /** Defines format (RGBA by default) */
  5594. format?: number;
  5595. }
  5596. }
  5597. declare module "babylonjs/States/alphaCullingState" {
  5598. /**
  5599. * @hidden
  5600. **/
  5601. export class _AlphaState {
  5602. private _isAlphaBlendDirty;
  5603. private _isBlendFunctionParametersDirty;
  5604. private _isBlendEquationParametersDirty;
  5605. private _isBlendConstantsDirty;
  5606. private _alphaBlend;
  5607. private _blendFunctionParameters;
  5608. private _blendEquationParameters;
  5609. private _blendConstants;
  5610. /**
  5611. * Initializes the state.
  5612. */
  5613. constructor();
  5614. readonly isDirty: boolean;
  5615. alphaBlend: boolean;
  5616. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  5617. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  5618. setAlphaEquationParameters(rgb: number, alpha: number): void;
  5619. reset(): void;
  5620. apply(gl: WebGLRenderingContext): void;
  5621. }
  5622. }
  5623. declare module "babylonjs/States/depthCullingState" {
  5624. import { Nullable } from "babylonjs/types";
  5625. /**
  5626. * @hidden
  5627. **/
  5628. export class _DepthCullingState {
  5629. private _isDepthTestDirty;
  5630. private _isDepthMaskDirty;
  5631. private _isDepthFuncDirty;
  5632. private _isCullFaceDirty;
  5633. private _isCullDirty;
  5634. private _isZOffsetDirty;
  5635. private _isFrontFaceDirty;
  5636. private _depthTest;
  5637. private _depthMask;
  5638. private _depthFunc;
  5639. private _cull;
  5640. private _cullFace;
  5641. private _zOffset;
  5642. private _frontFace;
  5643. /**
  5644. * Initializes the state.
  5645. */
  5646. constructor();
  5647. readonly isDirty: boolean;
  5648. zOffset: number;
  5649. cullFace: Nullable<number>;
  5650. cull: Nullable<boolean>;
  5651. depthFunc: Nullable<number>;
  5652. depthMask: boolean;
  5653. depthTest: boolean;
  5654. frontFace: Nullable<number>;
  5655. reset(): void;
  5656. apply(gl: WebGLRenderingContext): void;
  5657. }
  5658. }
  5659. declare module "babylonjs/States/stencilState" {
  5660. /**
  5661. * @hidden
  5662. **/
  5663. export class _StencilState {
  5664. /** 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 */
  5665. static readonly ALWAYS: number;
  5666. /** Passed to stencilOperation to specify that stencil value must be kept */
  5667. static readonly KEEP: number;
  5668. /** Passed to stencilOperation to specify that stencil value must be replaced */
  5669. static readonly REPLACE: number;
  5670. private _isStencilTestDirty;
  5671. private _isStencilMaskDirty;
  5672. private _isStencilFuncDirty;
  5673. private _isStencilOpDirty;
  5674. private _stencilTest;
  5675. private _stencilMask;
  5676. private _stencilFunc;
  5677. private _stencilFuncRef;
  5678. private _stencilFuncMask;
  5679. private _stencilOpStencilFail;
  5680. private _stencilOpDepthFail;
  5681. private _stencilOpStencilDepthPass;
  5682. readonly isDirty: boolean;
  5683. stencilFunc: number;
  5684. stencilFuncRef: number;
  5685. stencilFuncMask: number;
  5686. stencilOpStencilFail: number;
  5687. stencilOpDepthFail: number;
  5688. stencilOpStencilDepthPass: number;
  5689. stencilMask: number;
  5690. stencilTest: boolean;
  5691. constructor();
  5692. reset(): void;
  5693. apply(gl: WebGLRenderingContext): void;
  5694. }
  5695. }
  5696. declare module "babylonjs/States/index" {
  5697. export * from "babylonjs/States/alphaCullingState";
  5698. export * from "babylonjs/States/depthCullingState";
  5699. export * from "babylonjs/States/stencilState";
  5700. }
  5701. declare module "babylonjs/Instrumentation/timeToken" {
  5702. import { Nullable } from "babylonjs/types";
  5703. /**
  5704. * @hidden
  5705. **/
  5706. export class _TimeToken {
  5707. _startTimeQuery: Nullable<WebGLQuery>;
  5708. _endTimeQuery: Nullable<WebGLQuery>;
  5709. _timeElapsedQuery: Nullable<WebGLQuery>;
  5710. _timeElapsedQueryEnded: boolean;
  5711. }
  5712. }
  5713. declare module "babylonjs/Misc/andOrNotEvaluator" {
  5714. /**
  5715. * Class used to evalaute queries containing `and` and `or` operators
  5716. */
  5717. export class AndOrNotEvaluator {
  5718. /**
  5719. * Evaluate a query
  5720. * @param query defines the query to evaluate
  5721. * @param evaluateCallback defines the callback used to filter result
  5722. * @returns true if the query matches
  5723. */
  5724. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  5725. private static _HandleParenthesisContent;
  5726. private static _SimplifyNegation;
  5727. }
  5728. }
  5729. declare module "babylonjs/Misc/tags" {
  5730. /**
  5731. * Class used to store custom tags
  5732. */
  5733. export class Tags {
  5734. /**
  5735. * Adds support for tags on the given object
  5736. * @param obj defines the object to use
  5737. */
  5738. static EnableFor(obj: any): void;
  5739. /**
  5740. * Removes tags support
  5741. * @param obj defines the object to use
  5742. */
  5743. static DisableFor(obj: any): void;
  5744. /**
  5745. * Gets a boolean indicating if the given object has tags
  5746. * @param obj defines the object to use
  5747. * @returns a boolean
  5748. */
  5749. static HasTags(obj: any): boolean;
  5750. /**
  5751. * Gets the tags available on a given object
  5752. * @param obj defines the object to use
  5753. * @param asString defines if the tags must be returned as a string instead of an array of strings
  5754. * @returns the tags
  5755. */
  5756. static GetTags(obj: any, asString?: boolean): any;
  5757. /**
  5758. * Adds tags to an object
  5759. * @param obj defines the object to use
  5760. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  5761. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  5762. */
  5763. static AddTagsTo(obj: any, tagsString: string): void;
  5764. /**
  5765. * @hidden
  5766. */
  5767. static _AddTagTo(obj: any, tag: string): void;
  5768. /**
  5769. * Removes specific tags from a specific object
  5770. * @param obj defines the object to use
  5771. * @param tagsString defines the tags to remove
  5772. */
  5773. static RemoveTagsFrom(obj: any, tagsString: string): void;
  5774. /**
  5775. * @hidden
  5776. */
  5777. static _RemoveTagFrom(obj: any, tag: string): void;
  5778. /**
  5779. * Defines if tags hosted on an object match a given query
  5780. * @param obj defines the object to use
  5781. * @param tagsQuery defines the tag query
  5782. * @returns a boolean
  5783. */
  5784. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  5785. }
  5786. }
  5787. declare module "babylonjs/Maths/math.path" {
  5788. import { DeepImmutable, Nullable } from "babylonjs/types";
  5789. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  5790. /**
  5791. * Defines potential orientation for back face culling
  5792. */
  5793. export enum Orientation {
  5794. /**
  5795. * Clockwise
  5796. */
  5797. CW = 0,
  5798. /** Counter clockwise */
  5799. CCW = 1
  5800. }
  5801. /** Class used to represent a Bezier curve */
  5802. export class BezierCurve {
  5803. /**
  5804. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  5805. * @param t defines the time
  5806. * @param x1 defines the left coordinate on X axis
  5807. * @param y1 defines the left coordinate on Y axis
  5808. * @param x2 defines the right coordinate on X axis
  5809. * @param y2 defines the right coordinate on Y axis
  5810. * @returns the interpolated value
  5811. */
  5812. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  5813. }
  5814. /**
  5815. * Defines angle representation
  5816. */
  5817. export class Angle {
  5818. private _radians;
  5819. /**
  5820. * Creates an Angle object of "radians" radians (float).
  5821. * @param radians the angle in radians
  5822. */
  5823. constructor(radians: number);
  5824. /**
  5825. * Get value in degrees
  5826. * @returns the Angle value in degrees (float)
  5827. */
  5828. degrees(): number;
  5829. /**
  5830. * Get value in radians
  5831. * @returns the Angle value in radians (float)
  5832. */
  5833. radians(): number;
  5834. /**
  5835. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  5836. * @param a defines first vector
  5837. * @param b defines second vector
  5838. * @returns a new Angle
  5839. */
  5840. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  5841. /**
  5842. * Gets a new Angle object from the given float in radians
  5843. * @param radians defines the angle value in radians
  5844. * @returns a new Angle
  5845. */
  5846. static FromRadians(radians: number): Angle;
  5847. /**
  5848. * Gets a new Angle object from the given float in degrees
  5849. * @param degrees defines the angle value in degrees
  5850. * @returns a new Angle
  5851. */
  5852. static FromDegrees(degrees: number): Angle;
  5853. }
  5854. /**
  5855. * This represents an arc in a 2d space.
  5856. */
  5857. export class Arc2 {
  5858. /** Defines the start point of the arc */
  5859. startPoint: Vector2;
  5860. /** Defines the mid point of the arc */
  5861. midPoint: Vector2;
  5862. /** Defines the end point of the arc */
  5863. endPoint: Vector2;
  5864. /**
  5865. * Defines the center point of the arc.
  5866. */
  5867. centerPoint: Vector2;
  5868. /**
  5869. * Defines the radius of the arc.
  5870. */
  5871. radius: number;
  5872. /**
  5873. * Defines the angle of the arc (from mid point to end point).
  5874. */
  5875. angle: Angle;
  5876. /**
  5877. * Defines the start angle of the arc (from start point to middle point).
  5878. */
  5879. startAngle: Angle;
  5880. /**
  5881. * Defines the orientation of the arc (clock wise/counter clock wise).
  5882. */
  5883. orientation: Orientation;
  5884. /**
  5885. * Creates an Arc object from the three given points : start, middle and end.
  5886. * @param startPoint Defines the start point of the arc
  5887. * @param midPoint Defines the midlle point of the arc
  5888. * @param endPoint Defines the end point of the arc
  5889. */
  5890. constructor(
  5891. /** Defines the start point of the arc */
  5892. startPoint: Vector2,
  5893. /** Defines the mid point of the arc */
  5894. midPoint: Vector2,
  5895. /** Defines the end point of the arc */
  5896. endPoint: Vector2);
  5897. }
  5898. /**
  5899. * Represents a 2D path made up of multiple 2D points
  5900. */
  5901. export class Path2 {
  5902. private _points;
  5903. private _length;
  5904. /**
  5905. * If the path start and end point are the same
  5906. */
  5907. closed: boolean;
  5908. /**
  5909. * Creates a Path2 object from the starting 2D coordinates x and y.
  5910. * @param x the starting points x value
  5911. * @param y the starting points y value
  5912. */
  5913. constructor(x: number, y: number);
  5914. /**
  5915. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5916. * @param x the added points x value
  5917. * @param y the added points y value
  5918. * @returns the updated Path2.
  5919. */
  5920. addLineTo(x: number, y: number): Path2;
  5921. /**
  5922. * 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.
  5923. * @param midX middle point x value
  5924. * @param midY middle point y value
  5925. * @param endX end point x value
  5926. * @param endY end point y value
  5927. * @param numberOfSegments (default: 36)
  5928. * @returns the updated Path2.
  5929. */
  5930. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5931. /**
  5932. * Closes the Path2.
  5933. * @returns the Path2.
  5934. */
  5935. close(): Path2;
  5936. /**
  5937. * Gets the sum of the distance between each sequential point in the path
  5938. * @returns the Path2 total length (float).
  5939. */
  5940. length(): number;
  5941. /**
  5942. * Gets the points which construct the path
  5943. * @returns the Path2 internal array of points.
  5944. */
  5945. getPoints(): Vector2[];
  5946. /**
  5947. * Retreives the point at the distance aways from the starting point
  5948. * @param normalizedLengthPosition the length along the path to retreive the point from
  5949. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5950. */
  5951. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5952. /**
  5953. * Creates a new path starting from an x and y position
  5954. * @param x starting x value
  5955. * @param y starting y value
  5956. * @returns a new Path2 starting at the coordinates (x, y).
  5957. */
  5958. static StartingAt(x: number, y: number): Path2;
  5959. }
  5960. /**
  5961. * Represents a 3D path made up of multiple 3D points
  5962. */
  5963. export class Path3D {
  5964. /**
  5965. * an array of Vector3, the curve axis of the Path3D
  5966. */
  5967. path: Vector3[];
  5968. private _curve;
  5969. private _distances;
  5970. private _tangents;
  5971. private _normals;
  5972. private _binormals;
  5973. private _raw;
  5974. /**
  5975. * new Path3D(path, normal, raw)
  5976. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5977. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5978. * @param path an array of Vector3, the curve axis of the Path3D
  5979. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5980. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5981. */
  5982. constructor(
  5983. /**
  5984. * an array of Vector3, the curve axis of the Path3D
  5985. */
  5986. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  5987. /**
  5988. * Returns the Path3D array of successive Vector3 designing its curve.
  5989. * @returns the Path3D array of successive Vector3 designing its curve.
  5990. */
  5991. getCurve(): Vector3[];
  5992. /**
  5993. * Returns an array populated with tangent vectors on each Path3D curve point.
  5994. * @returns an array populated with tangent vectors on each Path3D curve point.
  5995. */
  5996. getTangents(): Vector3[];
  5997. /**
  5998. * Returns an array populated with normal vectors on each Path3D curve point.
  5999. * @returns an array populated with normal vectors on each Path3D curve point.
  6000. */
  6001. getNormals(): Vector3[];
  6002. /**
  6003. * Returns an array populated with binormal vectors on each Path3D curve point.
  6004. * @returns an array populated with binormal vectors on each Path3D curve point.
  6005. */
  6006. getBinormals(): Vector3[];
  6007. /**
  6008. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  6009. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  6010. */
  6011. getDistances(): number[];
  6012. /**
  6013. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  6014. * @param path path which all values are copied into the curves points
  6015. * @param firstNormal which should be projected onto the curve
  6016. * @returns the same object updated.
  6017. */
  6018. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  6019. private _compute;
  6020. private _getFirstNonNullVector;
  6021. private _getLastNonNullVector;
  6022. private _normalVector;
  6023. }
  6024. /**
  6025. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  6026. * A Curve3 is designed from a series of successive Vector3.
  6027. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  6028. */
  6029. export class Curve3 {
  6030. private _points;
  6031. private _length;
  6032. /**
  6033. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  6034. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  6035. * @param v1 (Vector3) the control point
  6036. * @param v2 (Vector3) the end point of the Quadratic Bezier
  6037. * @param nbPoints (integer) the wanted number of points in the curve
  6038. * @returns the created Curve3
  6039. */
  6040. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6041. /**
  6042. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  6043. * @param v0 (Vector3) the origin point of the Cubic Bezier
  6044. * @param v1 (Vector3) the first control point
  6045. * @param v2 (Vector3) the second control point
  6046. * @param v3 (Vector3) the end point of the Cubic Bezier
  6047. * @param nbPoints (integer) the wanted number of points in the curve
  6048. * @returns the created Curve3
  6049. */
  6050. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6051. /**
  6052. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  6053. * @param p1 (Vector3) the origin point of the Hermite Spline
  6054. * @param t1 (Vector3) the tangent vector at the origin point
  6055. * @param p2 (Vector3) the end point of the Hermite Spline
  6056. * @param t2 (Vector3) the tangent vector at the end point
  6057. * @param nbPoints (integer) the wanted number of points in the curve
  6058. * @returns the created Curve3
  6059. */
  6060. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6061. /**
  6062. * Returns a Curve3 object along a CatmullRom Spline curve :
  6063. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  6064. * @param nbPoints (integer) the wanted number of points between each curve control points
  6065. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  6066. * @returns the created Curve3
  6067. */
  6068. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  6069. /**
  6070. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  6071. * A Curve3 is designed from a series of successive Vector3.
  6072. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  6073. * @param points points which make up the curve
  6074. */
  6075. constructor(points: Vector3[]);
  6076. /**
  6077. * @returns the Curve3 stored array of successive Vector3
  6078. */
  6079. getPoints(): Vector3[];
  6080. /**
  6081. * @returns the computed length (float) of the curve.
  6082. */
  6083. length(): number;
  6084. /**
  6085. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  6086. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  6087. * curveA and curveB keep unchanged.
  6088. * @param curve the curve to continue from this curve
  6089. * @returns the newly constructed curve
  6090. */
  6091. continue(curve: DeepImmutable<Curve3>): Curve3;
  6092. private _computeLength;
  6093. }
  6094. }
  6095. declare module "babylonjs/Animations/easing" {
  6096. /**
  6097. * This represents the main contract an easing function should follow.
  6098. * Easing functions are used throughout the animation system.
  6099. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6100. */
  6101. export interface IEasingFunction {
  6102. /**
  6103. * Given an input gradient between 0 and 1, this returns the corrseponding value
  6104. * of the easing function.
  6105. * The link below provides some of the most common examples of easing functions.
  6106. * @see https://easings.net/
  6107. * @param gradient Defines the value between 0 and 1 we want the easing value for
  6108. * @returns the corresponding value on the curve defined by the easing function
  6109. */
  6110. ease(gradient: number): number;
  6111. }
  6112. /**
  6113. * Base class used for every default easing function.
  6114. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6115. */
  6116. export class EasingFunction implements IEasingFunction {
  6117. /**
  6118. * Interpolation follows the mathematical formula associated with the easing function.
  6119. */
  6120. static readonly EASINGMODE_EASEIN: number;
  6121. /**
  6122. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  6123. */
  6124. static readonly EASINGMODE_EASEOUT: number;
  6125. /**
  6126. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  6127. */
  6128. static readonly EASINGMODE_EASEINOUT: number;
  6129. private _easingMode;
  6130. /**
  6131. * Sets the easing mode of the current function.
  6132. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  6133. */
  6134. setEasingMode(easingMode: number): void;
  6135. /**
  6136. * Gets the current easing mode.
  6137. * @returns the easing mode
  6138. */
  6139. getEasingMode(): number;
  6140. /**
  6141. * @hidden
  6142. */
  6143. easeInCore(gradient: number): number;
  6144. /**
  6145. * Given an input gradient between 0 and 1, this returns the corresponding value
  6146. * of the easing function.
  6147. * @param gradient Defines the value between 0 and 1 we want the easing value for
  6148. * @returns the corresponding value on the curve defined by the easing function
  6149. */
  6150. ease(gradient: number): number;
  6151. }
  6152. /**
  6153. * Easing function with a circle shape (see link below).
  6154. * @see https://easings.net/#easeInCirc
  6155. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6156. */
  6157. export class CircleEase extends EasingFunction implements IEasingFunction {
  6158. /** @hidden */
  6159. easeInCore(gradient: number): number;
  6160. }
  6161. /**
  6162. * Easing function with a ease back shape (see link below).
  6163. * @see https://easings.net/#easeInBack
  6164. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6165. */
  6166. export class BackEase extends EasingFunction implements IEasingFunction {
  6167. /** Defines the amplitude of the function */
  6168. amplitude: number;
  6169. /**
  6170. * Instantiates a back ease easing
  6171. * @see https://easings.net/#easeInBack
  6172. * @param amplitude Defines the amplitude of the function
  6173. */
  6174. constructor(
  6175. /** Defines the amplitude of the function */
  6176. amplitude?: number);
  6177. /** @hidden */
  6178. easeInCore(gradient: number): number;
  6179. }
  6180. /**
  6181. * Easing function with a bouncing shape (see link below).
  6182. * @see https://easings.net/#easeInBounce
  6183. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6184. */
  6185. export class BounceEase extends EasingFunction implements IEasingFunction {
  6186. /** Defines the number of bounces */
  6187. bounces: number;
  6188. /** Defines the amplitude of the bounce */
  6189. bounciness: number;
  6190. /**
  6191. * Instantiates a bounce easing
  6192. * @see https://easings.net/#easeInBounce
  6193. * @param bounces Defines the number of bounces
  6194. * @param bounciness Defines the amplitude of the bounce
  6195. */
  6196. constructor(
  6197. /** Defines the number of bounces */
  6198. bounces?: number,
  6199. /** Defines the amplitude of the bounce */
  6200. bounciness?: number);
  6201. /** @hidden */
  6202. easeInCore(gradient: number): number;
  6203. }
  6204. /**
  6205. * Easing function with a power of 3 shape (see link below).
  6206. * @see https://easings.net/#easeInCubic
  6207. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6208. */
  6209. export class CubicEase extends EasingFunction implements IEasingFunction {
  6210. /** @hidden */
  6211. easeInCore(gradient: number): number;
  6212. }
  6213. /**
  6214. * Easing function with an elastic shape (see link below).
  6215. * @see https://easings.net/#easeInElastic
  6216. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6217. */
  6218. export class ElasticEase extends EasingFunction implements IEasingFunction {
  6219. /** Defines the number of oscillations*/
  6220. oscillations: number;
  6221. /** Defines the amplitude of the oscillations*/
  6222. springiness: number;
  6223. /**
  6224. * Instantiates an elastic easing function
  6225. * @see https://easings.net/#easeInElastic
  6226. * @param oscillations Defines the number of oscillations
  6227. * @param springiness Defines the amplitude of the oscillations
  6228. */
  6229. constructor(
  6230. /** Defines the number of oscillations*/
  6231. oscillations?: number,
  6232. /** Defines the amplitude of the oscillations*/
  6233. springiness?: number);
  6234. /** @hidden */
  6235. easeInCore(gradient: number): number;
  6236. }
  6237. /**
  6238. * Easing function with an exponential shape (see link below).
  6239. * @see https://easings.net/#easeInExpo
  6240. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6241. */
  6242. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  6243. /** Defines the exponent of the function */
  6244. exponent: number;
  6245. /**
  6246. * Instantiates an exponential easing function
  6247. * @see https://easings.net/#easeInExpo
  6248. * @param exponent Defines the exponent of the function
  6249. */
  6250. constructor(
  6251. /** Defines the exponent of the function */
  6252. exponent?: number);
  6253. /** @hidden */
  6254. easeInCore(gradient: number): number;
  6255. }
  6256. /**
  6257. * Easing function with a power shape (see link below).
  6258. * @see https://easings.net/#easeInQuad
  6259. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6260. */
  6261. export class PowerEase extends EasingFunction implements IEasingFunction {
  6262. /** Defines the power of the function */
  6263. power: number;
  6264. /**
  6265. * Instantiates an power base easing function
  6266. * @see https://easings.net/#easeInQuad
  6267. * @param power Defines the power of the function
  6268. */
  6269. constructor(
  6270. /** Defines the power of the function */
  6271. power?: number);
  6272. /** @hidden */
  6273. easeInCore(gradient: number): number;
  6274. }
  6275. /**
  6276. * Easing function with a power of 2 shape (see link below).
  6277. * @see https://easings.net/#easeInQuad
  6278. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6279. */
  6280. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  6281. /** @hidden */
  6282. easeInCore(gradient: number): number;
  6283. }
  6284. /**
  6285. * Easing function with a power of 4 shape (see link below).
  6286. * @see https://easings.net/#easeInQuart
  6287. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6288. */
  6289. export class QuarticEase extends EasingFunction implements IEasingFunction {
  6290. /** @hidden */
  6291. easeInCore(gradient: number): number;
  6292. }
  6293. /**
  6294. * Easing function with a power of 5 shape (see link below).
  6295. * @see https://easings.net/#easeInQuint
  6296. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6297. */
  6298. export class QuinticEase extends EasingFunction implements IEasingFunction {
  6299. /** @hidden */
  6300. easeInCore(gradient: number): number;
  6301. }
  6302. /**
  6303. * Easing function with a sin shape (see link below).
  6304. * @see https://easings.net/#easeInSine
  6305. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6306. */
  6307. export class SineEase extends EasingFunction implements IEasingFunction {
  6308. /** @hidden */
  6309. easeInCore(gradient: number): number;
  6310. }
  6311. /**
  6312. * Easing function with a bezier shape (see link below).
  6313. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  6314. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6315. */
  6316. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  6317. /** Defines the x component of the start tangent in the bezier curve */
  6318. x1: number;
  6319. /** Defines the y component of the start tangent in the bezier curve */
  6320. y1: number;
  6321. /** Defines the x component of the end tangent in the bezier curve */
  6322. x2: number;
  6323. /** Defines the y component of the end tangent in the bezier curve */
  6324. y2: number;
  6325. /**
  6326. * Instantiates a bezier function
  6327. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  6328. * @param x1 Defines the x component of the start tangent in the bezier curve
  6329. * @param y1 Defines the y component of the start tangent in the bezier curve
  6330. * @param x2 Defines the x component of the end tangent in the bezier curve
  6331. * @param y2 Defines the y component of the end tangent in the bezier curve
  6332. */
  6333. constructor(
  6334. /** Defines the x component of the start tangent in the bezier curve */
  6335. x1?: number,
  6336. /** Defines the y component of the start tangent in the bezier curve */
  6337. y1?: number,
  6338. /** Defines the x component of the end tangent in the bezier curve */
  6339. x2?: number,
  6340. /** Defines the y component of the end tangent in the bezier curve */
  6341. y2?: number);
  6342. /** @hidden */
  6343. easeInCore(gradient: number): number;
  6344. }
  6345. }
  6346. declare module "babylonjs/Animations/animationKey" {
  6347. /**
  6348. * Defines an interface which represents an animation key frame
  6349. */
  6350. export interface IAnimationKey {
  6351. /**
  6352. * Frame of the key frame
  6353. */
  6354. frame: number;
  6355. /**
  6356. * Value at the specifies key frame
  6357. */
  6358. value: any;
  6359. /**
  6360. * The input tangent for the cubic hermite spline
  6361. */
  6362. inTangent?: any;
  6363. /**
  6364. * The output tangent for the cubic hermite spline
  6365. */
  6366. outTangent?: any;
  6367. /**
  6368. * The animation interpolation type
  6369. */
  6370. interpolation?: AnimationKeyInterpolation;
  6371. }
  6372. /**
  6373. * Enum for the animation key frame interpolation type
  6374. */
  6375. export enum AnimationKeyInterpolation {
  6376. /**
  6377. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6378. */
  6379. STEP = 1
  6380. }
  6381. }
  6382. declare module "babylonjs/Animations/animationRange" {
  6383. /**
  6384. * Represents the range of an animation
  6385. */
  6386. export class AnimationRange {
  6387. /**The name of the animation range**/
  6388. name: string;
  6389. /**The starting frame of the animation */
  6390. from: number;
  6391. /**The ending frame of the animation*/
  6392. to: number;
  6393. /**
  6394. * Initializes the range of an animation
  6395. * @param name The name of the animation range
  6396. * @param from The starting frame of the animation
  6397. * @param to The ending frame of the animation
  6398. */
  6399. constructor(
  6400. /**The name of the animation range**/
  6401. name: string,
  6402. /**The starting frame of the animation */
  6403. from: number,
  6404. /**The ending frame of the animation*/
  6405. to: number);
  6406. /**
  6407. * Makes a copy of the animation range
  6408. * @returns A copy of the animation range
  6409. */
  6410. clone(): AnimationRange;
  6411. }
  6412. }
  6413. declare module "babylonjs/Animations/animationEvent" {
  6414. /**
  6415. * Composed of a frame, and an action function
  6416. */
  6417. export class AnimationEvent {
  6418. /** The frame for which the event is triggered **/
  6419. frame: number;
  6420. /** The event to perform when triggered **/
  6421. action: (currentFrame: number) => void;
  6422. /** Specifies if the event should be triggered only once**/
  6423. onlyOnce?: boolean | undefined;
  6424. /**
  6425. * Specifies if the animation event is done
  6426. */
  6427. isDone: boolean;
  6428. /**
  6429. * Initializes the animation event
  6430. * @param frame The frame for which the event is triggered
  6431. * @param action The event to perform when triggered
  6432. * @param onlyOnce Specifies if the event should be triggered only once
  6433. */
  6434. constructor(
  6435. /** The frame for which the event is triggered **/
  6436. frame: number,
  6437. /** The event to perform when triggered **/
  6438. action: (currentFrame: number) => void,
  6439. /** Specifies if the event should be triggered only once**/
  6440. onlyOnce?: boolean | undefined);
  6441. /** @hidden */
  6442. _clone(): AnimationEvent;
  6443. }
  6444. }
  6445. declare module "babylonjs/Behaviors/behavior" {
  6446. import { Nullable } from "babylonjs/types";
  6447. /**
  6448. * Interface used to define a behavior
  6449. */
  6450. export interface Behavior<T> {
  6451. /** gets or sets behavior's name */
  6452. name: string;
  6453. /**
  6454. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6455. */
  6456. init(): void;
  6457. /**
  6458. * Called when the behavior is attached to a target
  6459. * @param target defines the target where the behavior is attached to
  6460. */
  6461. attach(target: T): void;
  6462. /**
  6463. * Called when the behavior is detached from its target
  6464. */
  6465. detach(): void;
  6466. }
  6467. /**
  6468. * Interface implemented by classes supporting behaviors
  6469. */
  6470. export interface IBehaviorAware<T> {
  6471. /**
  6472. * Attach a behavior
  6473. * @param behavior defines the behavior to attach
  6474. * @returns the current host
  6475. */
  6476. addBehavior(behavior: Behavior<T>): T;
  6477. /**
  6478. * Remove a behavior from the current object
  6479. * @param behavior defines the behavior to detach
  6480. * @returns the current host
  6481. */
  6482. removeBehavior(behavior: Behavior<T>): T;
  6483. /**
  6484. * Gets a behavior using its name to search
  6485. * @param name defines the name to search
  6486. * @returns the behavior or null if not found
  6487. */
  6488. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6489. }
  6490. }
  6491. declare module "babylonjs/Misc/smartArray" {
  6492. /**
  6493. * Defines an array and its length.
  6494. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6495. */
  6496. export interface ISmartArrayLike<T> {
  6497. /**
  6498. * The data of the array.
  6499. */
  6500. data: Array<T>;
  6501. /**
  6502. * The active length of the array.
  6503. */
  6504. length: number;
  6505. }
  6506. /**
  6507. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6508. */
  6509. export class SmartArray<T> implements ISmartArrayLike<T> {
  6510. /**
  6511. * The full set of data from the array.
  6512. */
  6513. data: Array<T>;
  6514. /**
  6515. * The active length of the array.
  6516. */
  6517. length: number;
  6518. protected _id: number;
  6519. /**
  6520. * Instantiates a Smart Array.
  6521. * @param capacity defines the default capacity of the array.
  6522. */
  6523. constructor(capacity: number);
  6524. /**
  6525. * Pushes a value at the end of the active data.
  6526. * @param value defines the object to push in the array.
  6527. */
  6528. push(value: T): void;
  6529. /**
  6530. * Iterates over the active data and apply the lambda to them.
  6531. * @param func defines the action to apply on each value.
  6532. */
  6533. forEach(func: (content: T) => void): void;
  6534. /**
  6535. * Sorts the full sets of data.
  6536. * @param compareFn defines the comparison function to apply.
  6537. */
  6538. sort(compareFn: (a: T, b: T) => number): void;
  6539. /**
  6540. * Resets the active data to an empty array.
  6541. */
  6542. reset(): void;
  6543. /**
  6544. * Releases all the data from the array as well as the array.
  6545. */
  6546. dispose(): void;
  6547. /**
  6548. * Concats the active data with a given array.
  6549. * @param array defines the data to concatenate with.
  6550. */
  6551. concat(array: any): void;
  6552. /**
  6553. * Returns the position of a value in the active data.
  6554. * @param value defines the value to find the index for
  6555. * @returns the index if found in the active data otherwise -1
  6556. */
  6557. indexOf(value: T): number;
  6558. /**
  6559. * Returns whether an element is part of the active data.
  6560. * @param value defines the value to look for
  6561. * @returns true if found in the active data otherwise false
  6562. */
  6563. contains(value: T): boolean;
  6564. private static _GlobalId;
  6565. }
  6566. /**
  6567. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6568. * The data in this array can only be present once
  6569. */
  6570. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6571. private _duplicateId;
  6572. /**
  6573. * Pushes a value at the end of the active data.
  6574. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6575. * @param value defines the object to push in the array.
  6576. */
  6577. push(value: T): void;
  6578. /**
  6579. * Pushes a value at the end of the active data.
  6580. * If the data is already present, it won t be added again
  6581. * @param value defines the object to push in the array.
  6582. * @returns true if added false if it was already present
  6583. */
  6584. pushNoDuplicate(value: T): boolean;
  6585. /**
  6586. * Resets the active data to an empty array.
  6587. */
  6588. reset(): void;
  6589. /**
  6590. * Concats the active data with a given array.
  6591. * This ensures no dupplicate will be present in the result.
  6592. * @param array defines the data to concatenate with.
  6593. */
  6594. concatWithNoDuplicate(array: any): void;
  6595. }
  6596. }
  6597. declare module "babylonjs/Cameras/cameraInputsManager" {
  6598. import { Nullable } from "babylonjs/types";
  6599. import { Camera } from "babylonjs/Cameras/camera";
  6600. /**
  6601. * @ignore
  6602. * This is a list of all the different input types that are available in the application.
  6603. * Fo instance: ArcRotateCameraGamepadInput...
  6604. */
  6605. export var CameraInputTypes: {};
  6606. /**
  6607. * This is the contract to implement in order to create a new input class.
  6608. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6609. */
  6610. export interface ICameraInput<TCamera extends Camera> {
  6611. /**
  6612. * Defines the camera the input is attached to.
  6613. */
  6614. camera: Nullable<TCamera>;
  6615. /**
  6616. * Gets the class name of the current intput.
  6617. * @returns the class name
  6618. */
  6619. getClassName(): string;
  6620. /**
  6621. * Get the friendly name associated with the input class.
  6622. * @returns the input friendly name
  6623. */
  6624. getSimpleName(): string;
  6625. /**
  6626. * Attach the input controls to a specific dom element to get the input from.
  6627. * @param element Defines the element the controls should be listened from
  6628. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6629. */
  6630. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6631. /**
  6632. * Detach the current controls from the specified dom element.
  6633. * @param element Defines the element to stop listening the inputs from
  6634. */
  6635. detachControl(element: Nullable<HTMLElement>): void;
  6636. /**
  6637. * Update the current camera state depending on the inputs that have been used this frame.
  6638. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6639. */
  6640. checkInputs?: () => void;
  6641. }
  6642. /**
  6643. * Represents a map of input types to input instance or input index to input instance.
  6644. */
  6645. export interface CameraInputsMap<TCamera extends Camera> {
  6646. /**
  6647. * Accessor to the input by input type.
  6648. */
  6649. [name: string]: ICameraInput<TCamera>;
  6650. /**
  6651. * Accessor to the input by input index.
  6652. */
  6653. [idx: number]: ICameraInput<TCamera>;
  6654. }
  6655. /**
  6656. * This represents the input manager used within a camera.
  6657. * It helps dealing with all the different kind of input attached to a camera.
  6658. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6659. */
  6660. export class CameraInputsManager<TCamera extends Camera> {
  6661. /**
  6662. * Defines the list of inputs attahed to the camera.
  6663. */
  6664. attached: CameraInputsMap<TCamera>;
  6665. /**
  6666. * Defines the dom element the camera is collecting inputs from.
  6667. * This is null if the controls have not been attached.
  6668. */
  6669. attachedElement: Nullable<HTMLElement>;
  6670. /**
  6671. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6672. */
  6673. noPreventDefault: boolean;
  6674. /**
  6675. * Defined the camera the input manager belongs to.
  6676. */
  6677. camera: TCamera;
  6678. /**
  6679. * Update the current camera state depending on the inputs that have been used this frame.
  6680. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6681. */
  6682. checkInputs: () => void;
  6683. /**
  6684. * Instantiate a new Camera Input Manager.
  6685. * @param camera Defines the camera the input manager blongs to
  6686. */
  6687. constructor(camera: TCamera);
  6688. /**
  6689. * Add an input method to a camera
  6690. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6691. * @param input camera input method
  6692. */
  6693. add(input: ICameraInput<TCamera>): void;
  6694. /**
  6695. * Remove a specific input method from a camera
  6696. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6697. * @param inputToRemove camera input method
  6698. */
  6699. remove(inputToRemove: ICameraInput<TCamera>): void;
  6700. /**
  6701. * Remove a specific input type from a camera
  6702. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6703. * @param inputType the type of the input to remove
  6704. */
  6705. removeByType(inputType: string): void;
  6706. private _addCheckInputs;
  6707. /**
  6708. * Attach the input controls to the currently attached dom element to listen the events from.
  6709. * @param input Defines the input to attach
  6710. */
  6711. attachInput(input: ICameraInput<TCamera>): void;
  6712. /**
  6713. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6714. * @param element Defines the dom element to collect the events from
  6715. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6716. */
  6717. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6718. /**
  6719. * Detach the current manager inputs controls from a specific dom element.
  6720. * @param element Defines the dom element to collect the events from
  6721. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6722. */
  6723. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6724. /**
  6725. * Rebuild the dynamic inputCheck function from the current list of
  6726. * defined inputs in the manager.
  6727. */
  6728. rebuildInputCheck(): void;
  6729. /**
  6730. * Remove all attached input methods from a camera
  6731. */
  6732. clear(): void;
  6733. /**
  6734. * Serialize the current input manager attached to a camera.
  6735. * This ensures than once parsed,
  6736. * the input associated to the camera will be identical to the current ones
  6737. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6738. */
  6739. serialize(serializedCamera: any): void;
  6740. /**
  6741. * Parses an input manager serialized JSON to restore the previous list of inputs
  6742. * and states associated to a camera.
  6743. * @param parsedCamera Defines the JSON to parse
  6744. */
  6745. parse(parsedCamera: any): void;
  6746. }
  6747. }
  6748. declare module "babylonjs/Collisions/intersectionInfo" {
  6749. import { Nullable } from "babylonjs/types";
  6750. /**
  6751. * @hidden
  6752. */
  6753. export class IntersectionInfo {
  6754. bu: Nullable<number>;
  6755. bv: Nullable<number>;
  6756. distance: number;
  6757. faceId: number;
  6758. subMeshId: number;
  6759. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6760. }
  6761. }
  6762. declare module "babylonjs/Maths/math.plane" {
  6763. import { DeepImmutable } from "babylonjs/types";
  6764. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6765. /**
  6766. * Represens a plane by the equation ax + by + cz + d = 0
  6767. */
  6768. export class Plane {
  6769. private static _TmpMatrix;
  6770. /**
  6771. * Normal of the plane (a,b,c)
  6772. */
  6773. normal: Vector3;
  6774. /**
  6775. * d component of the plane
  6776. */
  6777. d: number;
  6778. /**
  6779. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6780. * @param a a component of the plane
  6781. * @param b b component of the plane
  6782. * @param c c component of the plane
  6783. * @param d d component of the plane
  6784. */
  6785. constructor(a: number, b: number, c: number, d: number);
  6786. /**
  6787. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6788. */
  6789. asArray(): number[];
  6790. /**
  6791. * @returns a new plane copied from the current Plane.
  6792. */
  6793. clone(): Plane;
  6794. /**
  6795. * @returns the string "Plane".
  6796. */
  6797. getClassName(): string;
  6798. /**
  6799. * @returns the Plane hash code.
  6800. */
  6801. getHashCode(): number;
  6802. /**
  6803. * Normalize the current Plane in place.
  6804. * @returns the updated Plane.
  6805. */
  6806. normalize(): Plane;
  6807. /**
  6808. * Applies a transformation the plane and returns the result
  6809. * @param transformation the transformation matrix to be applied to the plane
  6810. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6811. */
  6812. transform(transformation: DeepImmutable<Matrix>): Plane;
  6813. /**
  6814. * Calcualtte the dot product between the point and the plane normal
  6815. * @param point point to calculate the dot product with
  6816. * @returns the dot product (float) of the point coordinates and the plane normal.
  6817. */
  6818. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6819. /**
  6820. * Updates the current Plane from the plane defined by the three given points.
  6821. * @param point1 one of the points used to contruct the plane
  6822. * @param point2 one of the points used to contruct the plane
  6823. * @param point3 one of the points used to contruct the plane
  6824. * @returns the updated Plane.
  6825. */
  6826. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6827. /**
  6828. * Checks if the plane is facing a given direction
  6829. * @param direction the direction to check if the plane is facing
  6830. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6831. * @returns True is the vector "direction" is the same side than the plane normal.
  6832. */
  6833. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6834. /**
  6835. * Calculates the distance to a point
  6836. * @param point point to calculate distance to
  6837. * @returns the signed distance (float) from the given point to the Plane.
  6838. */
  6839. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6840. /**
  6841. * Creates a plane from an array
  6842. * @param array the array to create a plane from
  6843. * @returns a new Plane from the given array.
  6844. */
  6845. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6846. /**
  6847. * Creates a plane from three points
  6848. * @param point1 point used to create the plane
  6849. * @param point2 point used to create the plane
  6850. * @param point3 point used to create the plane
  6851. * @returns a new Plane defined by the three given points.
  6852. */
  6853. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6854. /**
  6855. * Creates a plane from an origin point and a normal
  6856. * @param origin origin of the plane to be constructed
  6857. * @param normal normal of the plane to be constructed
  6858. * @returns a new Plane the normal vector to this plane at the given origin point.
  6859. * Note : the vector "normal" is updated because normalized.
  6860. */
  6861. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6862. /**
  6863. * Calculates the distance from a plane and a point
  6864. * @param origin origin of the plane to be constructed
  6865. * @param normal normal of the plane to be constructed
  6866. * @param point point to calculate distance to
  6867. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6868. */
  6869. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6870. }
  6871. }
  6872. declare module "babylonjs/Culling/boundingSphere" {
  6873. import { DeepImmutable } from "babylonjs/types";
  6874. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6875. import { Plane } from "babylonjs/Maths/math.plane";
  6876. /**
  6877. * Class used to store bounding sphere information
  6878. */
  6879. export class BoundingSphere {
  6880. /**
  6881. * Gets the center of the bounding sphere in local space
  6882. */
  6883. readonly center: Vector3;
  6884. /**
  6885. * Radius of the bounding sphere in local space
  6886. */
  6887. radius: number;
  6888. /**
  6889. * Gets the center of the bounding sphere in world space
  6890. */
  6891. readonly centerWorld: Vector3;
  6892. /**
  6893. * Radius of the bounding sphere in world space
  6894. */
  6895. radiusWorld: number;
  6896. /**
  6897. * Gets the minimum vector in local space
  6898. */
  6899. readonly minimum: Vector3;
  6900. /**
  6901. * Gets the maximum vector in local space
  6902. */
  6903. readonly maximum: Vector3;
  6904. private _worldMatrix;
  6905. private static readonly TmpVector3;
  6906. /**
  6907. * Creates a new bounding sphere
  6908. * @param min defines the minimum vector (in local space)
  6909. * @param max defines the maximum vector (in local space)
  6910. * @param worldMatrix defines the new world matrix
  6911. */
  6912. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6913. /**
  6914. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6915. * @param min defines the new minimum vector (in local space)
  6916. * @param max defines the new maximum vector (in local space)
  6917. * @param worldMatrix defines the new world matrix
  6918. */
  6919. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6920. /**
  6921. * Scale the current bounding sphere by applying a scale factor
  6922. * @param factor defines the scale factor to apply
  6923. * @returns the current bounding box
  6924. */
  6925. scale(factor: number): BoundingSphere;
  6926. /**
  6927. * Gets the world matrix of the bounding box
  6928. * @returns a matrix
  6929. */
  6930. getWorldMatrix(): DeepImmutable<Matrix>;
  6931. /** @hidden */
  6932. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6933. /**
  6934. * Tests if the bounding sphere is intersecting the frustum planes
  6935. * @param frustumPlanes defines the frustum planes to test
  6936. * @returns true if there is an intersection
  6937. */
  6938. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6939. /**
  6940. * Tests if the bounding sphere center is in between the frustum planes.
  6941. * Used for optimistic fast inclusion.
  6942. * @param frustumPlanes defines the frustum planes to test
  6943. * @returns true if the sphere center is in between the frustum planes
  6944. */
  6945. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6946. /**
  6947. * Tests if a point is inside the bounding sphere
  6948. * @param point defines the point to test
  6949. * @returns true if the point is inside the bounding sphere
  6950. */
  6951. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6952. /**
  6953. * Checks if two sphere intersct
  6954. * @param sphere0 sphere 0
  6955. * @param sphere1 sphere 1
  6956. * @returns true if the speres intersect
  6957. */
  6958. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6959. }
  6960. }
  6961. declare module "babylonjs/Culling/boundingBox" {
  6962. import { DeepImmutable } from "babylonjs/types";
  6963. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6964. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6965. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6966. import { Plane } from "babylonjs/Maths/math.plane";
  6967. /**
  6968. * Class used to store bounding box information
  6969. */
  6970. export class BoundingBox implements ICullable {
  6971. /**
  6972. * Gets the 8 vectors representing the bounding box in local space
  6973. */
  6974. readonly vectors: Vector3[];
  6975. /**
  6976. * Gets the center of the bounding box in local space
  6977. */
  6978. readonly center: Vector3;
  6979. /**
  6980. * Gets the center of the bounding box in world space
  6981. */
  6982. readonly centerWorld: Vector3;
  6983. /**
  6984. * Gets the extend size in local space
  6985. */
  6986. readonly extendSize: Vector3;
  6987. /**
  6988. * Gets the extend size in world space
  6989. */
  6990. readonly extendSizeWorld: Vector3;
  6991. /**
  6992. * Gets the OBB (object bounding box) directions
  6993. */
  6994. readonly directions: Vector3[];
  6995. /**
  6996. * Gets the 8 vectors representing the bounding box in world space
  6997. */
  6998. readonly vectorsWorld: Vector3[];
  6999. /**
  7000. * Gets the minimum vector in world space
  7001. */
  7002. readonly minimumWorld: Vector3;
  7003. /**
  7004. * Gets the maximum vector in world space
  7005. */
  7006. readonly maximumWorld: Vector3;
  7007. /**
  7008. * Gets the minimum vector in local space
  7009. */
  7010. readonly minimum: Vector3;
  7011. /**
  7012. * Gets the maximum vector in local space
  7013. */
  7014. readonly maximum: Vector3;
  7015. private _worldMatrix;
  7016. private static readonly TmpVector3;
  7017. /**
  7018. * @hidden
  7019. */
  7020. _tag: number;
  7021. /**
  7022. * Creates a new bounding box
  7023. * @param min defines the minimum vector (in local space)
  7024. * @param max defines the maximum vector (in local space)
  7025. * @param worldMatrix defines the new world matrix
  7026. */
  7027. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7028. /**
  7029. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7030. * @param min defines the new minimum vector (in local space)
  7031. * @param max defines the new maximum vector (in local space)
  7032. * @param worldMatrix defines the new world matrix
  7033. */
  7034. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7035. /**
  7036. * Scale the current bounding box by applying a scale factor
  7037. * @param factor defines the scale factor to apply
  7038. * @returns the current bounding box
  7039. */
  7040. scale(factor: number): BoundingBox;
  7041. /**
  7042. * Gets the world matrix of the bounding box
  7043. * @returns a matrix
  7044. */
  7045. getWorldMatrix(): DeepImmutable<Matrix>;
  7046. /** @hidden */
  7047. _update(world: DeepImmutable<Matrix>): void;
  7048. /**
  7049. * Tests if the bounding box is intersecting the frustum planes
  7050. * @param frustumPlanes defines the frustum planes to test
  7051. * @returns true if there is an intersection
  7052. */
  7053. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7054. /**
  7055. * Tests if the bounding box is entirely inside the frustum planes
  7056. * @param frustumPlanes defines the frustum planes to test
  7057. * @returns true if there is an inclusion
  7058. */
  7059. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7060. /**
  7061. * Tests if a point is inside the bounding box
  7062. * @param point defines the point to test
  7063. * @returns true if the point is inside the bounding box
  7064. */
  7065. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7066. /**
  7067. * Tests if the bounding box intersects with a bounding sphere
  7068. * @param sphere defines the sphere to test
  7069. * @returns true if there is an intersection
  7070. */
  7071. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7072. /**
  7073. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7074. * @param min defines the min vector to use
  7075. * @param max defines the max vector to use
  7076. * @returns true if there is an intersection
  7077. */
  7078. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7079. /**
  7080. * Tests if two bounding boxes are intersections
  7081. * @param box0 defines the first box to test
  7082. * @param box1 defines the second box to test
  7083. * @returns true if there is an intersection
  7084. */
  7085. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7086. /**
  7087. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7088. * @param minPoint defines the minimum vector of the bounding box
  7089. * @param maxPoint defines the maximum vector of the bounding box
  7090. * @param sphereCenter defines the sphere center
  7091. * @param sphereRadius defines the sphere radius
  7092. * @returns true if there is an intersection
  7093. */
  7094. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7095. /**
  7096. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7097. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7098. * @param frustumPlanes defines the frustum planes to test
  7099. * @return true if there is an inclusion
  7100. */
  7101. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7102. /**
  7103. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7104. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7105. * @param frustumPlanes defines the frustum planes to test
  7106. * @return true if there is an intersection
  7107. */
  7108. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7109. }
  7110. }
  7111. declare module "babylonjs/Collisions/collider" {
  7112. import { Nullable, IndicesArray } from "babylonjs/types";
  7113. import { Vector3 } from "babylonjs/Maths/math.vector";
  7114. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7115. import { Plane } from "babylonjs/Maths/math.plane";
  7116. /** @hidden */
  7117. export class Collider {
  7118. /** Define if a collision was found */
  7119. collisionFound: boolean;
  7120. /**
  7121. * Define last intersection point in local space
  7122. */
  7123. intersectionPoint: Vector3;
  7124. /**
  7125. * Define last collided mesh
  7126. */
  7127. collidedMesh: Nullable<AbstractMesh>;
  7128. private _collisionPoint;
  7129. private _planeIntersectionPoint;
  7130. private _tempVector;
  7131. private _tempVector2;
  7132. private _tempVector3;
  7133. private _tempVector4;
  7134. private _edge;
  7135. private _baseToVertex;
  7136. private _destinationPoint;
  7137. private _slidePlaneNormal;
  7138. private _displacementVector;
  7139. /** @hidden */
  7140. _radius: Vector3;
  7141. /** @hidden */
  7142. _retry: number;
  7143. private _velocity;
  7144. private _basePoint;
  7145. private _epsilon;
  7146. /** @hidden */
  7147. _velocityWorldLength: number;
  7148. /** @hidden */
  7149. _basePointWorld: Vector3;
  7150. private _velocityWorld;
  7151. private _normalizedVelocity;
  7152. /** @hidden */
  7153. _initialVelocity: Vector3;
  7154. /** @hidden */
  7155. _initialPosition: Vector3;
  7156. private _nearestDistance;
  7157. private _collisionMask;
  7158. collisionMask: number;
  7159. /**
  7160. * Gets the plane normal used to compute the sliding response (in local space)
  7161. */
  7162. readonly slidePlaneNormal: Vector3;
  7163. /** @hidden */
  7164. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7165. /** @hidden */
  7166. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7167. /** @hidden */
  7168. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7169. /** @hidden */
  7170. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7171. /** @hidden */
  7172. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7173. /** @hidden */
  7174. _getResponse(pos: Vector3, vel: Vector3): void;
  7175. }
  7176. }
  7177. declare module "babylonjs/Culling/boundingInfo" {
  7178. import { DeepImmutable } from "babylonjs/types";
  7179. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7180. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7181. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7182. import { Plane } from "babylonjs/Maths/math.plane";
  7183. import { Collider } from "babylonjs/Collisions/collider";
  7184. /**
  7185. * Interface for cullable objects
  7186. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7187. */
  7188. export interface ICullable {
  7189. /**
  7190. * Checks if the object or part of the object is in the frustum
  7191. * @param frustumPlanes Camera near/planes
  7192. * @returns true if the object is in frustum otherwise false
  7193. */
  7194. isInFrustum(frustumPlanes: Plane[]): boolean;
  7195. /**
  7196. * Checks if a cullable object (mesh...) is in the camera frustum
  7197. * Unlike isInFrustum this cheks the full bounding box
  7198. * @param frustumPlanes Camera near/planes
  7199. * @returns true if the object is in frustum otherwise false
  7200. */
  7201. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7202. }
  7203. /**
  7204. * Info for a bounding data of a mesh
  7205. */
  7206. export class BoundingInfo implements ICullable {
  7207. /**
  7208. * Bounding box for the mesh
  7209. */
  7210. readonly boundingBox: BoundingBox;
  7211. /**
  7212. * Bounding sphere for the mesh
  7213. */
  7214. readonly boundingSphere: BoundingSphere;
  7215. private _isLocked;
  7216. private static readonly TmpVector3;
  7217. /**
  7218. * Constructs bounding info
  7219. * @param minimum min vector of the bounding box/sphere
  7220. * @param maximum max vector of the bounding box/sphere
  7221. * @param worldMatrix defines the new world matrix
  7222. */
  7223. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7224. /**
  7225. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7226. * @param min defines the new minimum vector (in local space)
  7227. * @param max defines the new maximum vector (in local space)
  7228. * @param worldMatrix defines the new world matrix
  7229. */
  7230. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7231. /**
  7232. * min vector of the bounding box/sphere
  7233. */
  7234. readonly minimum: Vector3;
  7235. /**
  7236. * max vector of the bounding box/sphere
  7237. */
  7238. readonly maximum: Vector3;
  7239. /**
  7240. * If the info is locked and won't be updated to avoid perf overhead
  7241. */
  7242. isLocked: boolean;
  7243. /**
  7244. * Updates the bounding sphere and box
  7245. * @param world world matrix to be used to update
  7246. */
  7247. update(world: DeepImmutable<Matrix>): void;
  7248. /**
  7249. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7250. * @param center New center of the bounding info
  7251. * @param extend New extend of the bounding info
  7252. * @returns the current bounding info
  7253. */
  7254. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7255. /**
  7256. * Scale the current bounding info by applying a scale factor
  7257. * @param factor defines the scale factor to apply
  7258. * @returns the current bounding info
  7259. */
  7260. scale(factor: number): BoundingInfo;
  7261. /**
  7262. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7263. * @param frustumPlanes defines the frustum to test
  7264. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7265. * @returns true if the bounding info is in the frustum planes
  7266. */
  7267. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7268. /**
  7269. * Gets the world distance between the min and max points of the bounding box
  7270. */
  7271. readonly diagonalLength: number;
  7272. /**
  7273. * Checks if a cullable object (mesh...) is in the camera frustum
  7274. * Unlike isInFrustum this cheks the full bounding box
  7275. * @param frustumPlanes Camera near/planes
  7276. * @returns true if the object is in frustum otherwise false
  7277. */
  7278. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7279. /** @hidden */
  7280. _checkCollision(collider: Collider): boolean;
  7281. /**
  7282. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7283. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7284. * @param point the point to check intersection with
  7285. * @returns if the point intersects
  7286. */
  7287. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7288. /**
  7289. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7290. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7291. * @param boundingInfo the bounding info to check intersection with
  7292. * @param precise if the intersection should be done using OBB
  7293. * @returns if the bounding info intersects
  7294. */
  7295. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7296. }
  7297. }
  7298. declare module "babylonjs/Maths/math.functions" {
  7299. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7300. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7301. /**
  7302. * Extracts minimum and maximum values from a list of indexed positions
  7303. * @param positions defines the positions to use
  7304. * @param indices defines the indices to the positions
  7305. * @param indexStart defines the start index
  7306. * @param indexCount defines the end index
  7307. * @param bias defines bias value to add to the result
  7308. * @return minimum and maximum values
  7309. */
  7310. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7311. minimum: Vector3;
  7312. maximum: Vector3;
  7313. };
  7314. /**
  7315. * Extracts minimum and maximum values from a list of positions
  7316. * @param positions defines the positions to use
  7317. * @param start defines the start index in the positions array
  7318. * @param count defines the number of positions to handle
  7319. * @param bias defines bias value to add to the result
  7320. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7321. * @return minimum and maximum values
  7322. */
  7323. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7324. minimum: Vector3;
  7325. maximum: Vector3;
  7326. };
  7327. }
  7328. declare module "babylonjs/Misc/iInspectable" {
  7329. /**
  7330. * Enum that determines the text-wrapping mode to use.
  7331. */
  7332. export enum InspectableType {
  7333. /**
  7334. * Checkbox for booleans
  7335. */
  7336. Checkbox = 0,
  7337. /**
  7338. * Sliders for numbers
  7339. */
  7340. Slider = 1,
  7341. /**
  7342. * Vector3
  7343. */
  7344. Vector3 = 2,
  7345. /**
  7346. * Quaternions
  7347. */
  7348. Quaternion = 3,
  7349. /**
  7350. * Color3
  7351. */
  7352. Color3 = 4,
  7353. /**
  7354. * String
  7355. */
  7356. String = 5
  7357. }
  7358. /**
  7359. * Interface used to define custom inspectable properties.
  7360. * This interface is used by the inspector to display custom property grids
  7361. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7362. */
  7363. export interface IInspectable {
  7364. /**
  7365. * Gets the label to display
  7366. */
  7367. label: string;
  7368. /**
  7369. * Gets the name of the property to edit
  7370. */
  7371. propertyName: string;
  7372. /**
  7373. * Gets the type of the editor to use
  7374. */
  7375. type: InspectableType;
  7376. /**
  7377. * Gets the minimum value of the property when using in "slider" mode
  7378. */
  7379. min?: number;
  7380. /**
  7381. * Gets the maximum value of the property when using in "slider" mode
  7382. */
  7383. max?: number;
  7384. /**
  7385. * Gets the setp to use when using in "slider" mode
  7386. */
  7387. step?: number;
  7388. }
  7389. }
  7390. declare module "babylonjs/Misc/timingTools" {
  7391. /**
  7392. * Class used to provide helper for timing
  7393. */
  7394. export class TimingTools {
  7395. /**
  7396. * Polyfill for setImmediate
  7397. * @param action defines the action to execute after the current execution block
  7398. */
  7399. static SetImmediate(action: () => void): void;
  7400. }
  7401. }
  7402. declare module "babylonjs/Misc/instantiationTools" {
  7403. /**
  7404. * Class used to enable instatition of objects by class name
  7405. */
  7406. export class InstantiationTools {
  7407. /**
  7408. * Use this object to register external classes like custom textures or material
  7409. * to allow the laoders to instantiate them
  7410. */
  7411. static RegisteredExternalClasses: {
  7412. [key: string]: Object;
  7413. };
  7414. /**
  7415. * Tries to instantiate a new object from a given class name
  7416. * @param className defines the class name to instantiate
  7417. * @returns the new object or null if the system was not able to do the instantiation
  7418. */
  7419. static Instantiate(className: string): any;
  7420. }
  7421. }
  7422. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  7423. import { Nullable } from "babylonjs/types";
  7424. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7425. /**
  7426. * This represents the required contract to create a new type of texture loader.
  7427. */
  7428. export interface IInternalTextureLoader {
  7429. /**
  7430. * Defines wether the loader supports cascade loading the different faces.
  7431. */
  7432. supportCascades: boolean;
  7433. /**
  7434. * This returns if the loader support the current file information.
  7435. * @param extension defines the file extension of the file being loaded
  7436. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7437. * @param fallback defines the fallback internal texture if any
  7438. * @param isBase64 defines whether the texture is encoded as a base64
  7439. * @param isBuffer defines whether the texture data are stored as a buffer
  7440. * @returns true if the loader can load the specified file
  7441. */
  7442. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  7443. /**
  7444. * Transform the url before loading if required.
  7445. * @param rootUrl the url of the texture
  7446. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7447. * @returns the transformed texture
  7448. */
  7449. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  7450. /**
  7451. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  7452. * @param rootUrl the url of the texture
  7453. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7454. * @returns the fallback texture
  7455. */
  7456. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  7457. /**
  7458. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  7459. * @param data contains the texture data
  7460. * @param texture defines the BabylonJS internal texture
  7461. * @param createPolynomials will be true if polynomials have been requested
  7462. * @param onLoad defines the callback to trigger once the texture is ready
  7463. * @param onError defines the callback to trigger in case of error
  7464. */
  7465. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  7466. /**
  7467. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  7468. * @param data contains the texture data
  7469. * @param texture defines the BabylonJS internal texture
  7470. * @param callback defines the method to call once ready to upload
  7471. */
  7472. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  7473. }
  7474. }
  7475. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7476. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7477. import { Nullable } from "babylonjs/types";
  7478. import { Scene } from "babylonjs/scene";
  7479. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7480. module "babylonjs/Engines/engine" {
  7481. interface Engine {
  7482. /**
  7483. * Creates a depth stencil cube texture.
  7484. * This is only available in WebGL 2.
  7485. * @param size The size of face edge in the cube texture.
  7486. * @param options The options defining the cube texture.
  7487. * @returns The cube texture
  7488. */
  7489. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7490. /**
  7491. * Creates a cube texture
  7492. * @param rootUrl defines the url where the files to load is located
  7493. * @param scene defines the current scene
  7494. * @param files defines the list of files to load (1 per face)
  7495. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7496. * @param onLoad defines an optional callback raised when the texture is loaded
  7497. * @param onError defines an optional callback raised if there is an issue to load the texture
  7498. * @param format defines the format of the data
  7499. * @param forcedExtension defines the extension to use to pick the right loader
  7500. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7501. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7502. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7503. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7504. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7505. * @returns the cube texture as an InternalTexture
  7506. */
  7507. 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;
  7508. /**
  7509. * Creates a cube texture
  7510. * @param rootUrl defines the url where the files to load is located
  7511. * @param scene defines the current scene
  7512. * @param files defines the list of files to load (1 per face)
  7513. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7514. * @param onLoad defines an optional callback raised when the texture is loaded
  7515. * @param onError defines an optional callback raised if there is an issue to load the texture
  7516. * @param format defines the format of the data
  7517. * @param forcedExtension defines the extension to use to pick the right loader
  7518. * @returns the cube texture as an InternalTexture
  7519. */
  7520. 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;
  7521. /**
  7522. * Creates a cube texture
  7523. * @param rootUrl defines the url where the files to load is located
  7524. * @param scene defines the current scene
  7525. * @param files defines the list of files to load (1 per face)
  7526. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7527. * @param onLoad defines an optional callback raised when the texture is loaded
  7528. * @param onError defines an optional callback raised if there is an issue to load the texture
  7529. * @param format defines the format of the data
  7530. * @param forcedExtension defines the extension to use to pick the right loader
  7531. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7532. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7533. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7534. * @returns the cube texture as an InternalTexture
  7535. */
  7536. 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;
  7537. /** @hidden */
  7538. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7539. /** @hidden */
  7540. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7541. /** @hidden */
  7542. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7543. /** @hidden */
  7544. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7545. }
  7546. }
  7547. }
  7548. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7549. import { Nullable } from "babylonjs/types";
  7550. import { Scene } from "babylonjs/scene";
  7551. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7552. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7553. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7554. /**
  7555. * Class for creating a cube texture
  7556. */
  7557. export class CubeTexture extends BaseTexture {
  7558. private _delayedOnLoad;
  7559. /**
  7560. * The url of the texture
  7561. */
  7562. url: string;
  7563. /**
  7564. * Gets or sets the center of the bounding box associated with the cube texture.
  7565. * It must define where the camera used to render the texture was set
  7566. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7567. */
  7568. boundingBoxPosition: Vector3;
  7569. private _boundingBoxSize;
  7570. /**
  7571. * Gets or sets the size of the bounding box associated with the cube texture
  7572. * When defined, the cubemap will switch to local mode
  7573. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7574. * @example https://www.babylonjs-playground.com/#RNASML
  7575. */
  7576. /**
  7577. * Returns the bounding box size
  7578. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7579. */
  7580. boundingBoxSize: Vector3;
  7581. protected _rotationY: number;
  7582. /**
  7583. * Sets texture matrix rotation angle around Y axis in radians.
  7584. */
  7585. /**
  7586. * Gets texture matrix rotation angle around Y axis radians.
  7587. */
  7588. rotationY: number;
  7589. /**
  7590. * Are mip maps generated for this texture or not.
  7591. */
  7592. readonly noMipmap: boolean;
  7593. private _noMipmap;
  7594. private _files;
  7595. private _extensions;
  7596. private _textureMatrix;
  7597. private _format;
  7598. private _createPolynomials;
  7599. /** @hidden */
  7600. _prefiltered: boolean;
  7601. /**
  7602. * Creates a cube texture from an array of image urls
  7603. * @param files defines an array of image urls
  7604. * @param scene defines the hosting scene
  7605. * @param noMipmap specifies if mip maps are not used
  7606. * @returns a cube texture
  7607. */
  7608. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7609. /**
  7610. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7611. * @param url defines the url of the prefiltered texture
  7612. * @param scene defines the scene the texture is attached to
  7613. * @param forcedExtension defines the extension of the file if different from the url
  7614. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7615. * @return the prefiltered texture
  7616. */
  7617. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7618. /**
  7619. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7620. * as prefiltered data.
  7621. * @param rootUrl defines the url of the texture or the root name of the six images
  7622. * @param scene defines the scene the texture is attached to
  7623. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7624. * @param noMipmap defines if mipmaps should be created or not
  7625. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7626. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7627. * @param onError defines a callback triggered in case of error during load
  7628. * @param format defines the internal format to use for the texture once loaded
  7629. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7630. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7631. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7632. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7633. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7634. * @return the cube texture
  7635. */
  7636. 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);
  7637. /**
  7638. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7639. */
  7640. readonly isPrefiltered: boolean;
  7641. /**
  7642. * Get the current class name of the texture useful for serialization or dynamic coding.
  7643. * @returns "CubeTexture"
  7644. */
  7645. getClassName(): string;
  7646. /**
  7647. * Update the url (and optional buffer) of this texture if url was null during construction.
  7648. * @param url the url of the texture
  7649. * @param forcedExtension defines the extension to use
  7650. * @param onLoad callback called when the texture is loaded (defaults to null)
  7651. */
  7652. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7653. /**
  7654. * Delays loading of the cube texture
  7655. * @param forcedExtension defines the extension to use
  7656. */
  7657. delayLoad(forcedExtension?: string): void;
  7658. /**
  7659. * Returns the reflection texture matrix
  7660. * @returns the reflection texture matrix
  7661. */
  7662. getReflectionTextureMatrix(): Matrix;
  7663. /**
  7664. * Sets the reflection texture matrix
  7665. * @param value Reflection texture matrix
  7666. */
  7667. setReflectionTextureMatrix(value: Matrix): void;
  7668. /**
  7669. * Parses text to create a cube texture
  7670. * @param parsedTexture define the serialized text to read from
  7671. * @param scene defines the hosting scene
  7672. * @param rootUrl defines the root url of the cube texture
  7673. * @returns a cube texture
  7674. */
  7675. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7676. /**
  7677. * Makes a clone, or deep copy, of the cube texture
  7678. * @returns a new cube texture
  7679. */
  7680. clone(): CubeTexture;
  7681. }
  7682. }
  7683. declare module "babylonjs/Materials/materialDefines" {
  7684. /**
  7685. * Manages the defines for the Material
  7686. */
  7687. export class MaterialDefines {
  7688. /** @hidden */
  7689. protected _keys: string[];
  7690. private _isDirty;
  7691. /** @hidden */
  7692. _renderId: number;
  7693. /** @hidden */
  7694. _areLightsDirty: boolean;
  7695. /** @hidden */
  7696. _areLightsDisposed: boolean;
  7697. /** @hidden */
  7698. _areAttributesDirty: boolean;
  7699. /** @hidden */
  7700. _areTexturesDirty: boolean;
  7701. /** @hidden */
  7702. _areFresnelDirty: boolean;
  7703. /** @hidden */
  7704. _areMiscDirty: boolean;
  7705. /** @hidden */
  7706. _areImageProcessingDirty: boolean;
  7707. /** @hidden */
  7708. _normals: boolean;
  7709. /** @hidden */
  7710. _uvs: boolean;
  7711. /** @hidden */
  7712. _needNormals: boolean;
  7713. /** @hidden */
  7714. _needUVs: boolean;
  7715. [id: string]: any;
  7716. /**
  7717. * Specifies if the material needs to be re-calculated
  7718. */
  7719. readonly isDirty: boolean;
  7720. /**
  7721. * Marks the material to indicate that it has been re-calculated
  7722. */
  7723. markAsProcessed(): void;
  7724. /**
  7725. * Marks the material to indicate that it needs to be re-calculated
  7726. */
  7727. markAsUnprocessed(): void;
  7728. /**
  7729. * Marks the material to indicate all of its defines need to be re-calculated
  7730. */
  7731. markAllAsDirty(): void;
  7732. /**
  7733. * Marks the material to indicate that image processing needs to be re-calculated
  7734. */
  7735. markAsImageProcessingDirty(): void;
  7736. /**
  7737. * Marks the material to indicate the lights need to be re-calculated
  7738. * @param disposed Defines whether the light is dirty due to dispose or not
  7739. */
  7740. markAsLightDirty(disposed?: boolean): void;
  7741. /**
  7742. * Marks the attribute state as changed
  7743. */
  7744. markAsAttributesDirty(): void;
  7745. /**
  7746. * Marks the texture state as changed
  7747. */
  7748. markAsTexturesDirty(): void;
  7749. /**
  7750. * Marks the fresnel state as changed
  7751. */
  7752. markAsFresnelDirty(): void;
  7753. /**
  7754. * Marks the misc state as changed
  7755. */
  7756. markAsMiscDirty(): void;
  7757. /**
  7758. * Rebuilds the material defines
  7759. */
  7760. rebuild(): void;
  7761. /**
  7762. * Specifies if two material defines are equal
  7763. * @param other - A material define instance to compare to
  7764. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7765. */
  7766. isEqual(other: MaterialDefines): boolean;
  7767. /**
  7768. * Clones this instance's defines to another instance
  7769. * @param other - material defines to clone values to
  7770. */
  7771. cloneTo(other: MaterialDefines): void;
  7772. /**
  7773. * Resets the material define values
  7774. */
  7775. reset(): void;
  7776. /**
  7777. * Converts the material define values to a string
  7778. * @returns - String of material define information
  7779. */
  7780. toString(): string;
  7781. }
  7782. }
  7783. declare module "babylonjs/Materials/colorCurves" {
  7784. import { Effect } from "babylonjs/Materials/effect";
  7785. /**
  7786. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7787. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7788. * 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;
  7789. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7790. */
  7791. export class ColorCurves {
  7792. private _dirty;
  7793. private _tempColor;
  7794. private _globalCurve;
  7795. private _highlightsCurve;
  7796. private _midtonesCurve;
  7797. private _shadowsCurve;
  7798. private _positiveCurve;
  7799. private _negativeCurve;
  7800. private _globalHue;
  7801. private _globalDensity;
  7802. private _globalSaturation;
  7803. private _globalExposure;
  7804. /**
  7805. * Gets the global Hue value.
  7806. * 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).
  7807. */
  7808. /**
  7809. * Sets the global Hue value.
  7810. * 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).
  7811. */
  7812. globalHue: number;
  7813. /**
  7814. * Gets the global Density value.
  7815. * 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.
  7816. * Values less than zero provide a filter of opposite hue.
  7817. */
  7818. /**
  7819. * Sets the global Density value.
  7820. * 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.
  7821. * Values less than zero provide a filter of opposite hue.
  7822. */
  7823. globalDensity: number;
  7824. /**
  7825. * Gets the global Saturation value.
  7826. * 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.
  7827. */
  7828. /**
  7829. * Sets the global Saturation value.
  7830. * 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.
  7831. */
  7832. globalSaturation: number;
  7833. /**
  7834. * Gets the global Exposure value.
  7835. * 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.
  7836. */
  7837. /**
  7838. * Sets the global Exposure value.
  7839. * 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.
  7840. */
  7841. globalExposure: number;
  7842. private _highlightsHue;
  7843. private _highlightsDensity;
  7844. private _highlightsSaturation;
  7845. private _highlightsExposure;
  7846. /**
  7847. * Gets the highlights Hue value.
  7848. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7849. */
  7850. /**
  7851. * Sets the highlights Hue value.
  7852. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7853. */
  7854. highlightsHue: number;
  7855. /**
  7856. * Gets the highlights Density value.
  7857. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7858. * Values less than zero provide a filter of opposite hue.
  7859. */
  7860. /**
  7861. * Sets the highlights Density value.
  7862. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7863. * Values less than zero provide a filter of opposite hue.
  7864. */
  7865. highlightsDensity: number;
  7866. /**
  7867. * Gets the highlights Saturation value.
  7868. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7869. */
  7870. /**
  7871. * Sets the highlights Saturation value.
  7872. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7873. */
  7874. highlightsSaturation: number;
  7875. /**
  7876. * Gets the highlights Exposure value.
  7877. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7878. */
  7879. /**
  7880. * Sets the highlights Exposure value.
  7881. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7882. */
  7883. highlightsExposure: number;
  7884. private _midtonesHue;
  7885. private _midtonesDensity;
  7886. private _midtonesSaturation;
  7887. private _midtonesExposure;
  7888. /**
  7889. * Gets the midtones Hue value.
  7890. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7891. */
  7892. /**
  7893. * Sets the midtones Hue value.
  7894. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7895. */
  7896. midtonesHue: number;
  7897. /**
  7898. * Gets the midtones Density value.
  7899. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7900. * Values less than zero provide a filter of opposite hue.
  7901. */
  7902. /**
  7903. * Sets the midtones Density value.
  7904. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7905. * Values less than zero provide a filter of opposite hue.
  7906. */
  7907. midtonesDensity: number;
  7908. /**
  7909. * Gets the midtones Saturation value.
  7910. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7911. */
  7912. /**
  7913. * Sets the midtones Saturation value.
  7914. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7915. */
  7916. midtonesSaturation: number;
  7917. /**
  7918. * Gets the midtones Exposure value.
  7919. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7920. */
  7921. /**
  7922. * Sets the midtones Exposure value.
  7923. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7924. */
  7925. midtonesExposure: number;
  7926. private _shadowsHue;
  7927. private _shadowsDensity;
  7928. private _shadowsSaturation;
  7929. private _shadowsExposure;
  7930. /**
  7931. * Gets the shadows Hue value.
  7932. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7933. */
  7934. /**
  7935. * Sets the shadows Hue value.
  7936. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7937. */
  7938. shadowsHue: number;
  7939. /**
  7940. * Gets the shadows Density value.
  7941. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7942. * Values less than zero provide a filter of opposite hue.
  7943. */
  7944. /**
  7945. * Sets the shadows 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. shadowsDensity: number;
  7950. /**
  7951. * Gets the shadows Saturation value.
  7952. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7953. */
  7954. /**
  7955. * Sets the shadows Saturation value.
  7956. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7957. */
  7958. shadowsSaturation: number;
  7959. /**
  7960. * Gets the shadows Exposure value.
  7961. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7962. */
  7963. /**
  7964. * Sets the shadows Exposure value.
  7965. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7966. */
  7967. shadowsExposure: number;
  7968. /**
  7969. * Returns the class name
  7970. * @returns The class name
  7971. */
  7972. getClassName(): string;
  7973. /**
  7974. * Binds the color curves to the shader.
  7975. * @param colorCurves The color curve to bind
  7976. * @param effect The effect to bind to
  7977. * @param positiveUniform The positive uniform shader parameter
  7978. * @param neutralUniform The neutral uniform shader parameter
  7979. * @param negativeUniform The negative uniform shader parameter
  7980. */
  7981. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  7982. /**
  7983. * Prepare the list of uniforms associated with the ColorCurves effects.
  7984. * @param uniformsList The list of uniforms used in the effect
  7985. */
  7986. static PrepareUniforms(uniformsList: string[]): void;
  7987. /**
  7988. * Returns color grading data based on a hue, density, saturation and exposure value.
  7989. * @param filterHue The hue of the color filter.
  7990. * @param filterDensity The density of the color filter.
  7991. * @param saturation The saturation.
  7992. * @param exposure The exposure.
  7993. * @param result The result data container.
  7994. */
  7995. private getColorGradingDataToRef;
  7996. /**
  7997. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  7998. * @param value The input slider value in range [-100,100].
  7999. * @returns Adjusted value.
  8000. */
  8001. private static applyColorGradingSliderNonlinear;
  8002. /**
  8003. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8004. * @param hue The hue (H) input.
  8005. * @param saturation The saturation (S) input.
  8006. * @param brightness The brightness (B) input.
  8007. * @result An RGBA color represented as Vector4.
  8008. */
  8009. private static fromHSBToRef;
  8010. /**
  8011. * Returns a value clamped between min and max
  8012. * @param value The value to clamp
  8013. * @param min The minimum of value
  8014. * @param max The maximum of value
  8015. * @returns The clamped value.
  8016. */
  8017. private static clamp;
  8018. /**
  8019. * Clones the current color curve instance.
  8020. * @return The cloned curves
  8021. */
  8022. clone(): ColorCurves;
  8023. /**
  8024. * Serializes the current color curve instance to a json representation.
  8025. * @return a JSON representation
  8026. */
  8027. serialize(): any;
  8028. /**
  8029. * Parses the color curve from a json representation.
  8030. * @param source the JSON source to parse
  8031. * @return The parsed curves
  8032. */
  8033. static Parse(source: any): ColorCurves;
  8034. }
  8035. }
  8036. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8037. import { Observable } from "babylonjs/Misc/observable";
  8038. import { Nullable } from "babylonjs/types";
  8039. import { Color4 } from "babylonjs/Maths/math.color";
  8040. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8041. import { Effect } from "babylonjs/Materials/effect";
  8042. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8043. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8044. /**
  8045. * Interface to follow in your material defines to integrate easily the
  8046. * Image proccessing functions.
  8047. * @hidden
  8048. */
  8049. export interface IImageProcessingConfigurationDefines {
  8050. IMAGEPROCESSING: boolean;
  8051. VIGNETTE: boolean;
  8052. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8053. VIGNETTEBLENDMODEOPAQUE: boolean;
  8054. TONEMAPPING: boolean;
  8055. TONEMAPPING_ACES: boolean;
  8056. CONTRAST: boolean;
  8057. EXPOSURE: boolean;
  8058. COLORCURVES: boolean;
  8059. COLORGRADING: boolean;
  8060. COLORGRADING3D: boolean;
  8061. SAMPLER3DGREENDEPTH: boolean;
  8062. SAMPLER3DBGRMAP: boolean;
  8063. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8064. }
  8065. /**
  8066. * @hidden
  8067. */
  8068. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8069. IMAGEPROCESSING: boolean;
  8070. VIGNETTE: boolean;
  8071. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8072. VIGNETTEBLENDMODEOPAQUE: boolean;
  8073. TONEMAPPING: boolean;
  8074. TONEMAPPING_ACES: boolean;
  8075. CONTRAST: boolean;
  8076. COLORCURVES: boolean;
  8077. COLORGRADING: boolean;
  8078. COLORGRADING3D: boolean;
  8079. SAMPLER3DGREENDEPTH: boolean;
  8080. SAMPLER3DBGRMAP: boolean;
  8081. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8082. EXPOSURE: boolean;
  8083. constructor();
  8084. }
  8085. /**
  8086. * This groups together the common properties used for image processing either in direct forward pass
  8087. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8088. * or not.
  8089. */
  8090. export class ImageProcessingConfiguration {
  8091. /**
  8092. * Default tone mapping applied in BabylonJS.
  8093. */
  8094. static readonly TONEMAPPING_STANDARD: number;
  8095. /**
  8096. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8097. * to other engines rendering to increase portability.
  8098. */
  8099. static readonly TONEMAPPING_ACES: number;
  8100. /**
  8101. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8102. */
  8103. colorCurves: Nullable<ColorCurves>;
  8104. private _colorCurvesEnabled;
  8105. /**
  8106. * Gets wether the color curves effect is enabled.
  8107. */
  8108. /**
  8109. * Sets wether the color curves effect is enabled.
  8110. */
  8111. colorCurvesEnabled: boolean;
  8112. private _colorGradingTexture;
  8113. /**
  8114. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8115. */
  8116. /**
  8117. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8118. */
  8119. colorGradingTexture: Nullable<BaseTexture>;
  8120. private _colorGradingEnabled;
  8121. /**
  8122. * Gets wether the color grading effect is enabled.
  8123. */
  8124. /**
  8125. * Sets wether the color grading effect is enabled.
  8126. */
  8127. colorGradingEnabled: boolean;
  8128. private _colorGradingWithGreenDepth;
  8129. /**
  8130. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8131. */
  8132. /**
  8133. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8134. */
  8135. colorGradingWithGreenDepth: boolean;
  8136. private _colorGradingBGR;
  8137. /**
  8138. * Gets wether the color grading texture contains BGR values.
  8139. */
  8140. /**
  8141. * Sets wether the color grading texture contains BGR values.
  8142. */
  8143. colorGradingBGR: boolean;
  8144. /** @hidden */
  8145. _exposure: number;
  8146. /**
  8147. * Gets the Exposure used in the effect.
  8148. */
  8149. /**
  8150. * Sets the Exposure used in the effect.
  8151. */
  8152. exposure: number;
  8153. private _toneMappingEnabled;
  8154. /**
  8155. * Gets wether the tone mapping effect is enabled.
  8156. */
  8157. /**
  8158. * Sets wether the tone mapping effect is enabled.
  8159. */
  8160. toneMappingEnabled: boolean;
  8161. private _toneMappingType;
  8162. /**
  8163. * Gets the type of tone mapping effect.
  8164. */
  8165. /**
  8166. * Sets the type of tone mapping effect used in BabylonJS.
  8167. */
  8168. toneMappingType: number;
  8169. protected _contrast: number;
  8170. /**
  8171. * Gets the contrast used in the effect.
  8172. */
  8173. /**
  8174. * Sets the contrast used in the effect.
  8175. */
  8176. contrast: number;
  8177. /**
  8178. * Vignette stretch size.
  8179. */
  8180. vignetteStretch: number;
  8181. /**
  8182. * Vignette centre X Offset.
  8183. */
  8184. vignetteCentreX: number;
  8185. /**
  8186. * Vignette centre Y Offset.
  8187. */
  8188. vignetteCentreY: number;
  8189. /**
  8190. * Vignette weight or intensity of the vignette effect.
  8191. */
  8192. vignetteWeight: number;
  8193. /**
  8194. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8195. * if vignetteEnabled is set to true.
  8196. */
  8197. vignetteColor: Color4;
  8198. /**
  8199. * Camera field of view used by the Vignette effect.
  8200. */
  8201. vignetteCameraFov: number;
  8202. private _vignetteBlendMode;
  8203. /**
  8204. * Gets the vignette blend mode allowing different kind of effect.
  8205. */
  8206. /**
  8207. * Sets the vignette blend mode allowing different kind of effect.
  8208. */
  8209. vignetteBlendMode: number;
  8210. private _vignetteEnabled;
  8211. /**
  8212. * Gets wether the vignette effect is enabled.
  8213. */
  8214. /**
  8215. * Sets wether the vignette effect is enabled.
  8216. */
  8217. vignetteEnabled: boolean;
  8218. private _applyByPostProcess;
  8219. /**
  8220. * Gets wether the image processing is applied through a post process or not.
  8221. */
  8222. /**
  8223. * Sets wether the image processing is applied through a post process or not.
  8224. */
  8225. applyByPostProcess: boolean;
  8226. private _isEnabled;
  8227. /**
  8228. * Gets wether the image processing is enabled or not.
  8229. */
  8230. /**
  8231. * Sets wether the image processing is enabled or not.
  8232. */
  8233. isEnabled: boolean;
  8234. /**
  8235. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8236. */
  8237. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8238. /**
  8239. * Method called each time the image processing information changes requires to recompile the effect.
  8240. */
  8241. protected _updateParameters(): void;
  8242. /**
  8243. * Gets the current class name.
  8244. * @return "ImageProcessingConfiguration"
  8245. */
  8246. getClassName(): string;
  8247. /**
  8248. * Prepare the list of uniforms associated with the Image Processing effects.
  8249. * @param uniforms The list of uniforms used in the effect
  8250. * @param defines the list of defines currently in use
  8251. */
  8252. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8253. /**
  8254. * Prepare the list of samplers associated with the Image Processing effects.
  8255. * @param samplersList The list of uniforms used in the effect
  8256. * @param defines the list of defines currently in use
  8257. */
  8258. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8259. /**
  8260. * Prepare the list of defines associated to the shader.
  8261. * @param defines the list of defines to complete
  8262. * @param forPostProcess Define if we are currently in post process mode or not
  8263. */
  8264. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8265. /**
  8266. * Returns true if all the image processing information are ready.
  8267. * @returns True if ready, otherwise, false
  8268. */
  8269. isReady(): boolean;
  8270. /**
  8271. * Binds the image processing to the shader.
  8272. * @param effect The effect to bind to
  8273. * @param aspectRatio Define the current aspect ratio of the effect
  8274. */
  8275. bind(effect: Effect, aspectRatio?: number): void;
  8276. /**
  8277. * Clones the current image processing instance.
  8278. * @return The cloned image processing
  8279. */
  8280. clone(): ImageProcessingConfiguration;
  8281. /**
  8282. * Serializes the current image processing instance to a json representation.
  8283. * @return a JSON representation
  8284. */
  8285. serialize(): any;
  8286. /**
  8287. * Parses the image processing from a json representation.
  8288. * @param source the JSON source to parse
  8289. * @return The parsed image processing
  8290. */
  8291. static Parse(source: any): ImageProcessingConfiguration;
  8292. private static _VIGNETTEMODE_MULTIPLY;
  8293. private static _VIGNETTEMODE_OPAQUE;
  8294. /**
  8295. * Used to apply the vignette as a mix with the pixel color.
  8296. */
  8297. static readonly VIGNETTEMODE_MULTIPLY: number;
  8298. /**
  8299. * Used to apply the vignette as a replacement of the pixel color.
  8300. */
  8301. static readonly VIGNETTEMODE_OPAQUE: number;
  8302. }
  8303. }
  8304. declare module "babylonjs/Shaders/postprocess.vertex" {
  8305. /** @hidden */
  8306. export var postprocessVertexShader: {
  8307. name: string;
  8308. shader: string;
  8309. };
  8310. }
  8311. declare module "babylonjs/Maths/math.axis" {
  8312. import { Vector3 } from "babylonjs/Maths/math.vector";
  8313. /** Defines supported spaces */
  8314. export enum Space {
  8315. /** Local (object) space */
  8316. LOCAL = 0,
  8317. /** World space */
  8318. WORLD = 1,
  8319. /** Bone space */
  8320. BONE = 2
  8321. }
  8322. /** Defines the 3 main axes */
  8323. export class Axis {
  8324. /** X axis */
  8325. static X: Vector3;
  8326. /** Y axis */
  8327. static Y: Vector3;
  8328. /** Z axis */
  8329. static Z: Vector3;
  8330. }
  8331. }
  8332. declare module "babylonjs/Cameras/targetCamera" {
  8333. import { Nullable } from "babylonjs/types";
  8334. import { Camera } from "babylonjs/Cameras/camera";
  8335. import { Scene } from "babylonjs/scene";
  8336. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8337. /**
  8338. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8339. * This is the base of the follow, arc rotate cameras and Free camera
  8340. * @see http://doc.babylonjs.com/features/cameras
  8341. */
  8342. export class TargetCamera extends Camera {
  8343. private static _RigCamTransformMatrix;
  8344. private static _TargetTransformMatrix;
  8345. private static _TargetFocalPoint;
  8346. /**
  8347. * Define the current direction the camera is moving to
  8348. */
  8349. cameraDirection: Vector3;
  8350. /**
  8351. * Define the current rotation the camera is rotating to
  8352. */
  8353. cameraRotation: Vector2;
  8354. /**
  8355. * When set, the up vector of the camera will be updated by the rotation of the camera
  8356. */
  8357. updateUpVectorFromRotation: boolean;
  8358. private _tmpQuaternion;
  8359. /**
  8360. * Define the current rotation of the camera
  8361. */
  8362. rotation: Vector3;
  8363. /**
  8364. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8365. */
  8366. rotationQuaternion: Quaternion;
  8367. /**
  8368. * Define the current speed of the camera
  8369. */
  8370. speed: number;
  8371. /**
  8372. * Add cconstraint to the camera to prevent it to move freely in all directions and
  8373. * around all axis.
  8374. */
  8375. noRotationConstraint: boolean;
  8376. /**
  8377. * Define the current target of the camera as an object or a position.
  8378. */
  8379. lockedTarget: any;
  8380. /** @hidden */
  8381. _currentTarget: Vector3;
  8382. /** @hidden */
  8383. _initialFocalDistance: number;
  8384. /** @hidden */
  8385. _viewMatrix: Matrix;
  8386. /** @hidden */
  8387. _camMatrix: Matrix;
  8388. /** @hidden */
  8389. _cameraTransformMatrix: Matrix;
  8390. /** @hidden */
  8391. _cameraRotationMatrix: Matrix;
  8392. /** @hidden */
  8393. _referencePoint: Vector3;
  8394. /** @hidden */
  8395. _transformedReferencePoint: Vector3;
  8396. protected _globalCurrentTarget: Vector3;
  8397. protected _globalCurrentUpVector: Vector3;
  8398. /** @hidden */
  8399. _reset: () => void;
  8400. private _defaultUp;
  8401. /**
  8402. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8403. * This is the base of the follow, arc rotate cameras and Free camera
  8404. * @see http://doc.babylonjs.com/features/cameras
  8405. * @param name Defines the name of the camera in the scene
  8406. * @param position Defines the start position of the camera in the scene
  8407. * @param scene Defines the scene the camera belongs to
  8408. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8409. */
  8410. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8411. /**
  8412. * Gets the position in front of the camera at a given distance.
  8413. * @param distance The distance from the camera we want the position to be
  8414. * @returns the position
  8415. */
  8416. getFrontPosition(distance: number): Vector3;
  8417. /** @hidden */
  8418. _getLockedTargetPosition(): Nullable<Vector3>;
  8419. private _storedPosition;
  8420. private _storedRotation;
  8421. private _storedRotationQuaternion;
  8422. /**
  8423. * Store current camera state of the camera (fov, position, rotation, etc..)
  8424. * @returns the camera
  8425. */
  8426. storeState(): Camera;
  8427. /**
  8428. * Restored camera state. You must call storeState() first
  8429. * @returns whether it was successful or not
  8430. * @hidden
  8431. */
  8432. _restoreStateValues(): boolean;
  8433. /** @hidden */
  8434. _initCache(): void;
  8435. /** @hidden */
  8436. _updateCache(ignoreParentClass?: boolean): void;
  8437. /** @hidden */
  8438. _isSynchronizedViewMatrix(): boolean;
  8439. /** @hidden */
  8440. _computeLocalCameraSpeed(): number;
  8441. /**
  8442. * Defines the target the camera should look at.
  8443. * @param target Defines the new target as a Vector or a mesh
  8444. */
  8445. setTarget(target: Vector3): void;
  8446. /**
  8447. * Return the current target position of the camera. This value is expressed in local space.
  8448. * @returns the target position
  8449. */
  8450. getTarget(): Vector3;
  8451. /** @hidden */
  8452. _decideIfNeedsToMove(): boolean;
  8453. /** @hidden */
  8454. _updatePosition(): void;
  8455. /** @hidden */
  8456. _checkInputs(): void;
  8457. protected _updateCameraRotationMatrix(): void;
  8458. /**
  8459. * 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)
  8460. * @returns the current camera
  8461. */
  8462. private _rotateUpVectorWithCameraRotationMatrix;
  8463. private _cachedRotationZ;
  8464. private _cachedQuaternionRotationZ;
  8465. /** @hidden */
  8466. _getViewMatrix(): Matrix;
  8467. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8468. /**
  8469. * @hidden
  8470. */
  8471. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8472. /**
  8473. * @hidden
  8474. */
  8475. _updateRigCameras(): void;
  8476. private _getRigCamPositionAndTarget;
  8477. /**
  8478. * Gets the current object class name.
  8479. * @return the class name
  8480. */
  8481. getClassName(): string;
  8482. }
  8483. }
  8484. declare module "babylonjs/Events/keyboardEvents" {
  8485. /**
  8486. * Gather the list of keyboard event types as constants.
  8487. */
  8488. export class KeyboardEventTypes {
  8489. /**
  8490. * The keydown event is fired when a key becomes active (pressed).
  8491. */
  8492. static readonly KEYDOWN: number;
  8493. /**
  8494. * The keyup event is fired when a key has been released.
  8495. */
  8496. static readonly KEYUP: number;
  8497. }
  8498. /**
  8499. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8500. */
  8501. export class KeyboardInfo {
  8502. /**
  8503. * Defines the type of event (KeyboardEventTypes)
  8504. */
  8505. type: number;
  8506. /**
  8507. * Defines the related dom event
  8508. */
  8509. event: KeyboardEvent;
  8510. /**
  8511. * Instantiates a new keyboard info.
  8512. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8513. * @param type Defines the type of event (KeyboardEventTypes)
  8514. * @param event Defines the related dom event
  8515. */
  8516. constructor(
  8517. /**
  8518. * Defines the type of event (KeyboardEventTypes)
  8519. */
  8520. type: number,
  8521. /**
  8522. * Defines the related dom event
  8523. */
  8524. event: KeyboardEvent);
  8525. }
  8526. /**
  8527. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8528. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8529. */
  8530. export class KeyboardInfoPre extends KeyboardInfo {
  8531. /**
  8532. * Defines the type of event (KeyboardEventTypes)
  8533. */
  8534. type: number;
  8535. /**
  8536. * Defines the related dom event
  8537. */
  8538. event: KeyboardEvent;
  8539. /**
  8540. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8541. */
  8542. skipOnPointerObservable: boolean;
  8543. /**
  8544. * Instantiates a new keyboard pre info.
  8545. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8546. * @param type Defines the type of event (KeyboardEventTypes)
  8547. * @param event Defines the related dom event
  8548. */
  8549. constructor(
  8550. /**
  8551. * Defines the type of event (KeyboardEventTypes)
  8552. */
  8553. type: number,
  8554. /**
  8555. * Defines the related dom event
  8556. */
  8557. event: KeyboardEvent);
  8558. }
  8559. }
  8560. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8561. import { Nullable } from "babylonjs/types";
  8562. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8563. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8564. /**
  8565. * Manage the keyboard inputs to control the movement of a free camera.
  8566. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8567. */
  8568. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8569. /**
  8570. * Defines the camera the input is attached to.
  8571. */
  8572. camera: FreeCamera;
  8573. /**
  8574. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8575. */
  8576. keysUp: number[];
  8577. /**
  8578. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8579. */
  8580. keysDown: number[];
  8581. /**
  8582. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8583. */
  8584. keysLeft: number[];
  8585. /**
  8586. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8587. */
  8588. keysRight: number[];
  8589. private _keys;
  8590. private _onCanvasBlurObserver;
  8591. private _onKeyboardObserver;
  8592. private _engine;
  8593. private _scene;
  8594. /**
  8595. * Attach the input controls to a specific dom element to get the input from.
  8596. * @param element Defines the element the controls should be listened from
  8597. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8598. */
  8599. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8600. /**
  8601. * Detach the current controls from the specified dom element.
  8602. * @param element Defines the element to stop listening the inputs from
  8603. */
  8604. detachControl(element: Nullable<HTMLElement>): void;
  8605. /**
  8606. * Update the current camera state depending on the inputs that have been used this frame.
  8607. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8608. */
  8609. checkInputs(): void;
  8610. /**
  8611. * Gets the class name of the current intput.
  8612. * @returns the class name
  8613. */
  8614. getClassName(): string;
  8615. /** @hidden */
  8616. _onLostFocus(): void;
  8617. /**
  8618. * Get the friendly name associated with the input class.
  8619. * @returns the input friendly name
  8620. */
  8621. getSimpleName(): string;
  8622. }
  8623. }
  8624. declare module "babylonjs/Lights/shadowLight" {
  8625. import { Camera } from "babylonjs/Cameras/camera";
  8626. import { Scene } from "babylonjs/scene";
  8627. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8628. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8629. import { Light } from "babylonjs/Lights/light";
  8630. /**
  8631. * Interface describing all the common properties and methods a shadow light needs to implement.
  8632. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8633. * as well as binding the different shadow properties to the effects.
  8634. */
  8635. export interface IShadowLight extends Light {
  8636. /**
  8637. * The light id in the scene (used in scene.findLighById for instance)
  8638. */
  8639. id: string;
  8640. /**
  8641. * The position the shdow will be casted from.
  8642. */
  8643. position: Vector3;
  8644. /**
  8645. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8646. */
  8647. direction: Vector3;
  8648. /**
  8649. * The transformed position. Position of the light in world space taking parenting in account.
  8650. */
  8651. transformedPosition: Vector3;
  8652. /**
  8653. * The transformed direction. Direction of the light in world space taking parenting in account.
  8654. */
  8655. transformedDirection: Vector3;
  8656. /**
  8657. * The friendly name of the light in the scene.
  8658. */
  8659. name: string;
  8660. /**
  8661. * Defines the shadow projection clipping minimum z value.
  8662. */
  8663. shadowMinZ: number;
  8664. /**
  8665. * Defines the shadow projection clipping maximum z value.
  8666. */
  8667. shadowMaxZ: number;
  8668. /**
  8669. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8670. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8671. */
  8672. computeTransformedInformation(): boolean;
  8673. /**
  8674. * Gets the scene the light belongs to.
  8675. * @returns The scene
  8676. */
  8677. getScene(): Scene;
  8678. /**
  8679. * Callback defining a custom Projection Matrix Builder.
  8680. * This can be used to override the default projection matrix computation.
  8681. */
  8682. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8683. /**
  8684. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8685. * @param matrix The materix to updated with the projection information
  8686. * @param viewMatrix The transform matrix of the light
  8687. * @param renderList The list of mesh to render in the map
  8688. * @returns The current light
  8689. */
  8690. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8691. /**
  8692. * Gets the current depth scale used in ESM.
  8693. * @returns The scale
  8694. */
  8695. getDepthScale(): number;
  8696. /**
  8697. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8698. * @returns true if a cube texture needs to be use
  8699. */
  8700. needCube(): boolean;
  8701. /**
  8702. * Detects if the projection matrix requires to be recomputed this frame.
  8703. * @returns true if it requires to be recomputed otherwise, false.
  8704. */
  8705. needProjectionMatrixCompute(): boolean;
  8706. /**
  8707. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8708. */
  8709. forceProjectionMatrixCompute(): void;
  8710. /**
  8711. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8712. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8713. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8714. */
  8715. getShadowDirection(faceIndex?: number): Vector3;
  8716. /**
  8717. * Gets the minZ used for shadow according to both the scene and the light.
  8718. * @param activeCamera The camera we are returning the min for
  8719. * @returns the depth min z
  8720. */
  8721. getDepthMinZ(activeCamera: Camera): number;
  8722. /**
  8723. * Gets the maxZ used for shadow according to both the scene and the light.
  8724. * @param activeCamera The camera we are returning the max for
  8725. * @returns the depth max z
  8726. */
  8727. getDepthMaxZ(activeCamera: Camera): number;
  8728. }
  8729. /**
  8730. * Base implementation IShadowLight
  8731. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8732. */
  8733. export abstract class ShadowLight extends Light implements IShadowLight {
  8734. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8735. protected _position: Vector3;
  8736. protected _setPosition(value: Vector3): void;
  8737. /**
  8738. * Sets the position the shadow will be casted from. Also use as the light position for both
  8739. * point and spot lights.
  8740. */
  8741. /**
  8742. * Sets the position the shadow will be casted from. Also use as the light position for both
  8743. * point and spot lights.
  8744. */
  8745. position: Vector3;
  8746. protected _direction: Vector3;
  8747. protected _setDirection(value: Vector3): void;
  8748. /**
  8749. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8750. * Also use as the light direction on spot and directional lights.
  8751. */
  8752. /**
  8753. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8754. * Also use as the light direction on spot and directional lights.
  8755. */
  8756. direction: Vector3;
  8757. private _shadowMinZ;
  8758. /**
  8759. * Gets the shadow projection clipping minimum z value.
  8760. */
  8761. /**
  8762. * Sets the shadow projection clipping minimum z value.
  8763. */
  8764. shadowMinZ: number;
  8765. private _shadowMaxZ;
  8766. /**
  8767. * Sets the shadow projection clipping maximum z value.
  8768. */
  8769. /**
  8770. * Gets the shadow projection clipping maximum z value.
  8771. */
  8772. shadowMaxZ: number;
  8773. /**
  8774. * Callback defining a custom Projection Matrix Builder.
  8775. * This can be used to override the default projection matrix computation.
  8776. */
  8777. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8778. /**
  8779. * The transformed position. Position of the light in world space taking parenting in account.
  8780. */
  8781. transformedPosition: Vector3;
  8782. /**
  8783. * The transformed direction. Direction of the light in world space taking parenting in account.
  8784. */
  8785. transformedDirection: Vector3;
  8786. private _needProjectionMatrixCompute;
  8787. /**
  8788. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8789. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8790. */
  8791. computeTransformedInformation(): boolean;
  8792. /**
  8793. * Return the depth scale used for the shadow map.
  8794. * @returns the depth scale.
  8795. */
  8796. getDepthScale(): number;
  8797. /**
  8798. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8799. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8800. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8801. */
  8802. getShadowDirection(faceIndex?: number): Vector3;
  8803. /**
  8804. * Returns the ShadowLight absolute position in the World.
  8805. * @returns the position vector in world space
  8806. */
  8807. getAbsolutePosition(): Vector3;
  8808. /**
  8809. * Sets the ShadowLight direction toward the passed target.
  8810. * @param target The point to target in local space
  8811. * @returns the updated ShadowLight direction
  8812. */
  8813. setDirectionToTarget(target: Vector3): Vector3;
  8814. /**
  8815. * Returns the light rotation in euler definition.
  8816. * @returns the x y z rotation in local space.
  8817. */
  8818. getRotation(): Vector3;
  8819. /**
  8820. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8821. * @returns true if a cube texture needs to be use
  8822. */
  8823. needCube(): boolean;
  8824. /**
  8825. * Detects if the projection matrix requires to be recomputed this frame.
  8826. * @returns true if it requires to be recomputed otherwise, false.
  8827. */
  8828. needProjectionMatrixCompute(): boolean;
  8829. /**
  8830. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8831. */
  8832. forceProjectionMatrixCompute(): void;
  8833. /** @hidden */
  8834. _initCache(): void;
  8835. /** @hidden */
  8836. _isSynchronized(): boolean;
  8837. /**
  8838. * Computes the world matrix of the node
  8839. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8840. * @returns the world matrix
  8841. */
  8842. computeWorldMatrix(force?: boolean): Matrix;
  8843. /**
  8844. * Gets the minZ used for shadow according to both the scene and the light.
  8845. * @param activeCamera The camera we are returning the min for
  8846. * @returns the depth min z
  8847. */
  8848. getDepthMinZ(activeCamera: Camera): number;
  8849. /**
  8850. * Gets the maxZ used for shadow according to both the scene and the light.
  8851. * @param activeCamera The camera we are returning the max for
  8852. * @returns the depth max z
  8853. */
  8854. getDepthMaxZ(activeCamera: Camera): number;
  8855. /**
  8856. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8857. * @param matrix The materix to updated with the projection information
  8858. * @param viewMatrix The transform matrix of the light
  8859. * @param renderList The list of mesh to render in the map
  8860. * @returns The current light
  8861. */
  8862. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8863. }
  8864. }
  8865. declare module "babylonjs/Materials/materialHelper" {
  8866. import { Nullable } from "babylonjs/types";
  8867. import { Scene } from "babylonjs/scene";
  8868. import { Engine } from "babylonjs/Engines/engine";
  8869. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8870. import { Light } from "babylonjs/Lights/light";
  8871. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  8872. import { Effect, EffectFallbacks, EffectCreationOptions } from "babylonjs/Materials/effect";
  8873. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8874. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8875. /**
  8876. * "Static Class" containing the most commonly used helper while dealing with material for
  8877. * rendering purpose.
  8878. *
  8879. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  8880. *
  8881. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  8882. */
  8883. export class MaterialHelper {
  8884. /**
  8885. * Bind the current view position to an effect.
  8886. * @param effect The effect to be bound
  8887. * @param scene The scene the eyes position is used from
  8888. */
  8889. static BindEyePosition(effect: Effect, scene: Scene): void;
  8890. /**
  8891. * Helps preparing the defines values about the UVs in used in the effect.
  8892. * UVs are shared as much as we can accross channels in the shaders.
  8893. * @param texture The texture we are preparing the UVs for
  8894. * @param defines The defines to update
  8895. * @param key The channel key "diffuse", "specular"... used in the shader
  8896. */
  8897. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  8898. /**
  8899. * Binds a texture matrix value to its corrsponding uniform
  8900. * @param texture The texture to bind the matrix for
  8901. * @param uniformBuffer The uniform buffer receivin the data
  8902. * @param key The channel key "diffuse", "specular"... used in the shader
  8903. */
  8904. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  8905. /**
  8906. * Gets the current status of the fog (should it be enabled?)
  8907. * @param mesh defines the mesh to evaluate for fog support
  8908. * @param scene defines the hosting scene
  8909. * @returns true if fog must be enabled
  8910. */
  8911. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  8912. /**
  8913. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  8914. * @param mesh defines the current mesh
  8915. * @param scene defines the current scene
  8916. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  8917. * @param pointsCloud defines if point cloud rendering has to be turned on
  8918. * @param fogEnabled defines if fog has to be turned on
  8919. * @param alphaTest defines if alpha testing has to be turned on
  8920. * @param defines defines the current list of defines
  8921. */
  8922. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  8923. /**
  8924. * Helper used to prepare the list of defines associated with frame values for shader compilation
  8925. * @param scene defines the current scene
  8926. * @param engine defines the current engine
  8927. * @param defines specifies the list of active defines
  8928. * @param useInstances defines if instances have to be turned on
  8929. * @param useClipPlane defines if clip plane have to be turned on
  8930. */
  8931. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  8932. /**
  8933. * Prepares the defines for bones
  8934. * @param mesh The mesh containing the geometry data we will draw
  8935. * @param defines The defines to update
  8936. */
  8937. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  8938. /**
  8939. * Prepares the defines for morph targets
  8940. * @param mesh The mesh containing the geometry data we will draw
  8941. * @param defines The defines to update
  8942. */
  8943. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  8944. /**
  8945. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  8946. * @param mesh The mesh containing the geometry data we will draw
  8947. * @param defines The defines to update
  8948. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  8949. * @param useBones Precise whether bones should be used or not (override mesh info)
  8950. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  8951. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  8952. * @returns false if defines are considered not dirty and have not been checked
  8953. */
  8954. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  8955. /**
  8956. * Prepares the defines related to multiview
  8957. * @param scene The scene we are intending to draw
  8958. * @param defines The defines to update
  8959. */
  8960. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  8961. /**
  8962. * Prepares the defines related to the light information passed in parameter
  8963. * @param scene The scene we are intending to draw
  8964. * @param mesh The mesh the effect is compiling for
  8965. * @param light The light the effect is compiling for
  8966. * @param lightIndex The index of the light
  8967. * @param defines The defines to update
  8968. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  8969. * @param state Defines the current state regarding what is needed (normals, etc...)
  8970. */
  8971. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  8972. needNormals: boolean;
  8973. needRebuild: boolean;
  8974. shadowEnabled: boolean;
  8975. specularEnabled: boolean;
  8976. lightmapMode: boolean;
  8977. }): void;
  8978. /**
  8979. * Prepares the defines related to the light information passed in parameter
  8980. * @param scene The scene we are intending to draw
  8981. * @param mesh The mesh the effect is compiling for
  8982. * @param defines The defines to update
  8983. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  8984. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  8985. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  8986. * @returns true if normals will be required for the rest of the effect
  8987. */
  8988. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  8989. /**
  8990. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  8991. * @param lightIndex defines the light index
  8992. * @param uniformsList The uniform list
  8993. * @param samplersList The sampler list
  8994. * @param projectedLightTexture defines if projected texture must be used
  8995. * @param uniformBuffersList defines an optional list of uniform buffers
  8996. */
  8997. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  8998. /**
  8999. * Prepares the uniforms and samplers list to be used in the effect
  9000. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9001. * @param samplersList The sampler list
  9002. * @param defines The defines helping in the list generation
  9003. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9004. */
  9005. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | EffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9006. /**
  9007. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9008. * @param defines The defines to update while falling back
  9009. * @param fallbacks The authorized effect fallbacks
  9010. * @param maxSimultaneousLights The maximum number of lights allowed
  9011. * @param rank the current rank of the Effect
  9012. * @returns The newly affected rank
  9013. */
  9014. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9015. private static _TmpMorphInfluencers;
  9016. /**
  9017. * Prepares the list of attributes required for morph targets according to the effect defines.
  9018. * @param attribs The current list of supported attribs
  9019. * @param mesh The mesh to prepare the morph targets attributes for
  9020. * @param influencers The number of influencers
  9021. */
  9022. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9023. /**
  9024. * Prepares the list of attributes required for morph targets according to the effect defines.
  9025. * @param attribs The current list of supported attribs
  9026. * @param mesh The mesh to prepare the morph targets attributes for
  9027. * @param defines The current Defines of the effect
  9028. */
  9029. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9030. /**
  9031. * Prepares the list of attributes required for bones according to the effect defines.
  9032. * @param attribs The current list of supported attribs
  9033. * @param mesh The mesh to prepare the bones attributes for
  9034. * @param defines The current Defines of the effect
  9035. * @param fallbacks The current efffect fallback strategy
  9036. */
  9037. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9038. /**
  9039. * Check and prepare the list of attributes required for instances according to the effect defines.
  9040. * @param attribs The current list of supported attribs
  9041. * @param defines The current MaterialDefines of the effect
  9042. */
  9043. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9044. /**
  9045. * Add the list of attributes required for instances to the attribs array.
  9046. * @param attribs The current list of supported attribs
  9047. */
  9048. static PushAttributesForInstances(attribs: string[]): void;
  9049. /**
  9050. * Binds the light shadow information to the effect for the given mesh.
  9051. * @param light The light containing the generator
  9052. * @param scene The scene the lights belongs to
  9053. * @param mesh The mesh we are binding the information to render
  9054. * @param lightIndex The light index in the effect used to render the mesh
  9055. * @param effect The effect we are binding the data to
  9056. */
  9057. static BindLightShadow(light: Light, mesh: AbstractMesh, lightIndex: string, effect: Effect): void;
  9058. /**
  9059. * Binds the light information to the effect.
  9060. * @param light The light containing the generator
  9061. * @param effect The effect we are binding the data to
  9062. * @param lightIndex The light index in the effect used to render
  9063. */
  9064. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9065. /**
  9066. * Binds the lights information from the scene to the effect for the given mesh.
  9067. * @param light Light to bind
  9068. * @param lightIndex Light index
  9069. * @param scene The scene where the light belongs to
  9070. * @param mesh The mesh we are binding the information to render
  9071. * @param effect The effect we are binding the data to
  9072. * @param useSpecular Defines if specular is supported
  9073. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9074. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9075. */
  9076. static BindLight(light: Light, lightIndex: number, scene: Scene, mesh: AbstractMesh, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9077. /**
  9078. * Binds the lights information from the scene to the effect for the given mesh.
  9079. * @param scene The scene the lights belongs to
  9080. * @param mesh The mesh we are binding the information to render
  9081. * @param effect The effect we are binding the data to
  9082. * @param defines The generated defines for the effect
  9083. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9084. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9085. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9086. */
  9087. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9088. private static _tempFogColor;
  9089. /**
  9090. * Binds the fog information from the scene to the effect for the given mesh.
  9091. * @param scene The scene the lights belongs to
  9092. * @param mesh The mesh we are binding the information to render
  9093. * @param effect The effect we are binding the data to
  9094. * @param linearSpace Defines if the fog effect is applied in linear space
  9095. */
  9096. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9097. /**
  9098. * Binds the bones information from the mesh to the effect.
  9099. * @param mesh The mesh we are binding the information to render
  9100. * @param effect The effect we are binding the data to
  9101. */
  9102. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9103. /**
  9104. * Binds the morph targets information from the mesh to the effect.
  9105. * @param abstractMesh The mesh we are binding the information to render
  9106. * @param effect The effect we are binding the data to
  9107. */
  9108. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9109. /**
  9110. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9111. * @param defines The generated defines used in the effect
  9112. * @param effect The effect we are binding the data to
  9113. * @param scene The scene we are willing to render with logarithmic scale for
  9114. */
  9115. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9116. /**
  9117. * Binds the clip plane information from the scene to the effect.
  9118. * @param scene The scene the clip plane information are extracted from
  9119. * @param effect The effect we are binding the data to
  9120. */
  9121. static BindClipPlane(effect: Effect, scene: Scene): void;
  9122. }
  9123. }
  9124. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9125. /** @hidden */
  9126. export var packingFunctions: {
  9127. name: string;
  9128. shader: string;
  9129. };
  9130. }
  9131. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9132. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9133. /** @hidden */
  9134. export var shadowMapPixelShader: {
  9135. name: string;
  9136. shader: string;
  9137. };
  9138. }
  9139. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9140. /** @hidden */
  9141. export var bonesDeclaration: {
  9142. name: string;
  9143. shader: string;
  9144. };
  9145. }
  9146. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9147. /** @hidden */
  9148. export var morphTargetsVertexGlobalDeclaration: {
  9149. name: string;
  9150. shader: string;
  9151. };
  9152. }
  9153. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9154. /** @hidden */
  9155. export var morphTargetsVertexDeclaration: {
  9156. name: string;
  9157. shader: string;
  9158. };
  9159. }
  9160. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9161. /** @hidden */
  9162. export var instancesDeclaration: {
  9163. name: string;
  9164. shader: string;
  9165. };
  9166. }
  9167. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9168. /** @hidden */
  9169. export var helperFunctions: {
  9170. name: string;
  9171. shader: string;
  9172. };
  9173. }
  9174. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9175. /** @hidden */
  9176. export var morphTargetsVertex: {
  9177. name: string;
  9178. shader: string;
  9179. };
  9180. }
  9181. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9182. /** @hidden */
  9183. export var instancesVertex: {
  9184. name: string;
  9185. shader: string;
  9186. };
  9187. }
  9188. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9189. /** @hidden */
  9190. export var bonesVertex: {
  9191. name: string;
  9192. shader: string;
  9193. };
  9194. }
  9195. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9196. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9197. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9198. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9199. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9200. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9201. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9202. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9203. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9204. /** @hidden */
  9205. export var shadowMapVertexShader: {
  9206. name: string;
  9207. shader: string;
  9208. };
  9209. }
  9210. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9211. /** @hidden */
  9212. export var depthBoxBlurPixelShader: {
  9213. name: string;
  9214. shader: string;
  9215. };
  9216. }
  9217. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9218. import { Nullable } from "babylonjs/types";
  9219. import { Scene } from "babylonjs/scene";
  9220. import { Matrix } from "babylonjs/Maths/math.vector";
  9221. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9223. import { Mesh } from "babylonjs/Meshes/mesh";
  9224. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9225. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9226. import { Effect } from "babylonjs/Materials/effect";
  9227. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9228. import "babylonjs/Shaders/shadowMap.fragment";
  9229. import "babylonjs/Shaders/shadowMap.vertex";
  9230. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9231. import { Observable } from "babylonjs/Misc/observable";
  9232. /**
  9233. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9234. */
  9235. export interface ICustomShaderOptions {
  9236. /**
  9237. * Gets or sets the custom shader name to use
  9238. */
  9239. shaderName: string;
  9240. /**
  9241. * The list of attribute names used in the shader
  9242. */
  9243. attributes?: string[];
  9244. /**
  9245. * The list of unifrom names used in the shader
  9246. */
  9247. uniforms?: string[];
  9248. /**
  9249. * The list of sampler names used in the shader
  9250. */
  9251. samplers?: string[];
  9252. /**
  9253. * The list of defines used in the shader
  9254. */
  9255. defines?: string[];
  9256. }
  9257. /**
  9258. * Interface to implement to create a shadow generator compatible with BJS.
  9259. */
  9260. export interface IShadowGenerator {
  9261. /**
  9262. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9263. * @returns The render target texture if present otherwise, null
  9264. */
  9265. getShadowMap(): Nullable<RenderTargetTexture>;
  9266. /**
  9267. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9268. * @returns The render target texture if the shadow map is present otherwise, null
  9269. */
  9270. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9271. /**
  9272. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9273. * @param subMesh The submesh we want to render in the shadow map
  9274. * @param useInstances Defines wether will draw in the map using instances
  9275. * @returns true if ready otherwise, false
  9276. */
  9277. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9278. /**
  9279. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9280. * @param defines Defines of the material we want to update
  9281. * @param lightIndex Index of the light in the enabled light list of the material
  9282. */
  9283. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9284. /**
  9285. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9286. * defined in the generator but impacting the effect).
  9287. * It implies the unifroms available on the materials are the standard BJS ones.
  9288. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9289. * @param effect The effect we are binfing the information for
  9290. */
  9291. bindShadowLight(lightIndex: string, effect: Effect): void;
  9292. /**
  9293. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9294. * (eq to shadow prjection matrix * light transform matrix)
  9295. * @returns The transform matrix used to create the shadow map
  9296. */
  9297. getTransformMatrix(): Matrix;
  9298. /**
  9299. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9300. * Cube and 2D textures for instance.
  9301. */
  9302. recreateShadowMap(): void;
  9303. /**
  9304. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9305. * @param onCompiled Callback triggered at the and of the effects compilation
  9306. * @param options Sets of optional options forcing the compilation with different modes
  9307. */
  9308. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9309. useInstances: boolean;
  9310. }>): void;
  9311. /**
  9312. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9313. * @param options Sets of optional options forcing the compilation with different modes
  9314. * @returns A promise that resolves when the compilation completes
  9315. */
  9316. forceCompilationAsync(options?: Partial<{
  9317. useInstances: boolean;
  9318. }>): Promise<void>;
  9319. /**
  9320. * Serializes the shadow generator setup to a json object.
  9321. * @returns The serialized JSON object
  9322. */
  9323. serialize(): any;
  9324. /**
  9325. * Disposes the Shadow map and related Textures and effects.
  9326. */
  9327. dispose(): void;
  9328. }
  9329. /**
  9330. * Default implementation IShadowGenerator.
  9331. * This is the main object responsible of generating shadows in the framework.
  9332. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9333. */
  9334. export class ShadowGenerator implements IShadowGenerator {
  9335. /**
  9336. * Shadow generator mode None: no filtering applied.
  9337. */
  9338. static readonly FILTER_NONE: number;
  9339. /**
  9340. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9341. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9342. */
  9343. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9344. /**
  9345. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9346. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9347. */
  9348. static readonly FILTER_POISSONSAMPLING: number;
  9349. /**
  9350. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9351. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9352. */
  9353. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9354. /**
  9355. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9356. * edge artifacts on steep falloff.
  9357. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9358. */
  9359. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9360. /**
  9361. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9362. * edge artifacts on steep falloff.
  9363. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9364. */
  9365. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9366. /**
  9367. * Shadow generator mode PCF: Percentage Closer Filtering
  9368. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9369. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9370. */
  9371. static readonly FILTER_PCF: number;
  9372. /**
  9373. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9374. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9375. * Contact Hardening
  9376. */
  9377. static readonly FILTER_PCSS: number;
  9378. /**
  9379. * Reserved for PCF and PCSS
  9380. * Highest Quality.
  9381. *
  9382. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9383. *
  9384. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9385. */
  9386. static readonly QUALITY_HIGH: number;
  9387. /**
  9388. * Reserved for PCF and PCSS
  9389. * Good tradeoff for quality/perf cross devices
  9390. *
  9391. * Execute PCF on a 3*3 kernel.
  9392. *
  9393. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9394. */
  9395. static readonly QUALITY_MEDIUM: number;
  9396. /**
  9397. * Reserved for PCF and PCSS
  9398. * The lowest quality but the fastest.
  9399. *
  9400. * Execute PCF on a 1*1 kernel.
  9401. *
  9402. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9403. */
  9404. static readonly QUALITY_LOW: number;
  9405. /** Gets or sets the custom shader name to use */
  9406. customShaderOptions: ICustomShaderOptions;
  9407. /**
  9408. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9409. */
  9410. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9411. /**
  9412. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9413. */
  9414. onAfterShadowMapRenderObservable: Observable<Effect>;
  9415. /**
  9416. * Observable triggered before a mesh is rendered in the shadow map.
  9417. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9418. */
  9419. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9420. /**
  9421. * Observable triggered after a mesh is rendered in the shadow map.
  9422. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9423. */
  9424. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9425. private _bias;
  9426. /**
  9427. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9428. */
  9429. /**
  9430. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9431. */
  9432. bias: number;
  9433. private _normalBias;
  9434. /**
  9435. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9436. */
  9437. /**
  9438. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9439. */
  9440. normalBias: number;
  9441. private _blurBoxOffset;
  9442. /**
  9443. * Gets the blur box offset: offset applied during the blur pass.
  9444. * Only useful if useKernelBlur = false
  9445. */
  9446. /**
  9447. * Sets the blur box offset: offset applied during the blur pass.
  9448. * Only useful if useKernelBlur = false
  9449. */
  9450. blurBoxOffset: number;
  9451. private _blurScale;
  9452. /**
  9453. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9454. * 2 means half of the size.
  9455. */
  9456. /**
  9457. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9458. * 2 means half of the size.
  9459. */
  9460. blurScale: number;
  9461. private _blurKernel;
  9462. /**
  9463. * Gets the blur kernel: kernel size of the blur pass.
  9464. * Only useful if useKernelBlur = true
  9465. */
  9466. /**
  9467. * Sets the blur kernel: kernel size of the blur pass.
  9468. * Only useful if useKernelBlur = true
  9469. */
  9470. blurKernel: number;
  9471. private _useKernelBlur;
  9472. /**
  9473. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9474. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9475. */
  9476. /**
  9477. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9478. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9479. */
  9480. useKernelBlur: boolean;
  9481. private _depthScale;
  9482. /**
  9483. * Gets the depth scale used in ESM mode.
  9484. */
  9485. /**
  9486. * Sets the depth scale used in ESM mode.
  9487. * This can override the scale stored on the light.
  9488. */
  9489. depthScale: number;
  9490. private _filter;
  9491. /**
  9492. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9493. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9494. */
  9495. /**
  9496. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9497. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9498. */
  9499. filter: number;
  9500. /**
  9501. * Gets if the current filter is set to Poisson Sampling.
  9502. */
  9503. /**
  9504. * Sets the current filter to Poisson Sampling.
  9505. */
  9506. usePoissonSampling: boolean;
  9507. /**
  9508. * Gets if the current filter is set to ESM.
  9509. */
  9510. /**
  9511. * Sets the current filter is to ESM.
  9512. */
  9513. useExponentialShadowMap: boolean;
  9514. /**
  9515. * Gets if the current filter is set to filtered ESM.
  9516. */
  9517. /**
  9518. * Gets if the current filter is set to filtered ESM.
  9519. */
  9520. useBlurExponentialShadowMap: boolean;
  9521. /**
  9522. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9523. * exponential to prevent steep falloff artifacts).
  9524. */
  9525. /**
  9526. * Sets the current filter to "close ESM" (using the inverse of the
  9527. * exponential to prevent steep falloff artifacts).
  9528. */
  9529. useCloseExponentialShadowMap: boolean;
  9530. /**
  9531. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9532. * exponential to prevent steep falloff artifacts).
  9533. */
  9534. /**
  9535. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9536. * exponential to prevent steep falloff artifacts).
  9537. */
  9538. useBlurCloseExponentialShadowMap: boolean;
  9539. /**
  9540. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9541. */
  9542. /**
  9543. * Sets the current filter to "PCF" (percentage closer filtering).
  9544. */
  9545. usePercentageCloserFiltering: boolean;
  9546. private _filteringQuality;
  9547. /**
  9548. * Gets the PCF or PCSS Quality.
  9549. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9550. */
  9551. /**
  9552. * Sets the PCF or PCSS Quality.
  9553. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9554. */
  9555. filteringQuality: number;
  9556. /**
  9557. * Gets if the current filter is set to "PCSS" (contact hardening).
  9558. */
  9559. /**
  9560. * Sets the current filter to "PCSS" (contact hardening).
  9561. */
  9562. useContactHardeningShadow: boolean;
  9563. private _contactHardeningLightSizeUVRatio;
  9564. /**
  9565. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9566. * Using a ratio helps keeping shape stability independently of the map size.
  9567. *
  9568. * It does not account for the light projection as it was having too much
  9569. * instability during the light setup or during light position changes.
  9570. *
  9571. * Only valid if useContactHardeningShadow is true.
  9572. */
  9573. /**
  9574. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9575. * Using a ratio helps keeping shape stability independently of the map size.
  9576. *
  9577. * It does not account for the light projection as it was having too much
  9578. * instability during the light setup or during light position changes.
  9579. *
  9580. * Only valid if useContactHardeningShadow is true.
  9581. */
  9582. contactHardeningLightSizeUVRatio: number;
  9583. private _darkness;
  9584. /** Gets or sets the actual darkness of a shadow */
  9585. darkness: number;
  9586. /**
  9587. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9588. * 0 means strongest and 1 would means no shadow.
  9589. * @returns the darkness.
  9590. */
  9591. getDarkness(): number;
  9592. /**
  9593. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9594. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9595. * @returns the shadow generator allowing fluent coding.
  9596. */
  9597. setDarkness(darkness: number): ShadowGenerator;
  9598. private _transparencyShadow;
  9599. /** Gets or sets the ability to have transparent shadow */
  9600. transparencyShadow: boolean;
  9601. /**
  9602. * Sets the ability to have transparent shadow (boolean).
  9603. * @param transparent True if transparent else False
  9604. * @returns the shadow generator allowing fluent coding
  9605. */
  9606. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9607. private _shadowMap;
  9608. private _shadowMap2;
  9609. /**
  9610. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9611. * @returns The render target texture if present otherwise, null
  9612. */
  9613. getShadowMap(): Nullable<RenderTargetTexture>;
  9614. /**
  9615. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9616. * @returns The render target texture if the shadow map is present otherwise, null
  9617. */
  9618. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9619. /**
  9620. * Gets the class name of that object
  9621. * @returns "ShadowGenerator"
  9622. */
  9623. getClassName(): string;
  9624. /**
  9625. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9626. * @param mesh Mesh to add
  9627. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9628. * @returns the Shadow Generator itself
  9629. */
  9630. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9631. /**
  9632. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9633. * @param mesh Mesh to remove
  9634. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9635. * @returns the Shadow Generator itself
  9636. */
  9637. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9638. /**
  9639. * Controls the extent to which the shadows fade out at the edge of the frustum
  9640. * Used only by directionals and spots
  9641. */
  9642. frustumEdgeFalloff: number;
  9643. private _light;
  9644. /**
  9645. * Returns the associated light object.
  9646. * @returns the light generating the shadow
  9647. */
  9648. getLight(): IShadowLight;
  9649. /**
  9650. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9651. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9652. * It might on the other hand introduce peter panning.
  9653. */
  9654. forceBackFacesOnly: boolean;
  9655. private _scene;
  9656. private _lightDirection;
  9657. private _effect;
  9658. private _viewMatrix;
  9659. private _projectionMatrix;
  9660. private _transformMatrix;
  9661. private _cachedPosition;
  9662. private _cachedDirection;
  9663. private _cachedDefines;
  9664. private _currentRenderID;
  9665. private _boxBlurPostprocess;
  9666. private _kernelBlurXPostprocess;
  9667. private _kernelBlurYPostprocess;
  9668. private _blurPostProcesses;
  9669. private _mapSize;
  9670. private _currentFaceIndex;
  9671. private _currentFaceIndexCache;
  9672. private _textureType;
  9673. private _defaultTextureMatrix;
  9674. /** @hidden */
  9675. static _SceneComponentInitialization: (scene: Scene) => void;
  9676. /**
  9677. * Creates a ShadowGenerator object.
  9678. * A ShadowGenerator is the required tool to use the shadows.
  9679. * Each light casting shadows needs to use its own ShadowGenerator.
  9680. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9681. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9682. * @param light The light object generating the shadows.
  9683. * @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.
  9684. */
  9685. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9686. private _initializeGenerator;
  9687. private _initializeShadowMap;
  9688. private _initializeBlurRTTAndPostProcesses;
  9689. private _renderForShadowMap;
  9690. private _renderSubMeshForShadowMap;
  9691. private _applyFilterValues;
  9692. /**
  9693. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9694. * @param onCompiled Callback triggered at the and of the effects compilation
  9695. * @param options Sets of optional options forcing the compilation with different modes
  9696. */
  9697. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9698. useInstances: boolean;
  9699. }>): void;
  9700. /**
  9701. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9702. * @param options Sets of optional options forcing the compilation with different modes
  9703. * @returns A promise that resolves when the compilation completes
  9704. */
  9705. forceCompilationAsync(options?: Partial<{
  9706. useInstances: boolean;
  9707. }>): Promise<void>;
  9708. /**
  9709. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9710. * @param subMesh The submesh we want to render in the shadow map
  9711. * @param useInstances Defines wether will draw in the map using instances
  9712. * @returns true if ready otherwise, false
  9713. */
  9714. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9715. /**
  9716. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9717. * @param defines Defines of the material we want to update
  9718. * @param lightIndex Index of the light in the enabled light list of the material
  9719. */
  9720. prepareDefines(defines: any, lightIndex: number): void;
  9721. /**
  9722. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9723. * defined in the generator but impacting the effect).
  9724. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9725. * @param effect The effect we are binfing the information for
  9726. */
  9727. bindShadowLight(lightIndex: string, effect: Effect): void;
  9728. /**
  9729. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9730. * (eq to shadow prjection matrix * light transform matrix)
  9731. * @returns The transform matrix used to create the shadow map
  9732. */
  9733. getTransformMatrix(): Matrix;
  9734. /**
  9735. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9736. * Cube and 2D textures for instance.
  9737. */
  9738. recreateShadowMap(): void;
  9739. private _disposeBlurPostProcesses;
  9740. private _disposeRTTandPostProcesses;
  9741. /**
  9742. * Disposes the ShadowGenerator.
  9743. * Returns nothing.
  9744. */
  9745. dispose(): void;
  9746. /**
  9747. * Serializes the shadow generator setup to a json object.
  9748. * @returns The serialized JSON object
  9749. */
  9750. serialize(): any;
  9751. /**
  9752. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9753. * @param parsedShadowGenerator The JSON object to parse
  9754. * @param scene The scene to create the shadow map for
  9755. * @returns The parsed shadow generator
  9756. */
  9757. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9758. }
  9759. }
  9760. declare module "babylonjs/Lights/light" {
  9761. import { Nullable } from "babylonjs/types";
  9762. import { Scene } from "babylonjs/scene";
  9763. import { Vector3 } from "babylonjs/Maths/math.vector";
  9764. import { Color3 } from "babylonjs/Maths/math.color";
  9765. import { Node } from "babylonjs/node";
  9766. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9767. import { Effect } from "babylonjs/Materials/effect";
  9768. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9769. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9770. /**
  9771. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9772. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9773. * 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.
  9774. */
  9775. export abstract class Light extends Node {
  9776. /**
  9777. * Falloff Default: light is falling off following the material specification:
  9778. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9779. */
  9780. static readonly FALLOFF_DEFAULT: number;
  9781. /**
  9782. * Falloff Physical: light is falling off following the inverse squared distance law.
  9783. */
  9784. static readonly FALLOFF_PHYSICAL: number;
  9785. /**
  9786. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9787. * to enhance interoperability with other engines.
  9788. */
  9789. static readonly FALLOFF_GLTF: number;
  9790. /**
  9791. * Falloff Standard: light is falling off like in the standard material
  9792. * to enhance interoperability with other materials.
  9793. */
  9794. static readonly FALLOFF_STANDARD: number;
  9795. /**
  9796. * If every light affecting the material is in this lightmapMode,
  9797. * material.lightmapTexture adds or multiplies
  9798. * (depends on material.useLightmapAsShadowmap)
  9799. * after every other light calculations.
  9800. */
  9801. static readonly LIGHTMAP_DEFAULT: number;
  9802. /**
  9803. * material.lightmapTexture as only diffuse lighting from this light
  9804. * adds only specular lighting from this light
  9805. * adds dynamic shadows
  9806. */
  9807. static readonly LIGHTMAP_SPECULAR: number;
  9808. /**
  9809. * material.lightmapTexture as only lighting
  9810. * no light calculation from this light
  9811. * only adds dynamic shadows from this light
  9812. */
  9813. static readonly LIGHTMAP_SHADOWSONLY: number;
  9814. /**
  9815. * Each light type uses the default quantity according to its type:
  9816. * point/spot lights use luminous intensity
  9817. * directional lights use illuminance
  9818. */
  9819. static readonly INTENSITYMODE_AUTOMATIC: number;
  9820. /**
  9821. * lumen (lm)
  9822. */
  9823. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  9824. /**
  9825. * candela (lm/sr)
  9826. */
  9827. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  9828. /**
  9829. * lux (lm/m^2)
  9830. */
  9831. static readonly INTENSITYMODE_ILLUMINANCE: number;
  9832. /**
  9833. * nit (cd/m^2)
  9834. */
  9835. static readonly INTENSITYMODE_LUMINANCE: number;
  9836. /**
  9837. * Light type const id of the point light.
  9838. */
  9839. static readonly LIGHTTYPEID_POINTLIGHT: number;
  9840. /**
  9841. * Light type const id of the directional light.
  9842. */
  9843. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  9844. /**
  9845. * Light type const id of the spot light.
  9846. */
  9847. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  9848. /**
  9849. * Light type const id of the hemispheric light.
  9850. */
  9851. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  9852. /**
  9853. * Diffuse gives the basic color to an object.
  9854. */
  9855. diffuse: Color3;
  9856. /**
  9857. * Specular produces a highlight color on an object.
  9858. * Note: This is note affecting PBR materials.
  9859. */
  9860. specular: Color3;
  9861. /**
  9862. * Defines the falloff type for this light. This lets overrriding how punctual light are
  9863. * falling off base on range or angle.
  9864. * This can be set to any values in Light.FALLOFF_x.
  9865. *
  9866. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  9867. * other types of materials.
  9868. */
  9869. falloffType: number;
  9870. /**
  9871. * Strength of the light.
  9872. * Note: By default it is define in the framework own unit.
  9873. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  9874. */
  9875. intensity: number;
  9876. private _range;
  9877. protected _inverseSquaredRange: number;
  9878. /**
  9879. * Defines how far from the source the light is impacting in scene units.
  9880. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9881. */
  9882. /**
  9883. * Defines how far from the source the light is impacting in scene units.
  9884. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9885. */
  9886. range: number;
  9887. /**
  9888. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  9889. * of light.
  9890. */
  9891. private _photometricScale;
  9892. private _intensityMode;
  9893. /**
  9894. * Gets the photometric scale used to interpret the intensity.
  9895. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  9896. */
  9897. /**
  9898. * Sets the photometric scale used to interpret the intensity.
  9899. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  9900. */
  9901. intensityMode: number;
  9902. private _radius;
  9903. /**
  9904. * Gets the light radius used by PBR Materials to simulate soft area lights.
  9905. */
  9906. /**
  9907. * sets the light radius used by PBR Materials to simulate soft area lights.
  9908. */
  9909. radius: number;
  9910. private _renderPriority;
  9911. /**
  9912. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  9913. * exceeding the number allowed of the materials.
  9914. */
  9915. renderPriority: number;
  9916. private _shadowEnabled;
  9917. /**
  9918. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  9919. * the current shadow generator.
  9920. */
  9921. /**
  9922. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  9923. * the current shadow generator.
  9924. */
  9925. shadowEnabled: boolean;
  9926. private _includedOnlyMeshes;
  9927. /**
  9928. * Gets the only meshes impacted by this light.
  9929. */
  9930. /**
  9931. * Sets the only meshes impacted by this light.
  9932. */
  9933. includedOnlyMeshes: AbstractMesh[];
  9934. private _excludedMeshes;
  9935. /**
  9936. * Gets the meshes not impacted by this light.
  9937. */
  9938. /**
  9939. * Sets the meshes not impacted by this light.
  9940. */
  9941. excludedMeshes: AbstractMesh[];
  9942. private _excludeWithLayerMask;
  9943. /**
  9944. * Gets the layer id use to find what meshes are not impacted by the light.
  9945. * Inactive if 0
  9946. */
  9947. /**
  9948. * Sets the layer id use to find what meshes are not impacted by the light.
  9949. * Inactive if 0
  9950. */
  9951. excludeWithLayerMask: number;
  9952. private _includeOnlyWithLayerMask;
  9953. /**
  9954. * Gets the layer id use to find what meshes are impacted by the light.
  9955. * Inactive if 0
  9956. */
  9957. /**
  9958. * Sets the layer id use to find what meshes are impacted by the light.
  9959. * Inactive if 0
  9960. */
  9961. includeOnlyWithLayerMask: number;
  9962. private _lightmapMode;
  9963. /**
  9964. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  9965. */
  9966. /**
  9967. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  9968. */
  9969. lightmapMode: number;
  9970. /**
  9971. * Shadow generator associted to the light.
  9972. * @hidden Internal use only.
  9973. */
  9974. _shadowGenerator: Nullable<IShadowGenerator>;
  9975. /**
  9976. * @hidden Internal use only.
  9977. */
  9978. _excludedMeshesIds: string[];
  9979. /**
  9980. * @hidden Internal use only.
  9981. */
  9982. _includedOnlyMeshesIds: string[];
  9983. /**
  9984. * The current light unifom buffer.
  9985. * @hidden Internal use only.
  9986. */
  9987. _uniformBuffer: UniformBuffer;
  9988. /**
  9989. * Creates a Light object in the scene.
  9990. * Documentation : https://doc.babylonjs.com/babylon101/lights
  9991. * @param name The firendly name of the light
  9992. * @param scene The scene the light belongs too
  9993. */
  9994. constructor(name: string, scene: Scene);
  9995. protected abstract _buildUniformLayout(): void;
  9996. /**
  9997. * Sets the passed Effect "effect" with the Light information.
  9998. * @param effect The effect to update
  9999. * @param lightIndex The index of the light in the effect to update
  10000. * @returns The light
  10001. */
  10002. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10003. /**
  10004. * Sets the passed Effect "effect" with the Light information.
  10005. * @param effect The effect to update
  10006. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10007. * @returns The light
  10008. */
  10009. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10010. /**
  10011. * Returns the string "Light".
  10012. * @returns the class name
  10013. */
  10014. getClassName(): string;
  10015. /** @hidden */
  10016. readonly _isLight: boolean;
  10017. /**
  10018. * Converts the light information to a readable string for debug purpose.
  10019. * @param fullDetails Supports for multiple levels of logging within scene loading
  10020. * @returns the human readable light info
  10021. */
  10022. toString(fullDetails?: boolean): string;
  10023. /** @hidden */
  10024. protected _syncParentEnabledState(): void;
  10025. /**
  10026. * Set the enabled state of this node.
  10027. * @param value - the new enabled state
  10028. */
  10029. setEnabled(value: boolean): void;
  10030. /**
  10031. * Returns the Light associated shadow generator if any.
  10032. * @return the associated shadow generator.
  10033. */
  10034. getShadowGenerator(): Nullable<IShadowGenerator>;
  10035. /**
  10036. * Returns a Vector3, the absolute light position in the World.
  10037. * @returns the world space position of the light
  10038. */
  10039. getAbsolutePosition(): Vector3;
  10040. /**
  10041. * Specifies if the light will affect the passed mesh.
  10042. * @param mesh The mesh to test against the light
  10043. * @return true the mesh is affected otherwise, false.
  10044. */
  10045. canAffectMesh(mesh: AbstractMesh): boolean;
  10046. /**
  10047. * Sort function to order lights for rendering.
  10048. * @param a First Light object to compare to second.
  10049. * @param b Second Light object to compare first.
  10050. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10051. */
  10052. static CompareLightsPriority(a: Light, b: Light): number;
  10053. /**
  10054. * Releases resources associated with this node.
  10055. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10056. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10057. */
  10058. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10059. /**
  10060. * Returns the light type ID (integer).
  10061. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10062. */
  10063. getTypeID(): number;
  10064. /**
  10065. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10066. * @returns the scaled intensity in intensity mode unit
  10067. */
  10068. getScaledIntensity(): number;
  10069. /**
  10070. * Returns a new Light object, named "name", from the current one.
  10071. * @param name The name of the cloned light
  10072. * @returns the new created light
  10073. */
  10074. clone(name: string): Nullable<Light>;
  10075. /**
  10076. * Serializes the current light into a Serialization object.
  10077. * @returns the serialized object.
  10078. */
  10079. serialize(): any;
  10080. /**
  10081. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10082. * This new light is named "name" and added to the passed scene.
  10083. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10084. * @param name The friendly name of the light
  10085. * @param scene The scene the new light will belong to
  10086. * @returns the constructor function
  10087. */
  10088. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10089. /**
  10090. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10091. * @param parsedLight The JSON representation of the light
  10092. * @param scene The scene to create the parsed light in
  10093. * @returns the created light after parsing
  10094. */
  10095. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10096. private _hookArrayForExcluded;
  10097. private _hookArrayForIncludedOnly;
  10098. private _resyncMeshes;
  10099. /**
  10100. * Forces the meshes to update their light related information in their rendering used effects
  10101. * @hidden Internal Use Only
  10102. */
  10103. _markMeshesAsLightDirty(): void;
  10104. /**
  10105. * Recomputes the cached photometric scale if needed.
  10106. */
  10107. private _computePhotometricScale;
  10108. /**
  10109. * Returns the Photometric Scale according to the light type and intensity mode.
  10110. */
  10111. private _getPhotometricScale;
  10112. /**
  10113. * Reorder the light in the scene according to their defined priority.
  10114. * @hidden Internal Use Only
  10115. */
  10116. _reorderLightsInScene(): void;
  10117. /**
  10118. * Prepares the list of defines specific to the light type.
  10119. * @param defines the list of defines
  10120. * @param lightIndex defines the index of the light for the effect
  10121. */
  10122. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10123. }
  10124. }
  10125. declare module "babylonjs/Actions/action" {
  10126. import { Observable } from "babylonjs/Misc/observable";
  10127. import { Condition } from "babylonjs/Actions/condition";
  10128. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10129. import { ActionManager } from "babylonjs/Actions/actionManager";
  10130. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10131. /**
  10132. * Interface used to define Action
  10133. */
  10134. export interface IAction {
  10135. /**
  10136. * Trigger for the action
  10137. */
  10138. trigger: number;
  10139. /** Options of the trigger */
  10140. triggerOptions: any;
  10141. /**
  10142. * Gets the trigger parameters
  10143. * @returns the trigger parameters
  10144. */
  10145. getTriggerParameter(): any;
  10146. /**
  10147. * Internal only - executes current action event
  10148. * @hidden
  10149. */
  10150. _executeCurrent(evt?: ActionEvent): void;
  10151. /**
  10152. * Serialize placeholder for child classes
  10153. * @param parent of child
  10154. * @returns the serialized object
  10155. */
  10156. serialize(parent: any): any;
  10157. /**
  10158. * Internal only
  10159. * @hidden
  10160. */
  10161. _prepare(): void;
  10162. /**
  10163. * Internal only - manager for action
  10164. * @hidden
  10165. */
  10166. _actionManager: AbstractActionManager;
  10167. /**
  10168. * Adds action to chain of actions, may be a DoNothingAction
  10169. * @param action defines the next action to execute
  10170. * @returns The action passed in
  10171. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10172. */
  10173. then(action: IAction): IAction;
  10174. }
  10175. /**
  10176. * The action to be carried out following a trigger
  10177. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10178. */
  10179. export class Action implements IAction {
  10180. /** the trigger, with or without parameters, for the action */
  10181. triggerOptions: any;
  10182. /**
  10183. * Trigger for the action
  10184. */
  10185. trigger: number;
  10186. /**
  10187. * Internal only - manager for action
  10188. * @hidden
  10189. */
  10190. _actionManager: ActionManager;
  10191. private _nextActiveAction;
  10192. private _child;
  10193. private _condition?;
  10194. private _triggerParameter;
  10195. /**
  10196. * An event triggered prior to action being executed.
  10197. */
  10198. onBeforeExecuteObservable: Observable<Action>;
  10199. /**
  10200. * Creates a new Action
  10201. * @param triggerOptions the trigger, with or without parameters, for the action
  10202. * @param condition an optional determinant of action
  10203. */
  10204. constructor(
  10205. /** the trigger, with or without parameters, for the action */
  10206. triggerOptions: any, condition?: Condition);
  10207. /**
  10208. * Internal only
  10209. * @hidden
  10210. */
  10211. _prepare(): void;
  10212. /**
  10213. * Gets the trigger parameters
  10214. * @returns the trigger parameters
  10215. */
  10216. getTriggerParameter(): any;
  10217. /**
  10218. * Internal only - executes current action event
  10219. * @hidden
  10220. */
  10221. _executeCurrent(evt?: ActionEvent): void;
  10222. /**
  10223. * Execute placeholder for child classes
  10224. * @param evt optional action event
  10225. */
  10226. execute(evt?: ActionEvent): void;
  10227. /**
  10228. * Skips to next active action
  10229. */
  10230. skipToNextActiveAction(): void;
  10231. /**
  10232. * Adds action to chain of actions, may be a DoNothingAction
  10233. * @param action defines the next action to execute
  10234. * @returns The action passed in
  10235. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10236. */
  10237. then(action: Action): Action;
  10238. /**
  10239. * Internal only
  10240. * @hidden
  10241. */
  10242. _getProperty(propertyPath: string): string;
  10243. /**
  10244. * Internal only
  10245. * @hidden
  10246. */
  10247. _getEffectiveTarget(target: any, propertyPath: string): any;
  10248. /**
  10249. * Serialize placeholder for child classes
  10250. * @param parent of child
  10251. * @returns the serialized object
  10252. */
  10253. serialize(parent: any): any;
  10254. /**
  10255. * Internal only called by serialize
  10256. * @hidden
  10257. */
  10258. protected _serialize(serializedAction: any, parent?: any): any;
  10259. /**
  10260. * Internal only
  10261. * @hidden
  10262. */
  10263. static _SerializeValueAsString: (value: any) => string;
  10264. /**
  10265. * Internal only
  10266. * @hidden
  10267. */
  10268. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10269. name: string;
  10270. targetType: string;
  10271. value: string;
  10272. };
  10273. }
  10274. }
  10275. declare module "babylonjs/Actions/condition" {
  10276. import { ActionManager } from "babylonjs/Actions/actionManager";
  10277. /**
  10278. * A Condition applied to an Action
  10279. */
  10280. export class Condition {
  10281. /**
  10282. * Internal only - manager for action
  10283. * @hidden
  10284. */
  10285. _actionManager: ActionManager;
  10286. /**
  10287. * Internal only
  10288. * @hidden
  10289. */
  10290. _evaluationId: number;
  10291. /**
  10292. * Internal only
  10293. * @hidden
  10294. */
  10295. _currentResult: boolean;
  10296. /**
  10297. * Creates a new Condition
  10298. * @param actionManager the manager of the action the condition is applied to
  10299. */
  10300. constructor(actionManager: ActionManager);
  10301. /**
  10302. * Check if the current condition is valid
  10303. * @returns a boolean
  10304. */
  10305. isValid(): boolean;
  10306. /**
  10307. * Internal only
  10308. * @hidden
  10309. */
  10310. _getProperty(propertyPath: string): string;
  10311. /**
  10312. * Internal only
  10313. * @hidden
  10314. */
  10315. _getEffectiveTarget(target: any, propertyPath: string): any;
  10316. /**
  10317. * Serialize placeholder for child classes
  10318. * @returns the serialized object
  10319. */
  10320. serialize(): any;
  10321. /**
  10322. * Internal only
  10323. * @hidden
  10324. */
  10325. protected _serialize(serializedCondition: any): any;
  10326. }
  10327. /**
  10328. * Defines specific conditional operators as extensions of Condition
  10329. */
  10330. export class ValueCondition extends Condition {
  10331. /** path to specify the property of the target the conditional operator uses */
  10332. propertyPath: string;
  10333. /** the value compared by the conditional operator against the current value of the property */
  10334. value: any;
  10335. /** the conditional operator, default ValueCondition.IsEqual */
  10336. operator: number;
  10337. /**
  10338. * Internal only
  10339. * @hidden
  10340. */
  10341. private static _IsEqual;
  10342. /**
  10343. * Internal only
  10344. * @hidden
  10345. */
  10346. private static _IsDifferent;
  10347. /**
  10348. * Internal only
  10349. * @hidden
  10350. */
  10351. private static _IsGreater;
  10352. /**
  10353. * Internal only
  10354. * @hidden
  10355. */
  10356. private static _IsLesser;
  10357. /**
  10358. * returns the number for IsEqual
  10359. */
  10360. static readonly IsEqual: number;
  10361. /**
  10362. * Returns the number for IsDifferent
  10363. */
  10364. static readonly IsDifferent: number;
  10365. /**
  10366. * Returns the number for IsGreater
  10367. */
  10368. static readonly IsGreater: number;
  10369. /**
  10370. * Returns the number for IsLesser
  10371. */
  10372. static readonly IsLesser: number;
  10373. /**
  10374. * Internal only The action manager for the condition
  10375. * @hidden
  10376. */
  10377. _actionManager: ActionManager;
  10378. /**
  10379. * Internal only
  10380. * @hidden
  10381. */
  10382. private _target;
  10383. /**
  10384. * Internal only
  10385. * @hidden
  10386. */
  10387. private _effectiveTarget;
  10388. /**
  10389. * Internal only
  10390. * @hidden
  10391. */
  10392. private _property;
  10393. /**
  10394. * Creates a new ValueCondition
  10395. * @param actionManager manager for the action the condition applies to
  10396. * @param target for the action
  10397. * @param propertyPath path to specify the property of the target the conditional operator uses
  10398. * @param value the value compared by the conditional operator against the current value of the property
  10399. * @param operator the conditional operator, default ValueCondition.IsEqual
  10400. */
  10401. constructor(actionManager: ActionManager, target: any,
  10402. /** path to specify the property of the target the conditional operator uses */
  10403. propertyPath: string,
  10404. /** the value compared by the conditional operator against the current value of the property */
  10405. value: any,
  10406. /** the conditional operator, default ValueCondition.IsEqual */
  10407. operator?: number);
  10408. /**
  10409. * Compares the given value with the property value for the specified conditional operator
  10410. * @returns the result of the comparison
  10411. */
  10412. isValid(): boolean;
  10413. /**
  10414. * Serialize the ValueCondition into a JSON compatible object
  10415. * @returns serialization object
  10416. */
  10417. serialize(): any;
  10418. /**
  10419. * Gets the name of the conditional operator for the ValueCondition
  10420. * @param operator the conditional operator
  10421. * @returns the name
  10422. */
  10423. static GetOperatorName(operator: number): string;
  10424. }
  10425. /**
  10426. * Defines a predicate condition as an extension of Condition
  10427. */
  10428. export class PredicateCondition extends Condition {
  10429. /** defines the predicate function used to validate the condition */
  10430. predicate: () => boolean;
  10431. /**
  10432. * Internal only - manager for action
  10433. * @hidden
  10434. */
  10435. _actionManager: ActionManager;
  10436. /**
  10437. * Creates a new PredicateCondition
  10438. * @param actionManager manager for the action the condition applies to
  10439. * @param predicate defines the predicate function used to validate the condition
  10440. */
  10441. constructor(actionManager: ActionManager,
  10442. /** defines the predicate function used to validate the condition */
  10443. predicate: () => boolean);
  10444. /**
  10445. * @returns the validity of the predicate condition
  10446. */
  10447. isValid(): boolean;
  10448. }
  10449. /**
  10450. * Defines a state condition as an extension of Condition
  10451. */
  10452. export class StateCondition extends Condition {
  10453. /** Value to compare with target state */
  10454. value: string;
  10455. /**
  10456. * Internal only - manager for action
  10457. * @hidden
  10458. */
  10459. _actionManager: ActionManager;
  10460. /**
  10461. * Internal only
  10462. * @hidden
  10463. */
  10464. private _target;
  10465. /**
  10466. * Creates a new StateCondition
  10467. * @param actionManager manager for the action the condition applies to
  10468. * @param target of the condition
  10469. * @param value to compare with target state
  10470. */
  10471. constructor(actionManager: ActionManager, target: any,
  10472. /** Value to compare with target state */
  10473. value: string);
  10474. /**
  10475. * Gets a boolean indicating if the current condition is met
  10476. * @returns the validity of the state
  10477. */
  10478. isValid(): boolean;
  10479. /**
  10480. * Serialize the StateCondition into a JSON compatible object
  10481. * @returns serialization object
  10482. */
  10483. serialize(): any;
  10484. }
  10485. }
  10486. declare module "babylonjs/Actions/directActions" {
  10487. import { Action } from "babylonjs/Actions/action";
  10488. import { Condition } from "babylonjs/Actions/condition";
  10489. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10490. /**
  10491. * This defines an action responsible to toggle a boolean once triggered.
  10492. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10493. */
  10494. export class SwitchBooleanAction extends Action {
  10495. /**
  10496. * The path to the boolean property in the target object
  10497. */
  10498. propertyPath: string;
  10499. private _target;
  10500. private _effectiveTarget;
  10501. private _property;
  10502. /**
  10503. * Instantiate the action
  10504. * @param triggerOptions defines the trigger options
  10505. * @param target defines the object containing the boolean
  10506. * @param propertyPath defines the path to the boolean property in the target object
  10507. * @param condition defines the trigger related conditions
  10508. */
  10509. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10510. /** @hidden */
  10511. _prepare(): void;
  10512. /**
  10513. * Execute the action toggle the boolean value.
  10514. */
  10515. execute(): void;
  10516. /**
  10517. * Serializes the actions and its related information.
  10518. * @param parent defines the object to serialize in
  10519. * @returns the serialized object
  10520. */
  10521. serialize(parent: any): any;
  10522. }
  10523. /**
  10524. * This defines an action responsible to set a the state field of the target
  10525. * to a desired value once triggered.
  10526. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10527. */
  10528. export class SetStateAction extends Action {
  10529. /**
  10530. * The value to store in the state field.
  10531. */
  10532. value: string;
  10533. private _target;
  10534. /**
  10535. * Instantiate the action
  10536. * @param triggerOptions defines the trigger options
  10537. * @param target defines the object containing the state property
  10538. * @param value defines the value to store in the state field
  10539. * @param condition defines the trigger related conditions
  10540. */
  10541. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10542. /**
  10543. * Execute the action and store the value on the target state property.
  10544. */
  10545. execute(): void;
  10546. /**
  10547. * Serializes the actions and its related information.
  10548. * @param parent defines the object to serialize in
  10549. * @returns the serialized object
  10550. */
  10551. serialize(parent: any): any;
  10552. }
  10553. /**
  10554. * This defines an action responsible to set a property of the target
  10555. * to a desired value once triggered.
  10556. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10557. */
  10558. export class SetValueAction extends Action {
  10559. /**
  10560. * The path of the property to set in the target.
  10561. */
  10562. propertyPath: string;
  10563. /**
  10564. * The value to set in the property
  10565. */
  10566. value: any;
  10567. private _target;
  10568. private _effectiveTarget;
  10569. private _property;
  10570. /**
  10571. * Instantiate the action
  10572. * @param triggerOptions defines the trigger options
  10573. * @param target defines the object containing the property
  10574. * @param propertyPath defines the path of the property to set in the target
  10575. * @param value defines the value to set in the property
  10576. * @param condition defines the trigger related conditions
  10577. */
  10578. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10579. /** @hidden */
  10580. _prepare(): void;
  10581. /**
  10582. * Execute the action and set the targetted property to the desired value.
  10583. */
  10584. execute(): void;
  10585. /**
  10586. * Serializes the actions and its related information.
  10587. * @param parent defines the object to serialize in
  10588. * @returns the serialized object
  10589. */
  10590. serialize(parent: any): any;
  10591. }
  10592. /**
  10593. * This defines an action responsible to increment the target value
  10594. * to a desired value once triggered.
  10595. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10596. */
  10597. export class IncrementValueAction extends Action {
  10598. /**
  10599. * The path of the property to increment in the target.
  10600. */
  10601. propertyPath: string;
  10602. /**
  10603. * The value we should increment the property by.
  10604. */
  10605. value: any;
  10606. private _target;
  10607. private _effectiveTarget;
  10608. private _property;
  10609. /**
  10610. * Instantiate the action
  10611. * @param triggerOptions defines the trigger options
  10612. * @param target defines the object containing the property
  10613. * @param propertyPath defines the path of the property to increment in the target
  10614. * @param value defines the value value we should increment the property by
  10615. * @param condition defines the trigger related conditions
  10616. */
  10617. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10618. /** @hidden */
  10619. _prepare(): void;
  10620. /**
  10621. * Execute the action and increment the target of the value amount.
  10622. */
  10623. execute(): void;
  10624. /**
  10625. * Serializes the actions and its related information.
  10626. * @param parent defines the object to serialize in
  10627. * @returns the serialized object
  10628. */
  10629. serialize(parent: any): any;
  10630. }
  10631. /**
  10632. * This defines an action responsible to start an animation once triggered.
  10633. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10634. */
  10635. export class PlayAnimationAction extends Action {
  10636. /**
  10637. * Where the animation should start (animation frame)
  10638. */
  10639. from: number;
  10640. /**
  10641. * Where the animation should stop (animation frame)
  10642. */
  10643. to: number;
  10644. /**
  10645. * Define if the animation should loop or stop after the first play.
  10646. */
  10647. loop?: boolean;
  10648. private _target;
  10649. /**
  10650. * Instantiate the action
  10651. * @param triggerOptions defines the trigger options
  10652. * @param target defines the target animation or animation name
  10653. * @param from defines from where the animation should start (animation frame)
  10654. * @param end defines where the animation should stop (animation frame)
  10655. * @param loop defines if the animation should loop or stop after the first play
  10656. * @param condition defines the trigger related conditions
  10657. */
  10658. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10659. /** @hidden */
  10660. _prepare(): void;
  10661. /**
  10662. * Execute the action and play the animation.
  10663. */
  10664. execute(): void;
  10665. /**
  10666. * Serializes the actions and its related information.
  10667. * @param parent defines the object to serialize in
  10668. * @returns the serialized object
  10669. */
  10670. serialize(parent: any): any;
  10671. }
  10672. /**
  10673. * This defines an action responsible to stop an animation once triggered.
  10674. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10675. */
  10676. export class StopAnimationAction extends Action {
  10677. private _target;
  10678. /**
  10679. * Instantiate the action
  10680. * @param triggerOptions defines the trigger options
  10681. * @param target defines the target animation or animation name
  10682. * @param condition defines the trigger related conditions
  10683. */
  10684. constructor(triggerOptions: any, target: any, condition?: Condition);
  10685. /** @hidden */
  10686. _prepare(): void;
  10687. /**
  10688. * Execute the action and stop the animation.
  10689. */
  10690. execute(): void;
  10691. /**
  10692. * Serializes the actions and its related information.
  10693. * @param parent defines the object to serialize in
  10694. * @returns the serialized object
  10695. */
  10696. serialize(parent: any): any;
  10697. }
  10698. /**
  10699. * This defines an action responsible that does nothing once triggered.
  10700. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10701. */
  10702. export class DoNothingAction extends Action {
  10703. /**
  10704. * Instantiate the action
  10705. * @param triggerOptions defines the trigger options
  10706. * @param condition defines the trigger related conditions
  10707. */
  10708. constructor(triggerOptions?: any, condition?: Condition);
  10709. /**
  10710. * Execute the action and do nothing.
  10711. */
  10712. execute(): void;
  10713. /**
  10714. * Serializes the actions and its related information.
  10715. * @param parent defines the object to serialize in
  10716. * @returns the serialized object
  10717. */
  10718. serialize(parent: any): any;
  10719. }
  10720. /**
  10721. * This defines an action responsible to trigger several actions once triggered.
  10722. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10723. */
  10724. export class CombineAction extends Action {
  10725. /**
  10726. * The list of aggregated animations to run.
  10727. */
  10728. children: Action[];
  10729. /**
  10730. * Instantiate the action
  10731. * @param triggerOptions defines the trigger options
  10732. * @param children defines the list of aggregated animations to run
  10733. * @param condition defines the trigger related conditions
  10734. */
  10735. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10736. /** @hidden */
  10737. _prepare(): void;
  10738. /**
  10739. * Execute the action and executes all the aggregated actions.
  10740. */
  10741. execute(evt: ActionEvent): void;
  10742. /**
  10743. * Serializes the actions and its related information.
  10744. * @param parent defines the object to serialize in
  10745. * @returns the serialized object
  10746. */
  10747. serialize(parent: any): any;
  10748. }
  10749. /**
  10750. * This defines an action responsible to run code (external event) once triggered.
  10751. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10752. */
  10753. export class ExecuteCodeAction extends Action {
  10754. /**
  10755. * The callback function to run.
  10756. */
  10757. func: (evt: ActionEvent) => void;
  10758. /**
  10759. * Instantiate the action
  10760. * @param triggerOptions defines the trigger options
  10761. * @param func defines the callback function to run
  10762. * @param condition defines the trigger related conditions
  10763. */
  10764. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10765. /**
  10766. * Execute the action and run the attached code.
  10767. */
  10768. execute(evt: ActionEvent): void;
  10769. }
  10770. /**
  10771. * This defines an action responsible to set the parent property of the target once triggered.
  10772. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10773. */
  10774. export class SetParentAction extends Action {
  10775. private _parent;
  10776. private _target;
  10777. /**
  10778. * Instantiate the action
  10779. * @param triggerOptions defines the trigger options
  10780. * @param target defines the target containing the parent property
  10781. * @param parent defines from where the animation should start (animation frame)
  10782. * @param condition defines the trigger related conditions
  10783. */
  10784. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10785. /** @hidden */
  10786. _prepare(): void;
  10787. /**
  10788. * Execute the action and set the parent property.
  10789. */
  10790. execute(): void;
  10791. /**
  10792. * Serializes the actions and its related information.
  10793. * @param parent defines the object to serialize in
  10794. * @returns the serialized object
  10795. */
  10796. serialize(parent: any): any;
  10797. }
  10798. }
  10799. declare module "babylonjs/Actions/actionManager" {
  10800. import { Nullable } from "babylonjs/types";
  10801. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10802. import { Scene } from "babylonjs/scene";
  10803. import { IAction } from "babylonjs/Actions/action";
  10804. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10805. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10806. /**
  10807. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10808. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10809. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10810. */
  10811. export class ActionManager extends AbstractActionManager {
  10812. /**
  10813. * Nothing
  10814. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10815. */
  10816. static readonly NothingTrigger: number;
  10817. /**
  10818. * On pick
  10819. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10820. */
  10821. static readonly OnPickTrigger: number;
  10822. /**
  10823. * On left pick
  10824. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10825. */
  10826. static readonly OnLeftPickTrigger: number;
  10827. /**
  10828. * On right pick
  10829. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10830. */
  10831. static readonly OnRightPickTrigger: number;
  10832. /**
  10833. * On center pick
  10834. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10835. */
  10836. static readonly OnCenterPickTrigger: number;
  10837. /**
  10838. * On pick down
  10839. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10840. */
  10841. static readonly OnPickDownTrigger: number;
  10842. /**
  10843. * On double pick
  10844. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10845. */
  10846. static readonly OnDoublePickTrigger: number;
  10847. /**
  10848. * On pick up
  10849. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10850. */
  10851. static readonly OnPickUpTrigger: number;
  10852. /**
  10853. * On pick out.
  10854. * This trigger will only be raised if you also declared a OnPickDown
  10855. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10856. */
  10857. static readonly OnPickOutTrigger: number;
  10858. /**
  10859. * On long press
  10860. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10861. */
  10862. static readonly OnLongPressTrigger: number;
  10863. /**
  10864. * On pointer over
  10865. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10866. */
  10867. static readonly OnPointerOverTrigger: number;
  10868. /**
  10869. * On pointer out
  10870. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10871. */
  10872. static readonly OnPointerOutTrigger: number;
  10873. /**
  10874. * On every frame
  10875. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10876. */
  10877. static readonly OnEveryFrameTrigger: number;
  10878. /**
  10879. * On intersection enter
  10880. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10881. */
  10882. static readonly OnIntersectionEnterTrigger: number;
  10883. /**
  10884. * On intersection exit
  10885. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10886. */
  10887. static readonly OnIntersectionExitTrigger: number;
  10888. /**
  10889. * On key down
  10890. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10891. */
  10892. static readonly OnKeyDownTrigger: number;
  10893. /**
  10894. * On key up
  10895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10896. */
  10897. static readonly OnKeyUpTrigger: number;
  10898. private _scene;
  10899. /**
  10900. * Creates a new action manager
  10901. * @param scene defines the hosting scene
  10902. */
  10903. constructor(scene: Scene);
  10904. /**
  10905. * Releases all associated resources
  10906. */
  10907. dispose(): void;
  10908. /**
  10909. * Gets hosting scene
  10910. * @returns the hosting scene
  10911. */
  10912. getScene(): Scene;
  10913. /**
  10914. * Does this action manager handles actions of any of the given triggers
  10915. * @param triggers defines the triggers to be tested
  10916. * @return a boolean indicating whether one (or more) of the triggers is handled
  10917. */
  10918. hasSpecificTriggers(triggers: number[]): boolean;
  10919. /**
  10920. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10921. * speed.
  10922. * @param triggerA defines the trigger to be tested
  10923. * @param triggerB defines the trigger to be tested
  10924. * @return a boolean indicating whether one (or more) of the triggers is handled
  10925. */
  10926. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10927. /**
  10928. * Does this action manager handles actions of a given trigger
  10929. * @param trigger defines the trigger to be tested
  10930. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10931. * @return whether the trigger is handled
  10932. */
  10933. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10934. /**
  10935. * Does this action manager has pointer triggers
  10936. */
  10937. readonly hasPointerTriggers: boolean;
  10938. /**
  10939. * Does this action manager has pick triggers
  10940. */
  10941. readonly hasPickTriggers: boolean;
  10942. /**
  10943. * Registers an action to this action manager
  10944. * @param action defines the action to be registered
  10945. * @return the action amended (prepared) after registration
  10946. */
  10947. registerAction(action: IAction): Nullable<IAction>;
  10948. /**
  10949. * Unregisters an action to this action manager
  10950. * @param action defines the action to be unregistered
  10951. * @return a boolean indicating whether the action has been unregistered
  10952. */
  10953. unregisterAction(action: IAction): Boolean;
  10954. /**
  10955. * Process a specific trigger
  10956. * @param trigger defines the trigger to process
  10957. * @param evt defines the event details to be processed
  10958. */
  10959. processTrigger(trigger: number, evt?: IActionEvent): void;
  10960. /** @hidden */
  10961. _getEffectiveTarget(target: any, propertyPath: string): any;
  10962. /** @hidden */
  10963. _getProperty(propertyPath: string): string;
  10964. /**
  10965. * Serialize this manager to a JSON object
  10966. * @param name defines the property name to store this manager
  10967. * @returns a JSON representation of this manager
  10968. */
  10969. serialize(name: string): any;
  10970. /**
  10971. * Creates a new ActionManager from a JSON data
  10972. * @param parsedActions defines the JSON data to read from
  10973. * @param object defines the hosting mesh
  10974. * @param scene defines the hosting scene
  10975. */
  10976. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10977. /**
  10978. * Get a trigger name by index
  10979. * @param trigger defines the trigger index
  10980. * @returns a trigger name
  10981. */
  10982. static GetTriggerName(trigger: number): string;
  10983. }
  10984. }
  10985. declare module "babylonjs/Culling/ray" {
  10986. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10987. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10988. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10989. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10990. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10991. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10992. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10993. import { Plane } from "babylonjs/Maths/math.plane";
  10994. /**
  10995. * Class representing a ray with position and direction
  10996. */
  10997. export class Ray {
  10998. /** origin point */
  10999. origin: Vector3;
  11000. /** direction */
  11001. direction: Vector3;
  11002. /** length of the ray */
  11003. length: number;
  11004. private static readonly TmpVector3;
  11005. private _tmpRay;
  11006. /**
  11007. * Creates a new ray
  11008. * @param origin origin point
  11009. * @param direction direction
  11010. * @param length length of the ray
  11011. */
  11012. constructor(
  11013. /** origin point */
  11014. origin: Vector3,
  11015. /** direction */
  11016. direction: Vector3,
  11017. /** length of the ray */
  11018. length?: number);
  11019. /**
  11020. * Checks if the ray intersects a box
  11021. * @param minimum bound of the box
  11022. * @param maximum bound of the box
  11023. * @param intersectionTreshold extra extend to be added to the box in all direction
  11024. * @returns if the box was hit
  11025. */
  11026. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11027. /**
  11028. * Checks if the ray intersects a box
  11029. * @param box the bounding box to check
  11030. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11031. * @returns if the box was hit
  11032. */
  11033. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11034. /**
  11035. * If the ray hits a sphere
  11036. * @param sphere the bounding sphere to check
  11037. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11038. * @returns true if it hits the sphere
  11039. */
  11040. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11041. /**
  11042. * If the ray hits a triange
  11043. * @param vertex0 triangle vertex
  11044. * @param vertex1 triangle vertex
  11045. * @param vertex2 triangle vertex
  11046. * @returns intersection information if hit
  11047. */
  11048. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11049. /**
  11050. * Checks if ray intersects a plane
  11051. * @param plane the plane to check
  11052. * @returns the distance away it was hit
  11053. */
  11054. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11055. /**
  11056. * Calculate the intercept of a ray on a given axis
  11057. * @param axis to check 'x' | 'y' | 'z'
  11058. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11059. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11060. */
  11061. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11062. /**
  11063. * Checks if ray intersects a mesh
  11064. * @param mesh the mesh to check
  11065. * @param fastCheck if only the bounding box should checked
  11066. * @returns picking info of the intersecton
  11067. */
  11068. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11069. /**
  11070. * Checks if ray intersects a mesh
  11071. * @param meshes the meshes to check
  11072. * @param fastCheck if only the bounding box should checked
  11073. * @param results array to store result in
  11074. * @returns Array of picking infos
  11075. */
  11076. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11077. private _comparePickingInfo;
  11078. private static smallnum;
  11079. private static rayl;
  11080. /**
  11081. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11082. * @param sega the first point of the segment to test the intersection against
  11083. * @param segb the second point of the segment to test the intersection against
  11084. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11085. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11086. */
  11087. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11088. /**
  11089. * Update the ray from viewport position
  11090. * @param x position
  11091. * @param y y position
  11092. * @param viewportWidth viewport width
  11093. * @param viewportHeight viewport height
  11094. * @param world world matrix
  11095. * @param view view matrix
  11096. * @param projection projection matrix
  11097. * @returns this ray updated
  11098. */
  11099. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11100. /**
  11101. * Creates a ray with origin and direction of 0,0,0
  11102. * @returns the new ray
  11103. */
  11104. static Zero(): Ray;
  11105. /**
  11106. * Creates a new ray from screen space and viewport
  11107. * @param x position
  11108. * @param y y position
  11109. * @param viewportWidth viewport width
  11110. * @param viewportHeight viewport height
  11111. * @param world world matrix
  11112. * @param view view matrix
  11113. * @param projection projection matrix
  11114. * @returns new ray
  11115. */
  11116. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11117. /**
  11118. * 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
  11119. * transformed to the given world matrix.
  11120. * @param origin The origin point
  11121. * @param end The end point
  11122. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11123. * @returns the new ray
  11124. */
  11125. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11126. /**
  11127. * Transforms a ray by a matrix
  11128. * @param ray ray to transform
  11129. * @param matrix matrix to apply
  11130. * @returns the resulting new ray
  11131. */
  11132. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11133. /**
  11134. * Transforms a ray by a matrix
  11135. * @param ray ray to transform
  11136. * @param matrix matrix to apply
  11137. * @param result ray to store result in
  11138. */
  11139. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11140. /**
  11141. * Unproject a ray from screen space to object space
  11142. * @param sourceX defines the screen space x coordinate to use
  11143. * @param sourceY defines the screen space y coordinate to use
  11144. * @param viewportWidth defines the current width of the viewport
  11145. * @param viewportHeight defines the current height of the viewport
  11146. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11147. * @param view defines the view matrix to use
  11148. * @param projection defines the projection matrix to use
  11149. */
  11150. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11151. }
  11152. /**
  11153. * Type used to define predicate used to select faces when a mesh intersection is detected
  11154. */
  11155. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11156. module "babylonjs/scene" {
  11157. interface Scene {
  11158. /** @hidden */
  11159. _tempPickingRay: Nullable<Ray>;
  11160. /** @hidden */
  11161. _cachedRayForTransform: Ray;
  11162. /** @hidden */
  11163. _pickWithRayInverseMatrix: Matrix;
  11164. /** @hidden */
  11165. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11166. /** @hidden */
  11167. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11168. }
  11169. }
  11170. }
  11171. declare module "babylonjs/sceneComponent" {
  11172. import { Scene } from "babylonjs/scene";
  11173. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11174. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11175. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11176. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11177. import { Nullable } from "babylonjs/types";
  11178. import { Camera } from "babylonjs/Cameras/camera";
  11179. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11180. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11181. import { AbstractScene } from "babylonjs/abstractScene";
  11182. /**
  11183. * Groups all the scene component constants in one place to ease maintenance.
  11184. * @hidden
  11185. */
  11186. export class SceneComponentConstants {
  11187. static readonly NAME_EFFECTLAYER: string;
  11188. static readonly NAME_LAYER: string;
  11189. static readonly NAME_LENSFLARESYSTEM: string;
  11190. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11191. static readonly NAME_PARTICLESYSTEM: string;
  11192. static readonly NAME_GAMEPAD: string;
  11193. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11194. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11195. static readonly NAME_DEPTHRENDERER: string;
  11196. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11197. static readonly NAME_SPRITE: string;
  11198. static readonly NAME_OUTLINERENDERER: string;
  11199. static readonly NAME_PROCEDURALTEXTURE: string;
  11200. static readonly NAME_SHADOWGENERATOR: string;
  11201. static readonly NAME_OCTREE: string;
  11202. static readonly NAME_PHYSICSENGINE: string;
  11203. static readonly NAME_AUDIO: string;
  11204. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11205. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11206. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11207. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11208. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11209. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11210. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11211. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11212. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11213. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11214. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11215. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11216. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11217. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11218. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11219. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11220. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11221. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11222. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11223. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11224. static readonly STEP_AFTERRENDER_AUDIO: number;
  11225. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11226. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11227. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11228. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11229. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11230. static readonly STEP_POINTERMOVE_SPRITE: number;
  11231. static readonly STEP_POINTERDOWN_SPRITE: number;
  11232. static readonly STEP_POINTERUP_SPRITE: number;
  11233. }
  11234. /**
  11235. * This represents a scene component.
  11236. *
  11237. * This is used to decouple the dependency the scene is having on the different workloads like
  11238. * layers, post processes...
  11239. */
  11240. export interface ISceneComponent {
  11241. /**
  11242. * The name of the component. Each component must have a unique name.
  11243. */
  11244. name: string;
  11245. /**
  11246. * The scene the component belongs to.
  11247. */
  11248. scene: Scene;
  11249. /**
  11250. * Register the component to one instance of a scene.
  11251. */
  11252. register(): void;
  11253. /**
  11254. * Rebuilds the elements related to this component in case of
  11255. * context lost for instance.
  11256. */
  11257. rebuild(): void;
  11258. /**
  11259. * Disposes the component and the associated ressources.
  11260. */
  11261. dispose(): void;
  11262. }
  11263. /**
  11264. * This represents a SERIALIZABLE scene component.
  11265. *
  11266. * This extends Scene Component to add Serialization methods on top.
  11267. */
  11268. export interface ISceneSerializableComponent extends ISceneComponent {
  11269. /**
  11270. * Adds all the elements from the container to the scene
  11271. * @param container the container holding the elements
  11272. */
  11273. addFromContainer(container: AbstractScene): void;
  11274. /**
  11275. * Removes all the elements in the container from the scene
  11276. * @param container contains the elements to remove
  11277. * @param dispose if the removed element should be disposed (default: false)
  11278. */
  11279. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11280. /**
  11281. * Serializes the component data to the specified json object
  11282. * @param serializationObject The object to serialize to
  11283. */
  11284. serialize(serializationObject: any): void;
  11285. }
  11286. /**
  11287. * Strong typing of a Mesh related stage step action
  11288. */
  11289. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11290. /**
  11291. * Strong typing of a Evaluate Sub Mesh related stage step action
  11292. */
  11293. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11294. /**
  11295. * Strong typing of a Active Mesh related stage step action
  11296. */
  11297. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11298. /**
  11299. * Strong typing of a Camera related stage step action
  11300. */
  11301. export type CameraStageAction = (camera: Camera) => void;
  11302. /**
  11303. * Strong typing of a Camera Frame buffer related stage step action
  11304. */
  11305. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11306. /**
  11307. * Strong typing of a Render Target related stage step action
  11308. */
  11309. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11310. /**
  11311. * Strong typing of a RenderingGroup related stage step action
  11312. */
  11313. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11314. /**
  11315. * Strong typing of a Mesh Render related stage step action
  11316. */
  11317. export type RenderingMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11318. /**
  11319. * Strong typing of a simple stage step action
  11320. */
  11321. export type SimpleStageAction = () => void;
  11322. /**
  11323. * Strong typing of a render target action.
  11324. */
  11325. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11326. /**
  11327. * Strong typing of a pointer move action.
  11328. */
  11329. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  11330. /**
  11331. * Strong typing of a pointer up/down action.
  11332. */
  11333. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11334. /**
  11335. * Repressentation of a stage in the scene (Basically a list of ordered steps)
  11336. * @hidden
  11337. */
  11338. export class Stage<T extends Function> extends Array<{
  11339. index: number;
  11340. component: ISceneComponent;
  11341. action: T;
  11342. }> {
  11343. /**
  11344. * Hide ctor from the rest of the world.
  11345. * @param items The items to add.
  11346. */
  11347. private constructor();
  11348. /**
  11349. * Creates a new Stage.
  11350. * @returns A new instance of a Stage
  11351. */
  11352. static Create<T extends Function>(): Stage<T>;
  11353. /**
  11354. * Registers a step in an ordered way in the targeted stage.
  11355. * @param index Defines the position to register the step in
  11356. * @param component Defines the component attached to the step
  11357. * @param action Defines the action to launch during the step
  11358. */
  11359. registerStep(index: number, component: ISceneComponent, action: T): void;
  11360. /**
  11361. * Clears all the steps from the stage.
  11362. */
  11363. clear(): void;
  11364. }
  11365. }
  11366. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11367. import { Nullable } from "babylonjs/types";
  11368. import { Observable } from "babylonjs/Misc/observable";
  11369. import { Scene } from "babylonjs/scene";
  11370. import { Sprite } from "babylonjs/Sprites/sprite";
  11371. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11372. import { Ray } from "babylonjs/Culling/ray";
  11373. import { Camera } from "babylonjs/Cameras/camera";
  11374. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11375. import { ISceneComponent } from "babylonjs/sceneComponent";
  11376. module "babylonjs/scene" {
  11377. interface Scene {
  11378. /** @hidden */
  11379. _pointerOverSprite: Nullable<Sprite>;
  11380. /** @hidden */
  11381. _pickedDownSprite: Nullable<Sprite>;
  11382. /** @hidden */
  11383. _tempSpritePickingRay: Nullable<Ray>;
  11384. /**
  11385. * All of the sprite managers added to this scene
  11386. * @see http://doc.babylonjs.com/babylon101/sprites
  11387. */
  11388. spriteManagers: Array<ISpriteManager>;
  11389. /**
  11390. * An event triggered when sprites rendering is about to start
  11391. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11392. */
  11393. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11394. /**
  11395. * An event triggered when sprites rendering is done
  11396. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11397. */
  11398. onAfterSpritesRenderingObservable: Observable<Scene>;
  11399. /** @hidden */
  11400. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11401. /** Launch a ray to try to pick a sprite in the scene
  11402. * @param x position on screen
  11403. * @param y position on screen
  11404. * @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
  11405. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11406. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11407. * @returns a PickingInfo
  11408. */
  11409. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11410. /** Use the given ray to pick a sprite in the scene
  11411. * @param ray The ray (in world space) to use to pick meshes
  11412. * @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
  11413. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11414. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11415. * @returns a PickingInfo
  11416. */
  11417. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11418. /** @hidden */
  11419. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11420. /** Launch a ray to try to pick sprites in the scene
  11421. * @param x position on screen
  11422. * @param y position on screen
  11423. * @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
  11424. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11425. * @returns a PickingInfo array
  11426. */
  11427. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11428. /** Use the given ray to pick sprites in the scene
  11429. * @param ray The ray (in world space) to use to pick meshes
  11430. * @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
  11431. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11432. * @returns a PickingInfo array
  11433. */
  11434. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11435. /**
  11436. * Force the sprite under the pointer
  11437. * @param sprite defines the sprite to use
  11438. */
  11439. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11440. /**
  11441. * Gets the sprite under the pointer
  11442. * @returns a Sprite or null if no sprite is under the pointer
  11443. */
  11444. getPointerOverSprite(): Nullable<Sprite>;
  11445. }
  11446. }
  11447. /**
  11448. * Defines the sprite scene component responsible to manage sprites
  11449. * in a given scene.
  11450. */
  11451. export class SpriteSceneComponent implements ISceneComponent {
  11452. /**
  11453. * The component name helpfull to identify the component in the list of scene components.
  11454. */
  11455. readonly name: string;
  11456. /**
  11457. * The scene the component belongs to.
  11458. */
  11459. scene: Scene;
  11460. /** @hidden */
  11461. private _spritePredicate;
  11462. /**
  11463. * Creates a new instance of the component for the given scene
  11464. * @param scene Defines the scene to register the component in
  11465. */
  11466. constructor(scene: Scene);
  11467. /**
  11468. * Registers the component in a given scene
  11469. */
  11470. register(): void;
  11471. /**
  11472. * Rebuilds the elements related to this component in case of
  11473. * context lost for instance.
  11474. */
  11475. rebuild(): void;
  11476. /**
  11477. * Disposes the component and the associated ressources.
  11478. */
  11479. dispose(): void;
  11480. private _pickSpriteButKeepRay;
  11481. private _pointerMove;
  11482. private _pointerDown;
  11483. private _pointerUp;
  11484. }
  11485. }
  11486. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11487. /** @hidden */
  11488. export var fogFragmentDeclaration: {
  11489. name: string;
  11490. shader: string;
  11491. };
  11492. }
  11493. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11494. /** @hidden */
  11495. export var fogFragment: {
  11496. name: string;
  11497. shader: string;
  11498. };
  11499. }
  11500. declare module "babylonjs/Shaders/sprites.fragment" {
  11501. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11502. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11503. /** @hidden */
  11504. export var spritesPixelShader: {
  11505. name: string;
  11506. shader: string;
  11507. };
  11508. }
  11509. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11510. /** @hidden */
  11511. export var fogVertexDeclaration: {
  11512. name: string;
  11513. shader: string;
  11514. };
  11515. }
  11516. declare module "babylonjs/Shaders/sprites.vertex" {
  11517. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11518. /** @hidden */
  11519. export var spritesVertexShader: {
  11520. name: string;
  11521. shader: string;
  11522. };
  11523. }
  11524. declare module "babylonjs/Sprites/spriteManager" {
  11525. import { IDisposable, Scene } from "babylonjs/scene";
  11526. import { Nullable } from "babylonjs/types";
  11527. import { Observable } from "babylonjs/Misc/observable";
  11528. import { Sprite } from "babylonjs/Sprites/sprite";
  11529. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11530. import { Camera } from "babylonjs/Cameras/camera";
  11531. import { Texture } from "babylonjs/Materials/Textures/texture";
  11532. import "babylonjs/Shaders/sprites.fragment";
  11533. import "babylonjs/Shaders/sprites.vertex";
  11534. import { Ray } from "babylonjs/Culling/ray";
  11535. /**
  11536. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11537. */
  11538. export interface ISpriteManager extends IDisposable {
  11539. /**
  11540. * Restricts the camera to viewing objects with the same layerMask.
  11541. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11542. */
  11543. layerMask: number;
  11544. /**
  11545. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11546. */
  11547. isPickable: boolean;
  11548. /**
  11549. * Specifies the rendering group id for this mesh (0 by default)
  11550. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11551. */
  11552. renderingGroupId: number;
  11553. /**
  11554. * Defines the list of sprites managed by the manager.
  11555. */
  11556. sprites: Array<Sprite>;
  11557. /**
  11558. * Tests the intersection of a sprite with a specific ray.
  11559. * @param ray The ray we are sending to test the collision
  11560. * @param camera The camera space we are sending rays in
  11561. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11562. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11563. * @returns picking info or null.
  11564. */
  11565. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11566. /**
  11567. * Intersects the sprites with a ray
  11568. * @param ray defines the ray to intersect with
  11569. * @param camera defines the current active camera
  11570. * @param predicate defines a predicate used to select candidate sprites
  11571. * @returns null if no hit or a PickingInfo array
  11572. */
  11573. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11574. /**
  11575. * Renders the list of sprites on screen.
  11576. */
  11577. render(): void;
  11578. }
  11579. /**
  11580. * Class used to manage multiple sprites on the same spritesheet
  11581. * @see http://doc.babylonjs.com/babylon101/sprites
  11582. */
  11583. export class SpriteManager implements ISpriteManager {
  11584. /** defines the manager's name */
  11585. name: string;
  11586. /** Gets the list of sprites */
  11587. sprites: Sprite[];
  11588. /** Gets or sets the rendering group id (0 by default) */
  11589. renderingGroupId: number;
  11590. /** Gets or sets camera layer mask */
  11591. layerMask: number;
  11592. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11593. fogEnabled: boolean;
  11594. /** Gets or sets a boolean indicating if the sprites are pickable */
  11595. isPickable: boolean;
  11596. /** Defines the default width of a cell in the spritesheet */
  11597. cellWidth: number;
  11598. /** Defines the default height of a cell in the spritesheet */
  11599. cellHeight: number;
  11600. /** Associative array from JSON sprite data file */
  11601. private _cellData;
  11602. /** Array of sprite names from JSON sprite data file */
  11603. private _spriteMap;
  11604. /** True when packed cell data from JSON file is ready*/
  11605. private _packedAndReady;
  11606. /**
  11607. * An event triggered when the manager is disposed.
  11608. */
  11609. onDisposeObservable: Observable<SpriteManager>;
  11610. private _onDisposeObserver;
  11611. /**
  11612. * Callback called when the manager is disposed
  11613. */
  11614. onDispose: () => void;
  11615. private _capacity;
  11616. private _fromPacked;
  11617. private _spriteTexture;
  11618. private _epsilon;
  11619. private _scene;
  11620. private _vertexData;
  11621. private _buffer;
  11622. private _vertexBuffers;
  11623. private _indexBuffer;
  11624. private _effectBase;
  11625. private _effectFog;
  11626. /**
  11627. * Gets or sets the spritesheet texture
  11628. */
  11629. texture: Texture;
  11630. /**
  11631. * Creates a new sprite manager
  11632. * @param name defines the manager's name
  11633. * @param imgUrl defines the sprite sheet url
  11634. * @param capacity defines the maximum allowed number of sprites
  11635. * @param cellSize defines the size of a sprite cell
  11636. * @param scene defines the hosting scene
  11637. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11638. * @param samplingMode defines the smapling mode to use with spritesheet
  11639. * @param fromPacked set to false; do not alter
  11640. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11641. */
  11642. constructor(
  11643. /** defines the manager's name */
  11644. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11645. private _makePacked;
  11646. private _appendSpriteVertex;
  11647. /**
  11648. * Intersects the sprites with a ray
  11649. * @param ray defines the ray to intersect with
  11650. * @param camera defines the current active camera
  11651. * @param predicate defines a predicate used to select candidate sprites
  11652. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11653. * @returns null if no hit or a PickingInfo
  11654. */
  11655. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11656. /**
  11657. * Intersects the sprites with a ray
  11658. * @param ray defines the ray to intersect with
  11659. * @param camera defines the current active camera
  11660. * @param predicate defines a predicate used to select candidate sprites
  11661. * @returns null if no hit or a PickingInfo array
  11662. */
  11663. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11664. /**
  11665. * Render all child sprites
  11666. */
  11667. render(): void;
  11668. /**
  11669. * Release associated resources
  11670. */
  11671. dispose(): void;
  11672. }
  11673. }
  11674. declare module "babylonjs/Sprites/sprite" {
  11675. import { Vector3 } from "babylonjs/Maths/math.vector";
  11676. import { Nullable } from "babylonjs/types";
  11677. import { ActionManager } from "babylonjs/Actions/actionManager";
  11678. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11679. import { Color4 } from "babylonjs/Maths/math.color";
  11680. /**
  11681. * Class used to represent a sprite
  11682. * @see http://doc.babylonjs.com/babylon101/sprites
  11683. */
  11684. export class Sprite {
  11685. /** defines the name */
  11686. name: string;
  11687. /** Gets or sets the current world position */
  11688. position: Vector3;
  11689. /** Gets or sets the main color */
  11690. color: Color4;
  11691. /** Gets or sets the width */
  11692. width: number;
  11693. /** Gets or sets the height */
  11694. height: number;
  11695. /** Gets or sets rotation angle */
  11696. angle: number;
  11697. /** Gets or sets the cell index in the sprite sheet */
  11698. cellIndex: number;
  11699. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11700. cellRef: string;
  11701. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11702. invertU: number;
  11703. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11704. invertV: number;
  11705. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11706. disposeWhenFinishedAnimating: boolean;
  11707. /** Gets the list of attached animations */
  11708. animations: Animation[];
  11709. /** Gets or sets a boolean indicating if the sprite can be picked */
  11710. isPickable: boolean;
  11711. /**
  11712. * Gets or sets the associated action manager
  11713. */
  11714. actionManager: Nullable<ActionManager>;
  11715. private _animationStarted;
  11716. private _loopAnimation;
  11717. private _fromIndex;
  11718. private _toIndex;
  11719. private _delay;
  11720. private _direction;
  11721. private _manager;
  11722. private _time;
  11723. private _onAnimationEnd;
  11724. /**
  11725. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11726. */
  11727. isVisible: boolean;
  11728. /**
  11729. * Gets or sets the sprite size
  11730. */
  11731. size: number;
  11732. /**
  11733. * Creates a new Sprite
  11734. * @param name defines the name
  11735. * @param manager defines the manager
  11736. */
  11737. constructor(
  11738. /** defines the name */
  11739. name: string, manager: ISpriteManager);
  11740. /**
  11741. * Starts an animation
  11742. * @param from defines the initial key
  11743. * @param to defines the end key
  11744. * @param loop defines if the animation must loop
  11745. * @param delay defines the start delay (in ms)
  11746. * @param onAnimationEnd defines a callback to call when animation ends
  11747. */
  11748. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11749. /** Stops current animation (if any) */
  11750. stopAnimation(): void;
  11751. /** @hidden */
  11752. _animate(deltaTime: number): void;
  11753. /** Release associated resources */
  11754. dispose(): void;
  11755. }
  11756. }
  11757. declare module "babylonjs/Collisions/pickingInfo" {
  11758. import { Nullable } from "babylonjs/types";
  11759. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11760. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11761. import { Sprite } from "babylonjs/Sprites/sprite";
  11762. import { Ray } from "babylonjs/Culling/ray";
  11763. /**
  11764. * Information about the result of picking within a scene
  11765. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11766. */
  11767. export class PickingInfo {
  11768. /** @hidden */
  11769. _pickingUnavailable: boolean;
  11770. /**
  11771. * If the pick collided with an object
  11772. */
  11773. hit: boolean;
  11774. /**
  11775. * Distance away where the pick collided
  11776. */
  11777. distance: number;
  11778. /**
  11779. * The location of pick collision
  11780. */
  11781. pickedPoint: Nullable<Vector3>;
  11782. /**
  11783. * The mesh corresponding the the pick collision
  11784. */
  11785. pickedMesh: Nullable<AbstractMesh>;
  11786. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11787. bu: number;
  11788. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11789. bv: number;
  11790. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11791. faceId: number;
  11792. /** Id of the the submesh that was picked */
  11793. subMeshId: number;
  11794. /** If a sprite was picked, this will be the sprite the pick collided with */
  11795. pickedSprite: Nullable<Sprite>;
  11796. /**
  11797. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  11798. */
  11799. originMesh: Nullable<AbstractMesh>;
  11800. /**
  11801. * The ray that was used to perform the picking.
  11802. */
  11803. ray: Nullable<Ray>;
  11804. /**
  11805. * Gets the normal correspodning to the face the pick collided with
  11806. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  11807. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  11808. * @returns The normal correspodning to the face the pick collided with
  11809. */
  11810. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  11811. /**
  11812. * Gets the texture coordinates of where the pick occured
  11813. * @returns the vector containing the coordnates of the texture
  11814. */
  11815. getTextureCoordinates(): Nullable<Vector2>;
  11816. }
  11817. }
  11818. declare module "babylonjs/Events/pointerEvents" {
  11819. import { Nullable } from "babylonjs/types";
  11820. import { Vector2 } from "babylonjs/Maths/math.vector";
  11821. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11822. import { Ray } from "babylonjs/Culling/ray";
  11823. /**
  11824. * Gather the list of pointer event types as constants.
  11825. */
  11826. export class PointerEventTypes {
  11827. /**
  11828. * 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.
  11829. */
  11830. static readonly POINTERDOWN: number;
  11831. /**
  11832. * The pointerup event is fired when a pointer is no longer active.
  11833. */
  11834. static readonly POINTERUP: number;
  11835. /**
  11836. * The pointermove event is fired when a pointer changes coordinates.
  11837. */
  11838. static readonly POINTERMOVE: number;
  11839. /**
  11840. * The pointerwheel event is fired when a mouse wheel has been rotated.
  11841. */
  11842. static readonly POINTERWHEEL: number;
  11843. /**
  11844. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  11845. */
  11846. static readonly POINTERPICK: number;
  11847. /**
  11848. * The pointertap event is fired when a the object has been touched and released without drag.
  11849. */
  11850. static readonly POINTERTAP: number;
  11851. /**
  11852. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  11853. */
  11854. static readonly POINTERDOUBLETAP: number;
  11855. }
  11856. /**
  11857. * Base class of pointer info types.
  11858. */
  11859. export class PointerInfoBase {
  11860. /**
  11861. * Defines the type of event (PointerEventTypes)
  11862. */
  11863. type: number;
  11864. /**
  11865. * Defines the related dom event
  11866. */
  11867. event: PointerEvent | MouseWheelEvent;
  11868. /**
  11869. * Instantiates the base class of pointers info.
  11870. * @param type Defines the type of event (PointerEventTypes)
  11871. * @param event Defines the related dom event
  11872. */
  11873. constructor(
  11874. /**
  11875. * Defines the type of event (PointerEventTypes)
  11876. */
  11877. type: number,
  11878. /**
  11879. * Defines the related dom event
  11880. */
  11881. event: PointerEvent | MouseWheelEvent);
  11882. }
  11883. /**
  11884. * This class is used to store pointer related info for the onPrePointerObservable event.
  11885. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  11886. */
  11887. export class PointerInfoPre extends PointerInfoBase {
  11888. /**
  11889. * Ray from a pointer if availible (eg. 6dof controller)
  11890. */
  11891. ray: Nullable<Ray>;
  11892. /**
  11893. * Defines the local position of the pointer on the canvas.
  11894. */
  11895. localPosition: Vector2;
  11896. /**
  11897. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  11898. */
  11899. skipOnPointerObservable: boolean;
  11900. /**
  11901. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  11902. * @param type Defines the type of event (PointerEventTypes)
  11903. * @param event Defines the related dom event
  11904. * @param localX Defines the local x coordinates of the pointer when the event occured
  11905. * @param localY Defines the local y coordinates of the pointer when the event occured
  11906. */
  11907. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  11908. }
  11909. /**
  11910. * This type contains all the data related to a pointer event in Babylon.js.
  11911. * 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.
  11912. */
  11913. export class PointerInfo extends PointerInfoBase {
  11914. /**
  11915. * Defines the picking info associated to the info (if any)\
  11916. */
  11917. pickInfo: Nullable<PickingInfo>;
  11918. /**
  11919. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  11920. * @param type Defines the type of event (PointerEventTypes)
  11921. * @param event Defines the related dom event
  11922. * @param pickInfo Defines the picking info associated to the info (if any)\
  11923. */
  11924. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  11925. /**
  11926. * Defines the picking info associated to the info (if any)\
  11927. */
  11928. pickInfo: Nullable<PickingInfo>);
  11929. }
  11930. /**
  11931. * Data relating to a touch event on the screen.
  11932. */
  11933. export interface PointerTouch {
  11934. /**
  11935. * X coordinate of touch.
  11936. */
  11937. x: number;
  11938. /**
  11939. * Y coordinate of touch.
  11940. */
  11941. y: number;
  11942. /**
  11943. * Id of touch. Unique for each finger.
  11944. */
  11945. pointerId: number;
  11946. /**
  11947. * Event type passed from DOM.
  11948. */
  11949. type: any;
  11950. }
  11951. }
  11952. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  11953. import { Observable } from "babylonjs/Misc/observable";
  11954. import { Nullable } from "babylonjs/types";
  11955. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  11956. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  11957. /**
  11958. * Manage the mouse inputs to control the movement of a free camera.
  11959. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  11960. */
  11961. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  11962. /**
  11963. * Define if touch is enabled in the mouse input
  11964. */
  11965. touchEnabled: boolean;
  11966. /**
  11967. * Defines the camera the input is attached to.
  11968. */
  11969. camera: FreeCamera;
  11970. /**
  11971. * Defines the buttons associated with the input to handle camera move.
  11972. */
  11973. buttons: number[];
  11974. /**
  11975. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  11976. */
  11977. angularSensibility: number;
  11978. private _pointerInput;
  11979. private _onMouseMove;
  11980. private _observer;
  11981. private previousPosition;
  11982. /**
  11983. * Observable for when a pointer move event occurs containing the move offset
  11984. */
  11985. onPointerMovedObservable: Observable<{
  11986. offsetX: number;
  11987. offsetY: number;
  11988. }>;
  11989. /**
  11990. * @hidden
  11991. * If the camera should be rotated automatically based on pointer movement
  11992. */
  11993. _allowCameraRotation: boolean;
  11994. /**
  11995. * Manage the mouse inputs to control the movement of a free camera.
  11996. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  11997. * @param touchEnabled Defines if touch is enabled or not
  11998. */
  11999. constructor(
  12000. /**
  12001. * Define if touch is enabled in the mouse input
  12002. */
  12003. touchEnabled?: boolean);
  12004. /**
  12005. * Attach the input controls to a specific dom element to get the input from.
  12006. * @param element Defines the element the controls should be listened from
  12007. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12008. */
  12009. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12010. /**
  12011. * Called on JS contextmenu event.
  12012. * Override this method to provide functionality.
  12013. */
  12014. protected onContextMenu(evt: PointerEvent): void;
  12015. /**
  12016. * Detach the current controls from the specified dom element.
  12017. * @param element Defines the element to stop listening the inputs from
  12018. */
  12019. detachControl(element: Nullable<HTMLElement>): void;
  12020. /**
  12021. * Gets the class name of the current intput.
  12022. * @returns the class name
  12023. */
  12024. getClassName(): string;
  12025. /**
  12026. * Get the friendly name associated with the input class.
  12027. * @returns the input friendly name
  12028. */
  12029. getSimpleName(): string;
  12030. }
  12031. }
  12032. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12033. import { Nullable } from "babylonjs/types";
  12034. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12035. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12036. /**
  12037. * Manage the touch inputs to control the movement of a free camera.
  12038. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12039. */
  12040. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12041. /**
  12042. * Defines the camera the input is attached to.
  12043. */
  12044. camera: FreeCamera;
  12045. /**
  12046. * Defines the touch sensibility for rotation.
  12047. * The higher the faster.
  12048. */
  12049. touchAngularSensibility: number;
  12050. /**
  12051. * Defines the touch sensibility for move.
  12052. * The higher the faster.
  12053. */
  12054. touchMoveSensibility: number;
  12055. private _offsetX;
  12056. private _offsetY;
  12057. private _pointerPressed;
  12058. private _pointerInput;
  12059. private _observer;
  12060. private _onLostFocus;
  12061. /**
  12062. * Attach the input controls to a specific dom element to get the input from.
  12063. * @param element Defines the element the controls should be listened from
  12064. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12065. */
  12066. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12067. /**
  12068. * Detach the current controls from the specified dom element.
  12069. * @param element Defines the element to stop listening the inputs from
  12070. */
  12071. detachControl(element: Nullable<HTMLElement>): void;
  12072. /**
  12073. * Update the current camera state depending on the inputs that have been used this frame.
  12074. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12075. */
  12076. checkInputs(): void;
  12077. /**
  12078. * Gets the class name of the current intput.
  12079. * @returns the class name
  12080. */
  12081. getClassName(): string;
  12082. /**
  12083. * Get the friendly name associated with the input class.
  12084. * @returns the input friendly name
  12085. */
  12086. getSimpleName(): string;
  12087. }
  12088. }
  12089. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12090. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12091. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12092. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12093. import { Nullable } from "babylonjs/types";
  12094. /**
  12095. * Default Inputs manager for the FreeCamera.
  12096. * It groups all the default supported inputs for ease of use.
  12097. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12098. */
  12099. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12100. /**
  12101. * @hidden
  12102. */
  12103. _mouseInput: Nullable<FreeCameraMouseInput>;
  12104. /**
  12105. * Instantiates a new FreeCameraInputsManager.
  12106. * @param camera Defines the camera the inputs belong to
  12107. */
  12108. constructor(camera: FreeCamera);
  12109. /**
  12110. * Add keyboard input support to the input manager.
  12111. * @returns the current input manager
  12112. */
  12113. addKeyboard(): FreeCameraInputsManager;
  12114. /**
  12115. * Add mouse input support to the input manager.
  12116. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12117. * @returns the current input manager
  12118. */
  12119. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12120. /**
  12121. * Removes the mouse input support from the manager
  12122. * @returns the current input manager
  12123. */
  12124. removeMouse(): FreeCameraInputsManager;
  12125. /**
  12126. * Add touch input support to the input manager.
  12127. * @returns the current input manager
  12128. */
  12129. addTouch(): FreeCameraInputsManager;
  12130. /**
  12131. * Remove all attached input methods from a camera
  12132. */
  12133. clear(): void;
  12134. }
  12135. }
  12136. declare module "babylonjs/Cameras/freeCamera" {
  12137. import { Vector3 } from "babylonjs/Maths/math.vector";
  12138. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12139. import { Scene } from "babylonjs/scene";
  12140. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12141. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12142. /**
  12143. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12144. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12145. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12146. */
  12147. export class FreeCamera extends TargetCamera {
  12148. /**
  12149. * Define the collision ellipsoid of the camera.
  12150. * This is helpful to simulate a camera body like the player body around the camera
  12151. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12152. */
  12153. ellipsoid: Vector3;
  12154. /**
  12155. * Define an offset for the position of the ellipsoid around the camera.
  12156. * This can be helpful to determine the center of the body near the gravity center of the body
  12157. * instead of its head.
  12158. */
  12159. ellipsoidOffset: Vector3;
  12160. /**
  12161. * Enable or disable collisions of the camera with the rest of the scene objects.
  12162. */
  12163. checkCollisions: boolean;
  12164. /**
  12165. * Enable or disable gravity on the camera.
  12166. */
  12167. applyGravity: boolean;
  12168. /**
  12169. * Define the input manager associated to the camera.
  12170. */
  12171. inputs: FreeCameraInputsManager;
  12172. /**
  12173. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12174. * Higher values reduce sensitivity.
  12175. */
  12176. /**
  12177. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12178. * Higher values reduce sensitivity.
  12179. */
  12180. angularSensibility: number;
  12181. /**
  12182. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12183. */
  12184. keysUp: number[];
  12185. /**
  12186. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12187. */
  12188. keysDown: number[];
  12189. /**
  12190. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12191. */
  12192. keysLeft: number[];
  12193. /**
  12194. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12195. */
  12196. keysRight: number[];
  12197. /**
  12198. * Event raised when the camera collide with a mesh in the scene.
  12199. */
  12200. onCollide: (collidedMesh: AbstractMesh) => void;
  12201. private _collider;
  12202. private _needMoveForGravity;
  12203. private _oldPosition;
  12204. private _diffPosition;
  12205. private _newPosition;
  12206. /** @hidden */
  12207. _localDirection: Vector3;
  12208. /** @hidden */
  12209. _transformedDirection: Vector3;
  12210. /**
  12211. * Instantiates a Free Camera.
  12212. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12213. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12214. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12215. * @param name Define the name of the camera in the scene
  12216. * @param position Define the start position of the camera in the scene
  12217. * @param scene Define the scene the camera belongs to
  12218. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12219. */
  12220. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12221. /**
  12222. * Attached controls to the current camera.
  12223. * @param element Defines the element the controls should be listened from
  12224. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12225. */
  12226. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12227. /**
  12228. * Detach the current controls from the camera.
  12229. * The camera will stop reacting to inputs.
  12230. * @param element Defines the element to stop listening the inputs from
  12231. */
  12232. detachControl(element: HTMLElement): void;
  12233. private _collisionMask;
  12234. /**
  12235. * Define a collision mask to limit the list of object the camera can collide with
  12236. */
  12237. collisionMask: number;
  12238. /** @hidden */
  12239. _collideWithWorld(displacement: Vector3): void;
  12240. private _onCollisionPositionChange;
  12241. /** @hidden */
  12242. _checkInputs(): void;
  12243. /** @hidden */
  12244. _decideIfNeedsToMove(): boolean;
  12245. /** @hidden */
  12246. _updatePosition(): void;
  12247. /**
  12248. * Destroy the camera and release the current resources hold by it.
  12249. */
  12250. dispose(): void;
  12251. /**
  12252. * Gets the current object class name.
  12253. * @return the class name
  12254. */
  12255. getClassName(): string;
  12256. }
  12257. }
  12258. declare module "babylonjs/Gamepads/gamepad" {
  12259. import { Observable } from "babylonjs/Misc/observable";
  12260. /**
  12261. * Represents a gamepad control stick position
  12262. */
  12263. export class StickValues {
  12264. /**
  12265. * The x component of the control stick
  12266. */
  12267. x: number;
  12268. /**
  12269. * The y component of the control stick
  12270. */
  12271. y: number;
  12272. /**
  12273. * Initializes the gamepad x and y control stick values
  12274. * @param x The x component of the gamepad control stick value
  12275. * @param y The y component of the gamepad control stick value
  12276. */
  12277. constructor(
  12278. /**
  12279. * The x component of the control stick
  12280. */
  12281. x: number,
  12282. /**
  12283. * The y component of the control stick
  12284. */
  12285. y: number);
  12286. }
  12287. /**
  12288. * An interface which manages callbacks for gamepad button changes
  12289. */
  12290. export interface GamepadButtonChanges {
  12291. /**
  12292. * Called when a gamepad has been changed
  12293. */
  12294. changed: boolean;
  12295. /**
  12296. * Called when a gamepad press event has been triggered
  12297. */
  12298. pressChanged: boolean;
  12299. /**
  12300. * Called when a touch event has been triggered
  12301. */
  12302. touchChanged: boolean;
  12303. /**
  12304. * Called when a value has changed
  12305. */
  12306. valueChanged: boolean;
  12307. }
  12308. /**
  12309. * Represents a gamepad
  12310. */
  12311. export class Gamepad {
  12312. /**
  12313. * The id of the gamepad
  12314. */
  12315. id: string;
  12316. /**
  12317. * The index of the gamepad
  12318. */
  12319. index: number;
  12320. /**
  12321. * The browser gamepad
  12322. */
  12323. browserGamepad: any;
  12324. /**
  12325. * Specifies what type of gamepad this represents
  12326. */
  12327. type: number;
  12328. private _leftStick;
  12329. private _rightStick;
  12330. /** @hidden */
  12331. _isConnected: boolean;
  12332. private _leftStickAxisX;
  12333. private _leftStickAxisY;
  12334. private _rightStickAxisX;
  12335. private _rightStickAxisY;
  12336. /**
  12337. * Triggered when the left control stick has been changed
  12338. */
  12339. private _onleftstickchanged;
  12340. /**
  12341. * Triggered when the right control stick has been changed
  12342. */
  12343. private _onrightstickchanged;
  12344. /**
  12345. * Represents a gamepad controller
  12346. */
  12347. static GAMEPAD: number;
  12348. /**
  12349. * Represents a generic controller
  12350. */
  12351. static GENERIC: number;
  12352. /**
  12353. * Represents an XBox controller
  12354. */
  12355. static XBOX: number;
  12356. /**
  12357. * Represents a pose-enabled controller
  12358. */
  12359. static POSE_ENABLED: number;
  12360. /**
  12361. * Represents an Dual Shock controller
  12362. */
  12363. static DUALSHOCK: number;
  12364. /**
  12365. * Specifies whether the left control stick should be Y-inverted
  12366. */
  12367. protected _invertLeftStickY: boolean;
  12368. /**
  12369. * Specifies if the gamepad has been connected
  12370. */
  12371. readonly isConnected: boolean;
  12372. /**
  12373. * Initializes the gamepad
  12374. * @param id The id of the gamepad
  12375. * @param index The index of the gamepad
  12376. * @param browserGamepad The browser gamepad
  12377. * @param leftStickX The x component of the left joystick
  12378. * @param leftStickY The y component of the left joystick
  12379. * @param rightStickX The x component of the right joystick
  12380. * @param rightStickY The y component of the right joystick
  12381. */
  12382. constructor(
  12383. /**
  12384. * The id of the gamepad
  12385. */
  12386. id: string,
  12387. /**
  12388. * The index of the gamepad
  12389. */
  12390. index: number,
  12391. /**
  12392. * The browser gamepad
  12393. */
  12394. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12395. /**
  12396. * Callback triggered when the left joystick has changed
  12397. * @param callback
  12398. */
  12399. onleftstickchanged(callback: (values: StickValues) => void): void;
  12400. /**
  12401. * Callback triggered when the right joystick has changed
  12402. * @param callback
  12403. */
  12404. onrightstickchanged(callback: (values: StickValues) => void): void;
  12405. /**
  12406. * Gets the left joystick
  12407. */
  12408. /**
  12409. * Sets the left joystick values
  12410. */
  12411. leftStick: StickValues;
  12412. /**
  12413. * Gets the right joystick
  12414. */
  12415. /**
  12416. * Sets the right joystick value
  12417. */
  12418. rightStick: StickValues;
  12419. /**
  12420. * Updates the gamepad joystick positions
  12421. */
  12422. update(): void;
  12423. /**
  12424. * Disposes the gamepad
  12425. */
  12426. dispose(): void;
  12427. }
  12428. /**
  12429. * Represents a generic gamepad
  12430. */
  12431. export class GenericPad extends Gamepad {
  12432. private _buttons;
  12433. private _onbuttondown;
  12434. private _onbuttonup;
  12435. /**
  12436. * Observable triggered when a button has been pressed
  12437. */
  12438. onButtonDownObservable: Observable<number>;
  12439. /**
  12440. * Observable triggered when a button has been released
  12441. */
  12442. onButtonUpObservable: Observable<number>;
  12443. /**
  12444. * Callback triggered when a button has been pressed
  12445. * @param callback Called when a button has been pressed
  12446. */
  12447. onbuttondown(callback: (buttonPressed: number) => void): void;
  12448. /**
  12449. * Callback triggered when a button has been released
  12450. * @param callback Called when a button has been released
  12451. */
  12452. onbuttonup(callback: (buttonReleased: number) => void): void;
  12453. /**
  12454. * Initializes the generic gamepad
  12455. * @param id The id of the generic gamepad
  12456. * @param index The index of the generic gamepad
  12457. * @param browserGamepad The browser gamepad
  12458. */
  12459. constructor(id: string, index: number, browserGamepad: any);
  12460. private _setButtonValue;
  12461. /**
  12462. * Updates the generic gamepad
  12463. */
  12464. update(): void;
  12465. /**
  12466. * Disposes the generic gamepad
  12467. */
  12468. dispose(): void;
  12469. }
  12470. }
  12471. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12472. import { Nullable } from "babylonjs/types";
  12473. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12474. import { Scene } from "babylonjs/scene";
  12475. module "babylonjs/Engines/engine" {
  12476. interface Engine {
  12477. /**
  12478. * Creates a raw texture
  12479. * @param data defines the data to store in the texture
  12480. * @param width defines the width of the texture
  12481. * @param height defines the height of the texture
  12482. * @param format defines the format of the data
  12483. * @param generateMipMaps defines if the engine should generate the mip levels
  12484. * @param invertY defines if data must be stored with Y axis inverted
  12485. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12486. * @param compression defines the compression used (null by default)
  12487. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12488. * @returns the raw texture inside an InternalTexture
  12489. */
  12490. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12491. /**
  12492. * Update a raw texture
  12493. * @param texture defines the texture to update
  12494. * @param data defines the data to store in the texture
  12495. * @param format defines the format of the data
  12496. * @param invertY defines if data must be stored with Y axis inverted
  12497. */
  12498. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12499. /**
  12500. * Update a raw texture
  12501. * @param texture defines the texture to update
  12502. * @param data defines the data to store in the texture
  12503. * @param format defines the format of the data
  12504. * @param invertY defines if data must be stored with Y axis inverted
  12505. * @param compression defines the compression used (null by default)
  12506. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12507. */
  12508. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12509. /**
  12510. * Creates a new raw cube texture
  12511. * @param data defines the array of data to use to create each face
  12512. * @param size defines the size of the textures
  12513. * @param format defines the format of the data
  12514. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12515. * @param generateMipMaps defines if the engine should generate the mip levels
  12516. * @param invertY defines if data must be stored with Y axis inverted
  12517. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12518. * @param compression defines the compression used (null by default)
  12519. * @returns the cube texture as an InternalTexture
  12520. */
  12521. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12522. /**
  12523. * Update a raw cube texture
  12524. * @param texture defines the texture to udpdate
  12525. * @param data defines the data to store
  12526. * @param format defines the data format
  12527. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12528. * @param invertY defines if data must be stored with Y axis inverted
  12529. */
  12530. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12531. /**
  12532. * Update a raw cube texture
  12533. * @param texture defines the texture to udpdate
  12534. * @param data defines the data to store
  12535. * @param format defines the data format
  12536. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12537. * @param invertY defines if data must be stored with Y axis inverted
  12538. * @param compression defines the compression used (null by default)
  12539. */
  12540. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12541. /**
  12542. * Update a raw cube texture
  12543. * @param texture defines the texture to udpdate
  12544. * @param data defines the data to store
  12545. * @param format defines the data format
  12546. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12547. * @param invertY defines if data must be stored with Y axis inverted
  12548. * @param compression defines the compression used (null by default)
  12549. * @param level defines which level of the texture to update
  12550. */
  12551. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12552. /**
  12553. * Creates a new raw cube texture from a specified url
  12554. * @param url defines the url where the data is located
  12555. * @param scene defines the current scene
  12556. * @param size defines the size of the textures
  12557. * @param format defines the format of the data
  12558. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12559. * @param noMipmap defines if the engine should avoid generating the mip levels
  12560. * @param callback defines a callback used to extract texture data from loaded data
  12561. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12562. * @param onLoad defines a callback called when texture is loaded
  12563. * @param onError defines a callback called if there is an error
  12564. * @returns the cube texture as an InternalTexture
  12565. */
  12566. 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;
  12567. /**
  12568. * Creates a new raw cube texture from a specified url
  12569. * @param url defines the url where the data is located
  12570. * @param scene defines the current scene
  12571. * @param size defines the size of the textures
  12572. * @param format defines the format of the data
  12573. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12574. * @param noMipmap defines if the engine should avoid generating the mip levels
  12575. * @param callback defines a callback used to extract texture data from loaded data
  12576. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12577. * @param onLoad defines a callback called when texture is loaded
  12578. * @param onError defines a callback called if there is an error
  12579. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12580. * @param invertY defines if data must be stored with Y axis inverted
  12581. * @returns the cube texture as an InternalTexture
  12582. */
  12583. 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;
  12584. /**
  12585. * Creates a new raw 3D texture
  12586. * @param data defines the data used to create the texture
  12587. * @param width defines the width of the texture
  12588. * @param height defines the height of the texture
  12589. * @param depth defines the depth of the texture
  12590. * @param format defines the format of the texture
  12591. * @param generateMipMaps defines if the engine must generate mip levels
  12592. * @param invertY defines if data must be stored with Y axis inverted
  12593. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12594. * @param compression defines the compressed used (can be null)
  12595. * @param textureType defines the compressed used (can be null)
  12596. * @returns a new raw 3D texture (stored in an InternalTexture)
  12597. */
  12598. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12599. /**
  12600. * Update a raw 3D texture
  12601. * @param texture defines the texture to update
  12602. * @param data defines the data to store
  12603. * @param format defines the data format
  12604. * @param invertY defines if data must be stored with Y axis inverted
  12605. */
  12606. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12607. /**
  12608. * Update a raw 3D texture
  12609. * @param texture defines the texture to update
  12610. * @param data defines the data to store
  12611. * @param format defines the data format
  12612. * @param invertY defines if data must be stored with Y axis inverted
  12613. * @param compression defines the used compression (can be null)
  12614. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12615. */
  12616. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12617. }
  12618. }
  12619. }
  12620. declare module "babylonjs/Materials/Textures/rawTexture" {
  12621. import { Scene } from "babylonjs/scene";
  12622. import { Texture } from "babylonjs/Materials/Textures/texture";
  12623. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12624. /**
  12625. * Raw texture can help creating a texture directly from an array of data.
  12626. * This can be super useful if you either get the data from an uncompressed source or
  12627. * if you wish to create your texture pixel by pixel.
  12628. */
  12629. export class RawTexture extends Texture {
  12630. /**
  12631. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12632. */
  12633. format: number;
  12634. private _engine;
  12635. /**
  12636. * Instantiates a new RawTexture.
  12637. * Raw texture can help creating a texture directly from an array of data.
  12638. * This can be super useful if you either get the data from an uncompressed source or
  12639. * if you wish to create your texture pixel by pixel.
  12640. * @param data define the array of data to use to create the texture
  12641. * @param width define the width of the texture
  12642. * @param height define the height of the texture
  12643. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12644. * @param scene define the scene the texture belongs to
  12645. * @param generateMipMaps define whether mip maps should be generated or not
  12646. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12647. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12648. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12649. */
  12650. constructor(data: ArrayBufferView, width: number, height: number,
  12651. /**
  12652. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12653. */
  12654. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12655. /**
  12656. * Updates the texture underlying data.
  12657. * @param data Define the new data of the texture
  12658. */
  12659. update(data: ArrayBufferView): void;
  12660. /**
  12661. * Creates a luminance texture from some data.
  12662. * @param data Define the texture data
  12663. * @param width Define the width of the texture
  12664. * @param height Define the height of the texture
  12665. * @param scene Define the scene the texture belongs to
  12666. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12667. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12668. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12669. * @returns the luminance texture
  12670. */
  12671. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12672. /**
  12673. * Creates a luminance alpha texture from some data.
  12674. * @param data Define the texture data
  12675. * @param width Define the width of the texture
  12676. * @param height Define the height of the texture
  12677. * @param scene Define the scene the texture belongs to
  12678. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12679. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12680. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12681. * @returns the luminance alpha texture
  12682. */
  12683. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12684. /**
  12685. * Creates an alpha texture from some data.
  12686. * @param data Define the texture data
  12687. * @param width Define the width of the texture
  12688. * @param height Define the height of the texture
  12689. * @param scene Define the scene the texture belongs to
  12690. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12691. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12692. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12693. * @returns the alpha texture
  12694. */
  12695. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12696. /**
  12697. * Creates a RGB texture from some data.
  12698. * @param data Define the texture data
  12699. * @param width Define the width of the texture
  12700. * @param height Define the height of the texture
  12701. * @param scene Define the scene the texture belongs to
  12702. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12703. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12704. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12705. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12706. * @returns the RGB alpha texture
  12707. */
  12708. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12709. /**
  12710. * Creates a RGBA texture from some data.
  12711. * @param data Define the texture data
  12712. * @param width Define the width of the texture
  12713. * @param height Define the height of the texture
  12714. * @param scene Define the scene the texture belongs to
  12715. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12716. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12717. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12718. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12719. * @returns the RGBA texture
  12720. */
  12721. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12722. /**
  12723. * Creates a R texture from some data.
  12724. * @param data Define the texture data
  12725. * @param width Define the width of the texture
  12726. * @param height Define the height of the texture
  12727. * @param scene Define the scene the texture belongs to
  12728. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12729. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12730. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12731. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12732. * @returns the R texture
  12733. */
  12734. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12735. }
  12736. }
  12737. declare module "babylonjs/Maths/math.size" {
  12738. /**
  12739. * Interface for the size containing width and height
  12740. */
  12741. export interface ISize {
  12742. /**
  12743. * Width
  12744. */
  12745. width: number;
  12746. /**
  12747. * Heighht
  12748. */
  12749. height: number;
  12750. }
  12751. /**
  12752. * Size containing widht and height
  12753. */
  12754. export class Size implements ISize {
  12755. /**
  12756. * Width
  12757. */
  12758. width: number;
  12759. /**
  12760. * Height
  12761. */
  12762. height: number;
  12763. /**
  12764. * Creates a Size object from the given width and height (floats).
  12765. * @param width width of the new size
  12766. * @param height height of the new size
  12767. */
  12768. constructor(width: number, height: number);
  12769. /**
  12770. * Returns a string with the Size width and height
  12771. * @returns a string with the Size width and height
  12772. */
  12773. toString(): string;
  12774. /**
  12775. * "Size"
  12776. * @returns the string "Size"
  12777. */
  12778. getClassName(): string;
  12779. /**
  12780. * Returns the Size hash code.
  12781. * @returns a hash code for a unique width and height
  12782. */
  12783. getHashCode(): number;
  12784. /**
  12785. * Updates the current size from the given one.
  12786. * @param src the given size
  12787. */
  12788. copyFrom(src: Size): void;
  12789. /**
  12790. * Updates in place the current Size from the given floats.
  12791. * @param width width of the new size
  12792. * @param height height of the new size
  12793. * @returns the updated Size.
  12794. */
  12795. copyFromFloats(width: number, height: number): Size;
  12796. /**
  12797. * Updates in place the current Size from the given floats.
  12798. * @param width width to set
  12799. * @param height height to set
  12800. * @returns the updated Size.
  12801. */
  12802. set(width: number, height: number): Size;
  12803. /**
  12804. * Multiplies the width and height by numbers
  12805. * @param w factor to multiple the width by
  12806. * @param h factor to multiple the height by
  12807. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  12808. */
  12809. multiplyByFloats(w: number, h: number): Size;
  12810. /**
  12811. * Clones the size
  12812. * @returns a new Size copied from the given one.
  12813. */
  12814. clone(): Size;
  12815. /**
  12816. * True if the current Size and the given one width and height are strictly equal.
  12817. * @param other the other size to compare against
  12818. * @returns True if the current Size and the given one width and height are strictly equal.
  12819. */
  12820. equals(other: Size): boolean;
  12821. /**
  12822. * The surface of the Size : width * height (float).
  12823. */
  12824. readonly surface: number;
  12825. /**
  12826. * Create a new size of zero
  12827. * @returns a new Size set to (0.0, 0.0)
  12828. */
  12829. static Zero(): Size;
  12830. /**
  12831. * Sums the width and height of two sizes
  12832. * @param otherSize size to add to this size
  12833. * @returns a new Size set as the addition result of the current Size and the given one.
  12834. */
  12835. add(otherSize: Size): Size;
  12836. /**
  12837. * Subtracts the width and height of two
  12838. * @param otherSize size to subtract to this size
  12839. * @returns a new Size set as the subtraction result of the given one from the current Size.
  12840. */
  12841. subtract(otherSize: Size): Size;
  12842. /**
  12843. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  12844. * @param start starting size to lerp between
  12845. * @param end end size to lerp between
  12846. * @param amount amount to lerp between the start and end values
  12847. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  12848. */
  12849. static Lerp(start: Size, end: Size, amount: number): Size;
  12850. }
  12851. }
  12852. declare module "babylonjs/Animations/runtimeAnimation" {
  12853. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  12854. import { Animatable } from "babylonjs/Animations/animatable";
  12855. import { Scene } from "babylonjs/scene";
  12856. /**
  12857. * Defines a runtime animation
  12858. */
  12859. export class RuntimeAnimation {
  12860. private _events;
  12861. /**
  12862. * The current frame of the runtime animation
  12863. */
  12864. private _currentFrame;
  12865. /**
  12866. * The animation used by the runtime animation
  12867. */
  12868. private _animation;
  12869. /**
  12870. * The target of the runtime animation
  12871. */
  12872. private _target;
  12873. /**
  12874. * The initiating animatable
  12875. */
  12876. private _host;
  12877. /**
  12878. * The original value of the runtime animation
  12879. */
  12880. private _originalValue;
  12881. /**
  12882. * The original blend value of the runtime animation
  12883. */
  12884. private _originalBlendValue;
  12885. /**
  12886. * The offsets cache of the runtime animation
  12887. */
  12888. private _offsetsCache;
  12889. /**
  12890. * The high limits cache of the runtime animation
  12891. */
  12892. private _highLimitsCache;
  12893. /**
  12894. * Specifies if the runtime animation has been stopped
  12895. */
  12896. private _stopped;
  12897. /**
  12898. * The blending factor of the runtime animation
  12899. */
  12900. private _blendingFactor;
  12901. /**
  12902. * The BabylonJS scene
  12903. */
  12904. private _scene;
  12905. /**
  12906. * The current value of the runtime animation
  12907. */
  12908. private _currentValue;
  12909. /** @hidden */
  12910. _animationState: _IAnimationState;
  12911. /**
  12912. * The active target of the runtime animation
  12913. */
  12914. private _activeTargets;
  12915. private _currentActiveTarget;
  12916. private _directTarget;
  12917. /**
  12918. * The target path of the runtime animation
  12919. */
  12920. private _targetPath;
  12921. /**
  12922. * The weight of the runtime animation
  12923. */
  12924. private _weight;
  12925. /**
  12926. * The ratio offset of the runtime animation
  12927. */
  12928. private _ratioOffset;
  12929. /**
  12930. * The previous delay of the runtime animation
  12931. */
  12932. private _previousDelay;
  12933. /**
  12934. * The previous ratio of the runtime animation
  12935. */
  12936. private _previousRatio;
  12937. private _enableBlending;
  12938. private _keys;
  12939. private _minFrame;
  12940. private _maxFrame;
  12941. private _minValue;
  12942. private _maxValue;
  12943. private _targetIsArray;
  12944. /**
  12945. * Gets the current frame of the runtime animation
  12946. */
  12947. readonly currentFrame: number;
  12948. /**
  12949. * Gets the weight of the runtime animation
  12950. */
  12951. readonly weight: number;
  12952. /**
  12953. * Gets the current value of the runtime animation
  12954. */
  12955. readonly currentValue: any;
  12956. /**
  12957. * Gets the target path of the runtime animation
  12958. */
  12959. readonly targetPath: string;
  12960. /**
  12961. * Gets the actual target of the runtime animation
  12962. */
  12963. readonly target: any;
  12964. /** @hidden */
  12965. _onLoop: () => void;
  12966. /**
  12967. * Create a new RuntimeAnimation object
  12968. * @param target defines the target of the animation
  12969. * @param animation defines the source animation object
  12970. * @param scene defines the hosting scene
  12971. * @param host defines the initiating Animatable
  12972. */
  12973. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  12974. private _preparePath;
  12975. /**
  12976. * Gets the animation from the runtime animation
  12977. */
  12978. readonly animation: Animation;
  12979. /**
  12980. * Resets the runtime animation to the beginning
  12981. * @param restoreOriginal defines whether to restore the target property to the original value
  12982. */
  12983. reset(restoreOriginal?: boolean): void;
  12984. /**
  12985. * Specifies if the runtime animation is stopped
  12986. * @returns Boolean specifying if the runtime animation is stopped
  12987. */
  12988. isStopped(): boolean;
  12989. /**
  12990. * Disposes of the runtime animation
  12991. */
  12992. dispose(): void;
  12993. /**
  12994. * Apply the interpolated value to the target
  12995. * @param currentValue defines the value computed by the animation
  12996. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  12997. */
  12998. setValue(currentValue: any, weight: number): void;
  12999. private _getOriginalValues;
  13000. private _setValue;
  13001. /**
  13002. * Gets the loop pmode of the runtime animation
  13003. * @returns Loop Mode
  13004. */
  13005. private _getCorrectLoopMode;
  13006. /**
  13007. * Move the current animation to a given frame
  13008. * @param frame defines the frame to move to
  13009. */
  13010. goToFrame(frame: number): void;
  13011. /**
  13012. * @hidden Internal use only
  13013. */
  13014. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13015. /**
  13016. * Execute the current animation
  13017. * @param delay defines the delay to add to the current frame
  13018. * @param from defines the lower bound of the animation range
  13019. * @param to defines the upper bound of the animation range
  13020. * @param loop defines if the current animation must loop
  13021. * @param speedRatio defines the current speed ratio
  13022. * @param weight defines the weight of the animation (default is -1 so no weight)
  13023. * @param onLoop optional callback called when animation loops
  13024. * @returns a boolean indicating if the animation is running
  13025. */
  13026. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13027. }
  13028. }
  13029. declare module "babylonjs/Animations/animatable" {
  13030. import { Animation } from "babylonjs/Animations/animation";
  13031. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13032. import { Nullable } from "babylonjs/types";
  13033. import { Observable } from "babylonjs/Misc/observable";
  13034. import { Scene } from "babylonjs/scene";
  13035. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13036. import { Node } from "babylonjs/node";
  13037. /**
  13038. * Class used to store an actual running animation
  13039. */
  13040. export class Animatable {
  13041. /** defines the target object */
  13042. target: any;
  13043. /** defines the starting frame number (default is 0) */
  13044. fromFrame: number;
  13045. /** defines the ending frame number (default is 100) */
  13046. toFrame: number;
  13047. /** defines if the animation must loop (default is false) */
  13048. loopAnimation: boolean;
  13049. /** defines a callback to call when animation ends if it is not looping */
  13050. onAnimationEnd?: (() => void) | null | undefined;
  13051. /** defines a callback to call when animation loops */
  13052. onAnimationLoop?: (() => void) | null | undefined;
  13053. private _localDelayOffset;
  13054. private _pausedDelay;
  13055. private _runtimeAnimations;
  13056. private _paused;
  13057. private _scene;
  13058. private _speedRatio;
  13059. private _weight;
  13060. private _syncRoot;
  13061. /**
  13062. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13063. * This will only apply for non looping animation (default is true)
  13064. */
  13065. disposeOnEnd: boolean;
  13066. /**
  13067. * Gets a boolean indicating if the animation has started
  13068. */
  13069. animationStarted: boolean;
  13070. /**
  13071. * Observer raised when the animation ends
  13072. */
  13073. onAnimationEndObservable: Observable<Animatable>;
  13074. /**
  13075. * Observer raised when the animation loops
  13076. */
  13077. onAnimationLoopObservable: Observable<Animatable>;
  13078. /**
  13079. * Gets the root Animatable used to synchronize and normalize animations
  13080. */
  13081. readonly syncRoot: Nullable<Animatable>;
  13082. /**
  13083. * Gets the current frame of the first RuntimeAnimation
  13084. * Used to synchronize Animatables
  13085. */
  13086. readonly masterFrame: number;
  13087. /**
  13088. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13089. */
  13090. weight: number;
  13091. /**
  13092. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13093. */
  13094. speedRatio: number;
  13095. /**
  13096. * Creates a new Animatable
  13097. * @param scene defines the hosting scene
  13098. * @param target defines the target object
  13099. * @param fromFrame defines the starting frame number (default is 0)
  13100. * @param toFrame defines the ending frame number (default is 100)
  13101. * @param loopAnimation defines if the animation must loop (default is false)
  13102. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13103. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13104. * @param animations defines a group of animation to add to the new Animatable
  13105. * @param onAnimationLoop defines a callback to call when animation loops
  13106. */
  13107. constructor(scene: Scene,
  13108. /** defines the target object */
  13109. target: any,
  13110. /** defines the starting frame number (default is 0) */
  13111. fromFrame?: number,
  13112. /** defines the ending frame number (default is 100) */
  13113. toFrame?: number,
  13114. /** defines if the animation must loop (default is false) */
  13115. loopAnimation?: boolean, speedRatio?: number,
  13116. /** defines a callback to call when animation ends if it is not looping */
  13117. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13118. /** defines a callback to call when animation loops */
  13119. onAnimationLoop?: (() => void) | null | undefined);
  13120. /**
  13121. * Synchronize and normalize current Animatable with a source Animatable
  13122. * This is useful when using animation weights and when animations are not of the same length
  13123. * @param root defines the root Animatable to synchronize with
  13124. * @returns the current Animatable
  13125. */
  13126. syncWith(root: Animatable): Animatable;
  13127. /**
  13128. * Gets the list of runtime animations
  13129. * @returns an array of RuntimeAnimation
  13130. */
  13131. getAnimations(): RuntimeAnimation[];
  13132. /**
  13133. * Adds more animations to the current animatable
  13134. * @param target defines the target of the animations
  13135. * @param animations defines the new animations to add
  13136. */
  13137. appendAnimations(target: any, animations: Animation[]): void;
  13138. /**
  13139. * Gets the source animation for a specific property
  13140. * @param property defines the propertyu to look for
  13141. * @returns null or the source animation for the given property
  13142. */
  13143. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13144. /**
  13145. * Gets the runtime animation for a specific property
  13146. * @param property defines the propertyu to look for
  13147. * @returns null or the runtime animation for the given property
  13148. */
  13149. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13150. /**
  13151. * Resets the animatable to its original state
  13152. */
  13153. reset(): void;
  13154. /**
  13155. * Allows the animatable to blend with current running animations
  13156. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13157. * @param blendingSpeed defines the blending speed to use
  13158. */
  13159. enableBlending(blendingSpeed: number): void;
  13160. /**
  13161. * Disable animation blending
  13162. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13163. */
  13164. disableBlending(): void;
  13165. /**
  13166. * Jump directly to a given frame
  13167. * @param frame defines the frame to jump to
  13168. */
  13169. goToFrame(frame: number): void;
  13170. /**
  13171. * Pause the animation
  13172. */
  13173. pause(): void;
  13174. /**
  13175. * Restart the animation
  13176. */
  13177. restart(): void;
  13178. private _raiseOnAnimationEnd;
  13179. /**
  13180. * Stop and delete the current animation
  13181. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13182. * @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)
  13183. */
  13184. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13185. /**
  13186. * Wait asynchronously for the animation to end
  13187. * @returns a promise which will be fullfilled when the animation ends
  13188. */
  13189. waitAsync(): Promise<Animatable>;
  13190. /** @hidden */
  13191. _animate(delay: number): boolean;
  13192. }
  13193. module "babylonjs/scene" {
  13194. interface Scene {
  13195. /** @hidden */
  13196. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13197. /** @hidden */
  13198. _processLateAnimationBindingsForMatrices(holder: {
  13199. totalWeight: number;
  13200. animations: RuntimeAnimation[];
  13201. originalValue: Matrix;
  13202. }): any;
  13203. /** @hidden */
  13204. _processLateAnimationBindingsForQuaternions(holder: {
  13205. totalWeight: number;
  13206. animations: RuntimeAnimation[];
  13207. originalValue: Quaternion;
  13208. }, refQuaternion: Quaternion): Quaternion;
  13209. /** @hidden */
  13210. _processLateAnimationBindings(): void;
  13211. /**
  13212. * Will start the animation sequence of a given target
  13213. * @param target defines the target
  13214. * @param from defines from which frame should animation start
  13215. * @param to defines until which frame should animation run.
  13216. * @param weight defines the weight to apply to the animation (1.0 by default)
  13217. * @param loop defines if the animation loops
  13218. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13219. * @param onAnimationEnd defines the function to be executed when the animation ends
  13220. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13221. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13222. * @param onAnimationLoop defines the callback to call when an animation loops
  13223. * @returns the animatable object created for this animation
  13224. */
  13225. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13226. /**
  13227. * Will start the animation sequence of a given target
  13228. * @param target defines the target
  13229. * @param from defines from which frame should animation start
  13230. * @param to defines until which frame should animation run.
  13231. * @param loop defines if the animation loops
  13232. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13233. * @param onAnimationEnd defines the function to be executed when the animation ends
  13234. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13235. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13236. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13237. * @param onAnimationLoop defines the callback to call when an animation loops
  13238. * @returns the animatable object created for this animation
  13239. */
  13240. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13241. /**
  13242. * Will start the animation sequence of a given target and its hierarchy
  13243. * @param target defines the target
  13244. * @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.
  13245. * @param from defines from which frame should animation start
  13246. * @param to defines until which frame should animation run.
  13247. * @param loop defines if the animation loops
  13248. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13249. * @param onAnimationEnd defines the function to be executed when the animation ends
  13250. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13251. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13252. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13253. * @param onAnimationLoop defines the callback to call when an animation loops
  13254. * @returns the list of created animatables
  13255. */
  13256. 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[];
  13257. /**
  13258. * Begin a new animation on a given node
  13259. * @param target defines the target where the animation will take place
  13260. * @param animations defines the list of animations to start
  13261. * @param from defines the initial value
  13262. * @param to defines the final value
  13263. * @param loop defines if you want animation to loop (off by default)
  13264. * @param speedRatio defines the speed ratio to apply to all animations
  13265. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13266. * @param onAnimationLoop defines the callback to call when an animation loops
  13267. * @returns the list of created animatables
  13268. */
  13269. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13270. /**
  13271. * Begin a new animation on a given node and its hierarchy
  13272. * @param target defines the root node where the animation will take place
  13273. * @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.
  13274. * @param animations defines the list of animations to start
  13275. * @param from defines the initial value
  13276. * @param to defines the final value
  13277. * @param loop defines if you want animation to loop (off by default)
  13278. * @param speedRatio defines the speed ratio to apply to all animations
  13279. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13280. * @param onAnimationLoop defines the callback to call when an animation loops
  13281. * @returns the list of animatables created for all nodes
  13282. */
  13283. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13284. /**
  13285. * Gets the animatable associated with a specific target
  13286. * @param target defines the target of the animatable
  13287. * @returns the required animatable if found
  13288. */
  13289. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13290. /**
  13291. * Gets all animatables associated with a given target
  13292. * @param target defines the target to look animatables for
  13293. * @returns an array of Animatables
  13294. */
  13295. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13296. /**
  13297. * Stops and removes all animations that have been applied to the scene
  13298. */
  13299. stopAllAnimations(): void;
  13300. }
  13301. }
  13302. module "babylonjs/Bones/bone" {
  13303. interface Bone {
  13304. /**
  13305. * Copy an animation range from another bone
  13306. * @param source defines the source bone
  13307. * @param rangeName defines the range name to copy
  13308. * @param frameOffset defines the frame offset
  13309. * @param rescaleAsRequired defines if rescaling must be applied if required
  13310. * @param skelDimensionsRatio defines the scaling ratio
  13311. * @returns true if operation was successful
  13312. */
  13313. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13314. }
  13315. }
  13316. }
  13317. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13318. /**
  13319. * Class used to override all child animations of a given target
  13320. */
  13321. export class AnimationPropertiesOverride {
  13322. /**
  13323. * Gets or sets a value indicating if animation blending must be used
  13324. */
  13325. enableBlending: boolean;
  13326. /**
  13327. * Gets or sets the blending speed to use when enableBlending is true
  13328. */
  13329. blendingSpeed: number;
  13330. /**
  13331. * Gets or sets the default loop mode to use
  13332. */
  13333. loopMode: number;
  13334. }
  13335. }
  13336. declare module "babylonjs/Bones/skeleton" {
  13337. import { Bone } from "babylonjs/Bones/bone";
  13338. import { Observable } from "babylonjs/Misc/observable";
  13339. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13340. import { Scene } from "babylonjs/scene";
  13341. import { Nullable } from "babylonjs/types";
  13342. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13343. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13344. import { Animatable } from "babylonjs/Animations/animatable";
  13345. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13346. import { Animation } from "babylonjs/Animations/animation";
  13347. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13348. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13349. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13350. /**
  13351. * Class used to handle skinning animations
  13352. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13353. */
  13354. export class Skeleton implements IAnimatable {
  13355. /** defines the skeleton name */
  13356. name: string;
  13357. /** defines the skeleton Id */
  13358. id: string;
  13359. /**
  13360. * Defines the list of child bones
  13361. */
  13362. bones: Bone[];
  13363. /**
  13364. * Defines an estimate of the dimension of the skeleton at rest
  13365. */
  13366. dimensionsAtRest: Vector3;
  13367. /**
  13368. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13369. */
  13370. needInitialSkinMatrix: boolean;
  13371. /**
  13372. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13373. */
  13374. overrideMesh: Nullable<AbstractMesh>;
  13375. /**
  13376. * Gets the list of animations attached to this skeleton
  13377. */
  13378. animations: Array<Animation>;
  13379. private _scene;
  13380. private _isDirty;
  13381. private _transformMatrices;
  13382. private _transformMatrixTexture;
  13383. private _meshesWithPoseMatrix;
  13384. private _animatables;
  13385. private _identity;
  13386. private _synchronizedWithMesh;
  13387. private _ranges;
  13388. private _lastAbsoluteTransformsUpdateId;
  13389. private _canUseTextureForBones;
  13390. private _uniqueId;
  13391. /** @hidden */
  13392. _numBonesWithLinkedTransformNode: number;
  13393. /** @hidden */
  13394. _hasWaitingData: Nullable<boolean>;
  13395. /**
  13396. * Specifies if the skeleton should be serialized
  13397. */
  13398. doNotSerialize: boolean;
  13399. private _useTextureToStoreBoneMatrices;
  13400. /**
  13401. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13402. * Please note that this option is not available if the hardware does not support it
  13403. */
  13404. useTextureToStoreBoneMatrices: boolean;
  13405. private _animationPropertiesOverride;
  13406. /**
  13407. * Gets or sets the animation properties override
  13408. */
  13409. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13410. /**
  13411. * List of inspectable custom properties (used by the Inspector)
  13412. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13413. */
  13414. inspectableCustomProperties: IInspectable[];
  13415. /**
  13416. * An observable triggered before computing the skeleton's matrices
  13417. */
  13418. onBeforeComputeObservable: Observable<Skeleton>;
  13419. /**
  13420. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13421. */
  13422. readonly isUsingTextureForMatrices: boolean;
  13423. /**
  13424. * Gets the unique ID of this skeleton
  13425. */
  13426. readonly uniqueId: number;
  13427. /**
  13428. * Creates a new skeleton
  13429. * @param name defines the skeleton name
  13430. * @param id defines the skeleton Id
  13431. * @param scene defines the hosting scene
  13432. */
  13433. constructor(
  13434. /** defines the skeleton name */
  13435. name: string,
  13436. /** defines the skeleton Id */
  13437. id: string, scene: Scene);
  13438. /**
  13439. * Gets the current object class name.
  13440. * @return the class name
  13441. */
  13442. getClassName(): string;
  13443. /**
  13444. * Returns an array containing the root bones
  13445. * @returns an array containing the root bones
  13446. */
  13447. getChildren(): Array<Bone>;
  13448. /**
  13449. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13450. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13451. * @returns a Float32Array containing matrices data
  13452. */
  13453. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13454. /**
  13455. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13456. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13457. * @returns a raw texture containing the data
  13458. */
  13459. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13460. /**
  13461. * Gets the current hosting scene
  13462. * @returns a scene object
  13463. */
  13464. getScene(): Scene;
  13465. /**
  13466. * Gets a string representing the current skeleton data
  13467. * @param fullDetails defines a boolean indicating if we want a verbose version
  13468. * @returns a string representing the current skeleton data
  13469. */
  13470. toString(fullDetails?: boolean): string;
  13471. /**
  13472. * Get bone's index searching by name
  13473. * @param name defines bone's name to search for
  13474. * @return the indice of the bone. Returns -1 if not found
  13475. */
  13476. getBoneIndexByName(name: string): number;
  13477. /**
  13478. * Creater a new animation range
  13479. * @param name defines the name of the range
  13480. * @param from defines the start key
  13481. * @param to defines the end key
  13482. */
  13483. createAnimationRange(name: string, from: number, to: number): void;
  13484. /**
  13485. * Delete a specific animation range
  13486. * @param name defines the name of the range
  13487. * @param deleteFrames defines if frames must be removed as well
  13488. */
  13489. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13490. /**
  13491. * Gets a specific animation range
  13492. * @param name defines the name of the range to look for
  13493. * @returns the requested animation range or null if not found
  13494. */
  13495. getAnimationRange(name: string): Nullable<AnimationRange>;
  13496. /**
  13497. * Gets the list of all animation ranges defined on this skeleton
  13498. * @returns an array
  13499. */
  13500. getAnimationRanges(): Nullable<AnimationRange>[];
  13501. /**
  13502. * Copy animation range from a source skeleton.
  13503. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13504. * @param source defines the source skeleton
  13505. * @param name defines the name of the range to copy
  13506. * @param rescaleAsRequired defines if rescaling must be applied if required
  13507. * @returns true if operation was successful
  13508. */
  13509. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13510. /**
  13511. * Forces the skeleton to go to rest pose
  13512. */
  13513. returnToRest(): void;
  13514. private _getHighestAnimationFrame;
  13515. /**
  13516. * Begin a specific animation range
  13517. * @param name defines the name of the range to start
  13518. * @param loop defines if looping must be turned on (false by default)
  13519. * @param speedRatio defines the speed ratio to apply (1 by default)
  13520. * @param onAnimationEnd defines a callback which will be called when animation will end
  13521. * @returns a new animatable
  13522. */
  13523. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13524. /** @hidden */
  13525. _markAsDirty(): void;
  13526. /** @hidden */
  13527. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13528. /** @hidden */
  13529. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13530. private _computeTransformMatrices;
  13531. /**
  13532. * Build all resources required to render a skeleton
  13533. */
  13534. prepare(): void;
  13535. /**
  13536. * Gets the list of animatables currently running for this skeleton
  13537. * @returns an array of animatables
  13538. */
  13539. getAnimatables(): IAnimatable[];
  13540. /**
  13541. * Clone the current skeleton
  13542. * @param name defines the name of the new skeleton
  13543. * @param id defines the id of the new skeleton
  13544. * @returns the new skeleton
  13545. */
  13546. clone(name: string, id: string): Skeleton;
  13547. /**
  13548. * Enable animation blending for this skeleton
  13549. * @param blendingSpeed defines the blending speed to apply
  13550. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13551. */
  13552. enableBlending(blendingSpeed?: number): void;
  13553. /**
  13554. * Releases all resources associated with the current skeleton
  13555. */
  13556. dispose(): void;
  13557. /**
  13558. * Serialize the skeleton in a JSON object
  13559. * @returns a JSON object
  13560. */
  13561. serialize(): any;
  13562. /**
  13563. * Creates a new skeleton from serialized data
  13564. * @param parsedSkeleton defines the serialized data
  13565. * @param scene defines the hosting scene
  13566. * @returns a new skeleton
  13567. */
  13568. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13569. /**
  13570. * Compute all node absolute transforms
  13571. * @param forceUpdate defines if computation must be done even if cache is up to date
  13572. */
  13573. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13574. /**
  13575. * Gets the root pose matrix
  13576. * @returns a matrix
  13577. */
  13578. getPoseMatrix(): Nullable<Matrix>;
  13579. /**
  13580. * Sorts bones per internal index
  13581. */
  13582. sortBones(): void;
  13583. private _sortBones;
  13584. }
  13585. }
  13586. declare module "babylonjs/Bones/bone" {
  13587. import { Skeleton } from "babylonjs/Bones/skeleton";
  13588. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13589. import { Nullable } from "babylonjs/types";
  13590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13591. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13592. import { Node } from "babylonjs/node";
  13593. import { Space } from "babylonjs/Maths/math.axis";
  13594. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13595. /**
  13596. * Class used to store bone information
  13597. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13598. */
  13599. export class Bone extends Node {
  13600. /**
  13601. * defines the bone name
  13602. */
  13603. name: string;
  13604. private static _tmpVecs;
  13605. private static _tmpQuat;
  13606. private static _tmpMats;
  13607. /**
  13608. * Gets the list of child bones
  13609. */
  13610. children: Bone[];
  13611. /** Gets the animations associated with this bone */
  13612. animations: import("babylonjs/Animations/animation").Animation[];
  13613. /**
  13614. * Gets or sets bone length
  13615. */
  13616. length: number;
  13617. /**
  13618. * @hidden Internal only
  13619. * Set this value to map this bone to a different index in the transform matrices
  13620. * Set this value to -1 to exclude the bone from the transform matrices
  13621. */
  13622. _index: Nullable<number>;
  13623. private _skeleton;
  13624. private _localMatrix;
  13625. private _restPose;
  13626. private _baseMatrix;
  13627. private _absoluteTransform;
  13628. private _invertedAbsoluteTransform;
  13629. private _parent;
  13630. private _scalingDeterminant;
  13631. private _worldTransform;
  13632. private _localScaling;
  13633. private _localRotation;
  13634. private _localPosition;
  13635. private _needToDecompose;
  13636. private _needToCompose;
  13637. /** @hidden */
  13638. _linkedTransformNode: Nullable<TransformNode>;
  13639. /** @hidden */
  13640. _waitingTransformNodeId: Nullable<string>;
  13641. /** @hidden */
  13642. /** @hidden */
  13643. _matrix: Matrix;
  13644. /**
  13645. * Create a new bone
  13646. * @param name defines the bone name
  13647. * @param skeleton defines the parent skeleton
  13648. * @param parentBone defines the parent (can be null if the bone is the root)
  13649. * @param localMatrix defines the local matrix
  13650. * @param restPose defines the rest pose matrix
  13651. * @param baseMatrix defines the base matrix
  13652. * @param index defines index of the bone in the hiearchy
  13653. */
  13654. constructor(
  13655. /**
  13656. * defines the bone name
  13657. */
  13658. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13659. /**
  13660. * Gets the current object class name.
  13661. * @return the class name
  13662. */
  13663. getClassName(): string;
  13664. /**
  13665. * Gets the parent skeleton
  13666. * @returns a skeleton
  13667. */
  13668. getSkeleton(): Skeleton;
  13669. /**
  13670. * Gets parent bone
  13671. * @returns a bone or null if the bone is the root of the bone hierarchy
  13672. */
  13673. getParent(): Nullable<Bone>;
  13674. /**
  13675. * Returns an array containing the root bones
  13676. * @returns an array containing the root bones
  13677. */
  13678. getChildren(): Array<Bone>;
  13679. /**
  13680. * Sets the parent bone
  13681. * @param parent defines the parent (can be null if the bone is the root)
  13682. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13683. */
  13684. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13685. /**
  13686. * Gets the local matrix
  13687. * @returns a matrix
  13688. */
  13689. getLocalMatrix(): Matrix;
  13690. /**
  13691. * Gets the base matrix (initial matrix which remains unchanged)
  13692. * @returns a matrix
  13693. */
  13694. getBaseMatrix(): Matrix;
  13695. /**
  13696. * Gets the rest pose matrix
  13697. * @returns a matrix
  13698. */
  13699. getRestPose(): Matrix;
  13700. /**
  13701. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13702. */
  13703. getWorldMatrix(): Matrix;
  13704. /**
  13705. * Sets the local matrix to rest pose matrix
  13706. */
  13707. returnToRest(): void;
  13708. /**
  13709. * Gets the inverse of the absolute transform matrix.
  13710. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13711. * @returns a matrix
  13712. */
  13713. getInvertedAbsoluteTransform(): Matrix;
  13714. /**
  13715. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13716. * @returns a matrix
  13717. */
  13718. getAbsoluteTransform(): Matrix;
  13719. /**
  13720. * Links with the given transform node.
  13721. * The local matrix of this bone is copied from the transform node every frame.
  13722. * @param transformNode defines the transform node to link to
  13723. */
  13724. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13725. /**
  13726. * Gets the node used to drive the bone's transformation
  13727. * @returns a transform node or null
  13728. */
  13729. getTransformNode(): Nullable<TransformNode>;
  13730. /** Gets or sets current position (in local space) */
  13731. position: Vector3;
  13732. /** Gets or sets current rotation (in local space) */
  13733. rotation: Vector3;
  13734. /** Gets or sets current rotation quaternion (in local space) */
  13735. rotationQuaternion: Quaternion;
  13736. /** Gets or sets current scaling (in local space) */
  13737. scaling: Vector3;
  13738. /**
  13739. * Gets the animation properties override
  13740. */
  13741. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13742. private _decompose;
  13743. private _compose;
  13744. /**
  13745. * Update the base and local matrices
  13746. * @param matrix defines the new base or local matrix
  13747. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13748. * @param updateLocalMatrix defines if the local matrix should be updated
  13749. */
  13750. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13751. /** @hidden */
  13752. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13753. /**
  13754. * Flag the bone as dirty (Forcing it to update everything)
  13755. */
  13756. markAsDirty(): void;
  13757. /** @hidden */
  13758. _markAsDirtyAndCompose(): void;
  13759. private _markAsDirtyAndDecompose;
  13760. /**
  13761. * Translate the bone in local or world space
  13762. * @param vec The amount to translate the bone
  13763. * @param space The space that the translation is in
  13764. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13765. */
  13766. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13767. /**
  13768. * Set the postion of the bone in local or world space
  13769. * @param position The position to set the bone
  13770. * @param space The space that the position is in
  13771. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13772. */
  13773. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13774. /**
  13775. * Set the absolute position of the bone (world space)
  13776. * @param position The position to set the bone
  13777. * @param mesh The mesh that this bone is attached to
  13778. */
  13779. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  13780. /**
  13781. * Scale the bone on the x, y and z axes (in local space)
  13782. * @param x The amount to scale the bone on the x axis
  13783. * @param y The amount to scale the bone on the y axis
  13784. * @param z The amount to scale the bone on the z axis
  13785. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  13786. */
  13787. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  13788. /**
  13789. * Set the bone scaling in local space
  13790. * @param scale defines the scaling vector
  13791. */
  13792. setScale(scale: Vector3): void;
  13793. /**
  13794. * Gets the current scaling in local space
  13795. * @returns the current scaling vector
  13796. */
  13797. getScale(): Vector3;
  13798. /**
  13799. * Gets the current scaling in local space and stores it in a target vector
  13800. * @param result defines the target vector
  13801. */
  13802. getScaleToRef(result: Vector3): void;
  13803. /**
  13804. * Set the yaw, pitch, and roll of the bone in local or world space
  13805. * @param yaw The rotation of the bone on the y axis
  13806. * @param pitch The rotation of the bone on the x axis
  13807. * @param roll The rotation of the bone on the z axis
  13808. * @param space The space that the axes of rotation are in
  13809. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13810. */
  13811. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  13812. /**
  13813. * Add a rotation to the bone on an axis in local or world space
  13814. * @param axis The axis to rotate the bone on
  13815. * @param amount The amount to rotate the bone
  13816. * @param space The space that the axis is in
  13817. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13818. */
  13819. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  13820. /**
  13821. * Set the rotation of the bone to a particular axis angle in local or world space
  13822. * @param axis The axis to rotate the bone on
  13823. * @param angle The angle that the bone should be rotated to
  13824. * @param space The space that the axis is in
  13825. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13826. */
  13827. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  13828. /**
  13829. * Set the euler rotation of the bone in local of world space
  13830. * @param rotation The euler rotation that the bone should be set to
  13831. * @param space The space that the rotation is in
  13832. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13833. */
  13834. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13835. /**
  13836. * Set the quaternion rotation of the bone in local of world space
  13837. * @param quat The quaternion rotation that the bone should be set to
  13838. * @param space The space that the rotation is in
  13839. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13840. */
  13841. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  13842. /**
  13843. * Set the rotation matrix of the bone in local of world space
  13844. * @param rotMat The rotation matrix that the bone should be set to
  13845. * @param space The space that the rotation is in
  13846. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13847. */
  13848. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  13849. private _rotateWithMatrix;
  13850. private _getNegativeRotationToRef;
  13851. /**
  13852. * Get the position of the bone in local or world space
  13853. * @param space The space that the returned position is in
  13854. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13855. * @returns The position of the bone
  13856. */
  13857. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13858. /**
  13859. * Copy the position of the bone to a vector3 in local or world space
  13860. * @param space The space that the returned position is in
  13861. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13862. * @param result The vector3 to copy the position to
  13863. */
  13864. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  13865. /**
  13866. * Get the absolute position of the bone (world space)
  13867. * @param mesh The mesh that this bone is attached to
  13868. * @returns The absolute position of the bone
  13869. */
  13870. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  13871. /**
  13872. * Copy the absolute position of the bone (world space) to the result param
  13873. * @param mesh The mesh that this bone is attached to
  13874. * @param result The vector3 to copy the absolute position to
  13875. */
  13876. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  13877. /**
  13878. * Compute the absolute transforms of this bone and its children
  13879. */
  13880. computeAbsoluteTransforms(): void;
  13881. /**
  13882. * Get the world direction from an axis that is in the local space of the bone
  13883. * @param localAxis The local direction that is used to compute the world direction
  13884. * @param mesh The mesh that this bone is attached to
  13885. * @returns The world direction
  13886. */
  13887. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13888. /**
  13889. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  13890. * @param localAxis The local direction that is used to compute the world direction
  13891. * @param mesh The mesh that this bone is attached to
  13892. * @param result The vector3 that the world direction will be copied to
  13893. */
  13894. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13895. /**
  13896. * Get the euler rotation of the bone in local or world space
  13897. * @param space The space that the rotation should be in
  13898. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13899. * @returns The euler rotation
  13900. */
  13901. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13902. /**
  13903. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  13904. * @param space The space that the rotation should be in
  13905. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13906. * @param result The vector3 that the rotation should be copied to
  13907. */
  13908. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13909. /**
  13910. * Get the quaternion rotation of the bone in either local or world space
  13911. * @param space The space that the rotation should be in
  13912. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13913. * @returns The quaternion rotation
  13914. */
  13915. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  13916. /**
  13917. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  13918. * @param space The space that the rotation should be in
  13919. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13920. * @param result The quaternion that the rotation should be copied to
  13921. */
  13922. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  13923. /**
  13924. * Get the rotation matrix of the bone in local or world space
  13925. * @param space The space that the rotation should be in
  13926. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13927. * @returns The rotation matrix
  13928. */
  13929. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  13930. /**
  13931. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  13932. * @param space The space that the rotation should be in
  13933. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13934. * @param result The quaternion that the rotation should be copied to
  13935. */
  13936. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  13937. /**
  13938. * Get the world position of a point that is in the local space of the bone
  13939. * @param position The local position
  13940. * @param mesh The mesh that this bone is attached to
  13941. * @returns The world position
  13942. */
  13943. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13944. /**
  13945. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  13946. * @param position The local position
  13947. * @param mesh The mesh that this bone is attached to
  13948. * @param result The vector3 that the world position should be copied to
  13949. */
  13950. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13951. /**
  13952. * Get the local position of a point that is in world space
  13953. * @param position The world position
  13954. * @param mesh The mesh that this bone is attached to
  13955. * @returns The local position
  13956. */
  13957. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13958. /**
  13959. * Get the local position of a point that is in world space and copy it to the result param
  13960. * @param position The world position
  13961. * @param mesh The mesh that this bone is attached to
  13962. * @param result The vector3 that the local position should be copied to
  13963. */
  13964. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13965. }
  13966. }
  13967. declare module "babylonjs/Meshes/transformNode" {
  13968. import { DeepImmutable } from "babylonjs/types";
  13969. import { Observable } from "babylonjs/Misc/observable";
  13970. import { Nullable } from "babylonjs/types";
  13971. import { Camera } from "babylonjs/Cameras/camera";
  13972. import { Scene } from "babylonjs/scene";
  13973. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  13974. import { Node } from "babylonjs/node";
  13975. import { Bone } from "babylonjs/Bones/bone";
  13976. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13977. import { Space } from "babylonjs/Maths/math.axis";
  13978. /**
  13979. * 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.
  13980. * @see https://doc.babylonjs.com/how_to/transformnode
  13981. */
  13982. export class TransformNode extends Node {
  13983. /**
  13984. * Object will not rotate to face the camera
  13985. */
  13986. static BILLBOARDMODE_NONE: number;
  13987. /**
  13988. * Object will rotate to face the camera but only on the x axis
  13989. */
  13990. static BILLBOARDMODE_X: number;
  13991. /**
  13992. * Object will rotate to face the camera but only on the y axis
  13993. */
  13994. static BILLBOARDMODE_Y: number;
  13995. /**
  13996. * Object will rotate to face the camera but only on the z axis
  13997. */
  13998. static BILLBOARDMODE_Z: number;
  13999. /**
  14000. * Object will rotate to face the camera
  14001. */
  14002. static BILLBOARDMODE_ALL: number;
  14003. /**
  14004. * Object will rotate to face the camera's position instead of orientation
  14005. */
  14006. static BILLBOARDMODE_USE_POSITION: number;
  14007. private _forward;
  14008. private _forwardInverted;
  14009. private _up;
  14010. private _right;
  14011. private _rightInverted;
  14012. private _position;
  14013. private _rotation;
  14014. private _rotationQuaternion;
  14015. protected _scaling: Vector3;
  14016. protected _isDirty: boolean;
  14017. private _transformToBoneReferal;
  14018. private _isAbsoluteSynced;
  14019. private _billboardMode;
  14020. /**
  14021. * Gets or sets the billboard mode. Default is 0.
  14022. *
  14023. * | Value | Type | Description |
  14024. * | --- | --- | --- |
  14025. * | 0 | BILLBOARDMODE_NONE | |
  14026. * | 1 | BILLBOARDMODE_X | |
  14027. * | 2 | BILLBOARDMODE_Y | |
  14028. * | 4 | BILLBOARDMODE_Z | |
  14029. * | 7 | BILLBOARDMODE_ALL | |
  14030. *
  14031. */
  14032. billboardMode: number;
  14033. private _preserveParentRotationForBillboard;
  14034. /**
  14035. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14036. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14037. */
  14038. preserveParentRotationForBillboard: boolean;
  14039. /**
  14040. * 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
  14041. */
  14042. scalingDeterminant: number;
  14043. private _infiniteDistance;
  14044. /**
  14045. * Gets or sets the distance of the object to max, often used by skybox
  14046. */
  14047. infiniteDistance: boolean;
  14048. /**
  14049. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14050. * By default the system will update normals to compensate
  14051. */
  14052. ignoreNonUniformScaling: boolean;
  14053. /**
  14054. * 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
  14055. */
  14056. reIntegrateRotationIntoRotationQuaternion: boolean;
  14057. /** @hidden */
  14058. _poseMatrix: Nullable<Matrix>;
  14059. /** @hidden */
  14060. _localMatrix: Matrix;
  14061. private _usePivotMatrix;
  14062. private _absolutePosition;
  14063. private _absoluteScaling;
  14064. private _absoluteRotationQuaternion;
  14065. private _pivotMatrix;
  14066. private _pivotMatrixInverse;
  14067. protected _postMultiplyPivotMatrix: boolean;
  14068. protected _isWorldMatrixFrozen: boolean;
  14069. /** @hidden */
  14070. _indexInSceneTransformNodesArray: number;
  14071. /**
  14072. * An event triggered after the world matrix is updated
  14073. */
  14074. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14075. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14076. /**
  14077. * Gets a string identifying the name of the class
  14078. * @returns "TransformNode" string
  14079. */
  14080. getClassName(): string;
  14081. /**
  14082. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14083. */
  14084. position: Vector3;
  14085. /**
  14086. * 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)).
  14087. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14088. */
  14089. rotation: Vector3;
  14090. /**
  14091. * 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)).
  14092. */
  14093. scaling: Vector3;
  14094. /**
  14095. * 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).
  14096. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14097. */
  14098. rotationQuaternion: Nullable<Quaternion>;
  14099. /**
  14100. * The forward direction of that transform in world space.
  14101. */
  14102. readonly forward: Vector3;
  14103. /**
  14104. * The up direction of that transform in world space.
  14105. */
  14106. readonly up: Vector3;
  14107. /**
  14108. * The right direction of that transform in world space.
  14109. */
  14110. readonly right: Vector3;
  14111. /**
  14112. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14113. * @param matrix the matrix to copy the pose from
  14114. * @returns this TransformNode.
  14115. */
  14116. updatePoseMatrix(matrix: Matrix): TransformNode;
  14117. /**
  14118. * Returns the mesh Pose matrix.
  14119. * @returns the pose matrix
  14120. */
  14121. getPoseMatrix(): Matrix;
  14122. /** @hidden */
  14123. _isSynchronized(): boolean;
  14124. /** @hidden */
  14125. _initCache(): void;
  14126. /**
  14127. * Flag the transform node as dirty (Forcing it to update everything)
  14128. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14129. * @returns this transform node
  14130. */
  14131. markAsDirty(property: string): TransformNode;
  14132. /**
  14133. * Returns the current mesh absolute position.
  14134. * Returns a Vector3.
  14135. */
  14136. readonly absolutePosition: Vector3;
  14137. /**
  14138. * Returns the current mesh absolute scaling.
  14139. * Returns a Vector3.
  14140. */
  14141. readonly absoluteScaling: Vector3;
  14142. /**
  14143. * Returns the current mesh absolute rotation.
  14144. * Returns a Quaternion.
  14145. */
  14146. readonly absoluteRotationQuaternion: Quaternion;
  14147. /**
  14148. * Sets a new matrix to apply before all other transformation
  14149. * @param matrix defines the transform matrix
  14150. * @returns the current TransformNode
  14151. */
  14152. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14153. /**
  14154. * Sets a new pivot matrix to the current node
  14155. * @param matrix defines the new pivot matrix to use
  14156. * @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
  14157. * @returns the current TransformNode
  14158. */
  14159. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14160. /**
  14161. * Returns the mesh pivot matrix.
  14162. * Default : Identity.
  14163. * @returns the matrix
  14164. */
  14165. getPivotMatrix(): Matrix;
  14166. /**
  14167. * Instantiate (when possible) or clone that node with its hierarchy
  14168. * @param newParent defines the new parent to use for the instance (or clone)
  14169. * @returns an instance (or a clone) of the current node with its hiearchy
  14170. */
  14171. instantiateHierarychy(newParent?: Nullable<TransformNode>): Nullable<TransformNode>;
  14172. /**
  14173. * Prevents the World matrix to be computed any longer
  14174. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14175. * @returns the TransformNode.
  14176. */
  14177. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14178. /**
  14179. * Allows back the World matrix computation.
  14180. * @returns the TransformNode.
  14181. */
  14182. unfreezeWorldMatrix(): this;
  14183. /**
  14184. * True if the World matrix has been frozen.
  14185. */
  14186. readonly isWorldMatrixFrozen: boolean;
  14187. /**
  14188. * Retuns the mesh absolute position in the World.
  14189. * @returns a Vector3.
  14190. */
  14191. getAbsolutePosition(): Vector3;
  14192. /**
  14193. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14194. * @param absolutePosition the absolute position to set
  14195. * @returns the TransformNode.
  14196. */
  14197. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14198. /**
  14199. * Sets the mesh position in its local space.
  14200. * @param vector3 the position to set in localspace
  14201. * @returns the TransformNode.
  14202. */
  14203. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14204. /**
  14205. * Returns the mesh position in the local space from the current World matrix values.
  14206. * @returns a new Vector3.
  14207. */
  14208. getPositionExpressedInLocalSpace(): Vector3;
  14209. /**
  14210. * Translates the mesh along the passed Vector3 in its local space.
  14211. * @param vector3 the distance to translate in localspace
  14212. * @returns the TransformNode.
  14213. */
  14214. locallyTranslate(vector3: Vector3): TransformNode;
  14215. private static _lookAtVectorCache;
  14216. /**
  14217. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14218. * @param targetPoint the position (must be in same space as current mesh) to look at
  14219. * @param yawCor optional yaw (y-axis) correction in radians
  14220. * @param pitchCor optional pitch (x-axis) correction in radians
  14221. * @param rollCor optional roll (z-axis) correction in radians
  14222. * @param space the choosen space of the target
  14223. * @returns the TransformNode.
  14224. */
  14225. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14226. /**
  14227. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14228. * This Vector3 is expressed in the World space.
  14229. * @param localAxis axis to rotate
  14230. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14231. */
  14232. getDirection(localAxis: Vector3): Vector3;
  14233. /**
  14234. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14235. * localAxis is expressed in the mesh local space.
  14236. * result is computed in the Wordl space from the mesh World matrix.
  14237. * @param localAxis axis to rotate
  14238. * @param result the resulting transformnode
  14239. * @returns this TransformNode.
  14240. */
  14241. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14242. /**
  14243. * Sets this transform node rotation to the given local axis.
  14244. * @param localAxis the axis in local space
  14245. * @param yawCor optional yaw (y-axis) correction in radians
  14246. * @param pitchCor optional pitch (x-axis) correction in radians
  14247. * @param rollCor optional roll (z-axis) correction in radians
  14248. * @returns this TransformNode
  14249. */
  14250. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14251. /**
  14252. * Sets a new pivot point to the current node
  14253. * @param point defines the new pivot point to use
  14254. * @param space defines if the point is in world or local space (local by default)
  14255. * @returns the current TransformNode
  14256. */
  14257. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14258. /**
  14259. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14260. * @returns the pivot point
  14261. */
  14262. getPivotPoint(): Vector3;
  14263. /**
  14264. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14265. * @param result the vector3 to store the result
  14266. * @returns this TransformNode.
  14267. */
  14268. getPivotPointToRef(result: Vector3): TransformNode;
  14269. /**
  14270. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14271. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14272. */
  14273. getAbsolutePivotPoint(): Vector3;
  14274. /**
  14275. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14276. * @param result vector3 to store the result
  14277. * @returns this TransformNode.
  14278. */
  14279. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14280. /**
  14281. * Defines the passed node as the parent of the current node.
  14282. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14283. * @see https://doc.babylonjs.com/how_to/parenting
  14284. * @param node the node ot set as the parent
  14285. * @returns this TransformNode.
  14286. */
  14287. setParent(node: Nullable<Node>): TransformNode;
  14288. private _nonUniformScaling;
  14289. /**
  14290. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14291. */
  14292. readonly nonUniformScaling: boolean;
  14293. /** @hidden */
  14294. _updateNonUniformScalingState(value: boolean): boolean;
  14295. /**
  14296. * Attach the current TransformNode to another TransformNode associated with a bone
  14297. * @param bone Bone affecting the TransformNode
  14298. * @param affectedTransformNode TransformNode associated with the bone
  14299. * @returns this object
  14300. */
  14301. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14302. /**
  14303. * Detach the transform node if its associated with a bone
  14304. * @returns this object
  14305. */
  14306. detachFromBone(): TransformNode;
  14307. private static _rotationAxisCache;
  14308. /**
  14309. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14310. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14311. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14312. * The passed axis is also normalized.
  14313. * @param axis the axis to rotate around
  14314. * @param amount the amount to rotate in radians
  14315. * @param space Space to rotate in (Default: local)
  14316. * @returns the TransformNode.
  14317. */
  14318. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14319. /**
  14320. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14321. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14322. * The passed axis is also normalized. .
  14323. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14324. * @param point the point to rotate around
  14325. * @param axis the axis to rotate around
  14326. * @param amount the amount to rotate in radians
  14327. * @returns the TransformNode
  14328. */
  14329. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14330. /**
  14331. * Translates the mesh along the axis vector for the passed distance in the given space.
  14332. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14333. * @param axis the axis to translate in
  14334. * @param distance the distance to translate
  14335. * @param space Space to rotate in (Default: local)
  14336. * @returns the TransformNode.
  14337. */
  14338. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14339. /**
  14340. * Adds a rotation step to the mesh current rotation.
  14341. * x, y, z are Euler angles expressed in radians.
  14342. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14343. * This means this rotation is made in the mesh local space only.
  14344. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14345. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14346. * ```javascript
  14347. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14348. * ```
  14349. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14350. * 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.
  14351. * @param x Rotation to add
  14352. * @param y Rotation to add
  14353. * @param z Rotation to add
  14354. * @returns the TransformNode.
  14355. */
  14356. addRotation(x: number, y: number, z: number): TransformNode;
  14357. /**
  14358. * @hidden
  14359. */
  14360. protected _getEffectiveParent(): Nullable<Node>;
  14361. /**
  14362. * Computes the world matrix of the node
  14363. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14364. * @returns the world matrix
  14365. */
  14366. computeWorldMatrix(force?: boolean): Matrix;
  14367. protected _afterComputeWorldMatrix(): void;
  14368. /**
  14369. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14370. * @param func callback function to add
  14371. *
  14372. * @returns the TransformNode.
  14373. */
  14374. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14375. /**
  14376. * Removes a registered callback function.
  14377. * @param func callback function to remove
  14378. * @returns the TransformNode.
  14379. */
  14380. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14381. /**
  14382. * Gets the position of the current mesh in camera space
  14383. * @param camera defines the camera to use
  14384. * @returns a position
  14385. */
  14386. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14387. /**
  14388. * Returns the distance from the mesh to the active camera
  14389. * @param camera defines the camera to use
  14390. * @returns the distance
  14391. */
  14392. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14393. /**
  14394. * Clone the current transform node
  14395. * @param name Name of the new clone
  14396. * @param newParent New parent for the clone
  14397. * @param doNotCloneChildren Do not clone children hierarchy
  14398. * @returns the new transform node
  14399. */
  14400. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14401. /**
  14402. * Serializes the objects information.
  14403. * @param currentSerializationObject defines the object to serialize in
  14404. * @returns the serialized object
  14405. */
  14406. serialize(currentSerializationObject?: any): any;
  14407. /**
  14408. * Returns a new TransformNode object parsed from the source provided.
  14409. * @param parsedTransformNode is the source.
  14410. * @param scene the scne the object belongs to
  14411. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14412. * @returns a new TransformNode object parsed from the source provided.
  14413. */
  14414. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14415. /**
  14416. * Get all child-transformNodes of this node
  14417. * @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
  14418. * @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
  14419. * @returns an array of TransformNode
  14420. */
  14421. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14422. /**
  14423. * Releases resources associated with this transform node.
  14424. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14425. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14426. */
  14427. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14428. /**
  14429. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14430. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14431. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14432. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14433. * @returns the current mesh
  14434. */
  14435. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14436. private _syncAbsoluteScalingAndRotation;
  14437. }
  14438. }
  14439. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14440. import { Observable } from "babylonjs/Misc/observable";
  14441. import { Nullable } from "babylonjs/types";
  14442. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14443. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14444. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14445. import { Ray } from "babylonjs/Culling/ray";
  14446. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14447. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14448. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14449. /**
  14450. * Defines the types of pose enabled controllers that are supported
  14451. */
  14452. export enum PoseEnabledControllerType {
  14453. /**
  14454. * HTC Vive
  14455. */
  14456. VIVE = 0,
  14457. /**
  14458. * Oculus Rift
  14459. */
  14460. OCULUS = 1,
  14461. /**
  14462. * Windows mixed reality
  14463. */
  14464. WINDOWS = 2,
  14465. /**
  14466. * Samsung gear VR
  14467. */
  14468. GEAR_VR = 3,
  14469. /**
  14470. * Google Daydream
  14471. */
  14472. DAYDREAM = 4,
  14473. /**
  14474. * Generic
  14475. */
  14476. GENERIC = 5
  14477. }
  14478. /**
  14479. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14480. */
  14481. export interface MutableGamepadButton {
  14482. /**
  14483. * Value of the button/trigger
  14484. */
  14485. value: number;
  14486. /**
  14487. * If the button/trigger is currently touched
  14488. */
  14489. touched: boolean;
  14490. /**
  14491. * If the button/trigger is currently pressed
  14492. */
  14493. pressed: boolean;
  14494. }
  14495. /**
  14496. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14497. * @hidden
  14498. */
  14499. export interface ExtendedGamepadButton extends GamepadButton {
  14500. /**
  14501. * If the button/trigger is currently pressed
  14502. */
  14503. readonly pressed: boolean;
  14504. /**
  14505. * If the button/trigger is currently touched
  14506. */
  14507. readonly touched: boolean;
  14508. /**
  14509. * Value of the button/trigger
  14510. */
  14511. readonly value: number;
  14512. }
  14513. /** @hidden */
  14514. export interface _GamePadFactory {
  14515. /**
  14516. * Returns wether or not the current gamepad can be created for this type of controller.
  14517. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14518. * @returns true if it can be created, otherwise false
  14519. */
  14520. canCreate(gamepadInfo: any): boolean;
  14521. /**
  14522. * Creates a new instance of the Gamepad.
  14523. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14524. * @returns the new gamepad instance
  14525. */
  14526. create(gamepadInfo: any): Gamepad;
  14527. }
  14528. /**
  14529. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14530. */
  14531. export class PoseEnabledControllerHelper {
  14532. /** @hidden */
  14533. static _ControllerFactories: _GamePadFactory[];
  14534. /** @hidden */
  14535. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14536. /**
  14537. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14538. * @param vrGamepad the gamepad to initialized
  14539. * @returns a vr controller of the type the gamepad identified as
  14540. */
  14541. static InitiateController(vrGamepad: any): Gamepad;
  14542. }
  14543. /**
  14544. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14545. */
  14546. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14547. /**
  14548. * If the controller is used in a webXR session
  14549. */
  14550. isXR: boolean;
  14551. private _deviceRoomPosition;
  14552. private _deviceRoomRotationQuaternion;
  14553. /**
  14554. * The device position in babylon space
  14555. */
  14556. devicePosition: Vector3;
  14557. /**
  14558. * The device rotation in babylon space
  14559. */
  14560. deviceRotationQuaternion: Quaternion;
  14561. /**
  14562. * The scale factor of the device in babylon space
  14563. */
  14564. deviceScaleFactor: number;
  14565. /**
  14566. * (Likely devicePosition should be used instead) The device position in its room space
  14567. */
  14568. position: Vector3;
  14569. /**
  14570. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14571. */
  14572. rotationQuaternion: Quaternion;
  14573. /**
  14574. * The type of controller (Eg. Windows mixed reality)
  14575. */
  14576. controllerType: PoseEnabledControllerType;
  14577. protected _calculatedPosition: Vector3;
  14578. private _calculatedRotation;
  14579. /**
  14580. * The raw pose from the device
  14581. */
  14582. rawPose: DevicePose;
  14583. private _trackPosition;
  14584. private _maxRotationDistFromHeadset;
  14585. private _draggedRoomRotation;
  14586. /**
  14587. * @hidden
  14588. */
  14589. _disableTrackPosition(fixedPosition: Vector3): void;
  14590. /**
  14591. * Internal, the mesh attached to the controller
  14592. * @hidden
  14593. */
  14594. _mesh: Nullable<AbstractMesh>;
  14595. private _poseControlledCamera;
  14596. private _leftHandSystemQuaternion;
  14597. /**
  14598. * Internal, matrix used to convert room space to babylon space
  14599. * @hidden
  14600. */
  14601. _deviceToWorld: Matrix;
  14602. /**
  14603. * Node to be used when casting a ray from the controller
  14604. * @hidden
  14605. */
  14606. _pointingPoseNode: Nullable<TransformNode>;
  14607. /**
  14608. * Name of the child mesh that can be used to cast a ray from the controller
  14609. */
  14610. static readonly POINTING_POSE: string;
  14611. /**
  14612. * Creates a new PoseEnabledController from a gamepad
  14613. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14614. */
  14615. constructor(browserGamepad: any);
  14616. private _workingMatrix;
  14617. /**
  14618. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14619. */
  14620. update(): void;
  14621. /**
  14622. * Updates only the pose device and mesh without doing any button event checking
  14623. */
  14624. protected _updatePoseAndMesh(): void;
  14625. /**
  14626. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14627. * @param poseData raw pose fromthe device
  14628. */
  14629. updateFromDevice(poseData: DevicePose): void;
  14630. /**
  14631. * @hidden
  14632. */
  14633. _meshAttachedObservable: Observable<AbstractMesh>;
  14634. /**
  14635. * Attaches a mesh to the controller
  14636. * @param mesh the mesh to be attached
  14637. */
  14638. attachToMesh(mesh: AbstractMesh): void;
  14639. /**
  14640. * Attaches the controllers mesh to a camera
  14641. * @param camera the camera the mesh should be attached to
  14642. */
  14643. attachToPoseControlledCamera(camera: TargetCamera): void;
  14644. /**
  14645. * Disposes of the controller
  14646. */
  14647. dispose(): void;
  14648. /**
  14649. * The mesh that is attached to the controller
  14650. */
  14651. readonly mesh: Nullable<AbstractMesh>;
  14652. /**
  14653. * Gets the ray of the controller in the direction the controller is pointing
  14654. * @param length the length the resulting ray should be
  14655. * @returns a ray in the direction the controller is pointing
  14656. */
  14657. getForwardRay(length?: number): Ray;
  14658. }
  14659. }
  14660. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14661. import { Observable } from "babylonjs/Misc/observable";
  14662. import { Scene } from "babylonjs/scene";
  14663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14664. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14665. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14666. /**
  14667. * Defines the WebVRController object that represents controllers tracked in 3D space
  14668. */
  14669. export abstract class WebVRController extends PoseEnabledController {
  14670. /**
  14671. * Internal, the default controller model for the controller
  14672. */
  14673. protected _defaultModel: AbstractMesh;
  14674. /**
  14675. * Fired when the trigger state has changed
  14676. */
  14677. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14678. /**
  14679. * Fired when the main button state has changed
  14680. */
  14681. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14682. /**
  14683. * Fired when the secondary button state has changed
  14684. */
  14685. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14686. /**
  14687. * Fired when the pad state has changed
  14688. */
  14689. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14690. /**
  14691. * Fired when controllers stick values have changed
  14692. */
  14693. onPadValuesChangedObservable: Observable<StickValues>;
  14694. /**
  14695. * Array of button availible on the controller
  14696. */
  14697. protected _buttons: Array<MutableGamepadButton>;
  14698. private _onButtonStateChange;
  14699. /**
  14700. * Fired when a controller button's state has changed
  14701. * @param callback the callback containing the button that was modified
  14702. */
  14703. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14704. /**
  14705. * X and Y axis corresponding to the controllers joystick
  14706. */
  14707. pad: StickValues;
  14708. /**
  14709. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14710. */
  14711. hand: string;
  14712. /**
  14713. * The default controller model for the controller
  14714. */
  14715. readonly defaultModel: AbstractMesh;
  14716. /**
  14717. * Creates a new WebVRController from a gamepad
  14718. * @param vrGamepad the gamepad that the WebVRController should be created from
  14719. */
  14720. constructor(vrGamepad: any);
  14721. /**
  14722. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14723. */
  14724. update(): void;
  14725. /**
  14726. * Function to be called when a button is modified
  14727. */
  14728. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14729. /**
  14730. * Loads a mesh and attaches it to the controller
  14731. * @param scene the scene the mesh should be added to
  14732. * @param meshLoaded callback for when the mesh has been loaded
  14733. */
  14734. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14735. private _setButtonValue;
  14736. private _changes;
  14737. private _checkChanges;
  14738. /**
  14739. * Disposes of th webVRCOntroller
  14740. */
  14741. dispose(): void;
  14742. }
  14743. }
  14744. declare module "babylonjs/Lights/hemisphericLight" {
  14745. import { Nullable } from "babylonjs/types";
  14746. import { Scene } from "babylonjs/scene";
  14747. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14748. import { Color3 } from "babylonjs/Maths/math.color";
  14749. import { Effect } from "babylonjs/Materials/effect";
  14750. import { Light } from "babylonjs/Lights/light";
  14751. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  14752. /**
  14753. * The HemisphericLight simulates the ambient environment light,
  14754. * so the passed direction is the light reflection direction, not the incoming direction.
  14755. */
  14756. export class HemisphericLight extends Light {
  14757. /**
  14758. * The groundColor is the light in the opposite direction to the one specified during creation.
  14759. * 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.
  14760. */
  14761. groundColor: Color3;
  14762. /**
  14763. * The light reflection direction, not the incoming direction.
  14764. */
  14765. direction: Vector3;
  14766. /**
  14767. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  14768. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  14769. * The HemisphericLight can't cast shadows.
  14770. * Documentation : https://doc.babylonjs.com/babylon101/lights
  14771. * @param name The friendly name of the light
  14772. * @param direction The direction of the light reflection
  14773. * @param scene The scene the light belongs to
  14774. */
  14775. constructor(name: string, direction: Vector3, scene: Scene);
  14776. protected _buildUniformLayout(): void;
  14777. /**
  14778. * Returns the string "HemisphericLight".
  14779. * @return The class name
  14780. */
  14781. getClassName(): string;
  14782. /**
  14783. * Sets the HemisphericLight direction towards the passed target (Vector3).
  14784. * Returns the updated direction.
  14785. * @param target The target the direction should point to
  14786. * @return The computed direction
  14787. */
  14788. setDirectionToTarget(target: Vector3): Vector3;
  14789. /**
  14790. * Returns the shadow generator associated to the light.
  14791. * @returns Always null for hemispheric lights because it does not support shadows.
  14792. */
  14793. getShadowGenerator(): Nullable<IShadowGenerator>;
  14794. /**
  14795. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  14796. * @param effect The effect to update
  14797. * @param lightIndex The index of the light in the effect to update
  14798. * @returns The hemispheric light
  14799. */
  14800. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  14801. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  14802. /**
  14803. * Computes the world matrix of the node
  14804. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14805. * @param useWasUpdatedFlag defines a reserved property
  14806. * @returns the world matrix
  14807. */
  14808. computeWorldMatrix(): Matrix;
  14809. /**
  14810. * Returns the integer 3.
  14811. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  14812. */
  14813. getTypeID(): number;
  14814. /**
  14815. * Prepares the list of defines specific to the light type.
  14816. * @param defines the list of defines
  14817. * @param lightIndex defines the index of the light for the effect
  14818. */
  14819. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  14820. }
  14821. }
  14822. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  14823. /** @hidden */
  14824. export var vrMultiviewToSingleviewPixelShader: {
  14825. name: string;
  14826. shader: string;
  14827. };
  14828. }
  14829. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  14830. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14831. import { Scene } from "babylonjs/scene";
  14832. /**
  14833. * Renders to multiple views with a single draw call
  14834. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  14835. */
  14836. export class MultiviewRenderTarget extends RenderTargetTexture {
  14837. /**
  14838. * Creates a multiview render target
  14839. * @param scene scene used with the render target
  14840. * @param size the size of the render target (used for each view)
  14841. */
  14842. constructor(scene: Scene, size?: number | {
  14843. width: number;
  14844. height: number;
  14845. } | {
  14846. ratio: number;
  14847. });
  14848. /**
  14849. * @hidden
  14850. * @param faceIndex the face index, if its a cube texture
  14851. */
  14852. _bindFrameBuffer(faceIndex?: number): void;
  14853. /**
  14854. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  14855. * @returns the view count
  14856. */
  14857. getViewCount(): number;
  14858. }
  14859. }
  14860. declare module "babylonjs/Maths/math.frustum" {
  14861. import { Matrix } from "babylonjs/Maths/math.vector";
  14862. import { DeepImmutable } from "babylonjs/types";
  14863. import { Plane } from "babylonjs/Maths/math.plane";
  14864. /**
  14865. * Represents a camera frustum
  14866. */
  14867. export class Frustum {
  14868. /**
  14869. * Gets the planes representing the frustum
  14870. * @param transform matrix to be applied to the returned planes
  14871. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  14872. */
  14873. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  14874. /**
  14875. * Gets the near frustum plane transformed by the transform matrix
  14876. * @param transform transformation matrix to be applied to the resulting frustum plane
  14877. * @param frustumPlane the resuling frustum plane
  14878. */
  14879. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14880. /**
  14881. * Gets the far frustum plane transformed by the transform matrix
  14882. * @param transform transformation matrix to be applied to the resulting frustum plane
  14883. * @param frustumPlane the resuling frustum plane
  14884. */
  14885. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14886. /**
  14887. * Gets the left frustum plane transformed by the transform matrix
  14888. * @param transform transformation matrix to be applied to the resulting frustum plane
  14889. * @param frustumPlane the resuling frustum plane
  14890. */
  14891. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14892. /**
  14893. * Gets the right frustum plane transformed by the transform matrix
  14894. * @param transform transformation matrix to be applied to the resulting frustum plane
  14895. * @param frustumPlane the resuling frustum plane
  14896. */
  14897. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14898. /**
  14899. * Gets the top frustum plane transformed by the transform matrix
  14900. * @param transform transformation matrix to be applied to the resulting frustum plane
  14901. * @param frustumPlane the resuling frustum plane
  14902. */
  14903. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14904. /**
  14905. * Gets the bottom frustum plane transformed by the transform matrix
  14906. * @param transform transformation matrix to be applied to the resulting frustum plane
  14907. * @param frustumPlane the resuling frustum plane
  14908. */
  14909. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14910. /**
  14911. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  14912. * @param transform transformation matrix to be applied to the resulting frustum planes
  14913. * @param frustumPlanes the resuling frustum planes
  14914. */
  14915. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  14916. }
  14917. }
  14918. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  14919. import { Camera } from "babylonjs/Cameras/camera";
  14920. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  14921. import { Nullable } from "babylonjs/types";
  14922. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14923. import { Matrix } from "babylonjs/Maths/math.vector";
  14924. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  14925. module "babylonjs/Engines/engine" {
  14926. interface Engine {
  14927. /**
  14928. * Creates a new multiview render target
  14929. * @param width defines the width of the texture
  14930. * @param height defines the height of the texture
  14931. * @returns the created multiview texture
  14932. */
  14933. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  14934. /**
  14935. * Binds a multiview framebuffer to be drawn to
  14936. * @param multiviewTexture texture to bind
  14937. */
  14938. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  14939. }
  14940. }
  14941. module "babylonjs/Cameras/camera" {
  14942. interface Camera {
  14943. /**
  14944. * @hidden
  14945. * 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)
  14946. */
  14947. _useMultiviewToSingleView: boolean;
  14948. /**
  14949. * @hidden
  14950. * 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)
  14951. */
  14952. _multiviewTexture: Nullable<RenderTargetTexture>;
  14953. /**
  14954. * @hidden
  14955. * ensures the multiview texture of the camera exists and has the specified width/height
  14956. * @param width height to set on the multiview texture
  14957. * @param height width to set on the multiview texture
  14958. */
  14959. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  14960. }
  14961. }
  14962. module "babylonjs/scene" {
  14963. interface Scene {
  14964. /** @hidden */
  14965. _transformMatrixR: Matrix;
  14966. /** @hidden */
  14967. _multiviewSceneUbo: Nullable<UniformBuffer>;
  14968. /** @hidden */
  14969. _createMultiviewUbo(): void;
  14970. /** @hidden */
  14971. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  14972. /** @hidden */
  14973. _renderMultiviewToSingleView(camera: Camera): void;
  14974. }
  14975. }
  14976. }
  14977. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  14978. import { Camera } from "babylonjs/Cameras/camera";
  14979. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  14980. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  14981. import "babylonjs/Engines/Extensions/engine.multiview";
  14982. /**
  14983. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  14984. * This will not be used for webXR as it supports displaying texture arrays directly
  14985. */
  14986. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  14987. /**
  14988. * Initializes a VRMultiviewToSingleview
  14989. * @param name name of the post process
  14990. * @param camera camera to be applied to
  14991. * @param scaleFactor scaling factor to the size of the output texture
  14992. */
  14993. constructor(name: string, camera: Camera, scaleFactor: number);
  14994. }
  14995. }
  14996. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  14997. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  14998. import { Nullable } from "babylonjs/types";
  14999. import { Size } from "babylonjs/Maths/math.size";
  15000. import { Observable } from "babylonjs/Misc/observable";
  15001. module "babylonjs/Engines/engine" {
  15002. interface Engine {
  15003. /** @hidden */
  15004. _vrDisplay: any;
  15005. /** @hidden */
  15006. _vrSupported: boolean;
  15007. /** @hidden */
  15008. _oldSize: Size;
  15009. /** @hidden */
  15010. _oldHardwareScaleFactor: number;
  15011. /** @hidden */
  15012. _vrExclusivePointerMode: boolean;
  15013. /** @hidden */
  15014. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15015. /** @hidden */
  15016. _onVRDisplayPointerRestricted: () => void;
  15017. /** @hidden */
  15018. _onVRDisplayPointerUnrestricted: () => void;
  15019. /** @hidden */
  15020. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15021. /** @hidden */
  15022. _onVrDisplayDisconnect: Nullable<() => void>;
  15023. /** @hidden */
  15024. _onVrDisplayPresentChange: Nullable<() => void>;
  15025. /**
  15026. * Observable signaled when VR display mode changes
  15027. */
  15028. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15029. /**
  15030. * Observable signaled when VR request present is complete
  15031. */
  15032. onVRRequestPresentComplete: Observable<boolean>;
  15033. /**
  15034. * Observable signaled when VR request present starts
  15035. */
  15036. onVRRequestPresentStart: Observable<Engine>;
  15037. /**
  15038. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15039. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15040. */
  15041. isInVRExclusivePointerMode: boolean;
  15042. /**
  15043. * Gets a boolean indicating if a webVR device was detected
  15044. * @returns true if a webVR device was detected
  15045. */
  15046. isVRDevicePresent(): boolean;
  15047. /**
  15048. * Gets the current webVR device
  15049. * @returns the current webVR device (or null)
  15050. */
  15051. getVRDevice(): any;
  15052. /**
  15053. * Initializes a webVR display and starts listening to display change events
  15054. * The onVRDisplayChangedObservable will be notified upon these changes
  15055. * @returns A promise containing a VRDisplay and if vr is supported
  15056. */
  15057. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15058. /** @hidden */
  15059. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15060. /**
  15061. * Call this function to switch to webVR mode
  15062. * Will do nothing if webVR is not supported or if there is no webVR device
  15063. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15064. */
  15065. enableVR(): void;
  15066. /** @hidden */
  15067. _onVRFullScreenTriggered(): void;
  15068. }
  15069. }
  15070. }
  15071. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15072. import { Nullable } from "babylonjs/types";
  15073. import { Observable } from "babylonjs/Misc/observable";
  15074. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15075. import { Scene } from "babylonjs/scene";
  15076. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15077. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15078. import { Node } from "babylonjs/node";
  15079. import { Ray } from "babylonjs/Culling/ray";
  15080. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15081. import "babylonjs/Engines/Extensions/engine.webVR";
  15082. /**
  15083. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15084. * IMPORTANT!! The data is right-hand data.
  15085. * @export
  15086. * @interface DevicePose
  15087. */
  15088. export interface DevicePose {
  15089. /**
  15090. * The position of the device, values in array are [x,y,z].
  15091. */
  15092. readonly position: Nullable<Float32Array>;
  15093. /**
  15094. * The linearVelocity of the device, values in array are [x,y,z].
  15095. */
  15096. readonly linearVelocity: Nullable<Float32Array>;
  15097. /**
  15098. * The linearAcceleration of the device, values in array are [x,y,z].
  15099. */
  15100. readonly linearAcceleration: Nullable<Float32Array>;
  15101. /**
  15102. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15103. */
  15104. readonly orientation: Nullable<Float32Array>;
  15105. /**
  15106. * The angularVelocity of the device, values in array are [x,y,z].
  15107. */
  15108. readonly angularVelocity: Nullable<Float32Array>;
  15109. /**
  15110. * The angularAcceleration of the device, values in array are [x,y,z].
  15111. */
  15112. readonly angularAcceleration: Nullable<Float32Array>;
  15113. }
  15114. /**
  15115. * Interface representing a pose controlled object in Babylon.
  15116. * A pose controlled object has both regular pose values as well as pose values
  15117. * from an external device such as a VR head mounted display
  15118. */
  15119. export interface PoseControlled {
  15120. /**
  15121. * The position of the object in babylon space.
  15122. */
  15123. position: Vector3;
  15124. /**
  15125. * The rotation quaternion of the object in babylon space.
  15126. */
  15127. rotationQuaternion: Quaternion;
  15128. /**
  15129. * The position of the device in babylon space.
  15130. */
  15131. devicePosition?: Vector3;
  15132. /**
  15133. * The rotation quaternion of the device in babylon space.
  15134. */
  15135. deviceRotationQuaternion: Quaternion;
  15136. /**
  15137. * The raw pose coming from the device.
  15138. */
  15139. rawPose: Nullable<DevicePose>;
  15140. /**
  15141. * The scale of the device to be used when translating from device space to babylon space.
  15142. */
  15143. deviceScaleFactor: number;
  15144. /**
  15145. * Updates the poseControlled values based on the input device pose.
  15146. * @param poseData the pose data to update the object with
  15147. */
  15148. updateFromDevice(poseData: DevicePose): void;
  15149. }
  15150. /**
  15151. * Set of options to customize the webVRCamera
  15152. */
  15153. export interface WebVROptions {
  15154. /**
  15155. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15156. */
  15157. trackPosition?: boolean;
  15158. /**
  15159. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15160. */
  15161. positionScale?: number;
  15162. /**
  15163. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15164. */
  15165. displayName?: string;
  15166. /**
  15167. * Should the native controller meshes be initialized. (default: true)
  15168. */
  15169. controllerMeshes?: boolean;
  15170. /**
  15171. * Creating a default HemiLight only on controllers. (default: true)
  15172. */
  15173. defaultLightingOnControllers?: boolean;
  15174. /**
  15175. * If you don't want to use the default VR button of the helper. (default: false)
  15176. */
  15177. useCustomVRButton?: boolean;
  15178. /**
  15179. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15180. */
  15181. customVRButton?: HTMLButtonElement;
  15182. /**
  15183. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15184. */
  15185. rayLength?: number;
  15186. /**
  15187. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15188. */
  15189. defaultHeight?: number;
  15190. /**
  15191. * If multiview should be used if availible (default: false)
  15192. */
  15193. useMultiview?: boolean;
  15194. }
  15195. /**
  15196. * This represents a WebVR camera.
  15197. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15198. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15199. */
  15200. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15201. private webVROptions;
  15202. /**
  15203. * @hidden
  15204. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15205. */
  15206. _vrDevice: any;
  15207. /**
  15208. * The rawPose of the vrDevice.
  15209. */
  15210. rawPose: Nullable<DevicePose>;
  15211. private _onVREnabled;
  15212. private _specsVersion;
  15213. private _attached;
  15214. private _frameData;
  15215. protected _descendants: Array<Node>;
  15216. private _deviceRoomPosition;
  15217. /** @hidden */
  15218. _deviceRoomRotationQuaternion: Quaternion;
  15219. private _standingMatrix;
  15220. /**
  15221. * Represents device position in babylon space.
  15222. */
  15223. devicePosition: Vector3;
  15224. /**
  15225. * Represents device rotation in babylon space.
  15226. */
  15227. deviceRotationQuaternion: Quaternion;
  15228. /**
  15229. * The scale of the device to be used when translating from device space to babylon space.
  15230. */
  15231. deviceScaleFactor: number;
  15232. private _deviceToWorld;
  15233. private _worldToDevice;
  15234. /**
  15235. * References to the webVR controllers for the vrDevice.
  15236. */
  15237. controllers: Array<WebVRController>;
  15238. /**
  15239. * Emits an event when a controller is attached.
  15240. */
  15241. onControllersAttachedObservable: Observable<WebVRController[]>;
  15242. /**
  15243. * Emits an event when a controller's mesh has been loaded;
  15244. */
  15245. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15246. /**
  15247. * Emits an event when the HMD's pose has been updated.
  15248. */
  15249. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15250. private _poseSet;
  15251. /**
  15252. * If the rig cameras be used as parent instead of this camera.
  15253. */
  15254. rigParenting: boolean;
  15255. private _lightOnControllers;
  15256. private _defaultHeight?;
  15257. /**
  15258. * Instantiates a WebVRFreeCamera.
  15259. * @param name The name of the WebVRFreeCamera
  15260. * @param position The starting anchor position for the camera
  15261. * @param scene The scene the camera belongs to
  15262. * @param webVROptions a set of customizable options for the webVRCamera
  15263. */
  15264. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15265. /**
  15266. * Gets the device distance from the ground in meters.
  15267. * @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.
  15268. */
  15269. deviceDistanceToRoomGround(): number;
  15270. /**
  15271. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15272. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15273. */
  15274. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15275. /**
  15276. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15277. * @returns A promise with a boolean set to if the standing matrix is supported.
  15278. */
  15279. useStandingMatrixAsync(): Promise<boolean>;
  15280. /**
  15281. * Disposes the camera
  15282. */
  15283. dispose(): void;
  15284. /**
  15285. * Gets a vrController by name.
  15286. * @param name The name of the controller to retreive
  15287. * @returns the controller matching the name specified or null if not found
  15288. */
  15289. getControllerByName(name: string): Nullable<WebVRController>;
  15290. private _leftController;
  15291. /**
  15292. * The controller corresponding to the users left hand.
  15293. */
  15294. readonly leftController: Nullable<WebVRController>;
  15295. private _rightController;
  15296. /**
  15297. * The controller corresponding to the users right hand.
  15298. */
  15299. readonly rightController: Nullable<WebVRController>;
  15300. /**
  15301. * Casts a ray forward from the vrCamera's gaze.
  15302. * @param length Length of the ray (default: 100)
  15303. * @returns the ray corresponding to the gaze
  15304. */
  15305. getForwardRay(length?: number): Ray;
  15306. /**
  15307. * @hidden
  15308. * Updates the camera based on device's frame data
  15309. */
  15310. _checkInputs(): void;
  15311. /**
  15312. * Updates the poseControlled values based on the input device pose.
  15313. * @param poseData Pose coming from the device
  15314. */
  15315. updateFromDevice(poseData: DevicePose): void;
  15316. private _htmlElementAttached;
  15317. private _detachIfAttached;
  15318. /**
  15319. * WebVR's attach control will start broadcasting frames to the device.
  15320. * Note that in certain browsers (chrome for example) this function must be called
  15321. * within a user-interaction callback. Example:
  15322. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15323. *
  15324. * @param element html element to attach the vrDevice to
  15325. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15326. */
  15327. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15328. /**
  15329. * Detaches the camera from the html element and disables VR
  15330. *
  15331. * @param element html element to detach from
  15332. */
  15333. detachControl(element: HTMLElement): void;
  15334. /**
  15335. * @returns the name of this class
  15336. */
  15337. getClassName(): string;
  15338. /**
  15339. * Calls resetPose on the vrDisplay
  15340. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15341. */
  15342. resetToCurrentRotation(): void;
  15343. /**
  15344. * @hidden
  15345. * Updates the rig cameras (left and right eye)
  15346. */
  15347. _updateRigCameras(): void;
  15348. private _workingVector;
  15349. private _oneVector;
  15350. private _workingMatrix;
  15351. private updateCacheCalled;
  15352. private _correctPositionIfNotTrackPosition;
  15353. /**
  15354. * @hidden
  15355. * Updates the cached values of the camera
  15356. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15357. */
  15358. _updateCache(ignoreParentClass?: boolean): void;
  15359. /**
  15360. * @hidden
  15361. * Get current device position in babylon world
  15362. */
  15363. _computeDevicePosition(): void;
  15364. /**
  15365. * Updates the current device position and rotation in the babylon world
  15366. */
  15367. update(): void;
  15368. /**
  15369. * @hidden
  15370. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15371. * @returns an identity matrix
  15372. */
  15373. _getViewMatrix(): Matrix;
  15374. private _tmpMatrix;
  15375. /**
  15376. * This function is called by the two RIG cameras.
  15377. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15378. * @hidden
  15379. */
  15380. _getWebVRViewMatrix(): Matrix;
  15381. /** @hidden */
  15382. _getWebVRProjectionMatrix(): Matrix;
  15383. private _onGamepadConnectedObserver;
  15384. private _onGamepadDisconnectedObserver;
  15385. private _updateCacheWhenTrackingDisabledObserver;
  15386. /**
  15387. * Initializes the controllers and their meshes
  15388. */
  15389. initControllers(): void;
  15390. }
  15391. }
  15392. declare module "babylonjs/PostProcesses/postProcess" {
  15393. import { Nullable } from "babylonjs/types";
  15394. import { SmartArray } from "babylonjs/Misc/smartArray";
  15395. import { Observable } from "babylonjs/Misc/observable";
  15396. import { Vector2 } from "babylonjs/Maths/math.vector";
  15397. import { Camera } from "babylonjs/Cameras/camera";
  15398. import { Effect } from "babylonjs/Materials/effect";
  15399. import "babylonjs/Shaders/postprocess.vertex";
  15400. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15401. import { Engine } from "babylonjs/Engines/engine";
  15402. import { Color4 } from "babylonjs/Maths/math.color";
  15403. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15404. /**
  15405. * Size options for a post process
  15406. */
  15407. export type PostProcessOptions = {
  15408. width: number;
  15409. height: number;
  15410. };
  15411. /**
  15412. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15413. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15414. */
  15415. export class PostProcess {
  15416. /** Name of the PostProcess. */
  15417. name: string;
  15418. /**
  15419. * Gets or sets the unique id of the post process
  15420. */
  15421. uniqueId: number;
  15422. /**
  15423. * Width of the texture to apply the post process on
  15424. */
  15425. width: number;
  15426. /**
  15427. * Height of the texture to apply the post process on
  15428. */
  15429. height: number;
  15430. /**
  15431. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15432. * @hidden
  15433. */
  15434. _outputTexture: Nullable<InternalTexture>;
  15435. /**
  15436. * Sampling mode used by the shader
  15437. * See https://doc.babylonjs.com/classes/3.1/texture
  15438. */
  15439. renderTargetSamplingMode: number;
  15440. /**
  15441. * Clear color to use when screen clearing
  15442. */
  15443. clearColor: Color4;
  15444. /**
  15445. * If the buffer needs to be cleared before applying the post process. (default: true)
  15446. * Should be set to false if shader will overwrite all previous pixels.
  15447. */
  15448. autoClear: boolean;
  15449. /**
  15450. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15451. */
  15452. alphaMode: number;
  15453. /**
  15454. * Sets the setAlphaBlendConstants of the babylon engine
  15455. */
  15456. alphaConstants: Color4;
  15457. /**
  15458. * Animations to be used for the post processing
  15459. */
  15460. animations: import("babylonjs/Animations/animation").Animation[];
  15461. /**
  15462. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15463. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15464. */
  15465. enablePixelPerfectMode: boolean;
  15466. /**
  15467. * Force the postprocess to be applied without taking in account viewport
  15468. */
  15469. forceFullscreenViewport: boolean;
  15470. /**
  15471. * List of inspectable custom properties (used by the Inspector)
  15472. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15473. */
  15474. inspectableCustomProperties: IInspectable[];
  15475. /**
  15476. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15477. *
  15478. * | Value | Type | Description |
  15479. * | ----- | ----------------------------------- | ----------- |
  15480. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15481. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15482. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15483. *
  15484. */
  15485. scaleMode: number;
  15486. /**
  15487. * Force textures to be a power of two (default: false)
  15488. */
  15489. alwaysForcePOT: boolean;
  15490. private _samples;
  15491. /**
  15492. * Number of sample textures (default: 1)
  15493. */
  15494. samples: number;
  15495. /**
  15496. * Modify the scale of the post process to be the same as the viewport (default: false)
  15497. */
  15498. adaptScaleToCurrentViewport: boolean;
  15499. private _camera;
  15500. private _scene;
  15501. private _engine;
  15502. private _options;
  15503. private _reusable;
  15504. private _textureType;
  15505. /**
  15506. * Smart array of input and output textures for the post process.
  15507. * @hidden
  15508. */
  15509. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15510. /**
  15511. * The index in _textures that corresponds to the output texture.
  15512. * @hidden
  15513. */
  15514. _currentRenderTextureInd: number;
  15515. private _effect;
  15516. private _samplers;
  15517. private _fragmentUrl;
  15518. private _vertexUrl;
  15519. private _parameters;
  15520. private _scaleRatio;
  15521. protected _indexParameters: any;
  15522. private _shareOutputWithPostProcess;
  15523. private _texelSize;
  15524. private _forcedOutputTexture;
  15525. /**
  15526. * Returns the fragment url or shader name used in the post process.
  15527. * @returns the fragment url or name in the shader store.
  15528. */
  15529. getEffectName(): string;
  15530. /**
  15531. * An event triggered when the postprocess is activated.
  15532. */
  15533. onActivateObservable: Observable<Camera>;
  15534. private _onActivateObserver;
  15535. /**
  15536. * A function that is added to the onActivateObservable
  15537. */
  15538. onActivate: Nullable<(camera: Camera) => void>;
  15539. /**
  15540. * An event triggered when the postprocess changes its size.
  15541. */
  15542. onSizeChangedObservable: Observable<PostProcess>;
  15543. private _onSizeChangedObserver;
  15544. /**
  15545. * A function that is added to the onSizeChangedObservable
  15546. */
  15547. onSizeChanged: (postProcess: PostProcess) => void;
  15548. /**
  15549. * An event triggered when the postprocess applies its effect.
  15550. */
  15551. onApplyObservable: Observable<Effect>;
  15552. private _onApplyObserver;
  15553. /**
  15554. * A function that is added to the onApplyObservable
  15555. */
  15556. onApply: (effect: Effect) => void;
  15557. /**
  15558. * An event triggered before rendering the postprocess
  15559. */
  15560. onBeforeRenderObservable: Observable<Effect>;
  15561. private _onBeforeRenderObserver;
  15562. /**
  15563. * A function that is added to the onBeforeRenderObservable
  15564. */
  15565. onBeforeRender: (effect: Effect) => void;
  15566. /**
  15567. * An event triggered after rendering the postprocess
  15568. */
  15569. onAfterRenderObservable: Observable<Effect>;
  15570. private _onAfterRenderObserver;
  15571. /**
  15572. * A function that is added to the onAfterRenderObservable
  15573. */
  15574. onAfterRender: (efect: Effect) => void;
  15575. /**
  15576. * 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
  15577. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15578. */
  15579. inputTexture: InternalTexture;
  15580. /**
  15581. * Gets the camera which post process is applied to.
  15582. * @returns The camera the post process is applied to.
  15583. */
  15584. getCamera(): Camera;
  15585. /**
  15586. * Gets the texel size of the postprocess.
  15587. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15588. */
  15589. readonly texelSize: Vector2;
  15590. /**
  15591. * Creates a new instance PostProcess
  15592. * @param name The name of the PostProcess.
  15593. * @param fragmentUrl The url of the fragment shader to be used.
  15594. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15595. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15596. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15597. * @param camera The camera to apply the render pass to.
  15598. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15599. * @param engine The engine which the post process will be applied. (default: current engine)
  15600. * @param reusable If the post process can be reused on the same frame. (default: false)
  15601. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15602. * @param textureType Type of textures used when performing the post process. (default: 0)
  15603. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15604. * @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
  15605. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15606. */
  15607. constructor(
  15608. /** Name of the PostProcess. */
  15609. 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);
  15610. /**
  15611. * Gets a string idenfifying the name of the class
  15612. * @returns "PostProcess" string
  15613. */
  15614. getClassName(): string;
  15615. /**
  15616. * Gets the engine which this post process belongs to.
  15617. * @returns The engine the post process was enabled with.
  15618. */
  15619. getEngine(): Engine;
  15620. /**
  15621. * The effect that is created when initializing the post process.
  15622. * @returns The created effect corresponding the the postprocess.
  15623. */
  15624. getEffect(): Effect;
  15625. /**
  15626. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15627. * @param postProcess The post process to share the output with.
  15628. * @returns This post process.
  15629. */
  15630. shareOutputWith(postProcess: PostProcess): PostProcess;
  15631. /**
  15632. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15633. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15634. */
  15635. useOwnOutput(): void;
  15636. /**
  15637. * Updates the effect with the current post process compile time values and recompiles the shader.
  15638. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15639. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15640. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15641. * @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
  15642. * @param onCompiled Called when the shader has been compiled.
  15643. * @param onError Called if there is an error when compiling a shader.
  15644. */
  15645. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15646. /**
  15647. * The post process is reusable if it can be used multiple times within one frame.
  15648. * @returns If the post process is reusable
  15649. */
  15650. isReusable(): boolean;
  15651. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15652. markTextureDirty(): void;
  15653. /**
  15654. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15655. * 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.
  15656. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15657. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15658. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15659. * @returns The target texture that was bound to be written to.
  15660. */
  15661. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15662. /**
  15663. * If the post process is supported.
  15664. */
  15665. readonly isSupported: boolean;
  15666. /**
  15667. * The aspect ratio of the output texture.
  15668. */
  15669. readonly aspectRatio: number;
  15670. /**
  15671. * Get a value indicating if the post-process is ready to be used
  15672. * @returns true if the post-process is ready (shader is compiled)
  15673. */
  15674. isReady(): boolean;
  15675. /**
  15676. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15677. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15678. */
  15679. apply(): Nullable<Effect>;
  15680. private _disposeTextures;
  15681. /**
  15682. * Disposes the post process.
  15683. * @param camera The camera to dispose the post process on.
  15684. */
  15685. dispose(camera?: Camera): void;
  15686. }
  15687. }
  15688. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15689. /** @hidden */
  15690. export var kernelBlurVaryingDeclaration: {
  15691. name: string;
  15692. shader: string;
  15693. };
  15694. }
  15695. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15696. /** @hidden */
  15697. export var kernelBlurFragment: {
  15698. name: string;
  15699. shader: string;
  15700. };
  15701. }
  15702. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15703. /** @hidden */
  15704. export var kernelBlurFragment2: {
  15705. name: string;
  15706. shader: string;
  15707. };
  15708. }
  15709. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15710. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15711. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15712. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15713. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15714. /** @hidden */
  15715. export var kernelBlurPixelShader: {
  15716. name: string;
  15717. shader: string;
  15718. };
  15719. }
  15720. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15721. /** @hidden */
  15722. export var kernelBlurVertex: {
  15723. name: string;
  15724. shader: string;
  15725. };
  15726. }
  15727. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15728. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15729. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  15730. /** @hidden */
  15731. export var kernelBlurVertexShader: {
  15732. name: string;
  15733. shader: string;
  15734. };
  15735. }
  15736. declare module "babylonjs/PostProcesses/blurPostProcess" {
  15737. import { Vector2 } from "babylonjs/Maths/math.vector";
  15738. import { Nullable } from "babylonjs/types";
  15739. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  15740. import { Camera } from "babylonjs/Cameras/camera";
  15741. import { Effect } from "babylonjs/Materials/effect";
  15742. import { Engine } from "babylonjs/Engines/engine";
  15743. import "babylonjs/Shaders/kernelBlur.fragment";
  15744. import "babylonjs/Shaders/kernelBlur.vertex";
  15745. /**
  15746. * The Blur Post Process which blurs an image based on a kernel and direction.
  15747. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  15748. */
  15749. export class BlurPostProcess extends PostProcess {
  15750. /** The direction in which to blur the image. */
  15751. direction: Vector2;
  15752. private blockCompilation;
  15753. protected _kernel: number;
  15754. protected _idealKernel: number;
  15755. protected _packedFloat: boolean;
  15756. private _staticDefines;
  15757. /**
  15758. * Sets the length in pixels of the blur sample region
  15759. */
  15760. /**
  15761. * Gets the length in pixels of the blur sample region
  15762. */
  15763. kernel: number;
  15764. /**
  15765. * Sets wether or not the blur needs to unpack/repack floats
  15766. */
  15767. /**
  15768. * Gets wether or not the blur is unpacking/repacking floats
  15769. */
  15770. packedFloat: boolean;
  15771. /**
  15772. * Creates a new instance BlurPostProcess
  15773. * @param name The name of the effect.
  15774. * @param direction The direction in which to blur the image.
  15775. * @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.
  15776. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15777. * @param camera The camera to apply the render pass to.
  15778. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15779. * @param engine The engine which the post process will be applied. (default: current engine)
  15780. * @param reusable If the post process can be reused on the same frame. (default: false)
  15781. * @param textureType Type of textures used when performing the post process. (default: 0)
  15782. * @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)
  15783. */
  15784. constructor(name: string,
  15785. /** The direction in which to blur the image. */
  15786. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  15787. /**
  15788. * Updates the effect with the current post process compile time values and recompiles the shader.
  15789. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15790. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15791. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15792. * @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
  15793. * @param onCompiled Called when the shader has been compiled.
  15794. * @param onError Called if there is an error when compiling a shader.
  15795. */
  15796. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15797. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15798. /**
  15799. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  15800. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  15801. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  15802. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  15803. * The gaps between physical kernels are compensated for in the weighting of the samples
  15804. * @param idealKernel Ideal blur kernel.
  15805. * @return Nearest best kernel.
  15806. */
  15807. protected _nearestBestKernel(idealKernel: number): number;
  15808. /**
  15809. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  15810. * @param x The point on the Gaussian distribution to sample.
  15811. * @return the value of the Gaussian function at x.
  15812. */
  15813. protected _gaussianWeight(x: number): number;
  15814. /**
  15815. * Generates a string that can be used as a floating point number in GLSL.
  15816. * @param x Value to print.
  15817. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  15818. * @return GLSL float string.
  15819. */
  15820. protected _glslFloat(x: number, decimalFigures?: number): string;
  15821. }
  15822. }
  15823. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  15824. import { Scene } from "babylonjs/scene";
  15825. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15826. import { Plane } from "babylonjs/Maths/math.plane";
  15827. /**
  15828. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15829. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15830. * You can then easily use it as a reflectionTexture on a flat surface.
  15831. * In case the surface is not a plane, please consider relying on reflection probes.
  15832. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15833. */
  15834. export class MirrorTexture extends RenderTargetTexture {
  15835. private scene;
  15836. /**
  15837. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  15838. * 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.
  15839. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15840. */
  15841. mirrorPlane: Plane;
  15842. /**
  15843. * Define the blur ratio used to blur the reflection if needed.
  15844. */
  15845. blurRatio: number;
  15846. /**
  15847. * Define the adaptive blur kernel used to blur the reflection if needed.
  15848. * This will autocompute the closest best match for the `blurKernel`
  15849. */
  15850. adaptiveBlurKernel: number;
  15851. /**
  15852. * Define the blur kernel used to blur the reflection if needed.
  15853. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15854. */
  15855. blurKernel: number;
  15856. /**
  15857. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  15858. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15859. */
  15860. blurKernelX: number;
  15861. /**
  15862. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  15863. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15864. */
  15865. blurKernelY: number;
  15866. private _autoComputeBlurKernel;
  15867. protected _onRatioRescale(): void;
  15868. private _updateGammaSpace;
  15869. private _imageProcessingConfigChangeObserver;
  15870. private _transformMatrix;
  15871. private _mirrorMatrix;
  15872. private _savedViewMatrix;
  15873. private _blurX;
  15874. private _blurY;
  15875. private _adaptiveBlurKernel;
  15876. private _blurKernelX;
  15877. private _blurKernelY;
  15878. private _blurRatio;
  15879. /**
  15880. * Instantiates a Mirror Texture.
  15881. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15882. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15883. * You can then easily use it as a reflectionTexture on a flat surface.
  15884. * In case the surface is not a plane, please consider relying on reflection probes.
  15885. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15886. * @param name
  15887. * @param size
  15888. * @param scene
  15889. * @param generateMipMaps
  15890. * @param type
  15891. * @param samplingMode
  15892. * @param generateDepthBuffer
  15893. */
  15894. constructor(name: string, size: number | {
  15895. width: number;
  15896. height: number;
  15897. } | {
  15898. ratio: number;
  15899. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  15900. private _preparePostProcesses;
  15901. /**
  15902. * Clone the mirror texture.
  15903. * @returns the cloned texture
  15904. */
  15905. clone(): MirrorTexture;
  15906. /**
  15907. * Serialize the texture to a JSON representation you could use in Parse later on
  15908. * @returns the serialized JSON representation
  15909. */
  15910. serialize(): any;
  15911. /**
  15912. * Dispose the texture and release its associated resources.
  15913. */
  15914. dispose(): void;
  15915. }
  15916. }
  15917. declare module "babylonjs/Materials/Textures/texture" {
  15918. import { Observable } from "babylonjs/Misc/observable";
  15919. import { Nullable } from "babylonjs/types";
  15920. import { Scene } from "babylonjs/scene";
  15921. import { Matrix } from "babylonjs/Maths/math.vector";
  15922. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  15923. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15924. import { Engine } from "babylonjs/Engines/engine";
  15925. /**
  15926. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  15927. * @see http://doc.babylonjs.com/babylon101/materials#texture
  15928. */
  15929. export class Texture extends BaseTexture {
  15930. /** @hidden */
  15931. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  15932. /** @hidden */
  15933. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  15934. /** @hidden */
  15935. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  15936. /** nearest is mag = nearest and min = nearest and mip = linear */
  15937. static readonly NEAREST_SAMPLINGMODE: number;
  15938. /** nearest is mag = nearest and min = nearest and mip = linear */
  15939. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  15940. /** Bilinear is mag = linear and min = linear and mip = nearest */
  15941. static readonly BILINEAR_SAMPLINGMODE: number;
  15942. /** Bilinear is mag = linear and min = linear and mip = nearest */
  15943. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  15944. /** Trilinear is mag = linear and min = linear and mip = linear */
  15945. static readonly TRILINEAR_SAMPLINGMODE: number;
  15946. /** Trilinear is mag = linear and min = linear and mip = linear */
  15947. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  15948. /** mag = nearest and min = nearest and mip = nearest */
  15949. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  15950. /** mag = nearest and min = linear and mip = nearest */
  15951. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  15952. /** mag = nearest and min = linear and mip = linear */
  15953. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  15954. /** mag = nearest and min = linear and mip = none */
  15955. static readonly NEAREST_LINEAR: number;
  15956. /** mag = nearest and min = nearest and mip = none */
  15957. static readonly NEAREST_NEAREST: number;
  15958. /** mag = linear and min = nearest and mip = nearest */
  15959. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  15960. /** mag = linear and min = nearest and mip = linear */
  15961. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  15962. /** mag = linear and min = linear and mip = none */
  15963. static readonly LINEAR_LINEAR: number;
  15964. /** mag = linear and min = nearest and mip = none */
  15965. static readonly LINEAR_NEAREST: number;
  15966. /** Explicit coordinates mode */
  15967. static readonly EXPLICIT_MODE: number;
  15968. /** Spherical coordinates mode */
  15969. static readonly SPHERICAL_MODE: number;
  15970. /** Planar coordinates mode */
  15971. static readonly PLANAR_MODE: number;
  15972. /** Cubic coordinates mode */
  15973. static readonly CUBIC_MODE: number;
  15974. /** Projection coordinates mode */
  15975. static readonly PROJECTION_MODE: number;
  15976. /** Inverse Cubic coordinates mode */
  15977. static readonly SKYBOX_MODE: number;
  15978. /** Inverse Cubic coordinates mode */
  15979. static readonly INVCUBIC_MODE: number;
  15980. /** Equirectangular coordinates mode */
  15981. static readonly EQUIRECTANGULAR_MODE: number;
  15982. /** Equirectangular Fixed coordinates mode */
  15983. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  15984. /** Equirectangular Fixed Mirrored coordinates mode */
  15985. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  15986. /** Texture is not repeating outside of 0..1 UVs */
  15987. static readonly CLAMP_ADDRESSMODE: number;
  15988. /** Texture is repeating outside of 0..1 UVs */
  15989. static readonly WRAP_ADDRESSMODE: number;
  15990. /** Texture is repeating and mirrored */
  15991. static readonly MIRROR_ADDRESSMODE: number;
  15992. /**
  15993. * 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
  15994. */
  15995. static UseSerializedUrlIfAny: boolean;
  15996. /**
  15997. * Define the url of the texture.
  15998. */
  15999. url: Nullable<string>;
  16000. /**
  16001. * Define an offset on the texture to offset the u coordinates of the UVs
  16002. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16003. */
  16004. uOffset: number;
  16005. /**
  16006. * Define an offset on the texture to offset the v coordinates of the UVs
  16007. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16008. */
  16009. vOffset: number;
  16010. /**
  16011. * Define an offset on the texture to scale the u coordinates of the UVs
  16012. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16013. */
  16014. uScale: number;
  16015. /**
  16016. * Define an offset on the texture to scale the v coordinates of the UVs
  16017. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16018. */
  16019. vScale: number;
  16020. /**
  16021. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16022. * @see http://doc.babylonjs.com/how_to/more_materials
  16023. */
  16024. uAng: number;
  16025. /**
  16026. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16027. * @see http://doc.babylonjs.com/how_to/more_materials
  16028. */
  16029. vAng: number;
  16030. /**
  16031. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16032. * @see http://doc.babylonjs.com/how_to/more_materials
  16033. */
  16034. wAng: number;
  16035. /**
  16036. * Defines the center of rotation (U)
  16037. */
  16038. uRotationCenter: number;
  16039. /**
  16040. * Defines the center of rotation (V)
  16041. */
  16042. vRotationCenter: number;
  16043. /**
  16044. * Defines the center of rotation (W)
  16045. */
  16046. wRotationCenter: number;
  16047. /**
  16048. * Are mip maps generated for this texture or not.
  16049. */
  16050. readonly noMipmap: boolean;
  16051. /**
  16052. * List of inspectable custom properties (used by the Inspector)
  16053. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16054. */
  16055. inspectableCustomProperties: Nullable<IInspectable[]>;
  16056. private _noMipmap;
  16057. /** @hidden */
  16058. _invertY: boolean;
  16059. private _rowGenerationMatrix;
  16060. private _cachedTextureMatrix;
  16061. private _projectionModeMatrix;
  16062. private _t0;
  16063. private _t1;
  16064. private _t2;
  16065. private _cachedUOffset;
  16066. private _cachedVOffset;
  16067. private _cachedUScale;
  16068. private _cachedVScale;
  16069. private _cachedUAng;
  16070. private _cachedVAng;
  16071. private _cachedWAng;
  16072. private _cachedProjectionMatrixId;
  16073. private _cachedCoordinatesMode;
  16074. /** @hidden */
  16075. protected _initialSamplingMode: number;
  16076. /** @hidden */
  16077. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>;
  16078. private _deleteBuffer;
  16079. protected _format: Nullable<number>;
  16080. private _delayedOnLoad;
  16081. private _delayedOnError;
  16082. /**
  16083. * Observable triggered once the texture has been loaded.
  16084. */
  16085. onLoadObservable: Observable<Texture>;
  16086. protected _isBlocking: boolean;
  16087. /**
  16088. * Is the texture preventing material to render while loading.
  16089. * If false, a default texture will be used instead of the loading one during the preparation step.
  16090. */
  16091. isBlocking: boolean;
  16092. /**
  16093. * Get the current sampling mode associated with the texture.
  16094. */
  16095. readonly samplingMode: number;
  16096. /**
  16097. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16098. */
  16099. readonly invertY: boolean;
  16100. /**
  16101. * Instantiates a new texture.
  16102. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16103. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16104. * @param url define the url of the picture to load as a texture
  16105. * @param scene define the scene or engine the texture will belong to
  16106. * @param noMipmap define if the texture will require mip maps or not
  16107. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16108. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16109. * @param onLoad define a callback triggered when the texture has been loaded
  16110. * @param onError define a callback triggered when an error occurred during the loading session
  16111. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16112. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16113. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16114. */
  16115. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | Engine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, deleteBuffer?: boolean, format?: number);
  16116. /**
  16117. * Update the url (and optional buffer) of this texture if url was null during construction.
  16118. * @param url the url of the texture
  16119. * @param buffer the buffer of the texture (defaults to null)
  16120. * @param onLoad callback called when the texture is loaded (defaults to null)
  16121. */
  16122. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16123. /**
  16124. * Finish the loading sequence of a texture flagged as delayed load.
  16125. * @hidden
  16126. */
  16127. delayLoad(): void;
  16128. private _prepareRowForTextureGeneration;
  16129. /**
  16130. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16131. * @returns the transform matrix of the texture.
  16132. */
  16133. getTextureMatrix(): Matrix;
  16134. /**
  16135. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16136. * @returns The reflection texture transform
  16137. */
  16138. getReflectionTextureMatrix(): Matrix;
  16139. /**
  16140. * Clones the texture.
  16141. * @returns the cloned texture
  16142. */
  16143. clone(): Texture;
  16144. /**
  16145. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16146. * @returns The JSON representation of the texture
  16147. */
  16148. serialize(): any;
  16149. /**
  16150. * Get the current class name of the texture useful for serialization or dynamic coding.
  16151. * @returns "Texture"
  16152. */
  16153. getClassName(): string;
  16154. /**
  16155. * Dispose the texture and release its associated resources.
  16156. */
  16157. dispose(): void;
  16158. /**
  16159. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16160. * @param parsedTexture Define the JSON representation of the texture
  16161. * @param scene Define the scene the parsed texture should be instantiated in
  16162. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16163. * @returns The parsed texture if successful
  16164. */
  16165. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16166. /**
  16167. * Creates a texture from its base 64 representation.
  16168. * @param data Define the base64 payload without the data: prefix
  16169. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16170. * @param scene Define the scene the texture should belong to
  16171. * @param noMipmap Forces the texture to not create mip map information if true
  16172. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16173. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16174. * @param onLoad define a callback triggered when the texture has been loaded
  16175. * @param onError define a callback triggered when an error occurred during the loading session
  16176. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16177. * @returns the created texture
  16178. */
  16179. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16180. /**
  16181. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16182. * @param data Define the base64 payload without the data: prefix
  16183. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16184. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16185. * @param scene Define the scene the texture should belong to
  16186. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16187. * @param noMipmap Forces the texture to not create mip map information if true
  16188. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16189. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16190. * @param onLoad define a callback triggered when the texture has been loaded
  16191. * @param onError define a callback triggered when an error occurred during the loading session
  16192. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16193. * @returns the created texture
  16194. */
  16195. 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;
  16196. }
  16197. }
  16198. declare module "babylonjs/PostProcesses/postProcessManager" {
  16199. import { Nullable } from "babylonjs/types";
  16200. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16201. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16202. import { Scene } from "babylonjs/scene";
  16203. /**
  16204. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16205. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16206. */
  16207. export class PostProcessManager {
  16208. private _scene;
  16209. private _indexBuffer;
  16210. private _vertexBuffers;
  16211. /**
  16212. * Creates a new instance PostProcess
  16213. * @param scene The scene that the post process is associated with.
  16214. */
  16215. constructor(scene: Scene);
  16216. private _prepareBuffers;
  16217. private _buildIndexBuffer;
  16218. /**
  16219. * Rebuilds the vertex buffers of the manager.
  16220. * @hidden
  16221. */
  16222. _rebuild(): void;
  16223. /**
  16224. * Prepares a frame to be run through a post process.
  16225. * @param sourceTexture The input texture to the post procesess. (default: null)
  16226. * @param postProcesses An array of post processes to be run. (default: null)
  16227. * @returns True if the post processes were able to be run.
  16228. * @hidden
  16229. */
  16230. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16231. /**
  16232. * Manually render a set of post processes to a texture.
  16233. * @param postProcesses An array of post processes to be run.
  16234. * @param targetTexture The target texture to render to.
  16235. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16236. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16237. * @param lodLevel defines which lod of the texture to render to
  16238. */
  16239. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16240. /**
  16241. * Finalize the result of the output of the postprocesses.
  16242. * @param doNotPresent If true the result will not be displayed to the screen.
  16243. * @param targetTexture The target texture to render to.
  16244. * @param faceIndex The index of the face to bind the target texture to.
  16245. * @param postProcesses The array of post processes to render.
  16246. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16247. * @hidden
  16248. */
  16249. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16250. /**
  16251. * Disposes of the post process manager.
  16252. */
  16253. dispose(): void;
  16254. }
  16255. }
  16256. declare module "babylonjs/Misc/gradients" {
  16257. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16258. /** Interface used by value gradients (color, factor, ...) */
  16259. export interface IValueGradient {
  16260. /**
  16261. * Gets or sets the gradient value (between 0 and 1)
  16262. */
  16263. gradient: number;
  16264. }
  16265. /** Class used to store color4 gradient */
  16266. export class ColorGradient implements IValueGradient {
  16267. /**
  16268. * Gets or sets the gradient value (between 0 and 1)
  16269. */
  16270. gradient: number;
  16271. /**
  16272. * Gets or sets first associated color
  16273. */
  16274. color1: Color4;
  16275. /**
  16276. * Gets or sets second associated color
  16277. */
  16278. color2?: Color4;
  16279. /**
  16280. * Will get a color picked randomly between color1 and color2.
  16281. * If color2 is undefined then color1 will be used
  16282. * @param result defines the target Color4 to store the result in
  16283. */
  16284. getColorToRef(result: Color4): void;
  16285. }
  16286. /** Class used to store color 3 gradient */
  16287. export class Color3Gradient implements IValueGradient {
  16288. /**
  16289. * Gets or sets the gradient value (between 0 and 1)
  16290. */
  16291. gradient: number;
  16292. /**
  16293. * Gets or sets the associated color
  16294. */
  16295. color: Color3;
  16296. }
  16297. /** Class used to store factor gradient */
  16298. export class FactorGradient implements IValueGradient {
  16299. /**
  16300. * Gets or sets the gradient value (between 0 and 1)
  16301. */
  16302. gradient: number;
  16303. /**
  16304. * Gets or sets first associated factor
  16305. */
  16306. factor1: number;
  16307. /**
  16308. * Gets or sets second associated factor
  16309. */
  16310. factor2?: number;
  16311. /**
  16312. * Will get a number picked randomly between factor1 and factor2.
  16313. * If factor2 is undefined then factor1 will be used
  16314. * @returns the picked number
  16315. */
  16316. getFactor(): number;
  16317. }
  16318. /**
  16319. * Helper used to simplify some generic gradient tasks
  16320. */
  16321. export class GradientHelper {
  16322. /**
  16323. * Gets the current gradient from an array of IValueGradient
  16324. * @param ratio defines the current ratio to get
  16325. * @param gradients defines the array of IValueGradient
  16326. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16327. */
  16328. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16329. }
  16330. }
  16331. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16332. import { Scene } from "babylonjs/scene";
  16333. import { ISceneComponent } from "babylonjs/sceneComponent";
  16334. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16335. module "babylonjs/abstractScene" {
  16336. interface AbstractScene {
  16337. /**
  16338. * The list of procedural textures added to the scene
  16339. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16340. */
  16341. proceduralTextures: Array<ProceduralTexture>;
  16342. }
  16343. }
  16344. /**
  16345. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16346. * in a given scene.
  16347. */
  16348. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16349. /**
  16350. * The component name helpfull to identify the component in the list of scene components.
  16351. */
  16352. readonly name: string;
  16353. /**
  16354. * The scene the component belongs to.
  16355. */
  16356. scene: Scene;
  16357. /**
  16358. * Creates a new instance of the component for the given scene
  16359. * @param scene Defines the scene to register the component in
  16360. */
  16361. constructor(scene: Scene);
  16362. /**
  16363. * Registers the component in a given scene
  16364. */
  16365. register(): void;
  16366. /**
  16367. * Rebuilds the elements related to this component in case of
  16368. * context lost for instance.
  16369. */
  16370. rebuild(): void;
  16371. /**
  16372. * Disposes the component and the associated ressources.
  16373. */
  16374. dispose(): void;
  16375. private _beforeClear;
  16376. }
  16377. }
  16378. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  16379. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16380. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16381. module "babylonjs/Engines/engine" {
  16382. interface Engine {
  16383. /**
  16384. * Creates a new render target cube texture
  16385. * @param size defines the size of the texture
  16386. * @param options defines the options used to create the texture
  16387. * @returns a new render target cube texture stored in an InternalTexture
  16388. */
  16389. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16390. }
  16391. }
  16392. }
  16393. declare module "babylonjs/Shaders/procedural.vertex" {
  16394. /** @hidden */
  16395. export var proceduralVertexShader: {
  16396. name: string;
  16397. shader: string;
  16398. };
  16399. }
  16400. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16401. import { Observable } from "babylonjs/Misc/observable";
  16402. import { Nullable } from "babylonjs/types";
  16403. import { Scene } from "babylonjs/scene";
  16404. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16405. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16406. import { Effect } from "babylonjs/Materials/effect";
  16407. import { Texture } from "babylonjs/Materials/Textures/texture";
  16408. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16409. import "babylonjs/Shaders/procedural.vertex";
  16410. /**
  16411. * 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.
  16412. * This is the base class of any Procedural texture and contains most of the shareable code.
  16413. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16414. */
  16415. export class ProceduralTexture extends Texture {
  16416. isCube: boolean;
  16417. /**
  16418. * Define if the texture is enabled or not (disabled texture will not render)
  16419. */
  16420. isEnabled: boolean;
  16421. /**
  16422. * Define if the texture must be cleared before rendering (default is true)
  16423. */
  16424. autoClear: boolean;
  16425. /**
  16426. * Callback called when the texture is generated
  16427. */
  16428. onGenerated: () => void;
  16429. /**
  16430. * Event raised when the texture is generated
  16431. */
  16432. onGeneratedObservable: Observable<ProceduralTexture>;
  16433. /** @hidden */
  16434. _generateMipMaps: boolean;
  16435. /** @hidden **/
  16436. _effect: Effect;
  16437. /** @hidden */
  16438. _textures: {
  16439. [key: string]: Texture;
  16440. };
  16441. private _size;
  16442. private _currentRefreshId;
  16443. private _refreshRate;
  16444. private _vertexBuffers;
  16445. private _indexBuffer;
  16446. private _uniforms;
  16447. private _samplers;
  16448. private _fragment;
  16449. private _floats;
  16450. private _ints;
  16451. private _floatsArrays;
  16452. private _colors3;
  16453. private _colors4;
  16454. private _vectors2;
  16455. private _vectors3;
  16456. private _matrices;
  16457. private _fallbackTexture;
  16458. private _fallbackTextureUsed;
  16459. private _engine;
  16460. private _cachedDefines;
  16461. private _contentUpdateId;
  16462. private _contentData;
  16463. /**
  16464. * Instantiates a new procedural texture.
  16465. * 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.
  16466. * This is the base class of any Procedural texture and contains most of the shareable code.
  16467. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16468. * @param name Define the name of the texture
  16469. * @param size Define the size of the texture to create
  16470. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16471. * @param scene Define the scene the texture belongs to
  16472. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16473. * @param generateMipMaps Define if the texture should creates mip maps or not
  16474. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16475. */
  16476. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16477. /**
  16478. * The effect that is created when initializing the post process.
  16479. * @returns The created effect corresponding the the postprocess.
  16480. */
  16481. getEffect(): Effect;
  16482. /**
  16483. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16484. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16485. */
  16486. getContent(): Nullable<ArrayBufferView>;
  16487. private _createIndexBuffer;
  16488. /** @hidden */
  16489. _rebuild(): void;
  16490. /**
  16491. * Resets the texture in order to recreate its associated resources.
  16492. * This can be called in case of context loss
  16493. */
  16494. reset(): void;
  16495. protected _getDefines(): string;
  16496. /**
  16497. * Is the texture ready to be used ? (rendered at least once)
  16498. * @returns true if ready, otherwise, false.
  16499. */
  16500. isReady(): boolean;
  16501. /**
  16502. * Resets the refresh counter of the texture and start bak from scratch.
  16503. * Could be useful to regenerate the texture if it is setup to render only once.
  16504. */
  16505. resetRefreshCounter(): void;
  16506. /**
  16507. * Set the fragment shader to use in order to render the texture.
  16508. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16509. */
  16510. setFragment(fragment: any): void;
  16511. /**
  16512. * Define the refresh rate of the texture or the rendering frequency.
  16513. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16514. */
  16515. refreshRate: number;
  16516. /** @hidden */
  16517. _shouldRender(): boolean;
  16518. /**
  16519. * Get the size the texture is rendering at.
  16520. * @returns the size (texture is always squared)
  16521. */
  16522. getRenderSize(): number;
  16523. /**
  16524. * Resize the texture to new value.
  16525. * @param size Define the new size the texture should have
  16526. * @param generateMipMaps Define whether the new texture should create mip maps
  16527. */
  16528. resize(size: number, generateMipMaps: boolean): void;
  16529. private _checkUniform;
  16530. /**
  16531. * Set a texture in the shader program used to render.
  16532. * @param name Define the name of the uniform samplers as defined in the shader
  16533. * @param texture Define the texture to bind to this sampler
  16534. * @return the texture itself allowing "fluent" like uniform updates
  16535. */
  16536. setTexture(name: string, texture: Texture): ProceduralTexture;
  16537. /**
  16538. * Set a float in the shader.
  16539. * @param name Define the name of the uniform as defined in the shader
  16540. * @param value Define the value to give to the uniform
  16541. * @return the texture itself allowing "fluent" like uniform updates
  16542. */
  16543. setFloat(name: string, value: number): ProceduralTexture;
  16544. /**
  16545. * Set a int in the shader.
  16546. * @param name Define the name of the uniform as defined in the shader
  16547. * @param value Define the value to give to the uniform
  16548. * @return the texture itself allowing "fluent" like uniform updates
  16549. */
  16550. setInt(name: string, value: number): ProceduralTexture;
  16551. /**
  16552. * Set an array of floats in the shader.
  16553. * @param name Define the name of the uniform as defined in the shader
  16554. * @param value Define the value to give to the uniform
  16555. * @return the texture itself allowing "fluent" like uniform updates
  16556. */
  16557. setFloats(name: string, value: number[]): ProceduralTexture;
  16558. /**
  16559. * Set a vec3 in the shader from a Color3.
  16560. * @param name Define the name of the uniform as defined in the shader
  16561. * @param value Define the value to give to the uniform
  16562. * @return the texture itself allowing "fluent" like uniform updates
  16563. */
  16564. setColor3(name: string, value: Color3): ProceduralTexture;
  16565. /**
  16566. * Set a vec4 in the shader from a Color4.
  16567. * @param name Define the name of the uniform as defined in the shader
  16568. * @param value Define the value to give to the uniform
  16569. * @return the texture itself allowing "fluent" like uniform updates
  16570. */
  16571. setColor4(name: string, value: Color4): ProceduralTexture;
  16572. /**
  16573. * Set a vec2 in the shader from a Vector2.
  16574. * @param name Define the name of the uniform as defined in the shader
  16575. * @param value Define the value to give to the uniform
  16576. * @return the texture itself allowing "fluent" like uniform updates
  16577. */
  16578. setVector2(name: string, value: Vector2): ProceduralTexture;
  16579. /**
  16580. * Set a vec3 in the shader from a Vector3.
  16581. * @param name Define the name of the uniform as defined in the shader
  16582. * @param value Define the value to give to the uniform
  16583. * @return the texture itself allowing "fluent" like uniform updates
  16584. */
  16585. setVector3(name: string, value: Vector3): ProceduralTexture;
  16586. /**
  16587. * Set a mat4 in the shader from a MAtrix.
  16588. * @param name Define the name of the uniform as defined in the shader
  16589. * @param value Define the value to give to the uniform
  16590. * @return the texture itself allowing "fluent" like uniform updates
  16591. */
  16592. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16593. /**
  16594. * Render the texture to its associated render target.
  16595. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16596. */
  16597. render(useCameraPostProcess?: boolean): void;
  16598. /**
  16599. * Clone the texture.
  16600. * @returns the cloned texture
  16601. */
  16602. clone(): ProceduralTexture;
  16603. /**
  16604. * Dispose the texture and release its asoociated resources.
  16605. */
  16606. dispose(): void;
  16607. }
  16608. }
  16609. declare module "babylonjs/Particles/baseParticleSystem" {
  16610. import { Nullable } from "babylonjs/types";
  16611. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  16612. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16613. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  16614. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16615. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16616. import { Scene } from "babylonjs/scene";
  16617. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  16618. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  16619. import { Texture } from "babylonjs/Materials/Textures/texture";
  16620. import { Color4 } from "babylonjs/Maths/math.color";
  16621. import { Animation } from "babylonjs/Animations/animation";
  16622. /**
  16623. * This represents the base class for particle system in Babylon.
  16624. * 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.
  16625. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  16626. * @example https://doc.babylonjs.com/babylon101/particles
  16627. */
  16628. export class BaseParticleSystem {
  16629. /**
  16630. * Source color is added to the destination color without alpha affecting the result
  16631. */
  16632. static BLENDMODE_ONEONE: number;
  16633. /**
  16634. * Blend current color and particle color using particle’s alpha
  16635. */
  16636. static BLENDMODE_STANDARD: number;
  16637. /**
  16638. * Add current color and particle color multiplied by particle’s alpha
  16639. */
  16640. static BLENDMODE_ADD: number;
  16641. /**
  16642. * Multiply current color with particle color
  16643. */
  16644. static BLENDMODE_MULTIPLY: number;
  16645. /**
  16646. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  16647. */
  16648. static BLENDMODE_MULTIPLYADD: number;
  16649. /**
  16650. * List of animations used by the particle system.
  16651. */
  16652. animations: Animation[];
  16653. /**
  16654. * The id of the Particle system.
  16655. */
  16656. id: string;
  16657. /**
  16658. * The friendly name of the Particle system.
  16659. */
  16660. name: string;
  16661. /**
  16662. * The rendering group used by the Particle system to chose when to render.
  16663. */
  16664. renderingGroupId: number;
  16665. /**
  16666. * The emitter represents the Mesh or position we are attaching the particle system to.
  16667. */
  16668. emitter: Nullable<AbstractMesh | Vector3>;
  16669. /**
  16670. * The maximum number of particles to emit per frame
  16671. */
  16672. emitRate: number;
  16673. /**
  16674. * If you want to launch only a few particles at once, that can be done, as well.
  16675. */
  16676. manualEmitCount: number;
  16677. /**
  16678. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16679. */
  16680. updateSpeed: number;
  16681. /**
  16682. * The amount of time the particle system is running (depends of the overall update speed).
  16683. */
  16684. targetStopDuration: number;
  16685. /**
  16686. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16687. */
  16688. disposeOnStop: boolean;
  16689. /**
  16690. * Minimum power of emitting particles.
  16691. */
  16692. minEmitPower: number;
  16693. /**
  16694. * Maximum power of emitting particles.
  16695. */
  16696. maxEmitPower: number;
  16697. /**
  16698. * Minimum life time of emitting particles.
  16699. */
  16700. minLifeTime: number;
  16701. /**
  16702. * Maximum life time of emitting particles.
  16703. */
  16704. maxLifeTime: number;
  16705. /**
  16706. * Minimum Size of emitting particles.
  16707. */
  16708. minSize: number;
  16709. /**
  16710. * Maximum Size of emitting particles.
  16711. */
  16712. maxSize: number;
  16713. /**
  16714. * Minimum scale of emitting particles on X axis.
  16715. */
  16716. minScaleX: number;
  16717. /**
  16718. * Maximum scale of emitting particles on X axis.
  16719. */
  16720. maxScaleX: number;
  16721. /**
  16722. * Minimum scale of emitting particles on Y axis.
  16723. */
  16724. minScaleY: number;
  16725. /**
  16726. * Maximum scale of emitting particles on Y axis.
  16727. */
  16728. maxScaleY: number;
  16729. /**
  16730. * Gets or sets the minimal initial rotation in radians.
  16731. */
  16732. minInitialRotation: number;
  16733. /**
  16734. * Gets or sets the maximal initial rotation in radians.
  16735. */
  16736. maxInitialRotation: number;
  16737. /**
  16738. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  16739. */
  16740. minAngularSpeed: number;
  16741. /**
  16742. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  16743. */
  16744. maxAngularSpeed: number;
  16745. /**
  16746. * The texture used to render each particle. (this can be a spritesheet)
  16747. */
  16748. particleTexture: Nullable<Texture>;
  16749. /**
  16750. * The layer mask we are rendering the particles through.
  16751. */
  16752. layerMask: number;
  16753. /**
  16754. * This can help using your own shader to render the particle system.
  16755. * The according effect will be created
  16756. */
  16757. customShader: any;
  16758. /**
  16759. * By default particle system starts as soon as they are created. This prevents the
  16760. * automatic start to happen and let you decide when to start emitting particles.
  16761. */
  16762. preventAutoStart: boolean;
  16763. private _noiseTexture;
  16764. /**
  16765. * Gets or sets a texture used to add random noise to particle positions
  16766. */
  16767. noiseTexture: Nullable<ProceduralTexture>;
  16768. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  16769. noiseStrength: Vector3;
  16770. /**
  16771. * Callback triggered when the particle animation is ending.
  16772. */
  16773. onAnimationEnd: Nullable<() => void>;
  16774. /**
  16775. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  16776. */
  16777. blendMode: number;
  16778. /**
  16779. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  16780. * to override the particles.
  16781. */
  16782. forceDepthWrite: boolean;
  16783. /** 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 */
  16784. preWarmCycles: number;
  16785. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  16786. preWarmStepOffset: number;
  16787. /**
  16788. * 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)
  16789. */
  16790. spriteCellChangeSpeed: number;
  16791. /**
  16792. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  16793. */
  16794. startSpriteCellID: number;
  16795. /**
  16796. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  16797. */
  16798. endSpriteCellID: number;
  16799. /**
  16800. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  16801. */
  16802. spriteCellWidth: number;
  16803. /**
  16804. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  16805. */
  16806. spriteCellHeight: number;
  16807. /**
  16808. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  16809. */
  16810. spriteRandomStartCell: boolean;
  16811. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  16812. translationPivot: Vector2;
  16813. /** @hidden */
  16814. protected _isAnimationSheetEnabled: boolean;
  16815. /**
  16816. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  16817. */
  16818. beginAnimationOnStart: boolean;
  16819. /**
  16820. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  16821. */
  16822. beginAnimationFrom: number;
  16823. /**
  16824. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  16825. */
  16826. beginAnimationTo: number;
  16827. /**
  16828. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  16829. */
  16830. beginAnimationLoop: boolean;
  16831. /**
  16832. * Gets or sets a world offset applied to all particles
  16833. */
  16834. worldOffset: Vector3;
  16835. /**
  16836. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  16837. */
  16838. isAnimationSheetEnabled: boolean;
  16839. /**
  16840. * Get hosting scene
  16841. * @returns the scene
  16842. */
  16843. getScene(): Scene;
  16844. /**
  16845. * You can use gravity if you want to give an orientation to your particles.
  16846. */
  16847. gravity: Vector3;
  16848. protected _colorGradients: Nullable<Array<ColorGradient>>;
  16849. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  16850. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  16851. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  16852. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  16853. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  16854. protected _dragGradients: Nullable<Array<FactorGradient>>;
  16855. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  16856. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  16857. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  16858. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  16859. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  16860. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  16861. /**
  16862. * Defines the delay in milliseconds before starting the system (0 by default)
  16863. */
  16864. startDelay: number;
  16865. /**
  16866. * Gets the current list of drag gradients.
  16867. * You must use addDragGradient and removeDragGradient to udpate this list
  16868. * @returns the list of drag gradients
  16869. */
  16870. getDragGradients(): Nullable<Array<FactorGradient>>;
  16871. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  16872. limitVelocityDamping: number;
  16873. /**
  16874. * Gets the current list of limit velocity gradients.
  16875. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  16876. * @returns the list of limit velocity gradients
  16877. */
  16878. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  16879. /**
  16880. * Gets the current list of color gradients.
  16881. * You must use addColorGradient and removeColorGradient to udpate this list
  16882. * @returns the list of color gradients
  16883. */
  16884. getColorGradients(): Nullable<Array<ColorGradient>>;
  16885. /**
  16886. * Gets the current list of size gradients.
  16887. * You must use addSizeGradient and removeSizeGradient to udpate this list
  16888. * @returns the list of size gradients
  16889. */
  16890. getSizeGradients(): Nullable<Array<FactorGradient>>;
  16891. /**
  16892. * Gets the current list of color remap gradients.
  16893. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  16894. * @returns the list of color remap gradients
  16895. */
  16896. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  16897. /**
  16898. * Gets the current list of alpha remap gradients.
  16899. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  16900. * @returns the list of alpha remap gradients
  16901. */
  16902. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  16903. /**
  16904. * Gets the current list of life time gradients.
  16905. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  16906. * @returns the list of life time gradients
  16907. */
  16908. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  16909. /**
  16910. * Gets the current list of angular speed gradients.
  16911. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  16912. * @returns the list of angular speed gradients
  16913. */
  16914. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  16915. /**
  16916. * Gets the current list of velocity gradients.
  16917. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  16918. * @returns the list of velocity gradients
  16919. */
  16920. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  16921. /**
  16922. * Gets the current list of start size gradients.
  16923. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  16924. * @returns the list of start size gradients
  16925. */
  16926. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  16927. /**
  16928. * Gets the current list of emit rate gradients.
  16929. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  16930. * @returns the list of emit rate gradients
  16931. */
  16932. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  16933. /**
  16934. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16935. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16936. */
  16937. direction1: Vector3;
  16938. /**
  16939. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16940. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16941. */
  16942. direction2: Vector3;
  16943. /**
  16944. * 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.
  16945. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16946. */
  16947. minEmitBox: Vector3;
  16948. /**
  16949. * 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.
  16950. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16951. */
  16952. maxEmitBox: Vector3;
  16953. /**
  16954. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  16955. */
  16956. color1: Color4;
  16957. /**
  16958. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  16959. */
  16960. color2: Color4;
  16961. /**
  16962. * Color the particle will have at the end of its lifetime
  16963. */
  16964. colorDead: Color4;
  16965. /**
  16966. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  16967. */
  16968. textureMask: Color4;
  16969. /**
  16970. * The particle emitter type defines the emitter used by the particle system.
  16971. * It can be for example box, sphere, or cone...
  16972. */
  16973. particleEmitterType: IParticleEmitterType;
  16974. /** @hidden */
  16975. _isSubEmitter: boolean;
  16976. /**
  16977. * Gets or sets the billboard mode to use when isBillboardBased = true.
  16978. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  16979. */
  16980. billboardMode: number;
  16981. protected _isBillboardBased: boolean;
  16982. /**
  16983. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  16984. */
  16985. isBillboardBased: boolean;
  16986. /**
  16987. * The scene the particle system belongs to.
  16988. */
  16989. protected _scene: Scene;
  16990. /**
  16991. * Local cache of defines for image processing.
  16992. */
  16993. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  16994. /**
  16995. * Default configuration related to image processing available in the standard Material.
  16996. */
  16997. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  16998. /**
  16999. * Gets the image processing configuration used either in this material.
  17000. */
  17001. /**
  17002. * Sets the Default image processing configuration used either in the this material.
  17003. *
  17004. * If sets to null, the scene one is in use.
  17005. */
  17006. imageProcessingConfiguration: ImageProcessingConfiguration;
  17007. /**
  17008. * Attaches a new image processing configuration to the Standard Material.
  17009. * @param configuration
  17010. */
  17011. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17012. /** @hidden */
  17013. protected _reset(): void;
  17014. /** @hidden */
  17015. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17016. /**
  17017. * Instantiates a particle system.
  17018. * 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.
  17019. * @param name The name of the particle system
  17020. */
  17021. constructor(name: string);
  17022. /**
  17023. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17024. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17025. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17026. * @returns the emitter
  17027. */
  17028. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17029. /**
  17030. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17031. * @param radius The radius of the hemisphere to emit from
  17032. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17033. * @returns the emitter
  17034. */
  17035. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17036. /**
  17037. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17038. * @param radius The radius of the sphere to emit from
  17039. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17040. * @returns the emitter
  17041. */
  17042. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17043. /**
  17044. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17045. * @param radius The radius of the sphere to emit from
  17046. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17047. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17048. * @returns the emitter
  17049. */
  17050. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17051. /**
  17052. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17053. * @param radius The radius of the emission cylinder
  17054. * @param height The height of the emission cylinder
  17055. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17056. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17057. * @returns the emitter
  17058. */
  17059. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17060. /**
  17061. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17062. * @param radius The radius of the cylinder to emit from
  17063. * @param height The height of the emission cylinder
  17064. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17065. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17066. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17067. * @returns the emitter
  17068. */
  17069. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17070. /**
  17071. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17072. * @param radius The radius of the cone to emit from
  17073. * @param angle The base angle of the cone
  17074. * @returns the emitter
  17075. */
  17076. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17077. /**
  17078. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17079. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17080. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17081. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17082. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17083. * @returns the emitter
  17084. */
  17085. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17086. }
  17087. }
  17088. declare module "babylonjs/Particles/subEmitter" {
  17089. import { Scene } from "babylonjs/scene";
  17090. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17091. /**
  17092. * Type of sub emitter
  17093. */
  17094. export enum SubEmitterType {
  17095. /**
  17096. * Attached to the particle over it's lifetime
  17097. */
  17098. ATTACHED = 0,
  17099. /**
  17100. * Created when the particle dies
  17101. */
  17102. END = 1
  17103. }
  17104. /**
  17105. * Sub emitter class used to emit particles from an existing particle
  17106. */
  17107. export class SubEmitter {
  17108. /**
  17109. * the particle system to be used by the sub emitter
  17110. */
  17111. particleSystem: ParticleSystem;
  17112. /**
  17113. * Type of the submitter (Default: END)
  17114. */
  17115. type: SubEmitterType;
  17116. /**
  17117. * 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)
  17118. * Note: This only is supported when using an emitter of type Mesh
  17119. */
  17120. inheritDirection: boolean;
  17121. /**
  17122. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17123. */
  17124. inheritedVelocityAmount: number;
  17125. /**
  17126. * Creates a sub emitter
  17127. * @param particleSystem the particle system to be used by the sub emitter
  17128. */
  17129. constructor(
  17130. /**
  17131. * the particle system to be used by the sub emitter
  17132. */
  17133. particleSystem: ParticleSystem);
  17134. /**
  17135. * Clones the sub emitter
  17136. * @returns the cloned sub emitter
  17137. */
  17138. clone(): SubEmitter;
  17139. /**
  17140. * Serialize current object to a JSON object
  17141. * @returns the serialized object
  17142. */
  17143. serialize(): any;
  17144. /** @hidden */
  17145. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17146. /**
  17147. * Creates a new SubEmitter from a serialized JSON version
  17148. * @param serializationObject defines the JSON object to read from
  17149. * @param scene defines the hosting scene
  17150. * @param rootUrl defines the rootUrl for data loading
  17151. * @returns a new SubEmitter
  17152. */
  17153. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17154. /** Release associated resources */
  17155. dispose(): void;
  17156. }
  17157. }
  17158. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17159. /** @hidden */
  17160. export var clipPlaneFragmentDeclaration: {
  17161. name: string;
  17162. shader: string;
  17163. };
  17164. }
  17165. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17166. /** @hidden */
  17167. export var imageProcessingDeclaration: {
  17168. name: string;
  17169. shader: string;
  17170. };
  17171. }
  17172. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17173. /** @hidden */
  17174. export var imageProcessingFunctions: {
  17175. name: string;
  17176. shader: string;
  17177. };
  17178. }
  17179. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17180. /** @hidden */
  17181. export var clipPlaneFragment: {
  17182. name: string;
  17183. shader: string;
  17184. };
  17185. }
  17186. declare module "babylonjs/Shaders/particles.fragment" {
  17187. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17188. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17189. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17190. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17191. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17192. /** @hidden */
  17193. export var particlesPixelShader: {
  17194. name: string;
  17195. shader: string;
  17196. };
  17197. }
  17198. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17199. /** @hidden */
  17200. export var clipPlaneVertexDeclaration: {
  17201. name: string;
  17202. shader: string;
  17203. };
  17204. }
  17205. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17206. /** @hidden */
  17207. export var clipPlaneVertex: {
  17208. name: string;
  17209. shader: string;
  17210. };
  17211. }
  17212. declare module "babylonjs/Shaders/particles.vertex" {
  17213. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17214. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17215. /** @hidden */
  17216. export var particlesVertexShader: {
  17217. name: string;
  17218. shader: string;
  17219. };
  17220. }
  17221. declare module "babylonjs/Particles/particleSystem" {
  17222. import { Nullable } from "babylonjs/types";
  17223. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17224. import { Observable } from "babylonjs/Misc/observable";
  17225. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17226. import { Effect } from "babylonjs/Materials/effect";
  17227. import { Scene, IDisposable } from "babylonjs/scene";
  17228. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17229. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17230. import { Particle } from "babylonjs/Particles/particle";
  17231. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17232. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17233. import "babylonjs/Shaders/particles.fragment";
  17234. import "babylonjs/Shaders/particles.vertex";
  17235. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17236. /**
  17237. * This represents a particle system in Babylon.
  17238. * 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.
  17239. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17240. * @example https://doc.babylonjs.com/babylon101/particles
  17241. */
  17242. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17243. /**
  17244. * Billboard mode will only apply to Y axis
  17245. */
  17246. static readonly BILLBOARDMODE_Y: number;
  17247. /**
  17248. * Billboard mode will apply to all axes
  17249. */
  17250. static readonly BILLBOARDMODE_ALL: number;
  17251. /**
  17252. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17253. */
  17254. static readonly BILLBOARDMODE_STRETCHED: number;
  17255. /**
  17256. * This function can be defined to provide custom update for active particles.
  17257. * This function will be called instead of regular update (age, position, color, etc.).
  17258. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17259. */
  17260. updateFunction: (particles: Particle[]) => void;
  17261. private _emitterWorldMatrix;
  17262. /**
  17263. * This function can be defined to specify initial direction for every new particle.
  17264. * It by default use the emitterType defined function
  17265. */
  17266. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17267. /**
  17268. * This function can be defined to specify initial position for every new particle.
  17269. * It by default use the emitterType defined function
  17270. */
  17271. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17272. /**
  17273. * @hidden
  17274. */
  17275. _inheritedVelocityOffset: Vector3;
  17276. /**
  17277. * An event triggered when the system is disposed
  17278. */
  17279. onDisposeObservable: Observable<ParticleSystem>;
  17280. private _onDisposeObserver;
  17281. /**
  17282. * Sets a callback that will be triggered when the system is disposed
  17283. */
  17284. onDispose: () => void;
  17285. private _particles;
  17286. private _epsilon;
  17287. private _capacity;
  17288. private _stockParticles;
  17289. private _newPartsExcess;
  17290. private _vertexData;
  17291. private _vertexBuffer;
  17292. private _vertexBuffers;
  17293. private _spriteBuffer;
  17294. private _indexBuffer;
  17295. private _effect;
  17296. private _customEffect;
  17297. private _cachedDefines;
  17298. private _scaledColorStep;
  17299. private _colorDiff;
  17300. private _scaledDirection;
  17301. private _scaledGravity;
  17302. private _currentRenderId;
  17303. private _alive;
  17304. private _useInstancing;
  17305. private _started;
  17306. private _stopped;
  17307. private _actualFrame;
  17308. private _scaledUpdateSpeed;
  17309. private _vertexBufferSize;
  17310. /** @hidden */
  17311. _currentEmitRateGradient: Nullable<FactorGradient>;
  17312. /** @hidden */
  17313. _currentEmitRate1: number;
  17314. /** @hidden */
  17315. _currentEmitRate2: number;
  17316. /** @hidden */
  17317. _currentStartSizeGradient: Nullable<FactorGradient>;
  17318. /** @hidden */
  17319. _currentStartSize1: number;
  17320. /** @hidden */
  17321. _currentStartSize2: number;
  17322. private readonly _rawTextureWidth;
  17323. private _rampGradientsTexture;
  17324. private _useRampGradients;
  17325. /** Gets or sets a boolean indicating that ramp gradients must be used
  17326. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17327. */
  17328. useRampGradients: boolean;
  17329. /**
  17330. * 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.
  17331. * 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: [])
  17332. */
  17333. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17334. private _subEmitters;
  17335. /**
  17336. * @hidden
  17337. * If the particle systems emitter should be disposed when the particle system is disposed
  17338. */
  17339. _disposeEmitterOnDispose: boolean;
  17340. /**
  17341. * The current active Sub-systems, this property is used by the root particle system only.
  17342. */
  17343. activeSubSystems: Array<ParticleSystem>;
  17344. private _rootParticleSystem;
  17345. /**
  17346. * Gets the current list of active particles
  17347. */
  17348. readonly particles: Particle[];
  17349. /**
  17350. * Returns the string "ParticleSystem"
  17351. * @returns a string containing the class name
  17352. */
  17353. getClassName(): string;
  17354. /**
  17355. * Instantiates a particle system.
  17356. * 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.
  17357. * @param name The name of the particle system
  17358. * @param capacity The max number of particles alive at the same time
  17359. * @param scene The scene the particle system belongs to
  17360. * @param customEffect a custom effect used to change the way particles are rendered by default
  17361. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17362. * @param epsilon Offset used to render the particles
  17363. */
  17364. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17365. private _addFactorGradient;
  17366. private _removeFactorGradient;
  17367. /**
  17368. * Adds a new life time gradient
  17369. * @param gradient defines the gradient to use (between 0 and 1)
  17370. * @param factor defines the life time factor to affect to the specified gradient
  17371. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17372. * @returns the current particle system
  17373. */
  17374. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17375. /**
  17376. * Remove a specific life time gradient
  17377. * @param gradient defines the gradient to remove
  17378. * @returns the current particle system
  17379. */
  17380. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17381. /**
  17382. * Adds a new size gradient
  17383. * @param gradient defines the gradient to use (between 0 and 1)
  17384. * @param factor defines the size factor to affect to the specified gradient
  17385. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17386. * @returns the current particle system
  17387. */
  17388. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17389. /**
  17390. * Remove a specific size gradient
  17391. * @param gradient defines the gradient to remove
  17392. * @returns the current particle system
  17393. */
  17394. removeSizeGradient(gradient: number): IParticleSystem;
  17395. /**
  17396. * Adds a new color remap gradient
  17397. * @param gradient defines the gradient to use (between 0 and 1)
  17398. * @param min defines the color remap minimal range
  17399. * @param max defines the color remap maximal range
  17400. * @returns the current particle system
  17401. */
  17402. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17403. /**
  17404. * Remove a specific color remap gradient
  17405. * @param gradient defines the gradient to remove
  17406. * @returns the current particle system
  17407. */
  17408. removeColorRemapGradient(gradient: number): IParticleSystem;
  17409. /**
  17410. * Adds a new alpha remap gradient
  17411. * @param gradient defines the gradient to use (between 0 and 1)
  17412. * @param min defines the alpha remap minimal range
  17413. * @param max defines the alpha remap maximal range
  17414. * @returns the current particle system
  17415. */
  17416. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17417. /**
  17418. * Remove a specific alpha remap gradient
  17419. * @param gradient defines the gradient to remove
  17420. * @returns the current particle system
  17421. */
  17422. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17423. /**
  17424. * Adds a new angular speed gradient
  17425. * @param gradient defines the gradient to use (between 0 and 1)
  17426. * @param factor defines the angular speed to affect to the specified gradient
  17427. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17428. * @returns the current particle system
  17429. */
  17430. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17431. /**
  17432. * Remove a specific angular speed gradient
  17433. * @param gradient defines the gradient to remove
  17434. * @returns the current particle system
  17435. */
  17436. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17437. /**
  17438. * Adds a new velocity gradient
  17439. * @param gradient defines the gradient to use (between 0 and 1)
  17440. * @param factor defines the velocity to affect to the specified gradient
  17441. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17442. * @returns the current particle system
  17443. */
  17444. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17445. /**
  17446. * Remove a specific velocity gradient
  17447. * @param gradient defines the gradient to remove
  17448. * @returns the current particle system
  17449. */
  17450. removeVelocityGradient(gradient: number): IParticleSystem;
  17451. /**
  17452. * Adds a new limit velocity gradient
  17453. * @param gradient defines the gradient to use (between 0 and 1)
  17454. * @param factor defines the limit velocity value to affect to the specified gradient
  17455. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17456. * @returns the current particle system
  17457. */
  17458. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17459. /**
  17460. * Remove a specific limit velocity gradient
  17461. * @param gradient defines the gradient to remove
  17462. * @returns the current particle system
  17463. */
  17464. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17465. /**
  17466. * Adds a new drag gradient
  17467. * @param gradient defines the gradient to use (between 0 and 1)
  17468. * @param factor defines the drag value to affect to the specified gradient
  17469. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17470. * @returns the current particle system
  17471. */
  17472. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17473. /**
  17474. * Remove a specific drag gradient
  17475. * @param gradient defines the gradient to remove
  17476. * @returns the current particle system
  17477. */
  17478. removeDragGradient(gradient: number): IParticleSystem;
  17479. /**
  17480. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17481. * @param gradient defines the gradient to use (between 0 and 1)
  17482. * @param factor defines the emit rate value to affect to the specified gradient
  17483. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17484. * @returns the current particle system
  17485. */
  17486. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17487. /**
  17488. * Remove a specific emit rate gradient
  17489. * @param gradient defines the gradient to remove
  17490. * @returns the current particle system
  17491. */
  17492. removeEmitRateGradient(gradient: number): IParticleSystem;
  17493. /**
  17494. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17495. * @param gradient defines the gradient to use (between 0 and 1)
  17496. * @param factor defines the start size value to affect to the specified gradient
  17497. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17498. * @returns the current particle system
  17499. */
  17500. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17501. /**
  17502. * Remove a specific start size gradient
  17503. * @param gradient defines the gradient to remove
  17504. * @returns the current particle system
  17505. */
  17506. removeStartSizeGradient(gradient: number): IParticleSystem;
  17507. private _createRampGradientTexture;
  17508. /**
  17509. * Gets the current list of ramp gradients.
  17510. * You must use addRampGradient and removeRampGradient to udpate this list
  17511. * @returns the list of ramp gradients
  17512. */
  17513. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17514. /**
  17515. * Adds a new ramp gradient used to remap particle colors
  17516. * @param gradient defines the gradient to use (between 0 and 1)
  17517. * @param color defines the color to affect to the specified gradient
  17518. * @returns the current particle system
  17519. */
  17520. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17521. /**
  17522. * Remove a specific ramp gradient
  17523. * @param gradient defines the gradient to remove
  17524. * @returns the current particle system
  17525. */
  17526. removeRampGradient(gradient: number): ParticleSystem;
  17527. /**
  17528. * Adds a new color gradient
  17529. * @param gradient defines the gradient to use (between 0 and 1)
  17530. * @param color1 defines the color to affect to the specified gradient
  17531. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17532. * @returns this particle system
  17533. */
  17534. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17535. /**
  17536. * Remove a specific color gradient
  17537. * @param gradient defines the gradient to remove
  17538. * @returns this particle system
  17539. */
  17540. removeColorGradient(gradient: number): IParticleSystem;
  17541. private _fetchR;
  17542. protected _reset(): void;
  17543. private _resetEffect;
  17544. private _createVertexBuffers;
  17545. private _createIndexBuffer;
  17546. /**
  17547. * Gets the maximum number of particles active at the same time.
  17548. * @returns The max number of active particles.
  17549. */
  17550. getCapacity(): number;
  17551. /**
  17552. * Gets whether there are still active particles in the system.
  17553. * @returns True if it is alive, otherwise false.
  17554. */
  17555. isAlive(): boolean;
  17556. /**
  17557. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17558. * @returns True if it has been started, otherwise false.
  17559. */
  17560. isStarted(): boolean;
  17561. private _prepareSubEmitterInternalArray;
  17562. /**
  17563. * Starts the particle system and begins to emit
  17564. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17565. */
  17566. start(delay?: number): void;
  17567. /**
  17568. * Stops the particle system.
  17569. * @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.
  17570. */
  17571. stop(stopSubEmitters?: boolean): void;
  17572. /**
  17573. * Remove all active particles
  17574. */
  17575. reset(): void;
  17576. /**
  17577. * @hidden (for internal use only)
  17578. */
  17579. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17580. /**
  17581. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17582. * Its lifetime will start back at 0.
  17583. */
  17584. recycleParticle: (particle: Particle) => void;
  17585. private _stopSubEmitters;
  17586. private _createParticle;
  17587. private _removeFromRoot;
  17588. private _emitFromParticle;
  17589. private _update;
  17590. /** @hidden */
  17591. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17592. /** @hidden */
  17593. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17594. /** @hidden */
  17595. private _getEffect;
  17596. /**
  17597. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  17598. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  17599. */
  17600. animate(preWarmOnly?: boolean): void;
  17601. private _appendParticleVertices;
  17602. /**
  17603. * Rebuilds the particle system.
  17604. */
  17605. rebuild(): void;
  17606. /**
  17607. * Is this system ready to be used/rendered
  17608. * @return true if the system is ready
  17609. */
  17610. isReady(): boolean;
  17611. private _render;
  17612. /**
  17613. * Renders the particle system in its current state.
  17614. * @returns the current number of particles
  17615. */
  17616. render(): number;
  17617. /**
  17618. * Disposes the particle system and free the associated resources
  17619. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  17620. */
  17621. dispose(disposeTexture?: boolean): void;
  17622. /**
  17623. * Clones the particle system.
  17624. * @param name The name of the cloned object
  17625. * @param newEmitter The new emitter to use
  17626. * @returns the cloned particle system
  17627. */
  17628. clone(name: string, newEmitter: any): ParticleSystem;
  17629. /**
  17630. * Serializes the particle system to a JSON object.
  17631. * @returns the JSON object
  17632. */
  17633. serialize(): any;
  17634. /** @hidden */
  17635. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  17636. /** @hidden */
  17637. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  17638. /**
  17639. * Parses a JSON object to create a particle system.
  17640. * @param parsedParticleSystem The JSON object to parse
  17641. * @param scene The scene to create the particle system in
  17642. * @param rootUrl The root url to use to load external dependencies like texture
  17643. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  17644. * @returns the Parsed particle system
  17645. */
  17646. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  17647. }
  17648. }
  17649. declare module "babylonjs/Particles/particle" {
  17650. import { Nullable } from "babylonjs/types";
  17651. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  17652. import { Color4 } from "babylonjs/Maths/math.color";
  17653. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17654. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17655. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  17656. /**
  17657. * A particle represents one of the element emitted by a particle system.
  17658. * This is mainly define by its coordinates, direction, velocity and age.
  17659. */
  17660. export class Particle {
  17661. /**
  17662. * The particle system the particle belongs to.
  17663. */
  17664. particleSystem: ParticleSystem;
  17665. private static _Count;
  17666. /**
  17667. * Unique ID of the particle
  17668. */
  17669. id: number;
  17670. /**
  17671. * The world position of the particle in the scene.
  17672. */
  17673. position: Vector3;
  17674. /**
  17675. * The world direction of the particle in the scene.
  17676. */
  17677. direction: Vector3;
  17678. /**
  17679. * The color of the particle.
  17680. */
  17681. color: Color4;
  17682. /**
  17683. * The color change of the particle per step.
  17684. */
  17685. colorStep: Color4;
  17686. /**
  17687. * Defines how long will the life of the particle be.
  17688. */
  17689. lifeTime: number;
  17690. /**
  17691. * The current age of the particle.
  17692. */
  17693. age: number;
  17694. /**
  17695. * The current size of the particle.
  17696. */
  17697. size: number;
  17698. /**
  17699. * The current scale of the particle.
  17700. */
  17701. scale: Vector2;
  17702. /**
  17703. * The current angle of the particle.
  17704. */
  17705. angle: number;
  17706. /**
  17707. * Defines how fast is the angle changing.
  17708. */
  17709. angularSpeed: number;
  17710. /**
  17711. * Defines the cell index used by the particle to be rendered from a sprite.
  17712. */
  17713. cellIndex: number;
  17714. /**
  17715. * The information required to support color remapping
  17716. */
  17717. remapData: Vector4;
  17718. /** @hidden */
  17719. _randomCellOffset?: number;
  17720. /** @hidden */
  17721. _initialDirection: Nullable<Vector3>;
  17722. /** @hidden */
  17723. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  17724. /** @hidden */
  17725. _initialStartSpriteCellID: number;
  17726. /** @hidden */
  17727. _initialEndSpriteCellID: number;
  17728. /** @hidden */
  17729. _currentColorGradient: Nullable<ColorGradient>;
  17730. /** @hidden */
  17731. _currentColor1: Color4;
  17732. /** @hidden */
  17733. _currentColor2: Color4;
  17734. /** @hidden */
  17735. _currentSizeGradient: Nullable<FactorGradient>;
  17736. /** @hidden */
  17737. _currentSize1: number;
  17738. /** @hidden */
  17739. _currentSize2: number;
  17740. /** @hidden */
  17741. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  17742. /** @hidden */
  17743. _currentAngularSpeed1: number;
  17744. /** @hidden */
  17745. _currentAngularSpeed2: number;
  17746. /** @hidden */
  17747. _currentVelocityGradient: Nullable<FactorGradient>;
  17748. /** @hidden */
  17749. _currentVelocity1: number;
  17750. /** @hidden */
  17751. _currentVelocity2: number;
  17752. /** @hidden */
  17753. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  17754. /** @hidden */
  17755. _currentLimitVelocity1: number;
  17756. /** @hidden */
  17757. _currentLimitVelocity2: number;
  17758. /** @hidden */
  17759. _currentDragGradient: Nullable<FactorGradient>;
  17760. /** @hidden */
  17761. _currentDrag1: number;
  17762. /** @hidden */
  17763. _currentDrag2: number;
  17764. /** @hidden */
  17765. _randomNoiseCoordinates1: Vector3;
  17766. /** @hidden */
  17767. _randomNoiseCoordinates2: Vector3;
  17768. /**
  17769. * Creates a new instance Particle
  17770. * @param particleSystem the particle system the particle belongs to
  17771. */
  17772. constructor(
  17773. /**
  17774. * The particle system the particle belongs to.
  17775. */
  17776. particleSystem: ParticleSystem);
  17777. private updateCellInfoFromSystem;
  17778. /**
  17779. * Defines how the sprite cell index is updated for the particle
  17780. */
  17781. updateCellIndex(): void;
  17782. /** @hidden */
  17783. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  17784. /** @hidden */
  17785. _inheritParticleInfoToSubEmitters(): void;
  17786. /** @hidden */
  17787. _reset(): void;
  17788. /**
  17789. * Copy the properties of particle to another one.
  17790. * @param other the particle to copy the information to.
  17791. */
  17792. copyTo(other: Particle): void;
  17793. }
  17794. }
  17795. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  17796. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17797. import { Effect } from "babylonjs/Materials/effect";
  17798. import { Particle } from "babylonjs/Particles/particle";
  17799. /**
  17800. * Particle emitter represents a volume emitting particles.
  17801. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  17802. */
  17803. export interface IParticleEmitterType {
  17804. /**
  17805. * Called by the particle System when the direction is computed for the created particle.
  17806. * @param worldMatrix is the world matrix of the particle system
  17807. * @param directionToUpdate is the direction vector to update with the result
  17808. * @param particle is the particle we are computed the direction for
  17809. */
  17810. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17811. /**
  17812. * Called by the particle System when the position is computed for the created particle.
  17813. * @param worldMatrix is the world matrix of the particle system
  17814. * @param positionToUpdate is the position vector to update with the result
  17815. * @param particle is the particle we are computed the position for
  17816. */
  17817. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17818. /**
  17819. * Clones the current emitter and returns a copy of it
  17820. * @returns the new emitter
  17821. */
  17822. clone(): IParticleEmitterType;
  17823. /**
  17824. * Called by the GPUParticleSystem to setup the update shader
  17825. * @param effect defines the update shader
  17826. */
  17827. applyToShader(effect: Effect): void;
  17828. /**
  17829. * Returns a string to use to update the GPU particles update shader
  17830. * @returns the effect defines string
  17831. */
  17832. getEffectDefines(): string;
  17833. /**
  17834. * Returns a string representing the class name
  17835. * @returns a string containing the class name
  17836. */
  17837. getClassName(): string;
  17838. /**
  17839. * Serializes the particle system to a JSON object.
  17840. * @returns the JSON object
  17841. */
  17842. serialize(): any;
  17843. /**
  17844. * Parse properties from a JSON object
  17845. * @param serializationObject defines the JSON object
  17846. */
  17847. parse(serializationObject: any): void;
  17848. }
  17849. }
  17850. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  17851. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17852. import { Effect } from "babylonjs/Materials/effect";
  17853. import { Particle } from "babylonjs/Particles/particle";
  17854. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  17855. /**
  17856. * Particle emitter emitting particles from the inside of a box.
  17857. * It emits the particles randomly between 2 given directions.
  17858. */
  17859. export class BoxParticleEmitter implements IParticleEmitterType {
  17860. /**
  17861. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17862. */
  17863. direction1: Vector3;
  17864. /**
  17865. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17866. */
  17867. direction2: Vector3;
  17868. /**
  17869. * 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.
  17870. */
  17871. minEmitBox: Vector3;
  17872. /**
  17873. * 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.
  17874. */
  17875. maxEmitBox: Vector3;
  17876. /**
  17877. * Creates a new instance BoxParticleEmitter
  17878. */
  17879. constructor();
  17880. /**
  17881. * Called by the particle System when the direction is computed for the created particle.
  17882. * @param worldMatrix is the world matrix of the particle system
  17883. * @param directionToUpdate is the direction vector to update with the result
  17884. * @param particle is the particle we are computed the direction for
  17885. */
  17886. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17887. /**
  17888. * Called by the particle System when the position is computed for the created particle.
  17889. * @param worldMatrix is the world matrix of the particle system
  17890. * @param positionToUpdate is the position vector to update with the result
  17891. * @param particle is the particle we are computed the position for
  17892. */
  17893. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17894. /**
  17895. * Clones the current emitter and returns a copy of it
  17896. * @returns the new emitter
  17897. */
  17898. clone(): BoxParticleEmitter;
  17899. /**
  17900. * Called by the GPUParticleSystem to setup the update shader
  17901. * @param effect defines the update shader
  17902. */
  17903. applyToShader(effect: Effect): void;
  17904. /**
  17905. * Returns a string to use to update the GPU particles update shader
  17906. * @returns a string containng the defines string
  17907. */
  17908. getEffectDefines(): string;
  17909. /**
  17910. * Returns the string "BoxParticleEmitter"
  17911. * @returns a string containing the class name
  17912. */
  17913. getClassName(): string;
  17914. /**
  17915. * Serializes the particle system to a JSON object.
  17916. * @returns the JSON object
  17917. */
  17918. serialize(): any;
  17919. /**
  17920. * Parse properties from a JSON object
  17921. * @param serializationObject defines the JSON object
  17922. */
  17923. parse(serializationObject: any): void;
  17924. }
  17925. }
  17926. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  17927. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17928. import { Effect } from "babylonjs/Materials/effect";
  17929. import { Particle } from "babylonjs/Particles/particle";
  17930. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  17931. /**
  17932. * Particle emitter emitting particles from the inside of a cone.
  17933. * It emits the particles alongside the cone volume from the base to the particle.
  17934. * The emission direction might be randomized.
  17935. */
  17936. export class ConeParticleEmitter implements IParticleEmitterType {
  17937. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  17938. directionRandomizer: number;
  17939. private _radius;
  17940. private _angle;
  17941. private _height;
  17942. /**
  17943. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  17944. */
  17945. radiusRange: number;
  17946. /**
  17947. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  17948. */
  17949. heightRange: number;
  17950. /**
  17951. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  17952. */
  17953. emitFromSpawnPointOnly: boolean;
  17954. /**
  17955. * Gets or sets the radius of the emission cone
  17956. */
  17957. radius: number;
  17958. /**
  17959. * Gets or sets the angle of the emission cone
  17960. */
  17961. angle: number;
  17962. private _buildHeight;
  17963. /**
  17964. * Creates a new instance ConeParticleEmitter
  17965. * @param radius the radius of the emission cone (1 by default)
  17966. * @param angle the cone base angle (PI by default)
  17967. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  17968. */
  17969. constructor(radius?: number, angle?: number,
  17970. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  17971. directionRandomizer?: number);
  17972. /**
  17973. * Called by the particle System when the direction is computed for the created particle.
  17974. * @param worldMatrix is the world matrix of the particle system
  17975. * @param directionToUpdate is the direction vector to update with the result
  17976. * @param particle is the particle we are computed the direction for
  17977. */
  17978. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17979. /**
  17980. * Called by the particle System when the position is computed for the created particle.
  17981. * @param worldMatrix is the world matrix of the particle system
  17982. * @param positionToUpdate is the position vector to update with the result
  17983. * @param particle is the particle we are computed the position for
  17984. */
  17985. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17986. /**
  17987. * Clones the current emitter and returns a copy of it
  17988. * @returns the new emitter
  17989. */
  17990. clone(): ConeParticleEmitter;
  17991. /**
  17992. * Called by the GPUParticleSystem to setup the update shader
  17993. * @param effect defines the update shader
  17994. */
  17995. applyToShader(effect: Effect): void;
  17996. /**
  17997. * Returns a string to use to update the GPU particles update shader
  17998. * @returns a string containng the defines string
  17999. */
  18000. getEffectDefines(): string;
  18001. /**
  18002. * Returns the string "ConeParticleEmitter"
  18003. * @returns a string containing the class name
  18004. */
  18005. getClassName(): string;
  18006. /**
  18007. * Serializes the particle system to a JSON object.
  18008. * @returns the JSON object
  18009. */
  18010. serialize(): any;
  18011. /**
  18012. * Parse properties from a JSON object
  18013. * @param serializationObject defines the JSON object
  18014. */
  18015. parse(serializationObject: any): void;
  18016. }
  18017. }
  18018. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18019. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18020. import { Effect } from "babylonjs/Materials/effect";
  18021. import { Particle } from "babylonjs/Particles/particle";
  18022. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18023. /**
  18024. * Particle emitter emitting particles from the inside of a cylinder.
  18025. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18026. */
  18027. export class CylinderParticleEmitter implements IParticleEmitterType {
  18028. /**
  18029. * The radius of the emission cylinder.
  18030. */
  18031. radius: number;
  18032. /**
  18033. * The height of the emission cylinder.
  18034. */
  18035. height: number;
  18036. /**
  18037. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18038. */
  18039. radiusRange: number;
  18040. /**
  18041. * How much to randomize the particle direction [0-1].
  18042. */
  18043. directionRandomizer: number;
  18044. /**
  18045. * Creates a new instance CylinderParticleEmitter
  18046. * @param radius the radius of the emission cylinder (1 by default)
  18047. * @param height the height of the emission cylinder (1 by default)
  18048. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18049. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18050. */
  18051. constructor(
  18052. /**
  18053. * The radius of the emission cylinder.
  18054. */
  18055. radius?: number,
  18056. /**
  18057. * The height of the emission cylinder.
  18058. */
  18059. height?: number,
  18060. /**
  18061. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18062. */
  18063. radiusRange?: number,
  18064. /**
  18065. * How much to randomize the particle direction [0-1].
  18066. */
  18067. directionRandomizer?: number);
  18068. /**
  18069. * Called by the particle System when the direction is computed for the created particle.
  18070. * @param worldMatrix is the world matrix of the particle system
  18071. * @param directionToUpdate is the direction vector to update with the result
  18072. * @param particle is the particle we are computed the direction for
  18073. */
  18074. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18075. /**
  18076. * Called by the particle System when the position is computed for the created particle.
  18077. * @param worldMatrix is the world matrix of the particle system
  18078. * @param positionToUpdate is the position vector to update with the result
  18079. * @param particle is the particle we are computed the position for
  18080. */
  18081. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18082. /**
  18083. * Clones the current emitter and returns a copy of it
  18084. * @returns the new emitter
  18085. */
  18086. clone(): CylinderParticleEmitter;
  18087. /**
  18088. * Called by the GPUParticleSystem to setup the update shader
  18089. * @param effect defines the update shader
  18090. */
  18091. applyToShader(effect: Effect): void;
  18092. /**
  18093. * Returns a string to use to update the GPU particles update shader
  18094. * @returns a string containng the defines string
  18095. */
  18096. getEffectDefines(): string;
  18097. /**
  18098. * Returns the string "CylinderParticleEmitter"
  18099. * @returns a string containing the class name
  18100. */
  18101. getClassName(): string;
  18102. /**
  18103. * Serializes the particle system to a JSON object.
  18104. * @returns the JSON object
  18105. */
  18106. serialize(): any;
  18107. /**
  18108. * Parse properties from a JSON object
  18109. * @param serializationObject defines the JSON object
  18110. */
  18111. parse(serializationObject: any): void;
  18112. }
  18113. /**
  18114. * Particle emitter emitting particles from the inside of a cylinder.
  18115. * It emits the particles randomly between two vectors.
  18116. */
  18117. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18118. /**
  18119. * The min limit of the emission direction.
  18120. */
  18121. direction1: Vector3;
  18122. /**
  18123. * The max limit of the emission direction.
  18124. */
  18125. direction2: Vector3;
  18126. /**
  18127. * Creates a new instance CylinderDirectedParticleEmitter
  18128. * @param radius the radius of the emission cylinder (1 by default)
  18129. * @param height the height of the emission cylinder (1 by default)
  18130. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18131. * @param direction1 the min limit of the emission direction (up vector by default)
  18132. * @param direction2 the max limit of the emission direction (up vector by default)
  18133. */
  18134. constructor(radius?: number, height?: number, radiusRange?: number,
  18135. /**
  18136. * The min limit of the emission direction.
  18137. */
  18138. direction1?: Vector3,
  18139. /**
  18140. * The max limit of the emission direction.
  18141. */
  18142. direction2?: Vector3);
  18143. /**
  18144. * Called by the particle System when the direction is computed for the created particle.
  18145. * @param worldMatrix is the world matrix of the particle system
  18146. * @param directionToUpdate is the direction vector to update with the result
  18147. * @param particle is the particle we are computed the direction for
  18148. */
  18149. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18150. /**
  18151. * Clones the current emitter and returns a copy of it
  18152. * @returns the new emitter
  18153. */
  18154. clone(): CylinderDirectedParticleEmitter;
  18155. /**
  18156. * Called by the GPUParticleSystem to setup the update shader
  18157. * @param effect defines the update shader
  18158. */
  18159. applyToShader(effect: Effect): void;
  18160. /**
  18161. * Returns a string to use to update the GPU particles update shader
  18162. * @returns a string containng the defines string
  18163. */
  18164. getEffectDefines(): string;
  18165. /**
  18166. * Returns the string "CylinderDirectedParticleEmitter"
  18167. * @returns a string containing the class name
  18168. */
  18169. getClassName(): string;
  18170. /**
  18171. * Serializes the particle system to a JSON object.
  18172. * @returns the JSON object
  18173. */
  18174. serialize(): any;
  18175. /**
  18176. * Parse properties from a JSON object
  18177. * @param serializationObject defines the JSON object
  18178. */
  18179. parse(serializationObject: any): void;
  18180. }
  18181. }
  18182. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18183. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18184. import { Effect } from "babylonjs/Materials/effect";
  18185. import { Particle } from "babylonjs/Particles/particle";
  18186. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18187. /**
  18188. * Particle emitter emitting particles from the inside of a hemisphere.
  18189. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18190. */
  18191. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18192. /**
  18193. * The radius of the emission hemisphere.
  18194. */
  18195. radius: number;
  18196. /**
  18197. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18198. */
  18199. radiusRange: number;
  18200. /**
  18201. * How much to randomize the particle direction [0-1].
  18202. */
  18203. directionRandomizer: number;
  18204. /**
  18205. * Creates a new instance HemisphericParticleEmitter
  18206. * @param radius the radius of the emission hemisphere (1 by default)
  18207. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18208. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18209. */
  18210. constructor(
  18211. /**
  18212. * The radius of the emission hemisphere.
  18213. */
  18214. radius?: number,
  18215. /**
  18216. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18217. */
  18218. radiusRange?: number,
  18219. /**
  18220. * How much to randomize the particle direction [0-1].
  18221. */
  18222. directionRandomizer?: number);
  18223. /**
  18224. * Called by the particle System when the direction is computed for the created particle.
  18225. * @param worldMatrix is the world matrix of the particle system
  18226. * @param directionToUpdate is the direction vector to update with the result
  18227. * @param particle is the particle we are computed the direction for
  18228. */
  18229. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18230. /**
  18231. * Called by the particle System when the position is computed for the created particle.
  18232. * @param worldMatrix is the world matrix of the particle system
  18233. * @param positionToUpdate is the position vector to update with the result
  18234. * @param particle is the particle we are computed the position for
  18235. */
  18236. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18237. /**
  18238. * Clones the current emitter and returns a copy of it
  18239. * @returns the new emitter
  18240. */
  18241. clone(): HemisphericParticleEmitter;
  18242. /**
  18243. * Called by the GPUParticleSystem to setup the update shader
  18244. * @param effect defines the update shader
  18245. */
  18246. applyToShader(effect: Effect): void;
  18247. /**
  18248. * Returns a string to use to update the GPU particles update shader
  18249. * @returns a string containng the defines string
  18250. */
  18251. getEffectDefines(): string;
  18252. /**
  18253. * Returns the string "HemisphericParticleEmitter"
  18254. * @returns a string containing the class name
  18255. */
  18256. getClassName(): string;
  18257. /**
  18258. * Serializes the particle system to a JSON object.
  18259. * @returns the JSON object
  18260. */
  18261. serialize(): any;
  18262. /**
  18263. * Parse properties from a JSON object
  18264. * @param serializationObject defines the JSON object
  18265. */
  18266. parse(serializationObject: any): void;
  18267. }
  18268. }
  18269. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18270. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18271. import { Effect } from "babylonjs/Materials/effect";
  18272. import { Particle } from "babylonjs/Particles/particle";
  18273. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18274. /**
  18275. * Particle emitter emitting particles from a point.
  18276. * It emits the particles randomly between 2 given directions.
  18277. */
  18278. export class PointParticleEmitter implements IParticleEmitterType {
  18279. /**
  18280. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18281. */
  18282. direction1: Vector3;
  18283. /**
  18284. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18285. */
  18286. direction2: Vector3;
  18287. /**
  18288. * Creates a new instance PointParticleEmitter
  18289. */
  18290. constructor();
  18291. /**
  18292. * Called by the particle System when the direction is computed for the created particle.
  18293. * @param worldMatrix is the world matrix of the particle system
  18294. * @param directionToUpdate is the direction vector to update with the result
  18295. * @param particle is the particle we are computed the direction for
  18296. */
  18297. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18298. /**
  18299. * Called by the particle System when the position is computed for the created particle.
  18300. * @param worldMatrix is the world matrix of the particle system
  18301. * @param positionToUpdate is the position vector to update with the result
  18302. * @param particle is the particle we are computed the position for
  18303. */
  18304. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18305. /**
  18306. * Clones the current emitter and returns a copy of it
  18307. * @returns the new emitter
  18308. */
  18309. clone(): PointParticleEmitter;
  18310. /**
  18311. * Called by the GPUParticleSystem to setup the update shader
  18312. * @param effect defines the update shader
  18313. */
  18314. applyToShader(effect: Effect): void;
  18315. /**
  18316. * Returns a string to use to update the GPU particles update shader
  18317. * @returns a string containng the defines string
  18318. */
  18319. getEffectDefines(): string;
  18320. /**
  18321. * Returns the string "PointParticleEmitter"
  18322. * @returns a string containing the class name
  18323. */
  18324. getClassName(): string;
  18325. /**
  18326. * Serializes the particle system to a JSON object.
  18327. * @returns the JSON object
  18328. */
  18329. serialize(): any;
  18330. /**
  18331. * Parse properties from a JSON object
  18332. * @param serializationObject defines the JSON object
  18333. */
  18334. parse(serializationObject: any): void;
  18335. }
  18336. }
  18337. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18338. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18339. import { Effect } from "babylonjs/Materials/effect";
  18340. import { Particle } from "babylonjs/Particles/particle";
  18341. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18342. /**
  18343. * Particle emitter emitting particles from the inside of a sphere.
  18344. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18345. */
  18346. export class SphereParticleEmitter implements IParticleEmitterType {
  18347. /**
  18348. * The radius of the emission sphere.
  18349. */
  18350. radius: number;
  18351. /**
  18352. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18353. */
  18354. radiusRange: number;
  18355. /**
  18356. * How much to randomize the particle direction [0-1].
  18357. */
  18358. directionRandomizer: number;
  18359. /**
  18360. * Creates a new instance SphereParticleEmitter
  18361. * @param radius the radius of the emission sphere (1 by default)
  18362. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18363. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18364. */
  18365. constructor(
  18366. /**
  18367. * The radius of the emission sphere.
  18368. */
  18369. radius?: number,
  18370. /**
  18371. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18372. */
  18373. radiusRange?: number,
  18374. /**
  18375. * How much to randomize the particle direction [0-1].
  18376. */
  18377. directionRandomizer?: number);
  18378. /**
  18379. * Called by the particle System when the direction is computed for the created particle.
  18380. * @param worldMatrix is the world matrix of the particle system
  18381. * @param directionToUpdate is the direction vector to update with the result
  18382. * @param particle is the particle we are computed the direction for
  18383. */
  18384. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18385. /**
  18386. * Called by the particle System when the position is computed for the created particle.
  18387. * @param worldMatrix is the world matrix of the particle system
  18388. * @param positionToUpdate is the position vector to update with the result
  18389. * @param particle is the particle we are computed the position for
  18390. */
  18391. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18392. /**
  18393. * Clones the current emitter and returns a copy of it
  18394. * @returns the new emitter
  18395. */
  18396. clone(): SphereParticleEmitter;
  18397. /**
  18398. * Called by the GPUParticleSystem to setup the update shader
  18399. * @param effect defines the update shader
  18400. */
  18401. applyToShader(effect: Effect): void;
  18402. /**
  18403. * Returns a string to use to update the GPU particles update shader
  18404. * @returns a string containng the defines string
  18405. */
  18406. getEffectDefines(): string;
  18407. /**
  18408. * Returns the string "SphereParticleEmitter"
  18409. * @returns a string containing the class name
  18410. */
  18411. getClassName(): string;
  18412. /**
  18413. * Serializes the particle system to a JSON object.
  18414. * @returns the JSON object
  18415. */
  18416. serialize(): any;
  18417. /**
  18418. * Parse properties from a JSON object
  18419. * @param serializationObject defines the JSON object
  18420. */
  18421. parse(serializationObject: any): void;
  18422. }
  18423. /**
  18424. * Particle emitter emitting particles from the inside of a sphere.
  18425. * It emits the particles randomly between two vectors.
  18426. */
  18427. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18428. /**
  18429. * The min limit of the emission direction.
  18430. */
  18431. direction1: Vector3;
  18432. /**
  18433. * The max limit of the emission direction.
  18434. */
  18435. direction2: Vector3;
  18436. /**
  18437. * Creates a new instance SphereDirectedParticleEmitter
  18438. * @param radius the radius of the emission sphere (1 by default)
  18439. * @param direction1 the min limit of the emission direction (up vector by default)
  18440. * @param direction2 the max limit of the emission direction (up vector by default)
  18441. */
  18442. constructor(radius?: number,
  18443. /**
  18444. * The min limit of the emission direction.
  18445. */
  18446. direction1?: Vector3,
  18447. /**
  18448. * The max limit of the emission direction.
  18449. */
  18450. direction2?: Vector3);
  18451. /**
  18452. * Called by the particle System when the direction is computed for the created particle.
  18453. * @param worldMatrix is the world matrix of the particle system
  18454. * @param directionToUpdate is the direction vector to update with the result
  18455. * @param particle is the particle we are computed the direction for
  18456. */
  18457. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18458. /**
  18459. * Clones the current emitter and returns a copy of it
  18460. * @returns the new emitter
  18461. */
  18462. clone(): SphereDirectedParticleEmitter;
  18463. /**
  18464. * Called by the GPUParticleSystem to setup the update shader
  18465. * @param effect defines the update shader
  18466. */
  18467. applyToShader(effect: Effect): void;
  18468. /**
  18469. * Returns a string to use to update the GPU particles update shader
  18470. * @returns a string containng the defines string
  18471. */
  18472. getEffectDefines(): string;
  18473. /**
  18474. * Returns the string "SphereDirectedParticleEmitter"
  18475. * @returns a string containing the class name
  18476. */
  18477. getClassName(): string;
  18478. /**
  18479. * Serializes the particle system to a JSON object.
  18480. * @returns the JSON object
  18481. */
  18482. serialize(): any;
  18483. /**
  18484. * Parse properties from a JSON object
  18485. * @param serializationObject defines the JSON object
  18486. */
  18487. parse(serializationObject: any): void;
  18488. }
  18489. }
  18490. declare module "babylonjs/Particles/EmitterTypes/index" {
  18491. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18492. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18493. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18494. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18495. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18496. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18497. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18498. }
  18499. declare module "babylonjs/Particles/IParticleSystem" {
  18500. import { Nullable } from "babylonjs/types";
  18501. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18502. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18503. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18504. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18505. import { Texture } from "babylonjs/Materials/Textures/texture";
  18506. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18507. import { Scene } from "babylonjs/scene";
  18508. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18509. import { Animation } from "babylonjs/Animations/animation";
  18510. /**
  18511. * Interface representing a particle system in Babylon.js.
  18512. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18513. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18514. */
  18515. export interface IParticleSystem {
  18516. /**
  18517. * List of animations used by the particle system.
  18518. */
  18519. animations: Animation[];
  18520. /**
  18521. * The id of the Particle system.
  18522. */
  18523. id: string;
  18524. /**
  18525. * The name of the Particle system.
  18526. */
  18527. name: string;
  18528. /**
  18529. * The emitter represents the Mesh or position we are attaching the particle system to.
  18530. */
  18531. emitter: Nullable<AbstractMesh | Vector3>;
  18532. /**
  18533. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18534. */
  18535. isBillboardBased: boolean;
  18536. /**
  18537. * The rendering group used by the Particle system to chose when to render.
  18538. */
  18539. renderingGroupId: number;
  18540. /**
  18541. * The layer mask we are rendering the particles through.
  18542. */
  18543. layerMask: number;
  18544. /**
  18545. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18546. */
  18547. updateSpeed: number;
  18548. /**
  18549. * The amount of time the particle system is running (depends of the overall update speed).
  18550. */
  18551. targetStopDuration: number;
  18552. /**
  18553. * The texture used to render each particle. (this can be a spritesheet)
  18554. */
  18555. particleTexture: Nullable<Texture>;
  18556. /**
  18557. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18558. */
  18559. blendMode: number;
  18560. /**
  18561. * Minimum life time of emitting particles.
  18562. */
  18563. minLifeTime: number;
  18564. /**
  18565. * Maximum life time of emitting particles.
  18566. */
  18567. maxLifeTime: number;
  18568. /**
  18569. * Minimum Size of emitting particles.
  18570. */
  18571. minSize: number;
  18572. /**
  18573. * Maximum Size of emitting particles.
  18574. */
  18575. maxSize: number;
  18576. /**
  18577. * Minimum scale of emitting particles on X axis.
  18578. */
  18579. minScaleX: number;
  18580. /**
  18581. * Maximum scale of emitting particles on X axis.
  18582. */
  18583. maxScaleX: number;
  18584. /**
  18585. * Minimum scale of emitting particles on Y axis.
  18586. */
  18587. minScaleY: number;
  18588. /**
  18589. * Maximum scale of emitting particles on Y axis.
  18590. */
  18591. maxScaleY: number;
  18592. /**
  18593. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18594. */
  18595. color1: Color4;
  18596. /**
  18597. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18598. */
  18599. color2: Color4;
  18600. /**
  18601. * Color the particle will have at the end of its lifetime.
  18602. */
  18603. colorDead: Color4;
  18604. /**
  18605. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  18606. */
  18607. emitRate: number;
  18608. /**
  18609. * You can use gravity if you want to give an orientation to your particles.
  18610. */
  18611. gravity: Vector3;
  18612. /**
  18613. * Minimum power of emitting particles.
  18614. */
  18615. minEmitPower: number;
  18616. /**
  18617. * Maximum power of emitting particles.
  18618. */
  18619. maxEmitPower: number;
  18620. /**
  18621. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  18622. */
  18623. minAngularSpeed: number;
  18624. /**
  18625. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  18626. */
  18627. maxAngularSpeed: number;
  18628. /**
  18629. * Gets or sets the minimal initial rotation in radians.
  18630. */
  18631. minInitialRotation: number;
  18632. /**
  18633. * Gets or sets the maximal initial rotation in radians.
  18634. */
  18635. maxInitialRotation: number;
  18636. /**
  18637. * The particle emitter type defines the emitter used by the particle system.
  18638. * It can be for example box, sphere, or cone...
  18639. */
  18640. particleEmitterType: Nullable<IParticleEmitterType>;
  18641. /**
  18642. * Defines the delay in milliseconds before starting the system (0 by default)
  18643. */
  18644. startDelay: number;
  18645. /**
  18646. * 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
  18647. */
  18648. preWarmCycles: number;
  18649. /**
  18650. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  18651. */
  18652. preWarmStepOffset: number;
  18653. /**
  18654. * 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)
  18655. */
  18656. spriteCellChangeSpeed: number;
  18657. /**
  18658. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  18659. */
  18660. startSpriteCellID: number;
  18661. /**
  18662. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  18663. */
  18664. endSpriteCellID: number;
  18665. /**
  18666. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  18667. */
  18668. spriteCellWidth: number;
  18669. /**
  18670. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  18671. */
  18672. spriteCellHeight: number;
  18673. /**
  18674. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  18675. */
  18676. spriteRandomStartCell: boolean;
  18677. /**
  18678. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  18679. */
  18680. isAnimationSheetEnabled: boolean;
  18681. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  18682. translationPivot: Vector2;
  18683. /**
  18684. * Gets or sets a texture used to add random noise to particle positions
  18685. */
  18686. noiseTexture: Nullable<BaseTexture>;
  18687. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  18688. noiseStrength: Vector3;
  18689. /**
  18690. * Gets or sets the billboard mode to use when isBillboardBased = true.
  18691. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  18692. */
  18693. billboardMode: number;
  18694. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  18695. limitVelocityDamping: number;
  18696. /**
  18697. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  18698. */
  18699. beginAnimationOnStart: boolean;
  18700. /**
  18701. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  18702. */
  18703. beginAnimationFrom: number;
  18704. /**
  18705. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  18706. */
  18707. beginAnimationTo: number;
  18708. /**
  18709. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  18710. */
  18711. beginAnimationLoop: boolean;
  18712. /**
  18713. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  18714. */
  18715. disposeOnStop: boolean;
  18716. /**
  18717. * Gets the maximum number of particles active at the same time.
  18718. * @returns The max number of active particles.
  18719. */
  18720. getCapacity(): number;
  18721. /**
  18722. * Gets if the system has been started. (Note: this will still be true after stop is called)
  18723. * @returns True if it has been started, otherwise false.
  18724. */
  18725. isStarted(): boolean;
  18726. /**
  18727. * Animates the particle system for this frame.
  18728. */
  18729. animate(): void;
  18730. /**
  18731. * Renders the particle system in its current state.
  18732. * @returns the current number of particles
  18733. */
  18734. render(): number;
  18735. /**
  18736. * Dispose the particle system and frees its associated resources.
  18737. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  18738. */
  18739. dispose(disposeTexture?: boolean): void;
  18740. /**
  18741. * Clones the particle system.
  18742. * @param name The name of the cloned object
  18743. * @param newEmitter The new emitter to use
  18744. * @returns the cloned particle system
  18745. */
  18746. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  18747. /**
  18748. * Serializes the particle system to a JSON object.
  18749. * @returns the JSON object
  18750. */
  18751. serialize(): any;
  18752. /**
  18753. * Rebuild the particle system
  18754. */
  18755. rebuild(): void;
  18756. /**
  18757. * Starts the particle system and begins to emit
  18758. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  18759. */
  18760. start(delay?: number): void;
  18761. /**
  18762. * Stops the particle system.
  18763. */
  18764. stop(): void;
  18765. /**
  18766. * Remove all active particles
  18767. */
  18768. reset(): void;
  18769. /**
  18770. * Is this system ready to be used/rendered
  18771. * @return true if the system is ready
  18772. */
  18773. isReady(): boolean;
  18774. /**
  18775. * Adds a new color gradient
  18776. * @param gradient defines the gradient to use (between 0 and 1)
  18777. * @param color1 defines the color to affect to the specified gradient
  18778. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  18779. * @returns the current particle system
  18780. */
  18781. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  18782. /**
  18783. * Remove a specific color gradient
  18784. * @param gradient defines the gradient to remove
  18785. * @returns the current particle system
  18786. */
  18787. removeColorGradient(gradient: number): IParticleSystem;
  18788. /**
  18789. * Adds a new size gradient
  18790. * @param gradient defines the gradient to use (between 0 and 1)
  18791. * @param factor defines the size factor to affect to the specified gradient
  18792. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18793. * @returns the current particle system
  18794. */
  18795. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18796. /**
  18797. * Remove a specific size gradient
  18798. * @param gradient defines the gradient to remove
  18799. * @returns the current particle system
  18800. */
  18801. removeSizeGradient(gradient: number): IParticleSystem;
  18802. /**
  18803. * Gets the current list of color gradients.
  18804. * You must use addColorGradient and removeColorGradient to udpate this list
  18805. * @returns the list of color gradients
  18806. */
  18807. getColorGradients(): Nullable<Array<ColorGradient>>;
  18808. /**
  18809. * Gets the current list of size gradients.
  18810. * You must use addSizeGradient and removeSizeGradient to udpate this list
  18811. * @returns the list of size gradients
  18812. */
  18813. getSizeGradients(): Nullable<Array<FactorGradient>>;
  18814. /**
  18815. * Gets the current list of angular speed gradients.
  18816. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  18817. * @returns the list of angular speed gradients
  18818. */
  18819. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  18820. /**
  18821. * Adds a new angular speed gradient
  18822. * @param gradient defines the gradient to use (between 0 and 1)
  18823. * @param factor defines the angular speed to affect to the specified gradient
  18824. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18825. * @returns the current particle system
  18826. */
  18827. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18828. /**
  18829. * Remove a specific angular speed gradient
  18830. * @param gradient defines the gradient to remove
  18831. * @returns the current particle system
  18832. */
  18833. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  18834. /**
  18835. * Gets the current list of velocity gradients.
  18836. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  18837. * @returns the list of velocity gradients
  18838. */
  18839. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  18840. /**
  18841. * Adds a new velocity gradient
  18842. * @param gradient defines the gradient to use (between 0 and 1)
  18843. * @param factor defines the velocity to affect to the specified gradient
  18844. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18845. * @returns the current particle system
  18846. */
  18847. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18848. /**
  18849. * Remove a specific velocity gradient
  18850. * @param gradient defines the gradient to remove
  18851. * @returns the current particle system
  18852. */
  18853. removeVelocityGradient(gradient: number): IParticleSystem;
  18854. /**
  18855. * Gets the current list of limit velocity gradients.
  18856. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  18857. * @returns the list of limit velocity gradients
  18858. */
  18859. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  18860. /**
  18861. * Adds a new limit velocity gradient
  18862. * @param gradient defines the gradient to use (between 0 and 1)
  18863. * @param factor defines the limit velocity to affect to the specified gradient
  18864. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18865. * @returns the current particle system
  18866. */
  18867. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18868. /**
  18869. * Remove a specific limit velocity gradient
  18870. * @param gradient defines the gradient to remove
  18871. * @returns the current particle system
  18872. */
  18873. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  18874. /**
  18875. * Adds a new drag gradient
  18876. * @param gradient defines the gradient to use (between 0 and 1)
  18877. * @param factor defines the drag to affect to the specified gradient
  18878. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18879. * @returns the current particle system
  18880. */
  18881. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18882. /**
  18883. * Remove a specific drag gradient
  18884. * @param gradient defines the gradient to remove
  18885. * @returns the current particle system
  18886. */
  18887. removeDragGradient(gradient: number): IParticleSystem;
  18888. /**
  18889. * Gets the current list of drag gradients.
  18890. * You must use addDragGradient and removeDragGradient to udpate this list
  18891. * @returns the list of drag gradients
  18892. */
  18893. getDragGradients(): Nullable<Array<FactorGradient>>;
  18894. /**
  18895. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  18896. * @param gradient defines the gradient to use (between 0 and 1)
  18897. * @param factor defines the emit rate to affect to the specified gradient
  18898. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18899. * @returns the current particle system
  18900. */
  18901. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18902. /**
  18903. * Remove a specific emit rate gradient
  18904. * @param gradient defines the gradient to remove
  18905. * @returns the current particle system
  18906. */
  18907. removeEmitRateGradient(gradient: number): IParticleSystem;
  18908. /**
  18909. * Gets the current list of emit rate gradients.
  18910. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  18911. * @returns the list of emit rate gradients
  18912. */
  18913. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  18914. /**
  18915. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  18916. * @param gradient defines the gradient to use (between 0 and 1)
  18917. * @param factor defines the start size to affect to the specified gradient
  18918. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18919. * @returns the current particle system
  18920. */
  18921. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18922. /**
  18923. * Remove a specific start size gradient
  18924. * @param gradient defines the gradient to remove
  18925. * @returns the current particle system
  18926. */
  18927. removeStartSizeGradient(gradient: number): IParticleSystem;
  18928. /**
  18929. * Gets the current list of start size gradients.
  18930. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  18931. * @returns the list of start size gradients
  18932. */
  18933. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  18934. /**
  18935. * Adds a new life time gradient
  18936. * @param gradient defines the gradient to use (between 0 and 1)
  18937. * @param factor defines the life time factor to affect to the specified gradient
  18938. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18939. * @returns the current particle system
  18940. */
  18941. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18942. /**
  18943. * Remove a specific life time gradient
  18944. * @param gradient defines the gradient to remove
  18945. * @returns the current particle system
  18946. */
  18947. removeLifeTimeGradient(gradient: number): IParticleSystem;
  18948. /**
  18949. * Gets the current list of life time gradients.
  18950. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  18951. * @returns the list of life time gradients
  18952. */
  18953. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  18954. /**
  18955. * Gets the current list of color gradients.
  18956. * You must use addColorGradient and removeColorGradient to udpate this list
  18957. * @returns the list of color gradients
  18958. */
  18959. getColorGradients(): Nullable<Array<ColorGradient>>;
  18960. /**
  18961. * Adds a new ramp gradient used to remap particle colors
  18962. * @param gradient defines the gradient to use (between 0 and 1)
  18963. * @param color defines the color to affect to the specified gradient
  18964. * @returns the current particle system
  18965. */
  18966. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  18967. /**
  18968. * Gets the current list of ramp gradients.
  18969. * You must use addRampGradient and removeRampGradient to udpate this list
  18970. * @returns the list of ramp gradients
  18971. */
  18972. getRampGradients(): Nullable<Array<Color3Gradient>>;
  18973. /** Gets or sets a boolean indicating that ramp gradients must be used
  18974. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  18975. */
  18976. useRampGradients: boolean;
  18977. /**
  18978. * Adds a new color remap gradient
  18979. * @param gradient defines the gradient to use (between 0 and 1)
  18980. * @param min defines the color remap minimal range
  18981. * @param max defines the color remap maximal range
  18982. * @returns the current particle system
  18983. */
  18984. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  18985. /**
  18986. * Gets the current list of color remap gradients.
  18987. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  18988. * @returns the list of color remap gradients
  18989. */
  18990. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  18991. /**
  18992. * Adds a new alpha remap gradient
  18993. * @param gradient defines the gradient to use (between 0 and 1)
  18994. * @param min defines the alpha remap minimal range
  18995. * @param max defines the alpha remap maximal range
  18996. * @returns the current particle system
  18997. */
  18998. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  18999. /**
  19000. * Gets the current list of alpha remap gradients.
  19001. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19002. * @returns the list of alpha remap gradients
  19003. */
  19004. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19005. /**
  19006. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19007. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19008. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19009. * @returns the emitter
  19010. */
  19011. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19012. /**
  19013. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19014. * @param radius The radius of the hemisphere to emit from
  19015. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19016. * @returns the emitter
  19017. */
  19018. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19019. /**
  19020. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19021. * @param radius The radius of the sphere to emit from
  19022. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19023. * @returns the emitter
  19024. */
  19025. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19026. /**
  19027. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19028. * @param radius The radius of the sphere to emit from
  19029. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19030. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19031. * @returns the emitter
  19032. */
  19033. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19034. /**
  19035. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19036. * @param radius The radius of the emission cylinder
  19037. * @param height The height of the emission cylinder
  19038. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19039. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19040. * @returns the emitter
  19041. */
  19042. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19043. /**
  19044. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19045. * @param radius The radius of the cylinder to emit from
  19046. * @param height The height of the emission cylinder
  19047. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19048. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19049. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19050. * @returns the emitter
  19051. */
  19052. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19053. /**
  19054. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19055. * @param radius The radius of the cone to emit from
  19056. * @param angle The base angle of the cone
  19057. * @returns the emitter
  19058. */
  19059. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19060. /**
  19061. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19062. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19063. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19064. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19065. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19066. * @returns the emitter
  19067. */
  19068. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19069. /**
  19070. * Get hosting scene
  19071. * @returns the scene
  19072. */
  19073. getScene(): Scene;
  19074. }
  19075. }
  19076. declare module "babylonjs/Meshes/instancedMesh" {
  19077. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19078. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19079. import { Camera } from "babylonjs/Cameras/camera";
  19080. import { Node } from "babylonjs/node";
  19081. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19082. import { Mesh } from "babylonjs/Meshes/mesh";
  19083. import { Material } from "babylonjs/Materials/material";
  19084. import { Skeleton } from "babylonjs/Bones/skeleton";
  19085. import { Light } from "babylonjs/Lights/light";
  19086. /**
  19087. * Creates an instance based on a source mesh.
  19088. */
  19089. export class InstancedMesh extends AbstractMesh {
  19090. private _sourceMesh;
  19091. private _currentLOD;
  19092. /** @hidden */
  19093. _indexInSourceMeshInstanceArray: number;
  19094. constructor(name: string, source: Mesh);
  19095. /**
  19096. * Returns the string "InstancedMesh".
  19097. */
  19098. getClassName(): string;
  19099. /** Gets the list of lights affecting that mesh */
  19100. readonly lightSources: Light[];
  19101. _resyncLightSources(): void;
  19102. _resyncLighSource(light: Light): void;
  19103. _removeLightSource(light: Light, dispose: boolean): void;
  19104. /**
  19105. * If the source mesh receives shadows
  19106. */
  19107. readonly receiveShadows: boolean;
  19108. /**
  19109. * The material of the source mesh
  19110. */
  19111. readonly material: Nullable<Material>;
  19112. /**
  19113. * Visibility of the source mesh
  19114. */
  19115. readonly visibility: number;
  19116. /**
  19117. * Skeleton of the source mesh
  19118. */
  19119. readonly skeleton: Nullable<Skeleton>;
  19120. /**
  19121. * Rendering ground id of the source mesh
  19122. */
  19123. renderingGroupId: number;
  19124. /**
  19125. * Returns the total number of vertices (integer).
  19126. */
  19127. getTotalVertices(): number;
  19128. /**
  19129. * Returns a positive integer : the total number of indices in this mesh geometry.
  19130. * @returns the numner of indices or zero if the mesh has no geometry.
  19131. */
  19132. getTotalIndices(): number;
  19133. /**
  19134. * The source mesh of the instance
  19135. */
  19136. readonly sourceMesh: Mesh;
  19137. /**
  19138. * Is this node ready to be used/rendered
  19139. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19140. * @return {boolean} is it ready
  19141. */
  19142. isReady(completeCheck?: boolean): boolean;
  19143. /**
  19144. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19145. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19146. * @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.
  19147. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19148. */
  19149. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19150. /**
  19151. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19152. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19153. * The `data` are either a numeric array either a Float32Array.
  19154. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19155. * 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).
  19156. * Note that a new underlying VertexBuffer object is created each call.
  19157. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19158. *
  19159. * Possible `kind` values :
  19160. * - VertexBuffer.PositionKind
  19161. * - VertexBuffer.UVKind
  19162. * - VertexBuffer.UV2Kind
  19163. * - VertexBuffer.UV3Kind
  19164. * - VertexBuffer.UV4Kind
  19165. * - VertexBuffer.UV5Kind
  19166. * - VertexBuffer.UV6Kind
  19167. * - VertexBuffer.ColorKind
  19168. * - VertexBuffer.MatricesIndicesKind
  19169. * - VertexBuffer.MatricesIndicesExtraKind
  19170. * - VertexBuffer.MatricesWeightsKind
  19171. * - VertexBuffer.MatricesWeightsExtraKind
  19172. *
  19173. * Returns the Mesh.
  19174. */
  19175. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19176. /**
  19177. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19178. * If the mesh has no geometry, it is simply returned as it is.
  19179. * The `data` are either a numeric array either a Float32Array.
  19180. * No new underlying VertexBuffer object is created.
  19181. * 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.
  19182. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19183. *
  19184. * Possible `kind` values :
  19185. * - VertexBuffer.PositionKind
  19186. * - VertexBuffer.UVKind
  19187. * - VertexBuffer.UV2Kind
  19188. * - VertexBuffer.UV3Kind
  19189. * - VertexBuffer.UV4Kind
  19190. * - VertexBuffer.UV5Kind
  19191. * - VertexBuffer.UV6Kind
  19192. * - VertexBuffer.ColorKind
  19193. * - VertexBuffer.MatricesIndicesKind
  19194. * - VertexBuffer.MatricesIndicesExtraKind
  19195. * - VertexBuffer.MatricesWeightsKind
  19196. * - VertexBuffer.MatricesWeightsExtraKind
  19197. *
  19198. * Returns the Mesh.
  19199. */
  19200. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19201. /**
  19202. * Sets the mesh indices.
  19203. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19204. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19205. * This method creates a new index buffer each call.
  19206. * Returns the Mesh.
  19207. */
  19208. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19209. /**
  19210. * Boolean : True if the mesh owns the requested kind of data.
  19211. */
  19212. isVerticesDataPresent(kind: string): boolean;
  19213. /**
  19214. * Returns an array of indices (IndicesArray).
  19215. */
  19216. getIndices(): Nullable<IndicesArray>;
  19217. readonly _positions: Nullable<Vector3[]>;
  19218. /**
  19219. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19220. * This means the mesh underlying bounding box and sphere are recomputed.
  19221. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19222. * @returns the current mesh
  19223. */
  19224. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19225. /** @hidden */
  19226. _preActivate(): InstancedMesh;
  19227. /** @hidden */
  19228. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19229. /** @hidden */
  19230. _postActivate(): void;
  19231. getWorldMatrix(): Matrix;
  19232. readonly isAnInstance: boolean;
  19233. /**
  19234. * Returns the current associated LOD AbstractMesh.
  19235. */
  19236. getLOD(camera: Camera): AbstractMesh;
  19237. /** @hidden */
  19238. _syncSubMeshes(): InstancedMesh;
  19239. /** @hidden */
  19240. _generatePointsArray(): boolean;
  19241. /**
  19242. * Creates a new InstancedMesh from the current mesh.
  19243. * - name (string) : the cloned mesh name
  19244. * - newParent (optional Node) : the optional Node to parent the clone to.
  19245. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19246. *
  19247. * Returns the clone.
  19248. */
  19249. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19250. /**
  19251. * Disposes the InstancedMesh.
  19252. * Returns nothing.
  19253. */
  19254. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19255. }
  19256. }
  19257. declare module "babylonjs/Materials/shaderMaterial" {
  19258. import { Scene } from "babylonjs/scene";
  19259. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19260. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19261. import { Mesh } from "babylonjs/Meshes/mesh";
  19262. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19263. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19264. import { Texture } from "babylonjs/Materials/Textures/texture";
  19265. import { Material } from "babylonjs/Materials/material";
  19266. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19267. /**
  19268. * Defines the options associated with the creation of a shader material.
  19269. */
  19270. export interface IShaderMaterialOptions {
  19271. /**
  19272. * Does the material work in alpha blend mode
  19273. */
  19274. needAlphaBlending: boolean;
  19275. /**
  19276. * Does the material work in alpha test mode
  19277. */
  19278. needAlphaTesting: boolean;
  19279. /**
  19280. * The list of attribute names used in the shader
  19281. */
  19282. attributes: string[];
  19283. /**
  19284. * The list of unifrom names used in the shader
  19285. */
  19286. uniforms: string[];
  19287. /**
  19288. * The list of UBO names used in the shader
  19289. */
  19290. uniformBuffers: string[];
  19291. /**
  19292. * The list of sampler names used in the shader
  19293. */
  19294. samplers: string[];
  19295. /**
  19296. * The list of defines used in the shader
  19297. */
  19298. defines: string[];
  19299. }
  19300. /**
  19301. * 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.
  19302. *
  19303. * This returned material effects how the mesh will look based on the code in the shaders.
  19304. *
  19305. * @see http://doc.babylonjs.com/how_to/shader_material
  19306. */
  19307. export class ShaderMaterial extends Material {
  19308. private _shaderPath;
  19309. private _options;
  19310. private _textures;
  19311. private _textureArrays;
  19312. private _floats;
  19313. private _ints;
  19314. private _floatsArrays;
  19315. private _colors3;
  19316. private _colors3Arrays;
  19317. private _colors4;
  19318. private _colors4Arrays;
  19319. private _vectors2;
  19320. private _vectors3;
  19321. private _vectors4;
  19322. private _matrices;
  19323. private _matrices3x3;
  19324. private _matrices2x2;
  19325. private _vectors2Arrays;
  19326. private _vectors3Arrays;
  19327. private _vectors4Arrays;
  19328. private _cachedWorldViewMatrix;
  19329. private _cachedWorldViewProjectionMatrix;
  19330. private _renderId;
  19331. /**
  19332. * Instantiate a new shader material.
  19333. * 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.
  19334. * This returned material effects how the mesh will look based on the code in the shaders.
  19335. * @see http://doc.babylonjs.com/how_to/shader_material
  19336. * @param name Define the name of the material in the scene
  19337. * @param scene Define the scene the material belongs to
  19338. * @param shaderPath Defines the route to the shader code in one of three ways:
  19339. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19340. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19341. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19342. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19343. * @param options Define the options used to create the shader
  19344. */
  19345. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19346. /**
  19347. * Gets the options used to compile the shader.
  19348. * They can be modified to trigger a new compilation
  19349. */
  19350. readonly options: IShaderMaterialOptions;
  19351. /**
  19352. * Gets the current class name of the material e.g. "ShaderMaterial"
  19353. * Mainly use in serialization.
  19354. * @returns the class name
  19355. */
  19356. getClassName(): string;
  19357. /**
  19358. * Specifies if the material will require alpha blending
  19359. * @returns a boolean specifying if alpha blending is needed
  19360. */
  19361. needAlphaBlending(): boolean;
  19362. /**
  19363. * Specifies if this material should be rendered in alpha test mode
  19364. * @returns a boolean specifying if an alpha test is needed.
  19365. */
  19366. needAlphaTesting(): boolean;
  19367. private _checkUniform;
  19368. /**
  19369. * Set a texture in the shader.
  19370. * @param name Define the name of the uniform samplers as defined in the shader
  19371. * @param texture Define the texture to bind to this sampler
  19372. * @return the material itself allowing "fluent" like uniform updates
  19373. */
  19374. setTexture(name: string, texture: Texture): ShaderMaterial;
  19375. /**
  19376. * Set a texture array in the shader.
  19377. * @param name Define the name of the uniform sampler array as defined in the shader
  19378. * @param textures Define the list of textures to bind to this sampler
  19379. * @return the material itself allowing "fluent" like uniform updates
  19380. */
  19381. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19382. /**
  19383. * Set a float in the shader.
  19384. * @param name Define the name of the uniform as defined in the shader
  19385. * @param value Define the value to give to the uniform
  19386. * @return the material itself allowing "fluent" like uniform updates
  19387. */
  19388. setFloat(name: string, value: number): ShaderMaterial;
  19389. /**
  19390. * Set a int in the shader.
  19391. * @param name Define the name of the uniform as defined in the shader
  19392. * @param value Define the value to give to the uniform
  19393. * @return the material itself allowing "fluent" like uniform updates
  19394. */
  19395. setInt(name: string, value: number): ShaderMaterial;
  19396. /**
  19397. * Set an array of floats in the shader.
  19398. * @param name Define the name of the uniform as defined in the shader
  19399. * @param value Define the value to give to the uniform
  19400. * @return the material itself allowing "fluent" like uniform updates
  19401. */
  19402. setFloats(name: string, value: number[]): ShaderMaterial;
  19403. /**
  19404. * Set a vec3 in the shader from a Color3.
  19405. * @param name Define the name of the uniform as defined in the shader
  19406. * @param value Define the value to give to the uniform
  19407. * @return the material itself allowing "fluent" like uniform updates
  19408. */
  19409. setColor3(name: string, value: Color3): ShaderMaterial;
  19410. /**
  19411. * Set a vec3 array in the shader from a Color3 array.
  19412. * @param name Define the name of the uniform as defined in the shader
  19413. * @param value Define the value to give to the uniform
  19414. * @return the material itself allowing "fluent" like uniform updates
  19415. */
  19416. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19417. /**
  19418. * Set a vec4 in the shader from a Color4.
  19419. * @param name Define the name of the uniform as defined in the shader
  19420. * @param value Define the value to give to the uniform
  19421. * @return the material itself allowing "fluent" like uniform updates
  19422. */
  19423. setColor4(name: string, value: Color4): ShaderMaterial;
  19424. /**
  19425. * Set a vec4 array in the shader from a Color4 array.
  19426. * @param name Define the name of the uniform as defined in the shader
  19427. * @param value Define the value to give to the uniform
  19428. * @return the material itself allowing "fluent" like uniform updates
  19429. */
  19430. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19431. /**
  19432. * Set a vec2 in the shader from a Vector2.
  19433. * @param name Define the name of the uniform as defined in the shader
  19434. * @param value Define the value to give to the uniform
  19435. * @return the material itself allowing "fluent" like uniform updates
  19436. */
  19437. setVector2(name: string, value: Vector2): ShaderMaterial;
  19438. /**
  19439. * Set a vec3 in the shader from a Vector3.
  19440. * @param name Define the name of the uniform as defined in the shader
  19441. * @param value Define the value to give to the uniform
  19442. * @return the material itself allowing "fluent" like uniform updates
  19443. */
  19444. setVector3(name: string, value: Vector3): ShaderMaterial;
  19445. /**
  19446. * Set a vec4 in the shader from a Vector4.
  19447. * @param name Define the name of the uniform as defined in the shader
  19448. * @param value Define the value to give to the uniform
  19449. * @return the material itself allowing "fluent" like uniform updates
  19450. */
  19451. setVector4(name: string, value: Vector4): ShaderMaterial;
  19452. /**
  19453. * Set a mat4 in the shader from a Matrix.
  19454. * @param name Define the name of the uniform as defined in the shader
  19455. * @param value Define the value to give to the uniform
  19456. * @return the material itself allowing "fluent" like uniform updates
  19457. */
  19458. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19459. /**
  19460. * Set a mat3 in the shader from a Float32Array.
  19461. * @param name Define the name of the uniform as defined in the shader
  19462. * @param value Define the value to give to the uniform
  19463. * @return the material itself allowing "fluent" like uniform updates
  19464. */
  19465. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19466. /**
  19467. * Set a mat2 in the shader from a Float32Array.
  19468. * @param name Define the name of the uniform as defined in the shader
  19469. * @param value Define the value to give to the uniform
  19470. * @return the material itself allowing "fluent" like uniform updates
  19471. */
  19472. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19473. /**
  19474. * Set a vec2 array in the shader from a number array.
  19475. * @param name Define the name of the uniform as defined in the shader
  19476. * @param value Define the value to give to the uniform
  19477. * @return the material itself allowing "fluent" like uniform updates
  19478. */
  19479. setArray2(name: string, value: number[]): ShaderMaterial;
  19480. /**
  19481. * Set a vec3 array in the shader from a number array.
  19482. * @param name Define the name of the uniform as defined in the shader
  19483. * @param value Define the value to give to the uniform
  19484. * @return the material itself allowing "fluent" like uniform updates
  19485. */
  19486. setArray3(name: string, value: number[]): ShaderMaterial;
  19487. /**
  19488. * Set a vec4 array in the shader from a number array.
  19489. * @param name Define the name of the uniform as defined in the shader
  19490. * @param value Define the value to give to the uniform
  19491. * @return the material itself allowing "fluent" like uniform updates
  19492. */
  19493. setArray4(name: string, value: number[]): ShaderMaterial;
  19494. private _checkCache;
  19495. /**
  19496. * Specifies that the submesh is ready to be used
  19497. * @param mesh defines the mesh to check
  19498. * @param subMesh defines which submesh to check
  19499. * @param useInstances specifies that instances should be used
  19500. * @returns a boolean indicating that the submesh is ready or not
  19501. */
  19502. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19503. /**
  19504. * Checks if the material is ready to render the requested mesh
  19505. * @param mesh Define the mesh to render
  19506. * @param useInstances Define whether or not the material is used with instances
  19507. * @returns true if ready, otherwise false
  19508. */
  19509. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19510. /**
  19511. * Binds the world matrix to the material
  19512. * @param world defines the world transformation matrix
  19513. */
  19514. bindOnlyWorldMatrix(world: Matrix): void;
  19515. /**
  19516. * Binds the material to the mesh
  19517. * @param world defines the world transformation matrix
  19518. * @param mesh defines the mesh to bind the material to
  19519. */
  19520. bind(world: Matrix, mesh?: Mesh): void;
  19521. /**
  19522. * Gets the active textures from the material
  19523. * @returns an array of textures
  19524. */
  19525. getActiveTextures(): BaseTexture[];
  19526. /**
  19527. * Specifies if the material uses a texture
  19528. * @param texture defines the texture to check against the material
  19529. * @returns a boolean specifying if the material uses the texture
  19530. */
  19531. hasTexture(texture: BaseTexture): boolean;
  19532. /**
  19533. * Makes a duplicate of the material, and gives it a new name
  19534. * @param name defines the new name for the duplicated material
  19535. * @returns the cloned material
  19536. */
  19537. clone(name: string): ShaderMaterial;
  19538. /**
  19539. * Disposes the material
  19540. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19541. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19542. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  19543. */
  19544. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  19545. /**
  19546. * Serializes this material in a JSON representation
  19547. * @returns the serialized material object
  19548. */
  19549. serialize(): any;
  19550. /**
  19551. * Creates a shader material from parsed shader material data
  19552. * @param source defines the JSON represnetation of the material
  19553. * @param scene defines the hosting scene
  19554. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19555. * @returns a new material
  19556. */
  19557. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  19558. }
  19559. }
  19560. declare module "babylonjs/Shaders/color.fragment" {
  19561. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  19562. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  19563. /** @hidden */
  19564. export var colorPixelShader: {
  19565. name: string;
  19566. shader: string;
  19567. };
  19568. }
  19569. declare module "babylonjs/Shaders/color.vertex" {
  19570. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  19571. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  19572. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  19573. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  19574. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  19575. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  19576. /** @hidden */
  19577. export var colorVertexShader: {
  19578. name: string;
  19579. shader: string;
  19580. };
  19581. }
  19582. declare module "babylonjs/Meshes/linesMesh" {
  19583. import { Nullable } from "babylonjs/types";
  19584. import { Scene } from "babylonjs/scene";
  19585. import { Color3 } from "babylonjs/Maths/math.color";
  19586. import { Node } from "babylonjs/node";
  19587. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19588. import { Mesh } from "babylonjs/Meshes/mesh";
  19589. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  19590. import { Effect } from "babylonjs/Materials/effect";
  19591. import { Material } from "babylonjs/Materials/material";
  19592. import "babylonjs/Shaders/color.fragment";
  19593. import "babylonjs/Shaders/color.vertex";
  19594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19595. /**
  19596. * Line mesh
  19597. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  19598. */
  19599. export class LinesMesh extends Mesh {
  19600. /**
  19601. * If vertex color should be applied to the mesh
  19602. */
  19603. readonly useVertexColor?: boolean | undefined;
  19604. /**
  19605. * If vertex alpha should be applied to the mesh
  19606. */
  19607. readonly useVertexAlpha?: boolean | undefined;
  19608. /**
  19609. * Color of the line (Default: White)
  19610. */
  19611. color: Color3;
  19612. /**
  19613. * Alpha of the line (Default: 1)
  19614. */
  19615. alpha: number;
  19616. /**
  19617. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19618. * This margin is expressed in world space coordinates, so its value may vary.
  19619. * Default value is 0.1
  19620. */
  19621. intersectionThreshold: number;
  19622. private _colorShader;
  19623. private color4;
  19624. /**
  19625. * Creates a new LinesMesh
  19626. * @param name defines the name
  19627. * @param scene defines the hosting scene
  19628. * @param parent defines the parent mesh if any
  19629. * @param source defines the optional source LinesMesh used to clone data from
  19630. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  19631. * When false, achieved by calling a clone(), also passing False.
  19632. * This will make creation of children, recursive.
  19633. * @param useVertexColor defines if this LinesMesh supports vertex color
  19634. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  19635. */
  19636. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  19637. /**
  19638. * If vertex color should be applied to the mesh
  19639. */
  19640. useVertexColor?: boolean | undefined,
  19641. /**
  19642. * If vertex alpha should be applied to the mesh
  19643. */
  19644. useVertexAlpha?: boolean | undefined);
  19645. private _addClipPlaneDefine;
  19646. private _removeClipPlaneDefine;
  19647. isReady(): boolean;
  19648. /**
  19649. * Returns the string "LineMesh"
  19650. */
  19651. getClassName(): string;
  19652. /**
  19653. * @hidden
  19654. */
  19655. /**
  19656. * @hidden
  19657. */
  19658. material: Material;
  19659. /**
  19660. * @hidden
  19661. */
  19662. readonly checkCollisions: boolean;
  19663. /** @hidden */
  19664. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  19665. /** @hidden */
  19666. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  19667. /**
  19668. * Disposes of the line mesh
  19669. * @param doNotRecurse If children should be disposed
  19670. */
  19671. dispose(doNotRecurse?: boolean): void;
  19672. /**
  19673. * Returns a new LineMesh object cloned from the current one.
  19674. */
  19675. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19676. /**
  19677. * Creates a new InstancedLinesMesh object from the mesh model.
  19678. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  19679. * @param name defines the name of the new instance
  19680. * @returns a new InstancedLinesMesh
  19681. */
  19682. createInstance(name: string): InstancedLinesMesh;
  19683. }
  19684. /**
  19685. * Creates an instance based on a source LinesMesh
  19686. */
  19687. export class InstancedLinesMesh extends InstancedMesh {
  19688. /**
  19689. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19690. * This margin is expressed in world space coordinates, so its value may vary.
  19691. * Initilized with the intersectionThreshold value of the source LinesMesh
  19692. */
  19693. intersectionThreshold: number;
  19694. constructor(name: string, source: LinesMesh);
  19695. /**
  19696. * Returns the string "InstancedLinesMesh".
  19697. */
  19698. getClassName(): string;
  19699. }
  19700. }
  19701. declare module "babylonjs/Shaders/line.fragment" {
  19702. /** @hidden */
  19703. export var linePixelShader: {
  19704. name: string;
  19705. shader: string;
  19706. };
  19707. }
  19708. declare module "babylonjs/Shaders/line.vertex" {
  19709. /** @hidden */
  19710. export var lineVertexShader: {
  19711. name: string;
  19712. shader: string;
  19713. };
  19714. }
  19715. declare module "babylonjs/Rendering/edgesRenderer" {
  19716. import { Nullable } from "babylonjs/types";
  19717. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19718. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19719. import { Vector3 } from "babylonjs/Maths/math.vector";
  19720. import { IDisposable } from "babylonjs/scene";
  19721. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  19722. import "babylonjs/Shaders/line.fragment";
  19723. import "babylonjs/Shaders/line.vertex";
  19724. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  19725. module "babylonjs/Meshes/abstractMesh" {
  19726. interface AbstractMesh {
  19727. /**
  19728. * Gets the edgesRenderer associated with the mesh
  19729. */
  19730. edgesRenderer: Nullable<EdgesRenderer>;
  19731. }
  19732. }
  19733. module "babylonjs/Meshes/linesMesh" {
  19734. interface LinesMesh {
  19735. /**
  19736. * Enables the edge rendering mode on the mesh.
  19737. * This mode makes the mesh edges visible
  19738. * @param epsilon defines the maximal distance between two angles to detect a face
  19739. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  19740. * @returns the currentAbstractMesh
  19741. * @see https://www.babylonjs-playground.com/#19O9TU#0
  19742. */
  19743. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  19744. }
  19745. }
  19746. module "babylonjs/Meshes/linesMesh" {
  19747. interface InstancedLinesMesh {
  19748. /**
  19749. * Enables the edge rendering mode on the mesh.
  19750. * This mode makes the mesh edges visible
  19751. * @param epsilon defines the maximal distance between two angles to detect a face
  19752. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  19753. * @returns the current InstancedLinesMesh
  19754. * @see https://www.babylonjs-playground.com/#19O9TU#0
  19755. */
  19756. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  19757. }
  19758. }
  19759. /**
  19760. * Defines the minimum contract an Edges renderer should follow.
  19761. */
  19762. export interface IEdgesRenderer extends IDisposable {
  19763. /**
  19764. * Gets or sets a boolean indicating if the edgesRenderer is active
  19765. */
  19766. isEnabled: boolean;
  19767. /**
  19768. * Renders the edges of the attached mesh,
  19769. */
  19770. render(): void;
  19771. /**
  19772. * Checks wether or not the edges renderer is ready to render.
  19773. * @return true if ready, otherwise false.
  19774. */
  19775. isReady(): boolean;
  19776. }
  19777. /**
  19778. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  19779. */
  19780. export class EdgesRenderer implements IEdgesRenderer {
  19781. /**
  19782. * Define the size of the edges with an orthographic camera
  19783. */
  19784. edgesWidthScalerForOrthographic: number;
  19785. /**
  19786. * Define the size of the edges with a perspective camera
  19787. */
  19788. edgesWidthScalerForPerspective: number;
  19789. protected _source: AbstractMesh;
  19790. protected _linesPositions: number[];
  19791. protected _linesNormals: number[];
  19792. protected _linesIndices: number[];
  19793. protected _epsilon: number;
  19794. protected _indicesCount: number;
  19795. protected _lineShader: ShaderMaterial;
  19796. protected _ib: DataBuffer;
  19797. protected _buffers: {
  19798. [key: string]: Nullable<VertexBuffer>;
  19799. };
  19800. protected _checkVerticesInsteadOfIndices: boolean;
  19801. private _meshRebuildObserver;
  19802. private _meshDisposeObserver;
  19803. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  19804. isEnabled: boolean;
  19805. /**
  19806. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  19807. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  19808. * @param source Mesh used to create edges
  19809. * @param epsilon sum of angles in adjacency to check for edge
  19810. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  19811. * @param generateEdgesLines - should generate Lines or only prepare resources.
  19812. */
  19813. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  19814. protected _prepareRessources(): void;
  19815. /** @hidden */
  19816. _rebuild(): void;
  19817. /**
  19818. * Releases the required resources for the edges renderer
  19819. */
  19820. dispose(): void;
  19821. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  19822. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  19823. /**
  19824. * Checks if the pair of p0 and p1 is en edge
  19825. * @param faceIndex
  19826. * @param edge
  19827. * @param faceNormals
  19828. * @param p0
  19829. * @param p1
  19830. * @private
  19831. */
  19832. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  19833. /**
  19834. * push line into the position, normal and index buffer
  19835. * @protected
  19836. */
  19837. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  19838. /**
  19839. * Generates lines edges from adjacencjes
  19840. * @private
  19841. */
  19842. _generateEdgesLines(): void;
  19843. /**
  19844. * Checks wether or not the edges renderer is ready to render.
  19845. * @return true if ready, otherwise false.
  19846. */
  19847. isReady(): boolean;
  19848. /**
  19849. * Renders the edges of the attached mesh,
  19850. */
  19851. render(): void;
  19852. }
  19853. /**
  19854. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  19855. */
  19856. export class LineEdgesRenderer extends EdgesRenderer {
  19857. /**
  19858. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  19859. * @param source LineMesh used to generate edges
  19860. * @param epsilon not important (specified angle for edge detection)
  19861. * @param checkVerticesInsteadOfIndices not important for LineMesh
  19862. */
  19863. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  19864. /**
  19865. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  19866. */
  19867. _generateEdgesLines(): void;
  19868. }
  19869. }
  19870. declare module "babylonjs/Rendering/renderingGroup" {
  19871. import { SmartArray } from "babylonjs/Misc/smartArray";
  19872. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19873. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19874. import { Nullable } from "babylonjs/types";
  19875. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  19876. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  19877. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  19878. import { Material } from "babylonjs/Materials/material";
  19879. import { Scene } from "babylonjs/scene";
  19880. /**
  19881. * This represents the object necessary to create a rendering group.
  19882. * This is exclusively used and created by the rendering manager.
  19883. * To modify the behavior, you use the available helpers in your scene or meshes.
  19884. * @hidden
  19885. */
  19886. export class RenderingGroup {
  19887. index: number;
  19888. private static _zeroVector;
  19889. private _scene;
  19890. private _opaqueSubMeshes;
  19891. private _transparentSubMeshes;
  19892. private _alphaTestSubMeshes;
  19893. private _depthOnlySubMeshes;
  19894. private _particleSystems;
  19895. private _spriteManagers;
  19896. private _opaqueSortCompareFn;
  19897. private _alphaTestSortCompareFn;
  19898. private _transparentSortCompareFn;
  19899. private _renderOpaque;
  19900. private _renderAlphaTest;
  19901. private _renderTransparent;
  19902. /** @hidden */
  19903. _edgesRenderers: SmartArray<IEdgesRenderer>;
  19904. onBeforeTransparentRendering: () => void;
  19905. /**
  19906. * Set the opaque sort comparison function.
  19907. * If null the sub meshes will be render in the order they were created
  19908. */
  19909. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19910. /**
  19911. * Set the alpha test sort comparison function.
  19912. * If null the sub meshes will be render in the order they were created
  19913. */
  19914. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19915. /**
  19916. * Set the transparent sort comparison function.
  19917. * If null the sub meshes will be render in the order they were created
  19918. */
  19919. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19920. /**
  19921. * Creates a new rendering group.
  19922. * @param index The rendering group index
  19923. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  19924. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  19925. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  19926. */
  19927. 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>);
  19928. /**
  19929. * Render all the sub meshes contained in the group.
  19930. * @param customRenderFunction Used to override the default render behaviour of the group.
  19931. * @returns true if rendered some submeshes.
  19932. */
  19933. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  19934. /**
  19935. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  19936. * @param subMeshes The submeshes to render
  19937. */
  19938. private renderOpaqueSorted;
  19939. /**
  19940. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  19941. * @param subMeshes The submeshes to render
  19942. */
  19943. private renderAlphaTestSorted;
  19944. /**
  19945. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  19946. * @param subMeshes The submeshes to render
  19947. */
  19948. private renderTransparentSorted;
  19949. /**
  19950. * Renders the submeshes in a specified order.
  19951. * @param subMeshes The submeshes to sort before render
  19952. * @param sortCompareFn The comparison function use to sort
  19953. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  19954. * @param transparent Specifies to activate blending if true
  19955. */
  19956. private static renderSorted;
  19957. /**
  19958. * Renders the submeshes in the order they were dispatched (no sort applied).
  19959. * @param subMeshes The submeshes to render
  19960. */
  19961. private static renderUnsorted;
  19962. /**
  19963. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19964. * are rendered back to front if in the same alpha index.
  19965. *
  19966. * @param a The first submesh
  19967. * @param b The second submesh
  19968. * @returns The result of the comparison
  19969. */
  19970. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  19971. /**
  19972. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19973. * are rendered back to front.
  19974. *
  19975. * @param a The first submesh
  19976. * @param b The second submesh
  19977. * @returns The result of the comparison
  19978. */
  19979. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  19980. /**
  19981. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19982. * are rendered front to back (prevent overdraw).
  19983. *
  19984. * @param a The first submesh
  19985. * @param b The second submesh
  19986. * @returns The result of the comparison
  19987. */
  19988. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  19989. /**
  19990. * Resets the different lists of submeshes to prepare a new frame.
  19991. */
  19992. prepare(): void;
  19993. dispose(): void;
  19994. /**
  19995. * Inserts the submesh in its correct queue depending on its material.
  19996. * @param subMesh The submesh to dispatch
  19997. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  19998. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  19999. */
  20000. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20001. dispatchSprites(spriteManager: ISpriteManager): void;
  20002. dispatchParticles(particleSystem: IParticleSystem): void;
  20003. private _renderParticles;
  20004. private _renderSprites;
  20005. }
  20006. }
  20007. declare module "babylonjs/Rendering/renderingManager" {
  20008. import { Nullable } from "babylonjs/types";
  20009. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20010. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20011. import { SmartArray } from "babylonjs/Misc/smartArray";
  20012. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20013. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20014. import { Material } from "babylonjs/Materials/material";
  20015. import { Scene } from "babylonjs/scene";
  20016. import { Camera } from "babylonjs/Cameras/camera";
  20017. /**
  20018. * Interface describing the different options available in the rendering manager
  20019. * regarding Auto Clear between groups.
  20020. */
  20021. export interface IRenderingManagerAutoClearSetup {
  20022. /**
  20023. * Defines whether or not autoclear is enable.
  20024. */
  20025. autoClear: boolean;
  20026. /**
  20027. * Defines whether or not to autoclear the depth buffer.
  20028. */
  20029. depth: boolean;
  20030. /**
  20031. * Defines whether or not to autoclear the stencil buffer.
  20032. */
  20033. stencil: boolean;
  20034. }
  20035. /**
  20036. * This class is used by the onRenderingGroupObservable
  20037. */
  20038. export class RenderingGroupInfo {
  20039. /**
  20040. * The Scene that being rendered
  20041. */
  20042. scene: Scene;
  20043. /**
  20044. * The camera currently used for the rendering pass
  20045. */
  20046. camera: Nullable<Camera>;
  20047. /**
  20048. * The ID of the renderingGroup being processed
  20049. */
  20050. renderingGroupId: number;
  20051. }
  20052. /**
  20053. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20054. * It is enable to manage the different groups as well as the different necessary sort functions.
  20055. * This should not be used directly aside of the few static configurations
  20056. */
  20057. export class RenderingManager {
  20058. /**
  20059. * The max id used for rendering groups (not included)
  20060. */
  20061. static MAX_RENDERINGGROUPS: number;
  20062. /**
  20063. * The min id used for rendering groups (included)
  20064. */
  20065. static MIN_RENDERINGGROUPS: number;
  20066. /**
  20067. * Used to globally prevent autoclearing scenes.
  20068. */
  20069. static AUTOCLEAR: boolean;
  20070. /**
  20071. * @hidden
  20072. */
  20073. _useSceneAutoClearSetup: boolean;
  20074. private _scene;
  20075. private _renderingGroups;
  20076. private _depthStencilBufferAlreadyCleaned;
  20077. private _autoClearDepthStencil;
  20078. private _customOpaqueSortCompareFn;
  20079. private _customAlphaTestSortCompareFn;
  20080. private _customTransparentSortCompareFn;
  20081. private _renderingGroupInfo;
  20082. /**
  20083. * Instantiates a new rendering group for a particular scene
  20084. * @param scene Defines the scene the groups belongs to
  20085. */
  20086. constructor(scene: Scene);
  20087. private _clearDepthStencilBuffer;
  20088. /**
  20089. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20090. * @hidden
  20091. */
  20092. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20093. /**
  20094. * Resets the different information of the group to prepare a new frame
  20095. * @hidden
  20096. */
  20097. reset(): void;
  20098. /**
  20099. * Dispose and release the group and its associated resources.
  20100. * @hidden
  20101. */
  20102. dispose(): void;
  20103. /**
  20104. * Clear the info related to rendering groups preventing retention points during dispose.
  20105. */
  20106. freeRenderingGroups(): void;
  20107. private _prepareRenderingGroup;
  20108. /**
  20109. * Add a sprite manager to the rendering manager in order to render it this frame.
  20110. * @param spriteManager Define the sprite manager to render
  20111. */
  20112. dispatchSprites(spriteManager: ISpriteManager): void;
  20113. /**
  20114. * Add a particle system to the rendering manager in order to render it this frame.
  20115. * @param particleSystem Define the particle system to render
  20116. */
  20117. dispatchParticles(particleSystem: IParticleSystem): void;
  20118. /**
  20119. * Add a submesh to the manager in order to render it this frame
  20120. * @param subMesh The submesh to dispatch
  20121. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20122. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20123. */
  20124. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20125. /**
  20126. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20127. * This allowed control for front to back rendering or reversly depending of the special needs.
  20128. *
  20129. * @param renderingGroupId The rendering group id corresponding to its index
  20130. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20131. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20132. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20133. */
  20134. 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;
  20135. /**
  20136. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20137. *
  20138. * @param renderingGroupId The rendering group id corresponding to its index
  20139. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20140. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20141. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20142. */
  20143. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20144. /**
  20145. * Gets the current auto clear configuration for one rendering group of the rendering
  20146. * manager.
  20147. * @param index the rendering group index to get the information for
  20148. * @returns The auto clear setup for the requested rendering group
  20149. */
  20150. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20151. }
  20152. }
  20153. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20154. import { Observable } from "babylonjs/Misc/observable";
  20155. import { SmartArray } from "babylonjs/Misc/smartArray";
  20156. import { Nullable } from "babylonjs/types";
  20157. import { Camera } from "babylonjs/Cameras/camera";
  20158. import { Scene } from "babylonjs/scene";
  20159. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20160. import { Color4 } from "babylonjs/Maths/math.color";
  20161. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20162. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20163. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20164. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20165. import { Texture } from "babylonjs/Materials/Textures/texture";
  20166. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20167. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20168. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20169. import { Engine } from "babylonjs/Engines/engine";
  20170. /**
  20171. * This Helps creating a texture that will be created from a camera in your scene.
  20172. * It is basically a dynamic texture that could be used to create special effects for instance.
  20173. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20174. */
  20175. export class RenderTargetTexture extends Texture {
  20176. isCube: boolean;
  20177. /**
  20178. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20179. */
  20180. static readonly REFRESHRATE_RENDER_ONCE: number;
  20181. /**
  20182. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20183. */
  20184. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20185. /**
  20186. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20187. * the central point of your effect and can save a lot of performances.
  20188. */
  20189. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20190. /**
  20191. * Use this predicate to dynamically define the list of mesh you want to render.
  20192. * If set, the renderList property will be overwritten.
  20193. */
  20194. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20195. private _renderList;
  20196. /**
  20197. * Use this list to define the list of mesh you want to render.
  20198. */
  20199. renderList: Nullable<Array<AbstractMesh>>;
  20200. private _hookArray;
  20201. /**
  20202. * Define if particles should be rendered in your texture.
  20203. */
  20204. renderParticles: boolean;
  20205. /**
  20206. * Define if sprites should be rendered in your texture.
  20207. */
  20208. renderSprites: boolean;
  20209. /**
  20210. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20211. */
  20212. coordinatesMode: number;
  20213. /**
  20214. * Define the camera used to render the texture.
  20215. */
  20216. activeCamera: Nullable<Camera>;
  20217. /**
  20218. * Override the render function of the texture with your own one.
  20219. */
  20220. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20221. /**
  20222. * Define if camera post processes should be use while rendering the texture.
  20223. */
  20224. useCameraPostProcesses: boolean;
  20225. /**
  20226. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20227. */
  20228. ignoreCameraViewport: boolean;
  20229. private _postProcessManager;
  20230. private _postProcesses;
  20231. private _resizeObserver;
  20232. /**
  20233. * An event triggered when the texture is unbind.
  20234. */
  20235. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20236. /**
  20237. * An event triggered when the texture is unbind.
  20238. */
  20239. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20240. private _onAfterUnbindObserver;
  20241. /**
  20242. * Set a after unbind callback in the texture.
  20243. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20244. */
  20245. onAfterUnbind: () => void;
  20246. /**
  20247. * An event triggered before rendering the texture
  20248. */
  20249. onBeforeRenderObservable: Observable<number>;
  20250. private _onBeforeRenderObserver;
  20251. /**
  20252. * Set a before render callback in the texture.
  20253. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20254. */
  20255. onBeforeRender: (faceIndex: number) => void;
  20256. /**
  20257. * An event triggered after rendering the texture
  20258. */
  20259. onAfterRenderObservable: Observable<number>;
  20260. private _onAfterRenderObserver;
  20261. /**
  20262. * Set a after render callback in the texture.
  20263. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20264. */
  20265. onAfterRender: (faceIndex: number) => void;
  20266. /**
  20267. * An event triggered after the texture clear
  20268. */
  20269. onClearObservable: Observable<Engine>;
  20270. private _onClearObserver;
  20271. /**
  20272. * Set a clear callback in the texture.
  20273. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20274. */
  20275. onClear: (Engine: Engine) => void;
  20276. /**
  20277. * An event triggered when the texture is resized.
  20278. */
  20279. onResizeObservable: Observable<RenderTargetTexture>;
  20280. /**
  20281. * Define the clear color of the Render Target if it should be different from the scene.
  20282. */
  20283. clearColor: Color4;
  20284. protected _size: number | {
  20285. width: number;
  20286. height: number;
  20287. };
  20288. protected _initialSizeParameter: number | {
  20289. width: number;
  20290. height: number;
  20291. } | {
  20292. ratio: number;
  20293. };
  20294. protected _sizeRatio: Nullable<number>;
  20295. /** @hidden */
  20296. _generateMipMaps: boolean;
  20297. protected _renderingManager: RenderingManager;
  20298. /** @hidden */
  20299. _waitingRenderList: string[];
  20300. protected _doNotChangeAspectRatio: boolean;
  20301. protected _currentRefreshId: number;
  20302. protected _refreshRate: number;
  20303. protected _textureMatrix: Matrix;
  20304. protected _samples: number;
  20305. protected _renderTargetOptions: RenderTargetCreationOptions;
  20306. /**
  20307. * Gets render target creation options that were used.
  20308. */
  20309. readonly renderTargetOptions: RenderTargetCreationOptions;
  20310. protected _engine: Engine;
  20311. protected _onRatioRescale(): void;
  20312. /**
  20313. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20314. * It must define where the camera used to render the texture is set
  20315. */
  20316. boundingBoxPosition: Vector3;
  20317. private _boundingBoxSize;
  20318. /**
  20319. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20320. * When defined, the cubemap will switch to local mode
  20321. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20322. * @example https://www.babylonjs-playground.com/#RNASML
  20323. */
  20324. boundingBoxSize: Vector3;
  20325. /**
  20326. * In case the RTT has been created with a depth texture, get the associated
  20327. * depth texture.
  20328. * Otherwise, return null.
  20329. */
  20330. depthStencilTexture: Nullable<InternalTexture>;
  20331. /**
  20332. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20333. * or used a shadow, depth texture...
  20334. * @param name The friendly name of the texture
  20335. * @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)
  20336. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20337. * @param generateMipMaps True if mip maps need to be generated after render.
  20338. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20339. * @param type The type of the buffer in the RTT (int, half float, float...)
  20340. * @param isCube True if a cube texture needs to be created
  20341. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20342. * @param generateDepthBuffer True to generate a depth buffer
  20343. * @param generateStencilBuffer True to generate a stencil buffer
  20344. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20345. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20346. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20347. */
  20348. constructor(name: string, size: number | {
  20349. width: number;
  20350. height: number;
  20351. } | {
  20352. ratio: number;
  20353. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20354. /**
  20355. * Creates a depth stencil texture.
  20356. * This is only available in WebGL 2 or with the depth texture extension available.
  20357. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20358. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20359. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20360. */
  20361. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20362. private _processSizeParameter;
  20363. /**
  20364. * Define the number of samples to use in case of MSAA.
  20365. * It defaults to one meaning no MSAA has been enabled.
  20366. */
  20367. samples: number;
  20368. /**
  20369. * Resets the refresh counter of the texture and start bak from scratch.
  20370. * Could be useful to regenerate the texture if it is setup to render only once.
  20371. */
  20372. resetRefreshCounter(): void;
  20373. /**
  20374. * Define the refresh rate of the texture or the rendering frequency.
  20375. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20376. */
  20377. refreshRate: number;
  20378. /**
  20379. * Adds a post process to the render target rendering passes.
  20380. * @param postProcess define the post process to add
  20381. */
  20382. addPostProcess(postProcess: PostProcess): void;
  20383. /**
  20384. * Clear all the post processes attached to the render target
  20385. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20386. */
  20387. clearPostProcesses(dispose?: boolean): void;
  20388. /**
  20389. * Remove one of the post process from the list of attached post processes to the texture
  20390. * @param postProcess define the post process to remove from the list
  20391. */
  20392. removePostProcess(postProcess: PostProcess): void;
  20393. /** @hidden */
  20394. _shouldRender(): boolean;
  20395. /**
  20396. * Gets the actual render size of the texture.
  20397. * @returns the width of the render size
  20398. */
  20399. getRenderSize(): number;
  20400. /**
  20401. * Gets the actual render width of the texture.
  20402. * @returns the width of the render size
  20403. */
  20404. getRenderWidth(): number;
  20405. /**
  20406. * Gets the actual render height of the texture.
  20407. * @returns the height of the render size
  20408. */
  20409. getRenderHeight(): number;
  20410. /**
  20411. * Get if the texture can be rescaled or not.
  20412. */
  20413. readonly canRescale: boolean;
  20414. /**
  20415. * Resize the texture using a ratio.
  20416. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20417. */
  20418. scale(ratio: number): void;
  20419. /**
  20420. * Get the texture reflection matrix used to rotate/transform the reflection.
  20421. * @returns the reflection matrix
  20422. */
  20423. getReflectionTextureMatrix(): Matrix;
  20424. /**
  20425. * Resize the texture to a new desired size.
  20426. * Be carrefull as it will recreate all the data in the new texture.
  20427. * @param size Define the new size. It can be:
  20428. * - a number for squared texture,
  20429. * - an object containing { width: number, height: number }
  20430. * - or an object containing a ratio { ratio: number }
  20431. */
  20432. resize(size: number | {
  20433. width: number;
  20434. height: number;
  20435. } | {
  20436. ratio: number;
  20437. }): void;
  20438. /**
  20439. * Renders all the objects from the render list into the texture.
  20440. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20441. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20442. */
  20443. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20444. private _bestReflectionRenderTargetDimension;
  20445. /**
  20446. * @hidden
  20447. * @param faceIndex face index to bind to if this is a cubetexture
  20448. */
  20449. _bindFrameBuffer(faceIndex?: number): void;
  20450. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20451. private renderToTarget;
  20452. /**
  20453. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20454. * This allowed control for front to back rendering or reversly depending of the special needs.
  20455. *
  20456. * @param renderingGroupId The rendering group id corresponding to its index
  20457. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20458. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20459. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20460. */
  20461. 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;
  20462. /**
  20463. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20464. *
  20465. * @param renderingGroupId The rendering group id corresponding to its index
  20466. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20467. */
  20468. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20469. /**
  20470. * Clones the texture.
  20471. * @returns the cloned texture
  20472. */
  20473. clone(): RenderTargetTexture;
  20474. /**
  20475. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20476. * @returns The JSON representation of the texture
  20477. */
  20478. serialize(): any;
  20479. /**
  20480. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20481. */
  20482. disposeFramebufferObjects(): void;
  20483. /**
  20484. * Dispose the texture and release its associated resources.
  20485. */
  20486. dispose(): void;
  20487. /** @hidden */
  20488. _rebuild(): void;
  20489. /**
  20490. * Clear the info related to rendering groups preventing retention point in material dispose.
  20491. */
  20492. freeRenderingGroups(): void;
  20493. /**
  20494. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20495. * @returns the view count
  20496. */
  20497. getViewCount(): number;
  20498. }
  20499. }
  20500. declare module "babylonjs/Materials/material" {
  20501. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20502. import { SmartArray } from "babylonjs/Misc/smartArray";
  20503. import { Observable } from "babylonjs/Misc/observable";
  20504. import { Nullable } from "babylonjs/types";
  20505. import { Scene } from "babylonjs/scene";
  20506. import { Matrix } from "babylonjs/Maths/math.vector";
  20507. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20508. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20509. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20510. import { Effect } from "babylonjs/Materials/effect";
  20511. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20512. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20513. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20514. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20515. import { Mesh } from "babylonjs/Meshes/mesh";
  20516. import { Animation } from "babylonjs/Animations/animation";
  20517. /**
  20518. * Base class for the main features of a material in Babylon.js
  20519. */
  20520. export class Material implements IAnimatable {
  20521. /**
  20522. * Returns the triangle fill mode
  20523. */
  20524. static readonly TriangleFillMode: number;
  20525. /**
  20526. * Returns the wireframe mode
  20527. */
  20528. static readonly WireFrameFillMode: number;
  20529. /**
  20530. * Returns the point fill mode
  20531. */
  20532. static readonly PointFillMode: number;
  20533. /**
  20534. * Returns the point list draw mode
  20535. */
  20536. static readonly PointListDrawMode: number;
  20537. /**
  20538. * Returns the line list draw mode
  20539. */
  20540. static readonly LineListDrawMode: number;
  20541. /**
  20542. * Returns the line loop draw mode
  20543. */
  20544. static readonly LineLoopDrawMode: number;
  20545. /**
  20546. * Returns the line strip draw mode
  20547. */
  20548. static readonly LineStripDrawMode: number;
  20549. /**
  20550. * Returns the triangle strip draw mode
  20551. */
  20552. static readonly TriangleStripDrawMode: number;
  20553. /**
  20554. * Returns the triangle fan draw mode
  20555. */
  20556. static readonly TriangleFanDrawMode: number;
  20557. /**
  20558. * Stores the clock-wise side orientation
  20559. */
  20560. static readonly ClockWiseSideOrientation: number;
  20561. /**
  20562. * Stores the counter clock-wise side orientation
  20563. */
  20564. static readonly CounterClockWiseSideOrientation: number;
  20565. /**
  20566. * The dirty texture flag value
  20567. */
  20568. static readonly TextureDirtyFlag: number;
  20569. /**
  20570. * The dirty light flag value
  20571. */
  20572. static readonly LightDirtyFlag: number;
  20573. /**
  20574. * The dirty fresnel flag value
  20575. */
  20576. static readonly FresnelDirtyFlag: number;
  20577. /**
  20578. * The dirty attribute flag value
  20579. */
  20580. static readonly AttributesDirtyFlag: number;
  20581. /**
  20582. * The dirty misc flag value
  20583. */
  20584. static readonly MiscDirtyFlag: number;
  20585. /**
  20586. * The all dirty flag value
  20587. */
  20588. static readonly AllDirtyFlag: number;
  20589. /**
  20590. * The ID of the material
  20591. */
  20592. id: string;
  20593. /**
  20594. * Gets or sets the unique id of the material
  20595. */
  20596. uniqueId: number;
  20597. /**
  20598. * The name of the material
  20599. */
  20600. name: string;
  20601. /**
  20602. * Gets or sets user defined metadata
  20603. */
  20604. metadata: any;
  20605. /**
  20606. * For internal use only. Please do not use.
  20607. */
  20608. reservedDataStore: any;
  20609. /**
  20610. * Specifies if the ready state should be checked on each call
  20611. */
  20612. checkReadyOnEveryCall: boolean;
  20613. /**
  20614. * Specifies if the ready state should be checked once
  20615. */
  20616. checkReadyOnlyOnce: boolean;
  20617. /**
  20618. * The state of the material
  20619. */
  20620. state: string;
  20621. /**
  20622. * The alpha value of the material
  20623. */
  20624. protected _alpha: number;
  20625. /**
  20626. * List of inspectable custom properties (used by the Inspector)
  20627. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  20628. */
  20629. inspectableCustomProperties: IInspectable[];
  20630. /**
  20631. * Sets the alpha value of the material
  20632. */
  20633. /**
  20634. * Gets the alpha value of the material
  20635. */
  20636. alpha: number;
  20637. /**
  20638. * Specifies if back face culling is enabled
  20639. */
  20640. protected _backFaceCulling: boolean;
  20641. /**
  20642. * Sets the back-face culling state
  20643. */
  20644. /**
  20645. * Gets the back-face culling state
  20646. */
  20647. backFaceCulling: boolean;
  20648. /**
  20649. * Stores the value for side orientation
  20650. */
  20651. sideOrientation: number;
  20652. /**
  20653. * Callback triggered when the material is compiled
  20654. */
  20655. onCompiled: Nullable<(effect: Effect) => void>;
  20656. /**
  20657. * Callback triggered when an error occurs
  20658. */
  20659. onError: Nullable<(effect: Effect, errors: string) => void>;
  20660. /**
  20661. * Callback triggered to get the render target textures
  20662. */
  20663. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  20664. /**
  20665. * Gets a boolean indicating that current material needs to register RTT
  20666. */
  20667. readonly hasRenderTargetTextures: boolean;
  20668. /**
  20669. * Specifies if the material should be serialized
  20670. */
  20671. doNotSerialize: boolean;
  20672. /**
  20673. * @hidden
  20674. */
  20675. _storeEffectOnSubMeshes: boolean;
  20676. /**
  20677. * Stores the animations for the material
  20678. */
  20679. animations: Nullable<Array<Animation>>;
  20680. /**
  20681. * An event triggered when the material is disposed
  20682. */
  20683. onDisposeObservable: Observable<Material>;
  20684. /**
  20685. * An observer which watches for dispose events
  20686. */
  20687. private _onDisposeObserver;
  20688. private _onUnBindObservable;
  20689. /**
  20690. * Called during a dispose event
  20691. */
  20692. onDispose: () => void;
  20693. private _onBindObservable;
  20694. /**
  20695. * An event triggered when the material is bound
  20696. */
  20697. readonly onBindObservable: Observable<AbstractMesh>;
  20698. /**
  20699. * An observer which watches for bind events
  20700. */
  20701. private _onBindObserver;
  20702. /**
  20703. * Called during a bind event
  20704. */
  20705. onBind: (Mesh: AbstractMesh) => void;
  20706. /**
  20707. * An event triggered when the material is unbound
  20708. */
  20709. readonly onUnBindObservable: Observable<Material>;
  20710. /**
  20711. * Stores the value of the alpha mode
  20712. */
  20713. private _alphaMode;
  20714. /**
  20715. * Sets the value of the alpha mode.
  20716. *
  20717. * | Value | Type | Description |
  20718. * | --- | --- | --- |
  20719. * | 0 | ALPHA_DISABLE | |
  20720. * | 1 | ALPHA_ADD | |
  20721. * | 2 | ALPHA_COMBINE | |
  20722. * | 3 | ALPHA_SUBTRACT | |
  20723. * | 4 | ALPHA_MULTIPLY | |
  20724. * | 5 | ALPHA_MAXIMIZED | |
  20725. * | 6 | ALPHA_ONEONE | |
  20726. * | 7 | ALPHA_PREMULTIPLIED | |
  20727. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  20728. * | 9 | ALPHA_INTERPOLATE | |
  20729. * | 10 | ALPHA_SCREENMODE | |
  20730. *
  20731. */
  20732. /**
  20733. * Gets the value of the alpha mode
  20734. */
  20735. alphaMode: number;
  20736. /**
  20737. * Stores the state of the need depth pre-pass value
  20738. */
  20739. private _needDepthPrePass;
  20740. /**
  20741. * Sets the need depth pre-pass value
  20742. */
  20743. /**
  20744. * Gets the depth pre-pass value
  20745. */
  20746. needDepthPrePass: boolean;
  20747. /**
  20748. * Specifies if depth writing should be disabled
  20749. */
  20750. disableDepthWrite: boolean;
  20751. /**
  20752. * Specifies if depth writing should be forced
  20753. */
  20754. forceDepthWrite: boolean;
  20755. /**
  20756. * Specifies if there should be a separate pass for culling
  20757. */
  20758. separateCullingPass: boolean;
  20759. /**
  20760. * Stores the state specifing if fog should be enabled
  20761. */
  20762. private _fogEnabled;
  20763. /**
  20764. * Sets the state for enabling fog
  20765. */
  20766. /**
  20767. * Gets the value of the fog enabled state
  20768. */
  20769. fogEnabled: boolean;
  20770. /**
  20771. * Stores the size of points
  20772. */
  20773. pointSize: number;
  20774. /**
  20775. * Stores the z offset value
  20776. */
  20777. zOffset: number;
  20778. /**
  20779. * Gets a value specifying if wireframe mode is enabled
  20780. */
  20781. /**
  20782. * Sets the state of wireframe mode
  20783. */
  20784. wireframe: boolean;
  20785. /**
  20786. * Gets the value specifying if point clouds are enabled
  20787. */
  20788. /**
  20789. * Sets the state of point cloud mode
  20790. */
  20791. pointsCloud: boolean;
  20792. /**
  20793. * Gets the material fill mode
  20794. */
  20795. /**
  20796. * Sets the material fill mode
  20797. */
  20798. fillMode: number;
  20799. /**
  20800. * @hidden
  20801. * Stores the effects for the material
  20802. */
  20803. _effect: Nullable<Effect>;
  20804. /**
  20805. * @hidden
  20806. * Specifies if the material was previously ready
  20807. */
  20808. _wasPreviouslyReady: boolean;
  20809. /**
  20810. * Specifies if uniform buffers should be used
  20811. */
  20812. private _useUBO;
  20813. /**
  20814. * Stores a reference to the scene
  20815. */
  20816. private _scene;
  20817. /**
  20818. * Stores the fill mode state
  20819. */
  20820. private _fillMode;
  20821. /**
  20822. * Specifies if the depth write state should be cached
  20823. */
  20824. private _cachedDepthWriteState;
  20825. /**
  20826. * Stores the uniform buffer
  20827. */
  20828. protected _uniformBuffer: UniformBuffer;
  20829. /** @hidden */
  20830. _indexInSceneMaterialArray: number;
  20831. /** @hidden */
  20832. meshMap: Nullable<{
  20833. [id: string]: AbstractMesh | undefined;
  20834. }>;
  20835. /**
  20836. * Creates a material instance
  20837. * @param name defines the name of the material
  20838. * @param scene defines the scene to reference
  20839. * @param doNotAdd specifies if the material should be added to the scene
  20840. */
  20841. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  20842. /**
  20843. * Returns a string representation of the current material
  20844. * @param fullDetails defines a boolean indicating which levels of logging is desired
  20845. * @returns a string with material information
  20846. */
  20847. toString(fullDetails?: boolean): string;
  20848. /**
  20849. * Gets the class name of the material
  20850. * @returns a string with the class name of the material
  20851. */
  20852. getClassName(): string;
  20853. /**
  20854. * Specifies if updates for the material been locked
  20855. */
  20856. readonly isFrozen: boolean;
  20857. /**
  20858. * Locks updates for the material
  20859. */
  20860. freeze(): void;
  20861. /**
  20862. * Unlocks updates for the material
  20863. */
  20864. unfreeze(): void;
  20865. /**
  20866. * Specifies if the material is ready to be used
  20867. * @param mesh defines the mesh to check
  20868. * @param useInstances specifies if instances should be used
  20869. * @returns a boolean indicating if the material is ready to be used
  20870. */
  20871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  20872. /**
  20873. * Specifies that the submesh is ready to be used
  20874. * @param mesh defines the mesh to check
  20875. * @param subMesh defines which submesh to check
  20876. * @param useInstances specifies that instances should be used
  20877. * @returns a boolean indicating that the submesh is ready or not
  20878. */
  20879. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  20880. /**
  20881. * Returns the material effect
  20882. * @returns the effect associated with the material
  20883. */
  20884. getEffect(): Nullable<Effect>;
  20885. /**
  20886. * Returns the current scene
  20887. * @returns a Scene
  20888. */
  20889. getScene(): Scene;
  20890. /**
  20891. * Specifies if the material will require alpha blending
  20892. * @returns a boolean specifying if alpha blending is needed
  20893. */
  20894. needAlphaBlending(): boolean;
  20895. /**
  20896. * Specifies if the mesh will require alpha blending
  20897. * @param mesh defines the mesh to check
  20898. * @returns a boolean specifying if alpha blending is needed for the mesh
  20899. */
  20900. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  20901. /**
  20902. * Specifies if this material should be rendered in alpha test mode
  20903. * @returns a boolean specifying if an alpha test is needed.
  20904. */
  20905. needAlphaTesting(): boolean;
  20906. /**
  20907. * Gets the texture used for the alpha test
  20908. * @returns the texture to use for alpha testing
  20909. */
  20910. getAlphaTestTexture(): Nullable<BaseTexture>;
  20911. /**
  20912. * Marks the material to indicate that it needs to be re-calculated
  20913. */
  20914. markDirty(): void;
  20915. /** @hidden */
  20916. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  20917. /**
  20918. * Binds the material to the mesh
  20919. * @param world defines the world transformation matrix
  20920. * @param mesh defines the mesh to bind the material to
  20921. */
  20922. bind(world: Matrix, mesh?: Mesh): void;
  20923. /**
  20924. * Binds the submesh to the material
  20925. * @param world defines the world transformation matrix
  20926. * @param mesh defines the mesh containing the submesh
  20927. * @param subMesh defines the submesh to bind the material to
  20928. */
  20929. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  20930. /**
  20931. * Binds the world matrix to the material
  20932. * @param world defines the world transformation matrix
  20933. */
  20934. bindOnlyWorldMatrix(world: Matrix): void;
  20935. /**
  20936. * Binds the scene's uniform buffer to the effect.
  20937. * @param effect defines the effect to bind to the scene uniform buffer
  20938. * @param sceneUbo defines the uniform buffer storing scene data
  20939. */
  20940. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  20941. /**
  20942. * Binds the view matrix to the effect
  20943. * @param effect defines the effect to bind the view matrix to
  20944. */
  20945. bindView(effect: Effect): void;
  20946. /**
  20947. * Binds the view projection matrix to the effect
  20948. * @param effect defines the effect to bind the view projection matrix to
  20949. */
  20950. bindViewProjection(effect: Effect): void;
  20951. /**
  20952. * Specifies if material alpha testing should be turned on for the mesh
  20953. * @param mesh defines the mesh to check
  20954. */
  20955. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  20956. /**
  20957. * Processes to execute after binding the material to a mesh
  20958. * @param mesh defines the rendered mesh
  20959. */
  20960. protected _afterBind(mesh?: Mesh): void;
  20961. /**
  20962. * Unbinds the material from the mesh
  20963. */
  20964. unbind(): void;
  20965. /**
  20966. * Gets the active textures from the material
  20967. * @returns an array of textures
  20968. */
  20969. getActiveTextures(): BaseTexture[];
  20970. /**
  20971. * Specifies if the material uses a texture
  20972. * @param texture defines the texture to check against the material
  20973. * @returns a boolean specifying if the material uses the texture
  20974. */
  20975. hasTexture(texture: BaseTexture): boolean;
  20976. /**
  20977. * Makes a duplicate of the material, and gives it a new name
  20978. * @param name defines the new name for the duplicated material
  20979. * @returns the cloned material
  20980. */
  20981. clone(name: string): Nullable<Material>;
  20982. /**
  20983. * Gets the meshes bound to the material
  20984. * @returns an array of meshes bound to the material
  20985. */
  20986. getBindedMeshes(): AbstractMesh[];
  20987. /**
  20988. * Force shader compilation
  20989. * @param mesh defines the mesh associated with this material
  20990. * @param onCompiled defines a function to execute once the material is compiled
  20991. * @param options defines the options to configure the compilation
  20992. */
  20993. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  20994. clipPlane: boolean;
  20995. }>): void;
  20996. /**
  20997. * Force shader compilation
  20998. * @param mesh defines the mesh that will use this material
  20999. * @param options defines additional options for compiling the shaders
  21000. * @returns a promise that resolves when the compilation completes
  21001. */
  21002. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<{
  21003. clipPlane: boolean;
  21004. }>): Promise<void>;
  21005. private static readonly _AllDirtyCallBack;
  21006. private static readonly _ImageProcessingDirtyCallBack;
  21007. private static readonly _TextureDirtyCallBack;
  21008. private static readonly _FresnelDirtyCallBack;
  21009. private static readonly _MiscDirtyCallBack;
  21010. private static readonly _LightsDirtyCallBack;
  21011. private static readonly _AttributeDirtyCallBack;
  21012. private static _FresnelAndMiscDirtyCallBack;
  21013. private static _TextureAndMiscDirtyCallBack;
  21014. private static readonly _DirtyCallbackArray;
  21015. private static readonly _RunDirtyCallBacks;
  21016. /**
  21017. * Marks a define in the material to indicate that it needs to be re-computed
  21018. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21019. */
  21020. markAsDirty(flag: number): void;
  21021. /**
  21022. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21023. * @param func defines a function which checks material defines against the submeshes
  21024. */
  21025. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21026. /**
  21027. * Indicates that we need to re-calculated for all submeshes
  21028. */
  21029. protected _markAllSubMeshesAsAllDirty(): void;
  21030. /**
  21031. * Indicates that image processing needs to be re-calculated for all submeshes
  21032. */
  21033. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21034. /**
  21035. * Indicates that textures need to be re-calculated for all submeshes
  21036. */
  21037. protected _markAllSubMeshesAsTexturesDirty(): void;
  21038. /**
  21039. * Indicates that fresnel needs to be re-calculated for all submeshes
  21040. */
  21041. protected _markAllSubMeshesAsFresnelDirty(): void;
  21042. /**
  21043. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21044. */
  21045. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21046. /**
  21047. * Indicates that lights need to be re-calculated for all submeshes
  21048. */
  21049. protected _markAllSubMeshesAsLightsDirty(): void;
  21050. /**
  21051. * Indicates that attributes need to be re-calculated for all submeshes
  21052. */
  21053. protected _markAllSubMeshesAsAttributesDirty(): void;
  21054. /**
  21055. * Indicates that misc needs to be re-calculated for all submeshes
  21056. */
  21057. protected _markAllSubMeshesAsMiscDirty(): void;
  21058. /**
  21059. * Indicates that textures and misc need to be re-calculated for all submeshes
  21060. */
  21061. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21062. /**
  21063. * Disposes the material
  21064. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21065. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21066. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21067. */
  21068. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21069. /** @hidden */
  21070. private releaseVertexArrayObject;
  21071. /**
  21072. * Serializes this material
  21073. * @returns the serialized material object
  21074. */
  21075. serialize(): any;
  21076. /**
  21077. * Creates a material from parsed material data
  21078. * @param parsedMaterial defines parsed material data
  21079. * @param scene defines the hosting scene
  21080. * @param rootUrl defines the root URL to use to load textures
  21081. * @returns a new material
  21082. */
  21083. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21084. }
  21085. }
  21086. declare module "babylonjs/Materials/multiMaterial" {
  21087. import { Nullable } from "babylonjs/types";
  21088. import { Scene } from "babylonjs/scene";
  21089. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21090. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21091. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21092. import { Material } from "babylonjs/Materials/material";
  21093. /**
  21094. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21095. * separate meshes. This can be use to improve performances.
  21096. * @see http://doc.babylonjs.com/how_to/multi_materials
  21097. */
  21098. export class MultiMaterial extends Material {
  21099. private _subMaterials;
  21100. /**
  21101. * Gets or Sets the list of Materials used within the multi material.
  21102. * They need to be ordered according to the submeshes order in the associated mesh
  21103. */
  21104. subMaterials: Nullable<Material>[];
  21105. /**
  21106. * Function used to align with Node.getChildren()
  21107. * @returns the list of Materials used within the multi material
  21108. */
  21109. getChildren(): Nullable<Material>[];
  21110. /**
  21111. * Instantiates a new Multi Material
  21112. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21113. * separate meshes. This can be use to improve performances.
  21114. * @see http://doc.babylonjs.com/how_to/multi_materials
  21115. * @param name Define the name in the scene
  21116. * @param scene Define the scene the material belongs to
  21117. */
  21118. constructor(name: string, scene: Scene);
  21119. private _hookArray;
  21120. /**
  21121. * Get one of the submaterial by its index in the submaterials array
  21122. * @param index The index to look the sub material at
  21123. * @returns The Material if the index has been defined
  21124. */
  21125. getSubMaterial(index: number): Nullable<Material>;
  21126. /**
  21127. * Get the list of active textures for the whole sub materials list.
  21128. * @returns All the textures that will be used during the rendering
  21129. */
  21130. getActiveTextures(): BaseTexture[];
  21131. /**
  21132. * Gets the current class name of the material e.g. "MultiMaterial"
  21133. * Mainly use in serialization.
  21134. * @returns the class name
  21135. */
  21136. getClassName(): string;
  21137. /**
  21138. * Checks if the material is ready to render the requested sub mesh
  21139. * @param mesh Define the mesh the submesh belongs to
  21140. * @param subMesh Define the sub mesh to look readyness for
  21141. * @param useInstances Define whether or not the material is used with instances
  21142. * @returns true if ready, otherwise false
  21143. */
  21144. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21145. /**
  21146. * Clones the current material and its related sub materials
  21147. * @param name Define the name of the newly cloned material
  21148. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21149. * @returns the cloned material
  21150. */
  21151. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21152. /**
  21153. * Serializes the materials into a JSON representation.
  21154. * @returns the JSON representation
  21155. */
  21156. serialize(): any;
  21157. /**
  21158. * Dispose the material and release its associated resources
  21159. * @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)
  21160. * @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)
  21161. * @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)
  21162. */
  21163. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21164. /**
  21165. * Creates a MultiMaterial from parsed MultiMaterial data.
  21166. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21167. * @param scene defines the hosting scene
  21168. * @returns a new MultiMaterial
  21169. */
  21170. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21171. }
  21172. }
  21173. declare module "babylonjs/Meshes/subMesh" {
  21174. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21175. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21176. import { Engine } from "babylonjs/Engines/engine";
  21177. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21178. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21179. import { Effect } from "babylonjs/Materials/effect";
  21180. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21181. import { Plane } from "babylonjs/Maths/math.plane";
  21182. import { Collider } from "babylonjs/Collisions/collider";
  21183. import { Material } from "babylonjs/Materials/material";
  21184. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21185. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21186. import { Mesh } from "babylonjs/Meshes/mesh";
  21187. import { Ray } from "babylonjs/Culling/ray";
  21188. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21189. /**
  21190. * Base class for submeshes
  21191. */
  21192. export class BaseSubMesh {
  21193. /** @hidden */
  21194. _materialDefines: Nullable<MaterialDefines>;
  21195. /** @hidden */
  21196. _materialEffect: Nullable<Effect>;
  21197. /**
  21198. * Gets associated effect
  21199. */
  21200. readonly effect: Nullable<Effect>;
  21201. /**
  21202. * Sets associated effect (effect used to render this submesh)
  21203. * @param effect defines the effect to associate with
  21204. * @param defines defines the set of defines used to compile this effect
  21205. */
  21206. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21207. }
  21208. /**
  21209. * Defines a subdivision inside a mesh
  21210. */
  21211. export class SubMesh extends BaseSubMesh implements ICullable {
  21212. /** the material index to use */
  21213. materialIndex: number;
  21214. /** vertex index start */
  21215. verticesStart: number;
  21216. /** vertices count */
  21217. verticesCount: number;
  21218. /** index start */
  21219. indexStart: number;
  21220. /** indices count */
  21221. indexCount: number;
  21222. /** @hidden */
  21223. _linesIndexCount: number;
  21224. private _mesh;
  21225. private _renderingMesh;
  21226. private _boundingInfo;
  21227. private _linesIndexBuffer;
  21228. /** @hidden */
  21229. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21230. /** @hidden */
  21231. _trianglePlanes: Plane[];
  21232. /** @hidden */
  21233. _lastColliderTransformMatrix: Nullable<Matrix>;
  21234. /** @hidden */
  21235. _renderId: number;
  21236. /** @hidden */
  21237. _alphaIndex: number;
  21238. /** @hidden */
  21239. _distanceToCamera: number;
  21240. /** @hidden */
  21241. _id: number;
  21242. private _currentMaterial;
  21243. /**
  21244. * Add a new submesh to a mesh
  21245. * @param materialIndex defines the material index to use
  21246. * @param verticesStart defines vertex index start
  21247. * @param verticesCount defines vertices count
  21248. * @param indexStart defines index start
  21249. * @param indexCount defines indices count
  21250. * @param mesh defines the parent mesh
  21251. * @param renderingMesh defines an optional rendering mesh
  21252. * @param createBoundingBox defines if bounding box should be created for this submesh
  21253. * @returns the new submesh
  21254. */
  21255. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21256. /**
  21257. * Creates a new submesh
  21258. * @param materialIndex defines the material index to use
  21259. * @param verticesStart defines vertex index start
  21260. * @param verticesCount defines vertices count
  21261. * @param indexStart defines index start
  21262. * @param indexCount defines indices count
  21263. * @param mesh defines the parent mesh
  21264. * @param renderingMesh defines an optional rendering mesh
  21265. * @param createBoundingBox defines if bounding box should be created for this submesh
  21266. */
  21267. constructor(
  21268. /** the material index to use */
  21269. materialIndex: number,
  21270. /** vertex index start */
  21271. verticesStart: number,
  21272. /** vertices count */
  21273. verticesCount: number,
  21274. /** index start */
  21275. indexStart: number,
  21276. /** indices count */
  21277. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21278. /**
  21279. * Returns true if this submesh covers the entire parent mesh
  21280. * @ignorenaming
  21281. */
  21282. readonly IsGlobal: boolean;
  21283. /**
  21284. * Returns the submesh BoudingInfo object
  21285. * @returns current bounding info (or mesh's one if the submesh is global)
  21286. */
  21287. getBoundingInfo(): BoundingInfo;
  21288. /**
  21289. * Sets the submesh BoundingInfo
  21290. * @param boundingInfo defines the new bounding info to use
  21291. * @returns the SubMesh
  21292. */
  21293. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21294. /**
  21295. * Returns the mesh of the current submesh
  21296. * @return the parent mesh
  21297. */
  21298. getMesh(): AbstractMesh;
  21299. /**
  21300. * Returns the rendering mesh of the submesh
  21301. * @returns the rendering mesh (could be different from parent mesh)
  21302. */
  21303. getRenderingMesh(): Mesh;
  21304. /**
  21305. * Returns the submesh material
  21306. * @returns null or the current material
  21307. */
  21308. getMaterial(): Nullable<Material>;
  21309. /**
  21310. * Sets a new updated BoundingInfo object to the submesh
  21311. * @param data defines an optional position array to use to determine the bounding info
  21312. * @returns the SubMesh
  21313. */
  21314. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21315. /** @hidden */
  21316. _checkCollision(collider: Collider): boolean;
  21317. /**
  21318. * Updates the submesh BoundingInfo
  21319. * @param world defines the world matrix to use to update the bounding info
  21320. * @returns the submesh
  21321. */
  21322. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21323. /**
  21324. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21325. * @param frustumPlanes defines the frustum planes
  21326. * @returns true if the submesh is intersecting with the frustum
  21327. */
  21328. isInFrustum(frustumPlanes: Plane[]): boolean;
  21329. /**
  21330. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21331. * @param frustumPlanes defines the frustum planes
  21332. * @returns true if the submesh is inside the frustum
  21333. */
  21334. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21335. /**
  21336. * Renders the submesh
  21337. * @param enableAlphaMode defines if alpha needs to be used
  21338. * @returns the submesh
  21339. */
  21340. render(enableAlphaMode: boolean): SubMesh;
  21341. /**
  21342. * @hidden
  21343. */
  21344. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21345. /**
  21346. * Checks if the submesh intersects with a ray
  21347. * @param ray defines the ray to test
  21348. * @returns true is the passed ray intersects the submesh bounding box
  21349. */
  21350. canIntersects(ray: Ray): boolean;
  21351. /**
  21352. * Intersects current submesh with a ray
  21353. * @param ray defines the ray to test
  21354. * @param positions defines mesh's positions array
  21355. * @param indices defines mesh's indices array
  21356. * @param fastCheck defines if only bounding info should be used
  21357. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21358. * @returns intersection info or null if no intersection
  21359. */
  21360. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21361. /** @hidden */
  21362. private _intersectLines;
  21363. /** @hidden */
  21364. private _intersectUnIndexedLines;
  21365. /** @hidden */
  21366. private _intersectTriangles;
  21367. /** @hidden */
  21368. private _intersectUnIndexedTriangles;
  21369. /** @hidden */
  21370. _rebuild(): void;
  21371. /**
  21372. * Creates a new submesh from the passed mesh
  21373. * @param newMesh defines the new hosting mesh
  21374. * @param newRenderingMesh defines an optional rendering mesh
  21375. * @returns the new submesh
  21376. */
  21377. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21378. /**
  21379. * Release associated resources
  21380. */
  21381. dispose(): void;
  21382. /**
  21383. * Gets the class name
  21384. * @returns the string "SubMesh".
  21385. */
  21386. getClassName(): string;
  21387. /**
  21388. * Creates a new submesh from indices data
  21389. * @param materialIndex the index of the main mesh material
  21390. * @param startIndex the index where to start the copy in the mesh indices array
  21391. * @param indexCount the number of indices to copy then from the startIndex
  21392. * @param mesh the main mesh to create the submesh from
  21393. * @param renderingMesh the optional rendering mesh
  21394. * @returns a new submesh
  21395. */
  21396. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21397. }
  21398. }
  21399. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21400. /**
  21401. * Class used to represent data loading progression
  21402. */
  21403. export class SceneLoaderFlags {
  21404. private static _ForceFullSceneLoadingForIncremental;
  21405. private static _ShowLoadingScreen;
  21406. private static _CleanBoneMatrixWeights;
  21407. private static _loggingLevel;
  21408. /**
  21409. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21410. */
  21411. static ForceFullSceneLoadingForIncremental: boolean;
  21412. /**
  21413. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21414. */
  21415. static ShowLoadingScreen: boolean;
  21416. /**
  21417. * Defines the current logging level (while loading the scene)
  21418. * @ignorenaming
  21419. */
  21420. static loggingLevel: number;
  21421. /**
  21422. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21423. */
  21424. static CleanBoneMatrixWeights: boolean;
  21425. }
  21426. }
  21427. declare module "babylonjs/Meshes/geometry" {
  21428. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21429. import { Scene } from "babylonjs/scene";
  21430. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21431. import { Engine } from "babylonjs/Engines/engine";
  21432. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21433. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21434. import { Effect } from "babylonjs/Materials/effect";
  21435. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21436. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21437. import { Mesh } from "babylonjs/Meshes/mesh";
  21438. /**
  21439. * Class used to store geometry data (vertex buffers + index buffer)
  21440. */
  21441. export class Geometry implements IGetSetVerticesData {
  21442. /**
  21443. * Gets or sets the ID of the geometry
  21444. */
  21445. id: string;
  21446. /**
  21447. * Gets or sets the unique ID of the geometry
  21448. */
  21449. uniqueId: number;
  21450. /**
  21451. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21452. */
  21453. delayLoadState: number;
  21454. /**
  21455. * Gets the file containing the data to load when running in delay load state
  21456. */
  21457. delayLoadingFile: Nullable<string>;
  21458. /**
  21459. * Callback called when the geometry is updated
  21460. */
  21461. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21462. private _scene;
  21463. private _engine;
  21464. private _meshes;
  21465. private _totalVertices;
  21466. /** @hidden */
  21467. _indices: IndicesArray;
  21468. /** @hidden */
  21469. _vertexBuffers: {
  21470. [key: string]: VertexBuffer;
  21471. };
  21472. private _isDisposed;
  21473. private _extend;
  21474. private _boundingBias;
  21475. /** @hidden */
  21476. _delayInfo: Array<string>;
  21477. private _indexBuffer;
  21478. private _indexBufferIsUpdatable;
  21479. /** @hidden */
  21480. _boundingInfo: Nullable<BoundingInfo>;
  21481. /** @hidden */
  21482. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21483. /** @hidden */
  21484. _softwareSkinningFrameId: number;
  21485. private _vertexArrayObjects;
  21486. private _updatable;
  21487. /** @hidden */
  21488. _positions: Nullable<Vector3[]>;
  21489. /**
  21490. * 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
  21491. */
  21492. /**
  21493. * 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
  21494. */
  21495. boundingBias: Vector2;
  21496. /**
  21497. * Static function used to attach a new empty geometry to a mesh
  21498. * @param mesh defines the mesh to attach the geometry to
  21499. * @returns the new Geometry
  21500. */
  21501. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21502. /**
  21503. * Creates a new geometry
  21504. * @param id defines the unique ID
  21505. * @param scene defines the hosting scene
  21506. * @param vertexData defines the VertexData used to get geometry data
  21507. * @param updatable defines if geometry must be updatable (false by default)
  21508. * @param mesh defines the mesh that will be associated with the geometry
  21509. */
  21510. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21511. /**
  21512. * Gets the current extend of the geometry
  21513. */
  21514. readonly extend: {
  21515. minimum: Vector3;
  21516. maximum: Vector3;
  21517. };
  21518. /**
  21519. * Gets the hosting scene
  21520. * @returns the hosting Scene
  21521. */
  21522. getScene(): Scene;
  21523. /**
  21524. * Gets the hosting engine
  21525. * @returns the hosting Engine
  21526. */
  21527. getEngine(): Engine;
  21528. /**
  21529. * Defines if the geometry is ready to use
  21530. * @returns true if the geometry is ready to be used
  21531. */
  21532. isReady(): boolean;
  21533. /**
  21534. * Gets a value indicating that the geometry should not be serialized
  21535. */
  21536. readonly doNotSerialize: boolean;
  21537. /** @hidden */
  21538. _rebuild(): void;
  21539. /**
  21540. * Affects all geometry data in one call
  21541. * @param vertexData defines the geometry data
  21542. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  21543. */
  21544. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  21545. /**
  21546. * Set specific vertex data
  21547. * @param kind defines the data kind (Position, normal, etc...)
  21548. * @param data defines the vertex data to use
  21549. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21550. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21551. */
  21552. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  21553. /**
  21554. * Removes a specific vertex data
  21555. * @param kind defines the data kind (Position, normal, etc...)
  21556. */
  21557. removeVerticesData(kind: string): void;
  21558. /**
  21559. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  21560. * @param buffer defines the vertex buffer to use
  21561. * @param totalVertices defines the total number of vertices for position kind (could be null)
  21562. */
  21563. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  21564. /**
  21565. * Update a specific vertex buffer
  21566. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  21567. * It will do nothing if the buffer is not updatable
  21568. * @param kind defines the data kind (Position, normal, etc...)
  21569. * @param data defines the data to use
  21570. * @param offset defines the offset in the target buffer where to store the data
  21571. * @param useBytes set to true if the offset is in bytes
  21572. */
  21573. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  21574. /**
  21575. * Update a specific vertex buffer
  21576. * This function will create a new buffer if the current one is not updatable
  21577. * @param kind defines the data kind (Position, normal, etc...)
  21578. * @param data defines the data to use
  21579. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  21580. */
  21581. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  21582. private _updateBoundingInfo;
  21583. /** @hidden */
  21584. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  21585. /**
  21586. * Gets total number of vertices
  21587. * @returns the total number of vertices
  21588. */
  21589. getTotalVertices(): number;
  21590. /**
  21591. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21592. * @param kind defines the data kind (Position, normal, etc...)
  21593. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21594. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21595. * @returns a float array containing vertex data
  21596. */
  21597. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21598. /**
  21599. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  21600. * @param kind defines the data kind (Position, normal, etc...)
  21601. * @returns true if the vertex buffer with the specified kind is updatable
  21602. */
  21603. isVertexBufferUpdatable(kind: string): boolean;
  21604. /**
  21605. * Gets a specific vertex buffer
  21606. * @param kind defines the data kind (Position, normal, etc...)
  21607. * @returns a VertexBuffer
  21608. */
  21609. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  21610. /**
  21611. * Returns all vertex buffers
  21612. * @return an object holding all vertex buffers indexed by kind
  21613. */
  21614. getVertexBuffers(): Nullable<{
  21615. [key: string]: VertexBuffer;
  21616. }>;
  21617. /**
  21618. * Gets a boolean indicating if specific vertex buffer is present
  21619. * @param kind defines the data kind (Position, normal, etc...)
  21620. * @returns true if data is present
  21621. */
  21622. isVerticesDataPresent(kind: string): boolean;
  21623. /**
  21624. * Gets a list of all attached data kinds (Position, normal, etc...)
  21625. * @returns a list of string containing all kinds
  21626. */
  21627. getVerticesDataKinds(): string[];
  21628. /**
  21629. * Update index buffer
  21630. * @param indices defines the indices to store in the index buffer
  21631. * @param offset defines the offset in the target buffer where to store the data
  21632. * @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)
  21633. */
  21634. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  21635. /**
  21636. * Creates a new index buffer
  21637. * @param indices defines the indices to store in the index buffer
  21638. * @param totalVertices defines the total number of vertices (could be null)
  21639. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21640. */
  21641. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  21642. /**
  21643. * Return the total number of indices
  21644. * @returns the total number of indices
  21645. */
  21646. getTotalIndices(): number;
  21647. /**
  21648. * Gets the index buffer array
  21649. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21650. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21651. * @returns the index buffer array
  21652. */
  21653. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21654. /**
  21655. * Gets the index buffer
  21656. * @return the index buffer
  21657. */
  21658. getIndexBuffer(): Nullable<DataBuffer>;
  21659. /** @hidden */
  21660. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  21661. /**
  21662. * Release the associated resources for a specific mesh
  21663. * @param mesh defines the source mesh
  21664. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  21665. */
  21666. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  21667. /**
  21668. * Apply current geometry to a given mesh
  21669. * @param mesh defines the mesh to apply geometry to
  21670. */
  21671. applyToMesh(mesh: Mesh): void;
  21672. private _updateExtend;
  21673. private _applyToMesh;
  21674. private notifyUpdate;
  21675. /**
  21676. * Load the geometry if it was flagged as delay loaded
  21677. * @param scene defines the hosting scene
  21678. * @param onLoaded defines a callback called when the geometry is loaded
  21679. */
  21680. load(scene: Scene, onLoaded?: () => void): void;
  21681. private _queueLoad;
  21682. /**
  21683. * Invert the geometry to move from a right handed system to a left handed one.
  21684. */
  21685. toLeftHanded(): void;
  21686. /** @hidden */
  21687. _resetPointsArrayCache(): void;
  21688. /** @hidden */
  21689. _generatePointsArray(): boolean;
  21690. /**
  21691. * Gets a value indicating if the geometry is disposed
  21692. * @returns true if the geometry was disposed
  21693. */
  21694. isDisposed(): boolean;
  21695. private _disposeVertexArrayObjects;
  21696. /**
  21697. * Free all associated resources
  21698. */
  21699. dispose(): void;
  21700. /**
  21701. * Clone the current geometry into a new geometry
  21702. * @param id defines the unique ID of the new geometry
  21703. * @returns a new geometry object
  21704. */
  21705. copy(id: string): Geometry;
  21706. /**
  21707. * Serialize the current geometry info (and not the vertices data) into a JSON object
  21708. * @return a JSON representation of the current geometry data (without the vertices data)
  21709. */
  21710. serialize(): any;
  21711. private toNumberArray;
  21712. /**
  21713. * Serialize all vertices data into a JSON oject
  21714. * @returns a JSON representation of the current geometry data
  21715. */
  21716. serializeVerticeData(): any;
  21717. /**
  21718. * Extracts a clone of a mesh geometry
  21719. * @param mesh defines the source mesh
  21720. * @param id defines the unique ID of the new geometry object
  21721. * @returns the new geometry object
  21722. */
  21723. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  21724. /**
  21725. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  21726. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  21727. * Be aware Math.random() could cause collisions, but:
  21728. * "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"
  21729. * @returns a string containing a new GUID
  21730. */
  21731. static RandomId(): string;
  21732. /** @hidden */
  21733. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  21734. private static _CleanMatricesWeights;
  21735. /**
  21736. * Create a new geometry from persisted data (Using .babylon file format)
  21737. * @param parsedVertexData defines the persisted data
  21738. * @param scene defines the hosting scene
  21739. * @param rootUrl defines the root url to use to load assets (like delayed data)
  21740. * @returns the new geometry object
  21741. */
  21742. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  21743. }
  21744. }
  21745. declare module "babylonjs/Meshes/mesh.vertexData" {
  21746. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  21747. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  21748. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  21749. import { Geometry } from "babylonjs/Meshes/geometry";
  21750. import { Mesh } from "babylonjs/Meshes/mesh";
  21751. /**
  21752. * Define an interface for all classes that will get and set the data on vertices
  21753. */
  21754. export interface IGetSetVerticesData {
  21755. /**
  21756. * Gets a boolean indicating if specific vertex data is present
  21757. * @param kind defines the vertex data kind to use
  21758. * @returns true is data kind is present
  21759. */
  21760. isVerticesDataPresent(kind: string): boolean;
  21761. /**
  21762. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21763. * @param kind defines the data kind (Position, normal, etc...)
  21764. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21765. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21766. * @returns a float array containing vertex data
  21767. */
  21768. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21769. /**
  21770. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  21771. * @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.
  21772. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21773. * @returns the indices array or an empty array if the mesh has no geometry
  21774. */
  21775. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21776. /**
  21777. * Set specific vertex data
  21778. * @param kind defines the data kind (Position, normal, etc...)
  21779. * @param data defines the vertex data to use
  21780. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21781. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21782. */
  21783. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  21784. /**
  21785. * Update a specific associated vertex buffer
  21786. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  21787. * - VertexBuffer.PositionKind
  21788. * - VertexBuffer.UVKind
  21789. * - VertexBuffer.UV2Kind
  21790. * - VertexBuffer.UV3Kind
  21791. * - VertexBuffer.UV4Kind
  21792. * - VertexBuffer.UV5Kind
  21793. * - VertexBuffer.UV6Kind
  21794. * - VertexBuffer.ColorKind
  21795. * - VertexBuffer.MatricesIndicesKind
  21796. * - VertexBuffer.MatricesIndicesExtraKind
  21797. * - VertexBuffer.MatricesWeightsKind
  21798. * - VertexBuffer.MatricesWeightsExtraKind
  21799. * @param data defines the data source
  21800. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  21801. * @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)
  21802. */
  21803. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  21804. /**
  21805. * Creates a new index buffer
  21806. * @param indices defines the indices to store in the index buffer
  21807. * @param totalVertices defines the total number of vertices (could be null)
  21808. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21809. */
  21810. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  21811. }
  21812. /**
  21813. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  21814. */
  21815. export class VertexData {
  21816. /**
  21817. * Mesh side orientation : usually the external or front surface
  21818. */
  21819. static readonly FRONTSIDE: number;
  21820. /**
  21821. * Mesh side orientation : usually the internal or back surface
  21822. */
  21823. static readonly BACKSIDE: number;
  21824. /**
  21825. * Mesh side orientation : both internal and external or front and back surfaces
  21826. */
  21827. static readonly DOUBLESIDE: number;
  21828. /**
  21829. * Mesh side orientation : by default, `FRONTSIDE`
  21830. */
  21831. static readonly DEFAULTSIDE: number;
  21832. /**
  21833. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  21834. */
  21835. positions: Nullable<FloatArray>;
  21836. /**
  21837. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  21838. */
  21839. normals: Nullable<FloatArray>;
  21840. /**
  21841. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  21842. */
  21843. tangents: Nullable<FloatArray>;
  21844. /**
  21845. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21846. */
  21847. uvs: Nullable<FloatArray>;
  21848. /**
  21849. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21850. */
  21851. uvs2: Nullable<FloatArray>;
  21852. /**
  21853. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21854. */
  21855. uvs3: Nullable<FloatArray>;
  21856. /**
  21857. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21858. */
  21859. uvs4: Nullable<FloatArray>;
  21860. /**
  21861. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21862. */
  21863. uvs5: Nullable<FloatArray>;
  21864. /**
  21865. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21866. */
  21867. uvs6: Nullable<FloatArray>;
  21868. /**
  21869. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  21870. */
  21871. colors: Nullable<FloatArray>;
  21872. /**
  21873. * 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).
  21874. */
  21875. matricesIndices: Nullable<FloatArray>;
  21876. /**
  21877. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  21878. */
  21879. matricesWeights: Nullable<FloatArray>;
  21880. /**
  21881. * An array extending the number of possible indices
  21882. */
  21883. matricesIndicesExtra: Nullable<FloatArray>;
  21884. /**
  21885. * An array extending the number of possible weights when the number of indices is extended
  21886. */
  21887. matricesWeightsExtra: Nullable<FloatArray>;
  21888. /**
  21889. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  21890. */
  21891. indices: Nullable<IndicesArray>;
  21892. /**
  21893. * Uses the passed data array to set the set the values for the specified kind of data
  21894. * @param data a linear array of floating numbers
  21895. * @param kind the type of data that is being set, eg positions, colors etc
  21896. */
  21897. set(data: FloatArray, kind: string): void;
  21898. /**
  21899. * Associates the vertexData to the passed Mesh.
  21900. * Sets it as updatable or not (default `false`)
  21901. * @param mesh the mesh the vertexData is applied to
  21902. * @param updatable when used and having the value true allows new data to update the vertexData
  21903. * @returns the VertexData
  21904. */
  21905. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  21906. /**
  21907. * Associates the vertexData to the passed Geometry.
  21908. * Sets it as updatable or not (default `false`)
  21909. * @param geometry the geometry the vertexData is applied to
  21910. * @param updatable when used and having the value true allows new data to update the vertexData
  21911. * @returns VertexData
  21912. */
  21913. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  21914. /**
  21915. * Updates the associated mesh
  21916. * @param mesh the mesh to be updated
  21917. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  21918. * @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
  21919. * @returns VertexData
  21920. */
  21921. updateMesh(mesh: Mesh): VertexData;
  21922. /**
  21923. * Updates the associated geometry
  21924. * @param geometry the geometry to be updated
  21925. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  21926. * @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
  21927. * @returns VertexData.
  21928. */
  21929. updateGeometry(geometry: Geometry): VertexData;
  21930. private _applyTo;
  21931. private _update;
  21932. /**
  21933. * Transforms each position and each normal of the vertexData according to the passed Matrix
  21934. * @param matrix the transforming matrix
  21935. * @returns the VertexData
  21936. */
  21937. transform(matrix: Matrix): VertexData;
  21938. /**
  21939. * Merges the passed VertexData into the current one
  21940. * @param other the VertexData to be merged into the current one
  21941. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  21942. * @returns the modified VertexData
  21943. */
  21944. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  21945. private _mergeElement;
  21946. private _validate;
  21947. /**
  21948. * Serializes the VertexData
  21949. * @returns a serialized object
  21950. */
  21951. serialize(): any;
  21952. /**
  21953. * Extracts the vertexData from a mesh
  21954. * @param mesh the mesh from which to extract the VertexData
  21955. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  21956. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  21957. * @returns the object VertexData associated to the passed mesh
  21958. */
  21959. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  21960. /**
  21961. * Extracts the vertexData from the geometry
  21962. * @param geometry the geometry from which to extract the VertexData
  21963. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  21964. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  21965. * @returns the object VertexData associated to the passed mesh
  21966. */
  21967. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  21968. private static _ExtractFrom;
  21969. /**
  21970. * Creates the VertexData for a Ribbon
  21971. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  21972. * * pathArray array of paths, each of which an array of successive Vector3
  21973. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  21974. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  21975. * * 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
  21976. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  21977. * * 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)
  21978. * * 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)
  21979. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  21980. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  21981. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  21982. * @returns the VertexData of the ribbon
  21983. */
  21984. static CreateRibbon(options: {
  21985. pathArray: Vector3[][];
  21986. closeArray?: boolean;
  21987. closePath?: boolean;
  21988. offset?: number;
  21989. sideOrientation?: number;
  21990. frontUVs?: Vector4;
  21991. backUVs?: Vector4;
  21992. invertUV?: boolean;
  21993. uvs?: Vector2[];
  21994. colors?: Color4[];
  21995. }): VertexData;
  21996. /**
  21997. * Creates the VertexData for a box
  21998. * @param options an object used to set the following optional parameters for the box, required but can be empty
  21999. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22000. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22001. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22002. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22003. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22004. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22005. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22006. * * 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)
  22007. * * 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)
  22008. * @returns the VertexData of the box
  22009. */
  22010. static CreateBox(options: {
  22011. size?: number;
  22012. width?: number;
  22013. height?: number;
  22014. depth?: number;
  22015. faceUV?: Vector4[];
  22016. faceColors?: Color4[];
  22017. sideOrientation?: number;
  22018. frontUVs?: Vector4;
  22019. backUVs?: Vector4;
  22020. }): VertexData;
  22021. /**
  22022. * Creates the VertexData for a tiled box
  22023. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22024. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22025. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22026. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22027. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22028. * @returns the VertexData of the box
  22029. */
  22030. static CreateTiledBox(options: {
  22031. pattern?: number;
  22032. width?: number;
  22033. height?: number;
  22034. depth?: number;
  22035. tileSize?: number;
  22036. tileWidth?: number;
  22037. tileHeight?: number;
  22038. alignHorizontal?: number;
  22039. alignVertical?: number;
  22040. faceUV?: Vector4[];
  22041. faceColors?: Color4[];
  22042. sideOrientation?: number;
  22043. }): VertexData;
  22044. /**
  22045. * Creates the VertexData for a tiled plane
  22046. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22047. * * pattern a limited pattern arrangement depending on the number
  22048. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22049. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22050. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22051. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22052. * * 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)
  22053. * * 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)
  22054. * @returns the VertexData of the tiled plane
  22055. */
  22056. static CreateTiledPlane(options: {
  22057. pattern?: number;
  22058. tileSize?: number;
  22059. tileWidth?: number;
  22060. tileHeight?: number;
  22061. size?: number;
  22062. width?: number;
  22063. height?: number;
  22064. alignHorizontal?: number;
  22065. alignVertical?: number;
  22066. sideOrientation?: number;
  22067. frontUVs?: Vector4;
  22068. backUVs?: Vector4;
  22069. }): VertexData;
  22070. /**
  22071. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22072. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22073. * * segments sets the number of horizontal strips optional, default 32
  22074. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22075. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22076. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22077. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22078. * * 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
  22079. * * 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
  22080. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22081. * * 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)
  22082. * * 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)
  22083. * @returns the VertexData of the ellipsoid
  22084. */
  22085. static CreateSphere(options: {
  22086. segments?: number;
  22087. diameter?: number;
  22088. diameterX?: number;
  22089. diameterY?: number;
  22090. diameterZ?: number;
  22091. arc?: number;
  22092. slice?: number;
  22093. sideOrientation?: number;
  22094. frontUVs?: Vector4;
  22095. backUVs?: Vector4;
  22096. }): VertexData;
  22097. /**
  22098. * Creates the VertexData for a cylinder, cone or prism
  22099. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22100. * * height sets the height (y direction) of the cylinder, optional, default 2
  22101. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22102. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22103. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22104. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22105. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22106. * * 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
  22107. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22108. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22109. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22110. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22111. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22112. * * 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)
  22113. * * 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)
  22114. * @returns the VertexData of the cylinder, cone or prism
  22115. */
  22116. static CreateCylinder(options: {
  22117. height?: number;
  22118. diameterTop?: number;
  22119. diameterBottom?: number;
  22120. diameter?: number;
  22121. tessellation?: number;
  22122. subdivisions?: number;
  22123. arc?: number;
  22124. faceColors?: Color4[];
  22125. faceUV?: Vector4[];
  22126. hasRings?: boolean;
  22127. enclose?: boolean;
  22128. sideOrientation?: number;
  22129. frontUVs?: Vector4;
  22130. backUVs?: Vector4;
  22131. }): VertexData;
  22132. /**
  22133. * Creates the VertexData for a torus
  22134. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22135. * * diameter the diameter of the torus, optional default 1
  22136. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22137. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22138. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22139. * * 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)
  22140. * * 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)
  22141. * @returns the VertexData of the torus
  22142. */
  22143. static CreateTorus(options: {
  22144. diameter?: number;
  22145. thickness?: number;
  22146. tessellation?: number;
  22147. sideOrientation?: number;
  22148. frontUVs?: Vector4;
  22149. backUVs?: Vector4;
  22150. }): VertexData;
  22151. /**
  22152. * Creates the VertexData of the LineSystem
  22153. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22154. * - lines an array of lines, each line being an array of successive Vector3
  22155. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22156. * @returns the VertexData of the LineSystem
  22157. */
  22158. static CreateLineSystem(options: {
  22159. lines: Vector3[][];
  22160. colors?: Nullable<Color4[][]>;
  22161. }): VertexData;
  22162. /**
  22163. * Create the VertexData for a DashedLines
  22164. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22165. * - points an array successive Vector3
  22166. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22167. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22168. * - dashNb the intended total number of dashes, optional, default 200
  22169. * @returns the VertexData for the DashedLines
  22170. */
  22171. static CreateDashedLines(options: {
  22172. points: Vector3[];
  22173. dashSize?: number;
  22174. gapSize?: number;
  22175. dashNb?: number;
  22176. }): VertexData;
  22177. /**
  22178. * Creates the VertexData for a Ground
  22179. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22180. * - width the width (x direction) of the ground, optional, default 1
  22181. * - height the height (z direction) of the ground, optional, default 1
  22182. * - subdivisions the number of subdivisions per side, optional, default 1
  22183. * @returns the VertexData of the Ground
  22184. */
  22185. static CreateGround(options: {
  22186. width?: number;
  22187. height?: number;
  22188. subdivisions?: number;
  22189. subdivisionsX?: number;
  22190. subdivisionsY?: number;
  22191. }): VertexData;
  22192. /**
  22193. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22194. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22195. * * xmin the ground minimum X coordinate, optional, default -1
  22196. * * zmin the ground minimum Z coordinate, optional, default -1
  22197. * * xmax the ground maximum X coordinate, optional, default 1
  22198. * * zmax the ground maximum Z coordinate, optional, default 1
  22199. * * 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}
  22200. * * 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}
  22201. * @returns the VertexData of the TiledGround
  22202. */
  22203. static CreateTiledGround(options: {
  22204. xmin: number;
  22205. zmin: number;
  22206. xmax: number;
  22207. zmax: number;
  22208. subdivisions?: {
  22209. w: number;
  22210. h: number;
  22211. };
  22212. precision?: {
  22213. w: number;
  22214. h: number;
  22215. };
  22216. }): VertexData;
  22217. /**
  22218. * Creates the VertexData of the Ground designed from a heightmap
  22219. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22220. * * width the width (x direction) of the ground
  22221. * * height the height (z direction) of the ground
  22222. * * subdivisions the number of subdivisions per side
  22223. * * minHeight the minimum altitude on the ground, optional, default 0
  22224. * * maxHeight the maximum altitude on the ground, optional default 1
  22225. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22226. * * buffer the array holding the image color data
  22227. * * bufferWidth the width of image
  22228. * * bufferHeight the height of image
  22229. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22230. * @returns the VertexData of the Ground designed from a heightmap
  22231. */
  22232. static CreateGroundFromHeightMap(options: {
  22233. width: number;
  22234. height: number;
  22235. subdivisions: number;
  22236. minHeight: number;
  22237. maxHeight: number;
  22238. colorFilter: Color3;
  22239. buffer: Uint8Array;
  22240. bufferWidth: number;
  22241. bufferHeight: number;
  22242. alphaFilter: number;
  22243. }): VertexData;
  22244. /**
  22245. * Creates the VertexData for a Plane
  22246. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22247. * * size sets the width and height of the plane to the value of size, optional default 1
  22248. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22249. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22250. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22251. * * 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)
  22252. * * 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)
  22253. * @returns the VertexData of the box
  22254. */
  22255. static CreatePlane(options: {
  22256. size?: number;
  22257. width?: number;
  22258. height?: number;
  22259. sideOrientation?: number;
  22260. frontUVs?: Vector4;
  22261. backUVs?: Vector4;
  22262. }): VertexData;
  22263. /**
  22264. * Creates the VertexData of the Disc or regular Polygon
  22265. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22266. * * radius the radius of the disc, optional default 0.5
  22267. * * tessellation the number of polygon sides, optional, default 64
  22268. * * 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
  22269. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22270. * * 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)
  22271. * * 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)
  22272. * @returns the VertexData of the box
  22273. */
  22274. static CreateDisc(options: {
  22275. radius?: number;
  22276. tessellation?: number;
  22277. arc?: number;
  22278. sideOrientation?: number;
  22279. frontUVs?: Vector4;
  22280. backUVs?: Vector4;
  22281. }): VertexData;
  22282. /**
  22283. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22284. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22285. * @param polygon a mesh built from polygonTriangulation.build()
  22286. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22287. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22288. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22289. * @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)
  22290. * @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)
  22291. * @returns the VertexData of the Polygon
  22292. */
  22293. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22294. /**
  22295. * Creates the VertexData of the IcoSphere
  22296. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22297. * * radius the radius of the IcoSphere, optional default 1
  22298. * * radiusX allows stretching in the x direction, optional, default radius
  22299. * * radiusY allows stretching in the y direction, optional, default radius
  22300. * * radiusZ allows stretching in the z direction, optional, default radius
  22301. * * flat when true creates a flat shaded mesh, optional, default true
  22302. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22303. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22304. * * 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)
  22305. * * 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)
  22306. * @returns the VertexData of the IcoSphere
  22307. */
  22308. static CreateIcoSphere(options: {
  22309. radius?: number;
  22310. radiusX?: number;
  22311. radiusY?: number;
  22312. radiusZ?: number;
  22313. flat?: boolean;
  22314. subdivisions?: number;
  22315. sideOrientation?: number;
  22316. frontUVs?: Vector4;
  22317. backUVs?: Vector4;
  22318. }): VertexData;
  22319. /**
  22320. * Creates the VertexData for a Polyhedron
  22321. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22322. * * type provided types are:
  22323. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22324. * * 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)
  22325. * * size the size of the IcoSphere, optional default 1
  22326. * * sizeX allows stretching in the x direction, optional, default size
  22327. * * sizeY allows stretching in the y direction, optional, default size
  22328. * * sizeZ allows stretching in the z direction, optional, default size
  22329. * * 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
  22330. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22331. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22332. * * flat when true creates a flat shaded mesh, optional, default true
  22333. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22335. * * 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)
  22336. * * 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)
  22337. * @returns the VertexData of the Polyhedron
  22338. */
  22339. static CreatePolyhedron(options: {
  22340. type?: number;
  22341. size?: number;
  22342. sizeX?: number;
  22343. sizeY?: number;
  22344. sizeZ?: number;
  22345. custom?: any;
  22346. faceUV?: Vector4[];
  22347. faceColors?: Color4[];
  22348. flat?: boolean;
  22349. sideOrientation?: number;
  22350. frontUVs?: Vector4;
  22351. backUVs?: Vector4;
  22352. }): VertexData;
  22353. /**
  22354. * Creates the VertexData for a TorusKnot
  22355. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22356. * * radius the radius of the torus knot, optional, default 2
  22357. * * tube the thickness of the tube, optional, default 0.5
  22358. * * radialSegments the number of sides on each tube segments, optional, default 32
  22359. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22360. * * p the number of windings around the z axis, optional, default 2
  22361. * * q the number of windings around the x axis, optional, default 3
  22362. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22363. * * 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)
  22364. * * 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)
  22365. * @returns the VertexData of the Torus Knot
  22366. */
  22367. static CreateTorusKnot(options: {
  22368. radius?: number;
  22369. tube?: number;
  22370. radialSegments?: number;
  22371. tubularSegments?: number;
  22372. p?: number;
  22373. q?: number;
  22374. sideOrientation?: number;
  22375. frontUVs?: Vector4;
  22376. backUVs?: Vector4;
  22377. }): VertexData;
  22378. /**
  22379. * Compute normals for given positions and indices
  22380. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22381. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22382. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22383. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22384. * * facetNormals : optional array of facet normals (vector3)
  22385. * * facetPositions : optional array of facet positions (vector3)
  22386. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22387. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22388. * * bInfo : optional bounding info, required for facetPartitioning computation
  22389. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22390. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22391. * * useRightHandedSystem: optional boolean to for right handed system computation
  22392. * * depthSort : optional boolean to enable the facet depth sort computation
  22393. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22394. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22395. */
  22396. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22397. facetNormals?: any;
  22398. facetPositions?: any;
  22399. facetPartitioning?: any;
  22400. ratio?: number;
  22401. bInfo?: any;
  22402. bbSize?: Vector3;
  22403. subDiv?: any;
  22404. useRightHandedSystem?: boolean;
  22405. depthSort?: boolean;
  22406. distanceTo?: Vector3;
  22407. depthSortedFacets?: any;
  22408. }): void;
  22409. /** @hidden */
  22410. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22411. /**
  22412. * Applies VertexData created from the imported parameters to the geometry
  22413. * @param parsedVertexData the parsed data from an imported file
  22414. * @param geometry the geometry to apply the VertexData to
  22415. */
  22416. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22417. }
  22418. }
  22419. declare module "babylonjs/Morph/morphTarget" {
  22420. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22421. import { Observable } from "babylonjs/Misc/observable";
  22422. import { Nullable, FloatArray } from "babylonjs/types";
  22423. import { Scene } from "babylonjs/scene";
  22424. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22425. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22426. /**
  22427. * Defines a target to use with MorphTargetManager
  22428. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22429. */
  22430. export class MorphTarget implements IAnimatable {
  22431. /** defines the name of the target */
  22432. name: string;
  22433. /**
  22434. * Gets or sets the list of animations
  22435. */
  22436. animations: import("babylonjs/Animations/animation").Animation[];
  22437. private _scene;
  22438. private _positions;
  22439. private _normals;
  22440. private _tangents;
  22441. private _uvs;
  22442. private _influence;
  22443. /**
  22444. * Observable raised when the influence changes
  22445. */
  22446. onInfluenceChanged: Observable<boolean>;
  22447. /** @hidden */
  22448. _onDataLayoutChanged: Observable<void>;
  22449. /**
  22450. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22451. */
  22452. influence: number;
  22453. /**
  22454. * Gets or sets the id of the morph Target
  22455. */
  22456. id: string;
  22457. private _animationPropertiesOverride;
  22458. /**
  22459. * Gets or sets the animation properties override
  22460. */
  22461. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22462. /**
  22463. * Creates a new MorphTarget
  22464. * @param name defines the name of the target
  22465. * @param influence defines the influence to use
  22466. * @param scene defines the scene the morphtarget belongs to
  22467. */
  22468. constructor(
  22469. /** defines the name of the target */
  22470. name: string, influence?: number, scene?: Nullable<Scene>);
  22471. /**
  22472. * Gets a boolean defining if the target contains position data
  22473. */
  22474. readonly hasPositions: boolean;
  22475. /**
  22476. * Gets a boolean defining if the target contains normal data
  22477. */
  22478. readonly hasNormals: boolean;
  22479. /**
  22480. * Gets a boolean defining if the target contains tangent data
  22481. */
  22482. readonly hasTangents: boolean;
  22483. /**
  22484. * Gets a boolean defining if the target contains texture coordinates data
  22485. */
  22486. readonly hasUVs: boolean;
  22487. /**
  22488. * Affects position data to this target
  22489. * @param data defines the position data to use
  22490. */
  22491. setPositions(data: Nullable<FloatArray>): void;
  22492. /**
  22493. * Gets the position data stored in this target
  22494. * @returns a FloatArray containing the position data (or null if not present)
  22495. */
  22496. getPositions(): Nullable<FloatArray>;
  22497. /**
  22498. * Affects normal data to this target
  22499. * @param data defines the normal data to use
  22500. */
  22501. setNormals(data: Nullable<FloatArray>): void;
  22502. /**
  22503. * Gets the normal data stored in this target
  22504. * @returns a FloatArray containing the normal data (or null if not present)
  22505. */
  22506. getNormals(): Nullable<FloatArray>;
  22507. /**
  22508. * Affects tangent data to this target
  22509. * @param data defines the tangent data to use
  22510. */
  22511. setTangents(data: Nullable<FloatArray>): void;
  22512. /**
  22513. * Gets the tangent data stored in this target
  22514. * @returns a FloatArray containing the tangent data (or null if not present)
  22515. */
  22516. getTangents(): Nullable<FloatArray>;
  22517. /**
  22518. * Affects texture coordinates data to this target
  22519. * @param data defines the texture coordinates data to use
  22520. */
  22521. setUVs(data: Nullable<FloatArray>): void;
  22522. /**
  22523. * Gets the texture coordinates data stored in this target
  22524. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  22525. */
  22526. getUVs(): Nullable<FloatArray>;
  22527. /**
  22528. * Serializes the current target into a Serialization object
  22529. * @returns the serialized object
  22530. */
  22531. serialize(): any;
  22532. /**
  22533. * Returns the string "MorphTarget"
  22534. * @returns "MorphTarget"
  22535. */
  22536. getClassName(): string;
  22537. /**
  22538. * Creates a new target from serialized data
  22539. * @param serializationObject defines the serialized data to use
  22540. * @returns a new MorphTarget
  22541. */
  22542. static Parse(serializationObject: any): MorphTarget;
  22543. /**
  22544. * Creates a MorphTarget from mesh data
  22545. * @param mesh defines the source mesh
  22546. * @param name defines the name to use for the new target
  22547. * @param influence defines the influence to attach to the target
  22548. * @returns a new MorphTarget
  22549. */
  22550. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  22551. }
  22552. }
  22553. declare module "babylonjs/Morph/morphTargetManager" {
  22554. import { Nullable } from "babylonjs/types";
  22555. import { Scene } from "babylonjs/scene";
  22556. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  22557. /**
  22558. * This class is used to deform meshes using morphing between different targets
  22559. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22560. */
  22561. export class MorphTargetManager {
  22562. private _targets;
  22563. private _targetInfluenceChangedObservers;
  22564. private _targetDataLayoutChangedObservers;
  22565. private _activeTargets;
  22566. private _scene;
  22567. private _influences;
  22568. private _supportsNormals;
  22569. private _supportsTangents;
  22570. private _supportsUVs;
  22571. private _vertexCount;
  22572. private _uniqueId;
  22573. private _tempInfluences;
  22574. /**
  22575. * Gets or sets a boolean indicating if normals must be morphed
  22576. */
  22577. enableNormalMorphing: boolean;
  22578. /**
  22579. * Gets or sets a boolean indicating if tangents must be morphed
  22580. */
  22581. enableTangentMorphing: boolean;
  22582. /**
  22583. * Gets or sets a boolean indicating if UV must be morphed
  22584. */
  22585. enableUVMorphing: boolean;
  22586. /**
  22587. * Creates a new MorphTargetManager
  22588. * @param scene defines the current scene
  22589. */
  22590. constructor(scene?: Nullable<Scene>);
  22591. /**
  22592. * Gets the unique ID of this manager
  22593. */
  22594. readonly uniqueId: number;
  22595. /**
  22596. * Gets the number of vertices handled by this manager
  22597. */
  22598. readonly vertexCount: number;
  22599. /**
  22600. * Gets a boolean indicating if this manager supports morphing of normals
  22601. */
  22602. readonly supportsNormals: boolean;
  22603. /**
  22604. * Gets a boolean indicating if this manager supports morphing of tangents
  22605. */
  22606. readonly supportsTangents: boolean;
  22607. /**
  22608. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  22609. */
  22610. readonly supportsUVs: boolean;
  22611. /**
  22612. * Gets the number of targets stored in this manager
  22613. */
  22614. readonly numTargets: number;
  22615. /**
  22616. * Gets the number of influencers (ie. the number of targets with influences > 0)
  22617. */
  22618. readonly numInfluencers: number;
  22619. /**
  22620. * Gets the list of influences (one per target)
  22621. */
  22622. readonly influences: Float32Array;
  22623. /**
  22624. * Gets the active target at specified index. An active target is a target with an influence > 0
  22625. * @param index defines the index to check
  22626. * @returns the requested target
  22627. */
  22628. getActiveTarget(index: number): MorphTarget;
  22629. /**
  22630. * Gets the target at specified index
  22631. * @param index defines the index to check
  22632. * @returns the requested target
  22633. */
  22634. getTarget(index: number): MorphTarget;
  22635. /**
  22636. * Add a new target to this manager
  22637. * @param target defines the target to add
  22638. */
  22639. addTarget(target: MorphTarget): void;
  22640. /**
  22641. * Removes a target from the manager
  22642. * @param target defines the target to remove
  22643. */
  22644. removeTarget(target: MorphTarget): void;
  22645. /**
  22646. * Serializes the current manager into a Serialization object
  22647. * @returns the serialized object
  22648. */
  22649. serialize(): any;
  22650. private _syncActiveTargets;
  22651. /**
  22652. * Syncrhonize the targets with all the meshes using this morph target manager
  22653. */
  22654. synchronize(): void;
  22655. /**
  22656. * Creates a new MorphTargetManager from serialized data
  22657. * @param serializationObject defines the serialized data
  22658. * @param scene defines the hosting scene
  22659. * @returns the new MorphTargetManager
  22660. */
  22661. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  22662. }
  22663. }
  22664. declare module "babylonjs/Meshes/meshLODLevel" {
  22665. import { Mesh } from "babylonjs/Meshes/mesh";
  22666. import { Nullable } from "babylonjs/types";
  22667. /**
  22668. * Class used to represent a specific level of detail of a mesh
  22669. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  22670. */
  22671. export class MeshLODLevel {
  22672. /** Defines the distance where this level should start being displayed */
  22673. distance: number;
  22674. /** Defines the mesh to use to render this level */
  22675. mesh: Nullable<Mesh>;
  22676. /**
  22677. * Creates a new LOD level
  22678. * @param distance defines the distance where this level should star being displayed
  22679. * @param mesh defines the mesh to use to render this level
  22680. */
  22681. constructor(
  22682. /** Defines the distance where this level should start being displayed */
  22683. distance: number,
  22684. /** Defines the mesh to use to render this level */
  22685. mesh: Nullable<Mesh>);
  22686. }
  22687. }
  22688. declare module "babylonjs/Meshes/groundMesh" {
  22689. import { Scene } from "babylonjs/scene";
  22690. import { Vector3 } from "babylonjs/Maths/math.vector";
  22691. import { Mesh } from "babylonjs/Meshes/mesh";
  22692. /**
  22693. * Mesh representing the gorund
  22694. */
  22695. export class GroundMesh extends Mesh {
  22696. /** If octree should be generated */
  22697. generateOctree: boolean;
  22698. private _heightQuads;
  22699. /** @hidden */
  22700. _subdivisionsX: number;
  22701. /** @hidden */
  22702. _subdivisionsY: number;
  22703. /** @hidden */
  22704. _width: number;
  22705. /** @hidden */
  22706. _height: number;
  22707. /** @hidden */
  22708. _minX: number;
  22709. /** @hidden */
  22710. _maxX: number;
  22711. /** @hidden */
  22712. _minZ: number;
  22713. /** @hidden */
  22714. _maxZ: number;
  22715. constructor(name: string, scene: Scene);
  22716. /**
  22717. * "GroundMesh"
  22718. * @returns "GroundMesh"
  22719. */
  22720. getClassName(): string;
  22721. /**
  22722. * The minimum of x and y subdivisions
  22723. */
  22724. readonly subdivisions: number;
  22725. /**
  22726. * X subdivisions
  22727. */
  22728. readonly subdivisionsX: number;
  22729. /**
  22730. * Y subdivisions
  22731. */
  22732. readonly subdivisionsY: number;
  22733. /**
  22734. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  22735. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  22736. * @param chunksCount the number of subdivisions for x and y
  22737. * @param octreeBlocksSize (Default: 32)
  22738. */
  22739. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  22740. /**
  22741. * Returns a height (y) value in the Worl system :
  22742. * the ground altitude at the coordinates (x, z) expressed in the World system.
  22743. * @param x x coordinate
  22744. * @param z z coordinate
  22745. * @returns the ground y position if (x, z) are outside the ground surface.
  22746. */
  22747. getHeightAtCoordinates(x: number, z: number): number;
  22748. /**
  22749. * Returns a normalized vector (Vector3) orthogonal to the ground
  22750. * at the ground coordinates (x, z) expressed in the World system.
  22751. * @param x x coordinate
  22752. * @param z z coordinate
  22753. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  22754. */
  22755. getNormalAtCoordinates(x: number, z: number): Vector3;
  22756. /**
  22757. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  22758. * at the ground coordinates (x, z) expressed in the World system.
  22759. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  22760. * @param x x coordinate
  22761. * @param z z coordinate
  22762. * @param ref vector to store the result
  22763. * @returns the GroundMesh.
  22764. */
  22765. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  22766. /**
  22767. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  22768. * if the ground has been updated.
  22769. * This can be used in the render loop.
  22770. * @returns the GroundMesh.
  22771. */
  22772. updateCoordinateHeights(): GroundMesh;
  22773. private _getFacetAt;
  22774. private _initHeightQuads;
  22775. private _computeHeightQuads;
  22776. /**
  22777. * Serializes this ground mesh
  22778. * @param serializationObject object to write serialization to
  22779. */
  22780. serialize(serializationObject: any): void;
  22781. /**
  22782. * Parses a serialized ground mesh
  22783. * @param parsedMesh the serialized mesh
  22784. * @param scene the scene to create the ground mesh in
  22785. * @returns the created ground mesh
  22786. */
  22787. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  22788. }
  22789. }
  22790. declare module "babylonjs/Physics/physicsJoint" {
  22791. import { Vector3 } from "babylonjs/Maths/math.vector";
  22792. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  22793. /**
  22794. * Interface for Physics-Joint data
  22795. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22796. */
  22797. export interface PhysicsJointData {
  22798. /**
  22799. * The main pivot of the joint
  22800. */
  22801. mainPivot?: Vector3;
  22802. /**
  22803. * The connected pivot of the joint
  22804. */
  22805. connectedPivot?: Vector3;
  22806. /**
  22807. * The main axis of the joint
  22808. */
  22809. mainAxis?: Vector3;
  22810. /**
  22811. * The connected axis of the joint
  22812. */
  22813. connectedAxis?: Vector3;
  22814. /**
  22815. * The collision of the joint
  22816. */
  22817. collision?: boolean;
  22818. /**
  22819. * Native Oimo/Cannon/Energy data
  22820. */
  22821. nativeParams?: any;
  22822. }
  22823. /**
  22824. * This is a holder class for the physics joint created by the physics plugin
  22825. * It holds a set of functions to control the underlying joint
  22826. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22827. */
  22828. export class PhysicsJoint {
  22829. /**
  22830. * The type of the physics joint
  22831. */
  22832. type: number;
  22833. /**
  22834. * The data for the physics joint
  22835. */
  22836. jointData: PhysicsJointData;
  22837. private _physicsJoint;
  22838. protected _physicsPlugin: IPhysicsEnginePlugin;
  22839. /**
  22840. * Initializes the physics joint
  22841. * @param type The type of the physics joint
  22842. * @param jointData The data for the physics joint
  22843. */
  22844. constructor(
  22845. /**
  22846. * The type of the physics joint
  22847. */
  22848. type: number,
  22849. /**
  22850. * The data for the physics joint
  22851. */
  22852. jointData: PhysicsJointData);
  22853. /**
  22854. * Gets the physics joint
  22855. */
  22856. /**
  22857. * Sets the physics joint
  22858. */
  22859. physicsJoint: any;
  22860. /**
  22861. * Sets the physics plugin
  22862. */
  22863. physicsPlugin: IPhysicsEnginePlugin;
  22864. /**
  22865. * Execute a function that is physics-plugin specific.
  22866. * @param {Function} func the function that will be executed.
  22867. * It accepts two parameters: the physics world and the physics joint
  22868. */
  22869. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  22870. /**
  22871. * Distance-Joint type
  22872. */
  22873. static DistanceJoint: number;
  22874. /**
  22875. * Hinge-Joint type
  22876. */
  22877. static HingeJoint: number;
  22878. /**
  22879. * Ball-and-Socket joint type
  22880. */
  22881. static BallAndSocketJoint: number;
  22882. /**
  22883. * Wheel-Joint type
  22884. */
  22885. static WheelJoint: number;
  22886. /**
  22887. * Slider-Joint type
  22888. */
  22889. static SliderJoint: number;
  22890. /**
  22891. * Prismatic-Joint type
  22892. */
  22893. static PrismaticJoint: number;
  22894. /**
  22895. * Universal-Joint type
  22896. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  22897. */
  22898. static UniversalJoint: number;
  22899. /**
  22900. * Hinge-Joint 2 type
  22901. */
  22902. static Hinge2Joint: number;
  22903. /**
  22904. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  22905. */
  22906. static PointToPointJoint: number;
  22907. /**
  22908. * Spring-Joint type
  22909. */
  22910. static SpringJoint: number;
  22911. /**
  22912. * Lock-Joint type
  22913. */
  22914. static LockJoint: number;
  22915. }
  22916. /**
  22917. * A class representing a physics distance joint
  22918. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22919. */
  22920. export class DistanceJoint extends PhysicsJoint {
  22921. /**
  22922. *
  22923. * @param jointData The data for the Distance-Joint
  22924. */
  22925. constructor(jointData: DistanceJointData);
  22926. /**
  22927. * Update the predefined distance.
  22928. * @param maxDistance The maximum preferred distance
  22929. * @param minDistance The minimum preferred distance
  22930. */
  22931. updateDistance(maxDistance: number, minDistance?: number): void;
  22932. }
  22933. /**
  22934. * Represents a Motor-Enabled Joint
  22935. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22936. */
  22937. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  22938. /**
  22939. * Initializes the Motor-Enabled Joint
  22940. * @param type The type of the joint
  22941. * @param jointData The physica joint data for the joint
  22942. */
  22943. constructor(type: number, jointData: PhysicsJointData);
  22944. /**
  22945. * Set the motor values.
  22946. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22947. * @param force the force to apply
  22948. * @param maxForce max force for this motor.
  22949. */
  22950. setMotor(force?: number, maxForce?: number): void;
  22951. /**
  22952. * Set the motor's limits.
  22953. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22954. * @param upperLimit The upper limit of the motor
  22955. * @param lowerLimit The lower limit of the motor
  22956. */
  22957. setLimit(upperLimit: number, lowerLimit?: number): void;
  22958. }
  22959. /**
  22960. * This class represents a single physics Hinge-Joint
  22961. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22962. */
  22963. export class HingeJoint extends MotorEnabledJoint {
  22964. /**
  22965. * Initializes the Hinge-Joint
  22966. * @param jointData The joint data for the Hinge-Joint
  22967. */
  22968. constructor(jointData: PhysicsJointData);
  22969. /**
  22970. * Set the motor values.
  22971. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22972. * @param {number} force the force to apply
  22973. * @param {number} maxForce max force for this motor.
  22974. */
  22975. setMotor(force?: number, maxForce?: number): void;
  22976. /**
  22977. * Set the motor's limits.
  22978. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22979. * @param upperLimit The upper limit of the motor
  22980. * @param lowerLimit The lower limit of the motor
  22981. */
  22982. setLimit(upperLimit: number, lowerLimit?: number): void;
  22983. }
  22984. /**
  22985. * This class represents a dual hinge physics joint (same as wheel joint)
  22986. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22987. */
  22988. export class Hinge2Joint extends MotorEnabledJoint {
  22989. /**
  22990. * Initializes the Hinge2-Joint
  22991. * @param jointData The joint data for the Hinge2-Joint
  22992. */
  22993. constructor(jointData: PhysicsJointData);
  22994. /**
  22995. * Set the motor values.
  22996. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22997. * @param {number} targetSpeed the speed the motor is to reach
  22998. * @param {number} maxForce max force for this motor.
  22999. * @param {motorIndex} the motor's index, 0 or 1.
  23000. */
  23001. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23002. /**
  23003. * Set the motor limits.
  23004. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23005. * @param {number} upperLimit the upper limit
  23006. * @param {number} lowerLimit lower limit
  23007. * @param {motorIndex} the motor's index, 0 or 1.
  23008. */
  23009. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23010. }
  23011. /**
  23012. * Interface for a motor enabled joint
  23013. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23014. */
  23015. export interface IMotorEnabledJoint {
  23016. /**
  23017. * Physics joint
  23018. */
  23019. physicsJoint: any;
  23020. /**
  23021. * Sets the motor of the motor-enabled joint
  23022. * @param force The force of the motor
  23023. * @param maxForce The maximum force of the motor
  23024. * @param motorIndex The index of the motor
  23025. */
  23026. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23027. /**
  23028. * Sets the limit of the motor
  23029. * @param upperLimit The upper limit of the motor
  23030. * @param lowerLimit The lower limit of the motor
  23031. * @param motorIndex The index of the motor
  23032. */
  23033. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23034. }
  23035. /**
  23036. * Joint data for a Distance-Joint
  23037. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23038. */
  23039. export interface DistanceJointData extends PhysicsJointData {
  23040. /**
  23041. * Max distance the 2 joint objects can be apart
  23042. */
  23043. maxDistance: number;
  23044. }
  23045. /**
  23046. * Joint data from a spring joint
  23047. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23048. */
  23049. export interface SpringJointData extends PhysicsJointData {
  23050. /**
  23051. * Length of the spring
  23052. */
  23053. length: number;
  23054. /**
  23055. * Stiffness of the spring
  23056. */
  23057. stiffness: number;
  23058. /**
  23059. * Damping of the spring
  23060. */
  23061. damping: number;
  23062. /** this callback will be called when applying the force to the impostors. */
  23063. forceApplicationCallback: () => void;
  23064. }
  23065. }
  23066. declare module "babylonjs/Physics/physicsRaycastResult" {
  23067. import { Vector3 } from "babylonjs/Maths/math.vector";
  23068. /**
  23069. * Holds the data for the raycast result
  23070. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23071. */
  23072. export class PhysicsRaycastResult {
  23073. private _hasHit;
  23074. private _hitDistance;
  23075. private _hitNormalWorld;
  23076. private _hitPointWorld;
  23077. private _rayFromWorld;
  23078. private _rayToWorld;
  23079. /**
  23080. * Gets if there was a hit
  23081. */
  23082. readonly hasHit: boolean;
  23083. /**
  23084. * Gets the distance from the hit
  23085. */
  23086. readonly hitDistance: number;
  23087. /**
  23088. * Gets the hit normal/direction in the world
  23089. */
  23090. readonly hitNormalWorld: Vector3;
  23091. /**
  23092. * Gets the hit point in the world
  23093. */
  23094. readonly hitPointWorld: Vector3;
  23095. /**
  23096. * Gets the ray "start point" of the ray in the world
  23097. */
  23098. readonly rayFromWorld: Vector3;
  23099. /**
  23100. * Gets the ray "end point" of the ray in the world
  23101. */
  23102. readonly rayToWorld: Vector3;
  23103. /**
  23104. * Sets the hit data (normal & point in world space)
  23105. * @param hitNormalWorld defines the normal in world space
  23106. * @param hitPointWorld defines the point in world space
  23107. */
  23108. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23109. /**
  23110. * Sets the distance from the start point to the hit point
  23111. * @param distance
  23112. */
  23113. setHitDistance(distance: number): void;
  23114. /**
  23115. * Calculates the distance manually
  23116. */
  23117. calculateHitDistance(): void;
  23118. /**
  23119. * Resets all the values to default
  23120. * @param from The from point on world space
  23121. * @param to The to point on world space
  23122. */
  23123. reset(from?: Vector3, to?: Vector3): void;
  23124. }
  23125. /**
  23126. * Interface for the size containing width and height
  23127. */
  23128. interface IXYZ {
  23129. /**
  23130. * X
  23131. */
  23132. x: number;
  23133. /**
  23134. * Y
  23135. */
  23136. y: number;
  23137. /**
  23138. * Z
  23139. */
  23140. z: number;
  23141. }
  23142. }
  23143. declare module "babylonjs/Physics/IPhysicsEngine" {
  23144. import { Nullable } from "babylonjs/types";
  23145. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23146. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23147. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23148. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23149. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23150. /**
  23151. * Interface used to describe a physics joint
  23152. */
  23153. export interface PhysicsImpostorJoint {
  23154. /** Defines the main impostor to which the joint is linked */
  23155. mainImpostor: PhysicsImpostor;
  23156. /** Defines the impostor that is connected to the main impostor using this joint */
  23157. connectedImpostor: PhysicsImpostor;
  23158. /** Defines the joint itself */
  23159. joint: PhysicsJoint;
  23160. }
  23161. /** @hidden */
  23162. export interface IPhysicsEnginePlugin {
  23163. world: any;
  23164. name: string;
  23165. setGravity(gravity: Vector3): void;
  23166. setTimeStep(timeStep: number): void;
  23167. getTimeStep(): number;
  23168. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23169. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23170. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23171. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23172. removePhysicsBody(impostor: PhysicsImpostor): void;
  23173. generateJoint(joint: PhysicsImpostorJoint): void;
  23174. removeJoint(joint: PhysicsImpostorJoint): void;
  23175. isSupported(): boolean;
  23176. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23177. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23178. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23179. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23180. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23181. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23182. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23183. getBodyMass(impostor: PhysicsImpostor): number;
  23184. getBodyFriction(impostor: PhysicsImpostor): number;
  23185. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23186. getBodyRestitution(impostor: PhysicsImpostor): number;
  23187. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23188. getBodyPressure?(impostor: PhysicsImpostor): number;
  23189. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23190. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23191. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23192. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23193. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23194. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23195. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23196. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23197. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23198. sleepBody(impostor: PhysicsImpostor): void;
  23199. wakeUpBody(impostor: PhysicsImpostor): void;
  23200. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23201. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23202. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23203. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23204. getRadius(impostor: PhysicsImpostor): number;
  23205. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23206. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23207. dispose(): void;
  23208. }
  23209. /**
  23210. * Interface used to define a physics engine
  23211. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23212. */
  23213. export interface IPhysicsEngine {
  23214. /**
  23215. * Gets the gravity vector used by the simulation
  23216. */
  23217. gravity: Vector3;
  23218. /**
  23219. * Sets the gravity vector used by the simulation
  23220. * @param gravity defines the gravity vector to use
  23221. */
  23222. setGravity(gravity: Vector3): void;
  23223. /**
  23224. * Set the time step of the physics engine.
  23225. * Default is 1/60.
  23226. * To slow it down, enter 1/600 for example.
  23227. * To speed it up, 1/30
  23228. * @param newTimeStep the new timestep to apply to this world.
  23229. */
  23230. setTimeStep(newTimeStep: number): void;
  23231. /**
  23232. * Get the time step of the physics engine.
  23233. * @returns the current time step
  23234. */
  23235. getTimeStep(): number;
  23236. /**
  23237. * Release all resources
  23238. */
  23239. dispose(): void;
  23240. /**
  23241. * Gets the name of the current physics plugin
  23242. * @returns the name of the plugin
  23243. */
  23244. getPhysicsPluginName(): string;
  23245. /**
  23246. * Adding a new impostor for the impostor tracking.
  23247. * This will be done by the impostor itself.
  23248. * @param impostor the impostor to add
  23249. */
  23250. addImpostor(impostor: PhysicsImpostor): void;
  23251. /**
  23252. * Remove an impostor from the engine.
  23253. * This impostor and its mesh will not longer be updated by the physics engine.
  23254. * @param impostor the impostor to remove
  23255. */
  23256. removeImpostor(impostor: PhysicsImpostor): void;
  23257. /**
  23258. * Add a joint to the physics engine
  23259. * @param mainImpostor defines the main impostor to which the joint is added.
  23260. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23261. * @param joint defines the joint that will connect both impostors.
  23262. */
  23263. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23264. /**
  23265. * Removes a joint from the simulation
  23266. * @param mainImpostor defines the impostor used with the joint
  23267. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23268. * @param joint defines the joint to remove
  23269. */
  23270. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23271. /**
  23272. * Gets the current plugin used to run the simulation
  23273. * @returns current plugin
  23274. */
  23275. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23276. /**
  23277. * Gets the list of physic impostors
  23278. * @returns an array of PhysicsImpostor
  23279. */
  23280. getImpostors(): Array<PhysicsImpostor>;
  23281. /**
  23282. * Gets the impostor for a physics enabled object
  23283. * @param object defines the object impersonated by the impostor
  23284. * @returns the PhysicsImpostor or null if not found
  23285. */
  23286. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23287. /**
  23288. * Gets the impostor for a physics body object
  23289. * @param body defines physics body used by the impostor
  23290. * @returns the PhysicsImpostor or null if not found
  23291. */
  23292. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23293. /**
  23294. * Does a raycast in the physics world
  23295. * @param from when should the ray start?
  23296. * @param to when should the ray end?
  23297. * @returns PhysicsRaycastResult
  23298. */
  23299. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23300. /**
  23301. * Called by the scene. No need to call it.
  23302. * @param delta defines the timespam between frames
  23303. */
  23304. _step(delta: number): void;
  23305. }
  23306. }
  23307. declare module "babylonjs/Physics/physicsImpostor" {
  23308. import { Nullable, IndicesArray } from "babylonjs/types";
  23309. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23310. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23311. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23312. import { Scene } from "babylonjs/scene";
  23313. import { Bone } from "babylonjs/Bones/bone";
  23314. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23315. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23316. import { Space } from "babylonjs/Maths/math.axis";
  23317. /**
  23318. * The interface for the physics imposter parameters
  23319. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23320. */
  23321. export interface PhysicsImpostorParameters {
  23322. /**
  23323. * The mass of the physics imposter
  23324. */
  23325. mass: number;
  23326. /**
  23327. * The friction of the physics imposter
  23328. */
  23329. friction?: number;
  23330. /**
  23331. * The coefficient of restitution of the physics imposter
  23332. */
  23333. restitution?: number;
  23334. /**
  23335. * The native options of the physics imposter
  23336. */
  23337. nativeOptions?: any;
  23338. /**
  23339. * Specifies if the parent should be ignored
  23340. */
  23341. ignoreParent?: boolean;
  23342. /**
  23343. * Specifies if bi-directional transformations should be disabled
  23344. */
  23345. disableBidirectionalTransformation?: boolean;
  23346. /**
  23347. * The pressure inside the physics imposter, soft object only
  23348. */
  23349. pressure?: number;
  23350. /**
  23351. * The stiffness the physics imposter, soft object only
  23352. */
  23353. stiffness?: number;
  23354. /**
  23355. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23356. */
  23357. velocityIterations?: number;
  23358. /**
  23359. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23360. */
  23361. positionIterations?: number;
  23362. /**
  23363. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23364. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23365. * Add to fix multiple points
  23366. */
  23367. fixedPoints?: number;
  23368. /**
  23369. * The collision margin around a soft object
  23370. */
  23371. margin?: number;
  23372. /**
  23373. * The collision margin around a soft object
  23374. */
  23375. damping?: number;
  23376. /**
  23377. * The path for a rope based on an extrusion
  23378. */
  23379. path?: any;
  23380. /**
  23381. * The shape of an extrusion used for a rope based on an extrusion
  23382. */
  23383. shape?: any;
  23384. }
  23385. /**
  23386. * Interface for a physics-enabled object
  23387. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23388. */
  23389. export interface IPhysicsEnabledObject {
  23390. /**
  23391. * The position of the physics-enabled object
  23392. */
  23393. position: Vector3;
  23394. /**
  23395. * The rotation of the physics-enabled object
  23396. */
  23397. rotationQuaternion: Nullable<Quaternion>;
  23398. /**
  23399. * The scale of the physics-enabled object
  23400. */
  23401. scaling: Vector3;
  23402. /**
  23403. * The rotation of the physics-enabled object
  23404. */
  23405. rotation?: Vector3;
  23406. /**
  23407. * The parent of the physics-enabled object
  23408. */
  23409. parent?: any;
  23410. /**
  23411. * The bounding info of the physics-enabled object
  23412. * @returns The bounding info of the physics-enabled object
  23413. */
  23414. getBoundingInfo(): BoundingInfo;
  23415. /**
  23416. * Computes the world matrix
  23417. * @param force Specifies if the world matrix should be computed by force
  23418. * @returns A world matrix
  23419. */
  23420. computeWorldMatrix(force: boolean): Matrix;
  23421. /**
  23422. * Gets the world matrix
  23423. * @returns A world matrix
  23424. */
  23425. getWorldMatrix?(): Matrix;
  23426. /**
  23427. * Gets the child meshes
  23428. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23429. * @returns An array of abstract meshes
  23430. */
  23431. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23432. /**
  23433. * Gets the vertex data
  23434. * @param kind The type of vertex data
  23435. * @returns A nullable array of numbers, or a float32 array
  23436. */
  23437. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23438. /**
  23439. * Gets the indices from the mesh
  23440. * @returns A nullable array of index arrays
  23441. */
  23442. getIndices?(): Nullable<IndicesArray>;
  23443. /**
  23444. * Gets the scene from the mesh
  23445. * @returns the indices array or null
  23446. */
  23447. getScene?(): Scene;
  23448. /**
  23449. * Gets the absolute position from the mesh
  23450. * @returns the absolute position
  23451. */
  23452. getAbsolutePosition(): Vector3;
  23453. /**
  23454. * Gets the absolute pivot point from the mesh
  23455. * @returns the absolute pivot point
  23456. */
  23457. getAbsolutePivotPoint(): Vector3;
  23458. /**
  23459. * Rotates the mesh
  23460. * @param axis The axis of rotation
  23461. * @param amount The amount of rotation
  23462. * @param space The space of the rotation
  23463. * @returns The rotation transform node
  23464. */
  23465. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23466. /**
  23467. * Translates the mesh
  23468. * @param axis The axis of translation
  23469. * @param distance The distance of translation
  23470. * @param space The space of the translation
  23471. * @returns The transform node
  23472. */
  23473. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23474. /**
  23475. * Sets the absolute position of the mesh
  23476. * @param absolutePosition The absolute position of the mesh
  23477. * @returns The transform node
  23478. */
  23479. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23480. /**
  23481. * Gets the class name of the mesh
  23482. * @returns The class name
  23483. */
  23484. getClassName(): string;
  23485. }
  23486. /**
  23487. * Represents a physics imposter
  23488. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23489. */
  23490. export class PhysicsImpostor {
  23491. /**
  23492. * The physics-enabled object used as the physics imposter
  23493. */
  23494. object: IPhysicsEnabledObject;
  23495. /**
  23496. * The type of the physics imposter
  23497. */
  23498. type: number;
  23499. private _options;
  23500. private _scene?;
  23501. /**
  23502. * The default object size of the imposter
  23503. */
  23504. static DEFAULT_OBJECT_SIZE: Vector3;
  23505. /**
  23506. * The identity quaternion of the imposter
  23507. */
  23508. static IDENTITY_QUATERNION: Quaternion;
  23509. /** @hidden */
  23510. _pluginData: any;
  23511. private _physicsEngine;
  23512. private _physicsBody;
  23513. private _bodyUpdateRequired;
  23514. private _onBeforePhysicsStepCallbacks;
  23515. private _onAfterPhysicsStepCallbacks;
  23516. /** @hidden */
  23517. _onPhysicsCollideCallbacks: Array<{
  23518. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  23519. otherImpostors: Array<PhysicsImpostor>;
  23520. }>;
  23521. private _deltaPosition;
  23522. private _deltaRotation;
  23523. private _deltaRotationConjugated;
  23524. /** @hidden */
  23525. _isFromLine: boolean;
  23526. private _parent;
  23527. private _isDisposed;
  23528. private static _tmpVecs;
  23529. private static _tmpQuat;
  23530. /**
  23531. * Specifies if the physics imposter is disposed
  23532. */
  23533. readonly isDisposed: boolean;
  23534. /**
  23535. * Gets the mass of the physics imposter
  23536. */
  23537. mass: number;
  23538. /**
  23539. * Gets the coefficient of friction
  23540. */
  23541. /**
  23542. * Sets the coefficient of friction
  23543. */
  23544. friction: number;
  23545. /**
  23546. * Gets the coefficient of restitution
  23547. */
  23548. /**
  23549. * Sets the coefficient of restitution
  23550. */
  23551. restitution: number;
  23552. /**
  23553. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  23554. */
  23555. /**
  23556. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  23557. */
  23558. pressure: number;
  23559. /**
  23560. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23561. */
  23562. /**
  23563. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23564. */
  23565. stiffness: number;
  23566. /**
  23567. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23568. */
  23569. /**
  23570. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23571. */
  23572. velocityIterations: number;
  23573. /**
  23574. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23575. */
  23576. /**
  23577. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23578. */
  23579. positionIterations: number;
  23580. /**
  23581. * The unique id of the physics imposter
  23582. * set by the physics engine when adding this impostor to the array
  23583. */
  23584. uniqueId: number;
  23585. /**
  23586. * @hidden
  23587. */
  23588. soft: boolean;
  23589. /**
  23590. * @hidden
  23591. */
  23592. segments: number;
  23593. private _joints;
  23594. /**
  23595. * Initializes the physics imposter
  23596. * @param object The physics-enabled object used as the physics imposter
  23597. * @param type The type of the physics imposter
  23598. * @param _options The options for the physics imposter
  23599. * @param _scene The Babylon scene
  23600. */
  23601. constructor(
  23602. /**
  23603. * The physics-enabled object used as the physics imposter
  23604. */
  23605. object: IPhysicsEnabledObject,
  23606. /**
  23607. * The type of the physics imposter
  23608. */
  23609. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  23610. /**
  23611. * This function will completly initialize this impostor.
  23612. * It will create a new body - but only if this mesh has no parent.
  23613. * If it has, this impostor will not be used other than to define the impostor
  23614. * of the child mesh.
  23615. * @hidden
  23616. */
  23617. _init(): void;
  23618. private _getPhysicsParent;
  23619. /**
  23620. * Should a new body be generated.
  23621. * @returns boolean specifying if body initialization is required
  23622. */
  23623. isBodyInitRequired(): boolean;
  23624. /**
  23625. * Sets the updated scaling
  23626. * @param updated Specifies if the scaling is updated
  23627. */
  23628. setScalingUpdated(): void;
  23629. /**
  23630. * Force a regeneration of this or the parent's impostor's body.
  23631. * Use under cautious - This will remove all joints already implemented.
  23632. */
  23633. forceUpdate(): void;
  23634. /**
  23635. * Gets the body that holds this impostor. Either its own, or its parent.
  23636. */
  23637. /**
  23638. * Set the physics body. Used mainly by the physics engine/plugin
  23639. */
  23640. physicsBody: any;
  23641. /**
  23642. * Get the parent of the physics imposter
  23643. * @returns Physics imposter or null
  23644. */
  23645. /**
  23646. * Sets the parent of the physics imposter
  23647. */
  23648. parent: Nullable<PhysicsImpostor>;
  23649. /**
  23650. * Resets the update flags
  23651. */
  23652. resetUpdateFlags(): void;
  23653. /**
  23654. * Gets the object extend size
  23655. * @returns the object extend size
  23656. */
  23657. getObjectExtendSize(): Vector3;
  23658. /**
  23659. * Gets the object center
  23660. * @returns The object center
  23661. */
  23662. getObjectCenter(): Vector3;
  23663. /**
  23664. * Get a specific parametes from the options parameter
  23665. * @param paramName The object parameter name
  23666. * @returns The object parameter
  23667. */
  23668. getParam(paramName: string): any;
  23669. /**
  23670. * Sets a specific parameter in the options given to the physics plugin
  23671. * @param paramName The parameter name
  23672. * @param value The value of the parameter
  23673. */
  23674. setParam(paramName: string, value: number): void;
  23675. /**
  23676. * Specifically change the body's mass option. Won't recreate the physics body object
  23677. * @param mass The mass of the physics imposter
  23678. */
  23679. setMass(mass: number): void;
  23680. /**
  23681. * Gets the linear velocity
  23682. * @returns linear velocity or null
  23683. */
  23684. getLinearVelocity(): Nullable<Vector3>;
  23685. /**
  23686. * Sets the linear velocity
  23687. * @param velocity linear velocity or null
  23688. */
  23689. setLinearVelocity(velocity: Nullable<Vector3>): void;
  23690. /**
  23691. * Gets the angular velocity
  23692. * @returns angular velocity or null
  23693. */
  23694. getAngularVelocity(): Nullable<Vector3>;
  23695. /**
  23696. * Sets the angular velocity
  23697. * @param velocity The velocity or null
  23698. */
  23699. setAngularVelocity(velocity: Nullable<Vector3>): void;
  23700. /**
  23701. * Execute a function with the physics plugin native code
  23702. * Provide a function the will have two variables - the world object and the physics body object
  23703. * @param func The function to execute with the physics plugin native code
  23704. */
  23705. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  23706. /**
  23707. * Register a function that will be executed before the physics world is stepping forward
  23708. * @param func The function to execute before the physics world is stepped forward
  23709. */
  23710. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23711. /**
  23712. * Unregister a function that will be executed before the physics world is stepping forward
  23713. * @param func The function to execute before the physics world is stepped forward
  23714. */
  23715. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23716. /**
  23717. * Register a function that will be executed after the physics step
  23718. * @param func The function to execute after physics step
  23719. */
  23720. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23721. /**
  23722. * Unregisters a function that will be executed after the physics step
  23723. * @param func The function to execute after physics step
  23724. */
  23725. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23726. /**
  23727. * register a function that will be executed when this impostor collides against a different body
  23728. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  23729. * @param func Callback that is executed on collision
  23730. */
  23731. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  23732. /**
  23733. * Unregisters the physics imposter on contact
  23734. * @param collideAgainst The physics object to collide against
  23735. * @param func Callback to execute on collision
  23736. */
  23737. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  23738. private _tmpQuat;
  23739. private _tmpQuat2;
  23740. /**
  23741. * Get the parent rotation
  23742. * @returns The parent rotation
  23743. */
  23744. getParentsRotation(): Quaternion;
  23745. /**
  23746. * this function is executed by the physics engine.
  23747. */
  23748. beforeStep: () => void;
  23749. /**
  23750. * this function is executed by the physics engine
  23751. */
  23752. afterStep: () => void;
  23753. /**
  23754. * Legacy collision detection event support
  23755. */
  23756. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  23757. /**
  23758. * event and body object due to cannon's event-based architecture.
  23759. */
  23760. onCollide: (e: {
  23761. body: any;
  23762. }) => void;
  23763. /**
  23764. * Apply a force
  23765. * @param force The force to apply
  23766. * @param contactPoint The contact point for the force
  23767. * @returns The physics imposter
  23768. */
  23769. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  23770. /**
  23771. * Apply an impulse
  23772. * @param force The impulse force
  23773. * @param contactPoint The contact point for the impulse force
  23774. * @returns The physics imposter
  23775. */
  23776. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  23777. /**
  23778. * A help function to create a joint
  23779. * @param otherImpostor A physics imposter used to create a joint
  23780. * @param jointType The type of joint
  23781. * @param jointData The data for the joint
  23782. * @returns The physics imposter
  23783. */
  23784. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  23785. /**
  23786. * Add a joint to this impostor with a different impostor
  23787. * @param otherImpostor A physics imposter used to add a joint
  23788. * @param joint The joint to add
  23789. * @returns The physics imposter
  23790. */
  23791. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  23792. /**
  23793. * Add an anchor to a cloth impostor
  23794. * @param otherImpostor rigid impostor to anchor to
  23795. * @param width ratio across width from 0 to 1
  23796. * @param height ratio up height from 0 to 1
  23797. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  23798. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  23799. * @returns impostor the soft imposter
  23800. */
  23801. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  23802. /**
  23803. * Add a hook to a rope impostor
  23804. * @param otherImpostor rigid impostor to anchor to
  23805. * @param length ratio across rope from 0 to 1
  23806. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  23807. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  23808. * @returns impostor the rope imposter
  23809. */
  23810. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  23811. /**
  23812. * Will keep this body still, in a sleep mode.
  23813. * @returns the physics imposter
  23814. */
  23815. sleep(): PhysicsImpostor;
  23816. /**
  23817. * Wake the body up.
  23818. * @returns The physics imposter
  23819. */
  23820. wakeUp(): PhysicsImpostor;
  23821. /**
  23822. * Clones the physics imposter
  23823. * @param newObject The physics imposter clones to this physics-enabled object
  23824. * @returns A nullable physics imposter
  23825. */
  23826. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23827. /**
  23828. * Disposes the physics imposter
  23829. */
  23830. dispose(): void;
  23831. /**
  23832. * Sets the delta position
  23833. * @param position The delta position amount
  23834. */
  23835. setDeltaPosition(position: Vector3): void;
  23836. /**
  23837. * Sets the delta rotation
  23838. * @param rotation The delta rotation amount
  23839. */
  23840. setDeltaRotation(rotation: Quaternion): void;
  23841. /**
  23842. * Gets the box size of the physics imposter and stores the result in the input parameter
  23843. * @param result Stores the box size
  23844. * @returns The physics imposter
  23845. */
  23846. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  23847. /**
  23848. * Gets the radius of the physics imposter
  23849. * @returns Radius of the physics imposter
  23850. */
  23851. getRadius(): number;
  23852. /**
  23853. * Sync a bone with this impostor
  23854. * @param bone The bone to sync to the impostor.
  23855. * @param boneMesh The mesh that the bone is influencing.
  23856. * @param jointPivot The pivot of the joint / bone in local space.
  23857. * @param distToJoint Optional distance from the impostor to the joint.
  23858. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  23859. */
  23860. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  23861. /**
  23862. * Sync impostor to a bone
  23863. * @param bone The bone that the impostor will be synced to.
  23864. * @param boneMesh The mesh that the bone is influencing.
  23865. * @param jointPivot The pivot of the joint / bone in local space.
  23866. * @param distToJoint Optional distance from the impostor to the joint.
  23867. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  23868. * @param boneAxis Optional vector3 axis the bone is aligned with
  23869. */
  23870. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  23871. /**
  23872. * No-Imposter type
  23873. */
  23874. static NoImpostor: number;
  23875. /**
  23876. * Sphere-Imposter type
  23877. */
  23878. static SphereImpostor: number;
  23879. /**
  23880. * Box-Imposter type
  23881. */
  23882. static BoxImpostor: number;
  23883. /**
  23884. * Plane-Imposter type
  23885. */
  23886. static PlaneImpostor: number;
  23887. /**
  23888. * Mesh-imposter type
  23889. */
  23890. static MeshImpostor: number;
  23891. /**
  23892. * Capsule-Impostor type (Ammo.js plugin only)
  23893. */
  23894. static CapsuleImpostor: number;
  23895. /**
  23896. * Cylinder-Imposter type
  23897. */
  23898. static CylinderImpostor: number;
  23899. /**
  23900. * Particle-Imposter type
  23901. */
  23902. static ParticleImpostor: number;
  23903. /**
  23904. * Heightmap-Imposter type
  23905. */
  23906. static HeightmapImpostor: number;
  23907. /**
  23908. * ConvexHull-Impostor type (Ammo.js plugin only)
  23909. */
  23910. static ConvexHullImpostor: number;
  23911. /**
  23912. * Rope-Imposter type
  23913. */
  23914. static RopeImpostor: number;
  23915. /**
  23916. * Cloth-Imposter type
  23917. */
  23918. static ClothImpostor: number;
  23919. /**
  23920. * Softbody-Imposter type
  23921. */
  23922. static SoftbodyImpostor: number;
  23923. }
  23924. }
  23925. declare module "babylonjs/Meshes/mesh" {
  23926. import { Observable } from "babylonjs/Misc/observable";
  23927. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  23928. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  23929. import { Camera } from "babylonjs/Cameras/camera";
  23930. import { Scene } from "babylonjs/scene";
  23931. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  23932. import { Color4 } from "babylonjs/Maths/math.color";
  23933. import { Engine } from "babylonjs/Engines/engine";
  23934. import { Node } from "babylonjs/node";
  23935. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  23936. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  23937. import { Buffer } from "babylonjs/Meshes/buffer";
  23938. import { Geometry } from "babylonjs/Meshes/geometry";
  23939. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23940. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23941. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  23942. import { Effect } from "babylonjs/Materials/effect";
  23943. import { Material } from "babylonjs/Materials/material";
  23944. import { Skeleton } from "babylonjs/Bones/skeleton";
  23945. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  23946. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  23947. import { Path3D } from "babylonjs/Maths/math.path";
  23948. import { Plane } from "babylonjs/Maths/math.plane";
  23949. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23950. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  23951. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  23952. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  23953. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23954. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  23955. /**
  23956. * @hidden
  23957. **/
  23958. export class _CreationDataStorage {
  23959. closePath?: boolean;
  23960. closeArray?: boolean;
  23961. idx: number[];
  23962. dashSize: number;
  23963. gapSize: number;
  23964. path3D: Path3D;
  23965. pathArray: Vector3[][];
  23966. arc: number;
  23967. radius: number;
  23968. cap: number;
  23969. tessellation: number;
  23970. }
  23971. /**
  23972. * @hidden
  23973. **/
  23974. class _InstanceDataStorage {
  23975. visibleInstances: any;
  23976. batchCache: _InstancesBatch;
  23977. instancesBufferSize: number;
  23978. instancesBuffer: Nullable<Buffer>;
  23979. instancesData: Float32Array;
  23980. overridenInstanceCount: number;
  23981. isFrozen: boolean;
  23982. previousBatch: Nullable<_InstancesBatch>;
  23983. hardwareInstancedRendering: boolean;
  23984. sideOrientation: number;
  23985. }
  23986. /**
  23987. * @hidden
  23988. **/
  23989. export class _InstancesBatch {
  23990. mustReturn: boolean;
  23991. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  23992. renderSelf: boolean[];
  23993. hardwareInstancedRendering: boolean[];
  23994. }
  23995. /**
  23996. * Class used to represent renderable models
  23997. */
  23998. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  23999. /**
  24000. * Mesh side orientation : usually the external or front surface
  24001. */
  24002. static readonly FRONTSIDE: number;
  24003. /**
  24004. * Mesh side orientation : usually the internal or back surface
  24005. */
  24006. static readonly BACKSIDE: number;
  24007. /**
  24008. * Mesh side orientation : both internal and external or front and back surfaces
  24009. */
  24010. static readonly DOUBLESIDE: number;
  24011. /**
  24012. * Mesh side orientation : by default, `FRONTSIDE`
  24013. */
  24014. static readonly DEFAULTSIDE: number;
  24015. /**
  24016. * Mesh cap setting : no cap
  24017. */
  24018. static readonly NO_CAP: number;
  24019. /**
  24020. * Mesh cap setting : one cap at the beginning of the mesh
  24021. */
  24022. static readonly CAP_START: number;
  24023. /**
  24024. * Mesh cap setting : one cap at the end of the mesh
  24025. */
  24026. static readonly CAP_END: number;
  24027. /**
  24028. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24029. */
  24030. static readonly CAP_ALL: number;
  24031. /**
  24032. * Mesh pattern setting : no flip or rotate
  24033. */
  24034. static readonly NO_FLIP: number;
  24035. /**
  24036. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24037. */
  24038. static readonly FLIP_TILE: number;
  24039. /**
  24040. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24041. */
  24042. static readonly ROTATE_TILE: number;
  24043. /**
  24044. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24045. */
  24046. static readonly FLIP_ROW: number;
  24047. /**
  24048. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24049. */
  24050. static readonly ROTATE_ROW: number;
  24051. /**
  24052. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24053. */
  24054. static readonly FLIP_N_ROTATE_TILE: number;
  24055. /**
  24056. * Mesh pattern setting : rotate pattern and rotate
  24057. */
  24058. static readonly FLIP_N_ROTATE_ROW: number;
  24059. /**
  24060. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24061. */
  24062. static readonly CENTER: number;
  24063. /**
  24064. * Mesh tile positioning : part tiles on left
  24065. */
  24066. static readonly LEFT: number;
  24067. /**
  24068. * Mesh tile positioning : part tiles on right
  24069. */
  24070. static readonly RIGHT: number;
  24071. /**
  24072. * Mesh tile positioning : part tiles on top
  24073. */
  24074. static readonly TOP: number;
  24075. /**
  24076. * Mesh tile positioning : part tiles on bottom
  24077. */
  24078. static readonly BOTTOM: number;
  24079. /**
  24080. * Gets the default side orientation.
  24081. * @param orientation the orientation to value to attempt to get
  24082. * @returns the default orientation
  24083. * @hidden
  24084. */
  24085. static _GetDefaultSideOrientation(orientation?: number): number;
  24086. private _internalMeshDataInfo;
  24087. /**
  24088. * An event triggered before rendering the mesh
  24089. */
  24090. readonly onBeforeRenderObservable: Observable<Mesh>;
  24091. /**
  24092. * An event triggered before binding the mesh
  24093. */
  24094. readonly onBeforeBindObservable: Observable<Mesh>;
  24095. /**
  24096. * An event triggered after rendering the mesh
  24097. */
  24098. readonly onAfterRenderObservable: Observable<Mesh>;
  24099. /**
  24100. * An event triggered before drawing the mesh
  24101. */
  24102. readonly onBeforeDrawObservable: Observable<Mesh>;
  24103. private _onBeforeDrawObserver;
  24104. /**
  24105. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24106. */
  24107. onBeforeDraw: () => void;
  24108. readonly hasInstances: boolean;
  24109. /**
  24110. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24111. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24112. */
  24113. delayLoadState: number;
  24114. /**
  24115. * Gets the list of instances created from this mesh
  24116. * it is not supposed to be modified manually.
  24117. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24118. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24119. */
  24120. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24121. /**
  24122. * Gets the file containing delay loading data for this mesh
  24123. */
  24124. delayLoadingFile: string;
  24125. /** @hidden */
  24126. _binaryInfo: any;
  24127. /**
  24128. * User defined function used to change how LOD level selection is done
  24129. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24130. */
  24131. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24132. /**
  24133. * Gets or sets the morph target manager
  24134. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24135. */
  24136. morphTargetManager: Nullable<MorphTargetManager>;
  24137. /** @hidden */
  24138. _creationDataStorage: Nullable<_CreationDataStorage>;
  24139. /** @hidden */
  24140. _geometry: Nullable<Geometry>;
  24141. /** @hidden */
  24142. _delayInfo: Array<string>;
  24143. /** @hidden */
  24144. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24145. /** @hidden */
  24146. _instanceDataStorage: _InstanceDataStorage;
  24147. private _effectiveMaterial;
  24148. /** @hidden */
  24149. _shouldGenerateFlatShading: boolean;
  24150. /** @hidden */
  24151. _originalBuilderSideOrientation: number;
  24152. /**
  24153. * Use this property to change the original side orientation defined at construction time
  24154. */
  24155. overrideMaterialSideOrientation: Nullable<number>;
  24156. /**
  24157. * Gets the source mesh (the one used to clone this one from)
  24158. */
  24159. readonly source: Nullable<Mesh>;
  24160. /**
  24161. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24162. */
  24163. isUnIndexed: boolean;
  24164. /**
  24165. * @constructor
  24166. * @param name The value used by scene.getMeshByName() to do a lookup.
  24167. * @param scene The scene to add this mesh to.
  24168. * @param parent The parent of this mesh, if it has one
  24169. * @param source An optional Mesh from which geometry is shared, cloned.
  24170. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24171. * When false, achieved by calling a clone(), also passing False.
  24172. * This will make creation of children, recursive.
  24173. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24174. */
  24175. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24176. instantiateHierarychy(newParent?: Nullable<TransformNode>): Nullable<TransformNode>;
  24177. /**
  24178. * Gets the class name
  24179. * @returns the string "Mesh".
  24180. */
  24181. getClassName(): string;
  24182. /** @hidden */
  24183. readonly _isMesh: boolean;
  24184. /**
  24185. * Returns a description of this mesh
  24186. * @param fullDetails define if full details about this mesh must be used
  24187. * @returns a descriptive string representing this mesh
  24188. */
  24189. toString(fullDetails?: boolean): string;
  24190. /** @hidden */
  24191. _unBindEffect(): void;
  24192. /**
  24193. * Gets a boolean indicating if this mesh has LOD
  24194. */
  24195. readonly hasLODLevels: boolean;
  24196. /**
  24197. * Gets the list of MeshLODLevel associated with the current mesh
  24198. * @returns an array of MeshLODLevel
  24199. */
  24200. getLODLevels(): MeshLODLevel[];
  24201. private _sortLODLevels;
  24202. /**
  24203. * Add a mesh as LOD level triggered at the given distance.
  24204. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24205. * @param distance The distance from the center of the object to show this level
  24206. * @param mesh The mesh to be added as LOD level (can be null)
  24207. * @return This mesh (for chaining)
  24208. */
  24209. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24210. /**
  24211. * Returns the LOD level mesh at the passed distance or null if not found.
  24212. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24213. * @param distance The distance from the center of the object to show this level
  24214. * @returns a Mesh or `null`
  24215. */
  24216. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24217. /**
  24218. * Remove a mesh from the LOD array
  24219. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24220. * @param mesh defines the mesh to be removed
  24221. * @return This mesh (for chaining)
  24222. */
  24223. removeLODLevel(mesh: Mesh): Mesh;
  24224. /**
  24225. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24226. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24227. * @param camera defines the camera to use to compute distance
  24228. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24229. * @return This mesh (for chaining)
  24230. */
  24231. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24232. /**
  24233. * Gets the mesh internal Geometry object
  24234. */
  24235. readonly geometry: Nullable<Geometry>;
  24236. /**
  24237. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24238. * @returns the total number of vertices
  24239. */
  24240. getTotalVertices(): number;
  24241. /**
  24242. * Returns the content of an associated vertex buffer
  24243. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24244. * - VertexBuffer.PositionKind
  24245. * - VertexBuffer.UVKind
  24246. * - VertexBuffer.UV2Kind
  24247. * - VertexBuffer.UV3Kind
  24248. * - VertexBuffer.UV4Kind
  24249. * - VertexBuffer.UV5Kind
  24250. * - VertexBuffer.UV6Kind
  24251. * - VertexBuffer.ColorKind
  24252. * - VertexBuffer.MatricesIndicesKind
  24253. * - VertexBuffer.MatricesIndicesExtraKind
  24254. * - VertexBuffer.MatricesWeightsKind
  24255. * - VertexBuffer.MatricesWeightsExtraKind
  24256. * @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
  24257. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24258. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24259. */
  24260. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24261. /**
  24262. * Returns the mesh VertexBuffer object from the requested `kind`
  24263. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24264. * - VertexBuffer.PositionKind
  24265. * - VertexBuffer.NormalKind
  24266. * - VertexBuffer.UVKind
  24267. * - VertexBuffer.UV2Kind
  24268. * - VertexBuffer.UV3Kind
  24269. * - VertexBuffer.UV4Kind
  24270. * - VertexBuffer.UV5Kind
  24271. * - VertexBuffer.UV6Kind
  24272. * - VertexBuffer.ColorKind
  24273. * - VertexBuffer.MatricesIndicesKind
  24274. * - VertexBuffer.MatricesIndicesExtraKind
  24275. * - VertexBuffer.MatricesWeightsKind
  24276. * - VertexBuffer.MatricesWeightsExtraKind
  24277. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24278. */
  24279. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24280. /**
  24281. * Tests if a specific vertex buffer is associated with this mesh
  24282. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24283. * - VertexBuffer.PositionKind
  24284. * - VertexBuffer.NormalKind
  24285. * - VertexBuffer.UVKind
  24286. * - VertexBuffer.UV2Kind
  24287. * - VertexBuffer.UV3Kind
  24288. * - VertexBuffer.UV4Kind
  24289. * - VertexBuffer.UV5Kind
  24290. * - VertexBuffer.UV6Kind
  24291. * - VertexBuffer.ColorKind
  24292. * - VertexBuffer.MatricesIndicesKind
  24293. * - VertexBuffer.MatricesIndicesExtraKind
  24294. * - VertexBuffer.MatricesWeightsKind
  24295. * - VertexBuffer.MatricesWeightsExtraKind
  24296. * @returns a boolean
  24297. */
  24298. isVerticesDataPresent(kind: string): boolean;
  24299. /**
  24300. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24301. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24302. * - VertexBuffer.PositionKind
  24303. * - VertexBuffer.UVKind
  24304. * - VertexBuffer.UV2Kind
  24305. * - VertexBuffer.UV3Kind
  24306. * - VertexBuffer.UV4Kind
  24307. * - VertexBuffer.UV5Kind
  24308. * - VertexBuffer.UV6Kind
  24309. * - VertexBuffer.ColorKind
  24310. * - VertexBuffer.MatricesIndicesKind
  24311. * - VertexBuffer.MatricesIndicesExtraKind
  24312. * - VertexBuffer.MatricesWeightsKind
  24313. * - VertexBuffer.MatricesWeightsExtraKind
  24314. * @returns a boolean
  24315. */
  24316. isVertexBufferUpdatable(kind: string): boolean;
  24317. /**
  24318. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24319. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24320. * - VertexBuffer.PositionKind
  24321. * - VertexBuffer.NormalKind
  24322. * - VertexBuffer.UVKind
  24323. * - VertexBuffer.UV2Kind
  24324. * - VertexBuffer.UV3Kind
  24325. * - VertexBuffer.UV4Kind
  24326. * - VertexBuffer.UV5Kind
  24327. * - VertexBuffer.UV6Kind
  24328. * - VertexBuffer.ColorKind
  24329. * - VertexBuffer.MatricesIndicesKind
  24330. * - VertexBuffer.MatricesIndicesExtraKind
  24331. * - VertexBuffer.MatricesWeightsKind
  24332. * - VertexBuffer.MatricesWeightsExtraKind
  24333. * @returns an array of strings
  24334. */
  24335. getVerticesDataKinds(): string[];
  24336. /**
  24337. * Returns a positive integer : the total number of indices in this mesh geometry.
  24338. * @returns the numner of indices or zero if the mesh has no geometry.
  24339. */
  24340. getTotalIndices(): number;
  24341. /**
  24342. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24343. * @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.
  24344. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24345. * @returns the indices array or an empty array if the mesh has no geometry
  24346. */
  24347. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24348. readonly isBlocked: boolean;
  24349. /**
  24350. * Determine if the current mesh is ready to be rendered
  24351. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24352. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24353. * @returns true if all associated assets are ready (material, textures, shaders)
  24354. */
  24355. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24356. /**
  24357. * 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.
  24358. */
  24359. readonly areNormalsFrozen: boolean;
  24360. /**
  24361. * 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.
  24362. * @returns the current mesh
  24363. */
  24364. freezeNormals(): Mesh;
  24365. /**
  24366. * 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
  24367. * @returns the current mesh
  24368. */
  24369. unfreezeNormals(): Mesh;
  24370. /**
  24371. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24372. */
  24373. overridenInstanceCount: number;
  24374. /** @hidden */
  24375. _preActivate(): Mesh;
  24376. /** @hidden */
  24377. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24378. /** @hidden */
  24379. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24380. /**
  24381. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24382. * This means the mesh underlying bounding box and sphere are recomputed.
  24383. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24384. * @returns the current mesh
  24385. */
  24386. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24387. /** @hidden */
  24388. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24389. /**
  24390. * This function will subdivide the mesh into multiple submeshes
  24391. * @param count defines the expected number of submeshes
  24392. */
  24393. subdivide(count: number): void;
  24394. /**
  24395. * Copy a FloatArray into a specific associated vertex buffer
  24396. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24397. * - VertexBuffer.PositionKind
  24398. * - VertexBuffer.UVKind
  24399. * - VertexBuffer.UV2Kind
  24400. * - VertexBuffer.UV3Kind
  24401. * - VertexBuffer.UV4Kind
  24402. * - VertexBuffer.UV5Kind
  24403. * - VertexBuffer.UV6Kind
  24404. * - VertexBuffer.ColorKind
  24405. * - VertexBuffer.MatricesIndicesKind
  24406. * - VertexBuffer.MatricesIndicesExtraKind
  24407. * - VertexBuffer.MatricesWeightsKind
  24408. * - VertexBuffer.MatricesWeightsExtraKind
  24409. * @param data defines the data source
  24410. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24411. * @param stride defines the data stride size (can be null)
  24412. * @returns the current mesh
  24413. */
  24414. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24415. /**
  24416. * Flags an associated vertex buffer as updatable
  24417. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24418. * - VertexBuffer.PositionKind
  24419. * - VertexBuffer.UVKind
  24420. * - VertexBuffer.UV2Kind
  24421. * - VertexBuffer.UV3Kind
  24422. * - VertexBuffer.UV4Kind
  24423. * - VertexBuffer.UV5Kind
  24424. * - VertexBuffer.UV6Kind
  24425. * - VertexBuffer.ColorKind
  24426. * - VertexBuffer.MatricesIndicesKind
  24427. * - VertexBuffer.MatricesIndicesExtraKind
  24428. * - VertexBuffer.MatricesWeightsKind
  24429. * - VertexBuffer.MatricesWeightsExtraKind
  24430. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24431. */
  24432. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24433. /**
  24434. * Sets the mesh global Vertex Buffer
  24435. * @param buffer defines the buffer to use
  24436. * @returns the current mesh
  24437. */
  24438. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24439. /**
  24440. * Update a specific associated vertex buffer
  24441. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24442. * - VertexBuffer.PositionKind
  24443. * - VertexBuffer.UVKind
  24444. * - VertexBuffer.UV2Kind
  24445. * - VertexBuffer.UV3Kind
  24446. * - VertexBuffer.UV4Kind
  24447. * - VertexBuffer.UV5Kind
  24448. * - VertexBuffer.UV6Kind
  24449. * - VertexBuffer.ColorKind
  24450. * - VertexBuffer.MatricesIndicesKind
  24451. * - VertexBuffer.MatricesIndicesExtraKind
  24452. * - VertexBuffer.MatricesWeightsKind
  24453. * - VertexBuffer.MatricesWeightsExtraKind
  24454. * @param data defines the data source
  24455. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24456. * @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)
  24457. * @returns the current mesh
  24458. */
  24459. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24460. /**
  24461. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24462. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24463. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24464. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24465. * @returns the current mesh
  24466. */
  24467. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24468. /**
  24469. * Creates a un-shared specific occurence of the geometry for the mesh.
  24470. * @returns the current mesh
  24471. */
  24472. makeGeometryUnique(): Mesh;
  24473. /**
  24474. * Set the index buffer of this mesh
  24475. * @param indices defines the source data
  24476. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24477. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24478. * @returns the current mesh
  24479. */
  24480. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  24481. /**
  24482. * Update the current index buffer
  24483. * @param indices defines the source data
  24484. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  24485. * @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)
  24486. * @returns the current mesh
  24487. */
  24488. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  24489. /**
  24490. * Invert the geometry to move from a right handed system to a left handed one.
  24491. * @returns the current mesh
  24492. */
  24493. toLeftHanded(): Mesh;
  24494. /** @hidden */
  24495. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  24496. /** @hidden */
  24497. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  24498. /**
  24499. * Registers for this mesh a javascript function called just before the rendering process
  24500. * @param func defines the function to call before rendering this mesh
  24501. * @returns the current mesh
  24502. */
  24503. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24504. /**
  24505. * Disposes a previously registered javascript function called before the rendering
  24506. * @param func defines the function to remove
  24507. * @returns the current mesh
  24508. */
  24509. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24510. /**
  24511. * Registers for this mesh a javascript function called just after the rendering is complete
  24512. * @param func defines the function to call after rendering this mesh
  24513. * @returns the current mesh
  24514. */
  24515. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24516. /**
  24517. * Disposes a previously registered javascript function called after the rendering.
  24518. * @param func defines the function to remove
  24519. * @returns the current mesh
  24520. */
  24521. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24522. /** @hidden */
  24523. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  24524. /** @hidden */
  24525. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  24526. /** @hidden */
  24527. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  24528. /** @hidden */
  24529. _rebuild(): void;
  24530. /** @hidden */
  24531. _freeze(): void;
  24532. /** @hidden */
  24533. _unFreeze(): void;
  24534. /**
  24535. * 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
  24536. * @param subMesh defines the subMesh to render
  24537. * @param enableAlphaMode defines if alpha mode can be changed
  24538. * @returns the current mesh
  24539. */
  24540. render(subMesh: SubMesh, enableAlphaMode: boolean): Mesh;
  24541. private _onBeforeDraw;
  24542. /**
  24543. * Renormalize the mesh and patch it up if there are no weights
  24544. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  24545. * However in the case of zero weights then we set just a single influence to 1.
  24546. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  24547. */
  24548. cleanMatrixWeights(): void;
  24549. private normalizeSkinFourWeights;
  24550. private normalizeSkinWeightsAndExtra;
  24551. /**
  24552. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  24553. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  24554. * the user know there was an issue with importing the mesh
  24555. * @returns a validation object with skinned, valid and report string
  24556. */
  24557. validateSkinning(): {
  24558. skinned: boolean;
  24559. valid: boolean;
  24560. report: string;
  24561. };
  24562. /** @hidden */
  24563. _checkDelayState(): Mesh;
  24564. private _queueLoad;
  24565. /**
  24566. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  24567. * A mesh is in the frustum if its bounding box intersects the frustum
  24568. * @param frustumPlanes defines the frustum to test
  24569. * @returns true if the mesh is in the frustum planes
  24570. */
  24571. isInFrustum(frustumPlanes: Plane[]): boolean;
  24572. /**
  24573. * Sets the mesh material by the material or multiMaterial `id` property
  24574. * @param id is a string identifying the material or the multiMaterial
  24575. * @returns the current mesh
  24576. */
  24577. setMaterialByID(id: string): Mesh;
  24578. /**
  24579. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  24580. * @returns an array of IAnimatable
  24581. */
  24582. getAnimatables(): IAnimatable[];
  24583. /**
  24584. * Modifies the mesh geometry according to the passed transformation matrix.
  24585. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  24586. * The mesh normals are modified using the same transformation.
  24587. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24588. * @param transform defines the transform matrix to use
  24589. * @see http://doc.babylonjs.com/resources/baking_transformations
  24590. * @returns the current mesh
  24591. */
  24592. bakeTransformIntoVertices(transform: Matrix): Mesh;
  24593. /**
  24594. * Modifies the mesh geometry according to its own current World Matrix.
  24595. * The mesh World Matrix is then reset.
  24596. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  24597. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24598. * @see http://doc.babylonjs.com/resources/baking_transformations
  24599. * @returns the current mesh
  24600. */
  24601. bakeCurrentTransformIntoVertices(): Mesh;
  24602. /** @hidden */
  24603. readonly _positions: Nullable<Vector3[]>;
  24604. /** @hidden */
  24605. _resetPointsArrayCache(): Mesh;
  24606. /** @hidden */
  24607. _generatePointsArray(): boolean;
  24608. /**
  24609. * Returns a new Mesh object generated from the current mesh properties.
  24610. * This method must not get confused with createInstance()
  24611. * @param name is a string, the name given to the new mesh
  24612. * @param newParent can be any Node object (default `null`)
  24613. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  24614. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  24615. * @returns a new mesh
  24616. */
  24617. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  24618. /**
  24619. * Releases resources associated with this mesh.
  24620. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  24621. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  24622. */
  24623. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  24624. /**
  24625. * Modifies the mesh geometry according to a displacement map.
  24626. * 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.
  24627. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24628. * @param url is a string, the URL from the image file is to be downloaded.
  24629. * @param minHeight is the lower limit of the displacement.
  24630. * @param maxHeight is the upper limit of the displacement.
  24631. * @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.
  24632. * @param uvOffset is an optional vector2 used to offset UV.
  24633. * @param uvScale is an optional vector2 used to scale UV.
  24634. * @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.
  24635. * @returns the Mesh.
  24636. */
  24637. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  24638. /**
  24639. * Modifies the mesh geometry according to a displacementMap buffer.
  24640. * 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.
  24641. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24642. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  24643. * @param heightMapWidth is the width of the buffer image.
  24644. * @param heightMapHeight is the height of the buffer image.
  24645. * @param minHeight is the lower limit of the displacement.
  24646. * @param maxHeight is the upper limit of the displacement.
  24647. * @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.
  24648. * @param uvOffset is an optional vector2 used to offset UV.
  24649. * @param uvScale is an optional vector2 used to scale UV.
  24650. * @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.
  24651. * @returns the Mesh.
  24652. */
  24653. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  24654. /**
  24655. * Modify the mesh to get a flat shading rendering.
  24656. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  24657. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  24658. * @returns current mesh
  24659. */
  24660. convertToFlatShadedMesh(): Mesh;
  24661. /**
  24662. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  24663. * In other words, more vertices, no more indices and a single bigger VBO.
  24664. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  24665. * @returns current mesh
  24666. */
  24667. convertToUnIndexedMesh(): Mesh;
  24668. /**
  24669. * Inverses facet orientations.
  24670. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24671. * @param flipNormals will also inverts the normals
  24672. * @returns current mesh
  24673. */
  24674. flipFaces(flipNormals?: boolean): Mesh;
  24675. /**
  24676. * Increase the number of facets and hence vertices in a mesh
  24677. * Vertex normals are interpolated from existing vertex normals
  24678. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24679. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  24680. */
  24681. increaseVertices(numberPerEdge: number): void;
  24682. /**
  24683. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  24684. * This will undo any application of covertToFlatShadedMesh
  24685. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24686. */
  24687. forceSharedVertices(): void;
  24688. /** @hidden */
  24689. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  24690. /** @hidden */
  24691. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  24692. /**
  24693. * Creates a new InstancedMesh object from the mesh model.
  24694. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24695. * @param name defines the name of the new instance
  24696. * @returns a new InstancedMesh
  24697. */
  24698. createInstance(name: string): InstancedMesh;
  24699. /**
  24700. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  24701. * After this call, all the mesh instances have the same submeshes than the current mesh.
  24702. * @returns the current mesh
  24703. */
  24704. synchronizeInstances(): Mesh;
  24705. /**
  24706. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  24707. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  24708. * This should be used together with the simplification to avoid disappearing triangles.
  24709. * @param successCallback an optional success callback to be called after the optimization finished.
  24710. * @returns the current mesh
  24711. */
  24712. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  24713. /**
  24714. * Serialize current mesh
  24715. * @param serializationObject defines the object which will receive the serialization data
  24716. */
  24717. serialize(serializationObject: any): void;
  24718. /** @hidden */
  24719. _syncGeometryWithMorphTargetManager(): void;
  24720. /** @hidden */
  24721. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  24722. /**
  24723. * Returns a new Mesh object parsed from the source provided.
  24724. * @param parsedMesh is the source
  24725. * @param scene defines the hosting scene
  24726. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  24727. * @returns a new Mesh
  24728. */
  24729. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  24730. /**
  24731. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  24732. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  24733. * @param name defines the name of the mesh to create
  24734. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  24735. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  24736. * @param closePath creates a seam between the first and the last points of each path of the path array
  24737. * @param offset is taken in account only if the `pathArray` is containing a single path
  24738. * @param scene defines the hosting scene
  24739. * @param updatable defines if the mesh must be flagged as updatable
  24740. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24741. * @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)
  24742. * @returns a new Mesh
  24743. */
  24744. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  24745. /**
  24746. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  24747. * @param name defines the name of the mesh to create
  24748. * @param radius sets the radius size (float) of the polygon (default 0.5)
  24749. * @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
  24750. * @param scene defines the hosting scene
  24751. * @param updatable defines if the mesh must be flagged as updatable
  24752. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24753. * @returns a new Mesh
  24754. */
  24755. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  24756. /**
  24757. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  24758. * @param name defines the name of the mesh to create
  24759. * @param size sets the size (float) of each box side (default 1)
  24760. * @param scene defines the hosting scene
  24761. * @param updatable defines if the mesh must be flagged as updatable
  24762. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24763. * @returns a new Mesh
  24764. */
  24765. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  24766. /**
  24767. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  24768. * @param name defines the name of the mesh to create
  24769. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  24770. * @param diameter sets the diameter size (float) of the sphere (default 1)
  24771. * @param scene defines the hosting scene
  24772. * @param updatable defines if the mesh must be flagged as updatable
  24773. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24774. * @returns a new Mesh
  24775. */
  24776. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24777. /**
  24778. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  24779. * @param name defines the name of the mesh to create
  24780. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  24781. * @param diameter sets the diameter size (float) of the sphere (default 1)
  24782. * @param scene defines the hosting scene
  24783. * @returns a new Mesh
  24784. */
  24785. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  24786. /**
  24787. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  24788. * @param name defines the name of the mesh to create
  24789. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  24790. * @param diameterTop set the top cap diameter (floats, default 1)
  24791. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  24792. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  24793. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  24794. * @param scene defines the hosting scene
  24795. * @param updatable defines if the mesh must be flagged as updatable
  24796. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24797. * @returns a new Mesh
  24798. */
  24799. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  24800. /**
  24801. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  24802. * @param name defines the name of the mesh to create
  24803. * @param diameter sets the diameter size (float) of the torus (default 1)
  24804. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  24805. * @param tessellation sets the number of torus sides (postive integer, default 16)
  24806. * @param scene defines the hosting scene
  24807. * @param updatable defines if the mesh must be flagged as updatable
  24808. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24809. * @returns a new Mesh
  24810. */
  24811. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24812. /**
  24813. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  24814. * @param name defines the name of the mesh to create
  24815. * @param radius sets the global radius size (float) of the torus knot (default 2)
  24816. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  24817. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  24818. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  24819. * @param p the number of windings on X axis (positive integers, default 2)
  24820. * @param q the number of windings on Y axis (positive integers, default 3)
  24821. * @param scene defines the hosting scene
  24822. * @param updatable defines if the mesh must be flagged as updatable
  24823. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24824. * @returns a new Mesh
  24825. */
  24826. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24827. /**
  24828. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  24829. * @param name defines the name of the mesh to create
  24830. * @param points is an array successive Vector3
  24831. * @param scene defines the hosting scene
  24832. * @param updatable defines if the mesh must be flagged as updatable
  24833. * @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).
  24834. * @returns a new Mesh
  24835. */
  24836. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  24837. /**
  24838. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  24839. * @param name defines the name of the mesh to create
  24840. * @param points is an array successive Vector3
  24841. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  24842. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  24843. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  24844. * @param scene defines the hosting scene
  24845. * @param updatable defines if the mesh must be flagged as updatable
  24846. * @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)
  24847. * @returns a new Mesh
  24848. */
  24849. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  24850. /**
  24851. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  24852. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  24853. * 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.
  24854. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  24855. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  24856. * Remember you can only change the shape positions, not their number when updating a polygon.
  24857. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  24858. * @param name defines the name of the mesh to create
  24859. * @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
  24860. * @param scene defines the hosting scene
  24861. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  24862. * @param updatable defines if the mesh must be flagged as updatable
  24863. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24864. * @param earcutInjection can be used to inject your own earcut reference
  24865. * @returns a new Mesh
  24866. */
  24867. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  24868. /**
  24869. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  24870. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  24871. * @param name defines the name of the mesh to create
  24872. * @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
  24873. * @param depth defines the height of extrusion
  24874. * @param scene defines the hosting scene
  24875. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  24876. * @param updatable defines if the mesh must be flagged as updatable
  24877. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24878. * @param earcutInjection can be used to inject your own earcut reference
  24879. * @returns a new Mesh
  24880. */
  24881. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  24882. /**
  24883. * Creates an extruded shape mesh.
  24884. * 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
  24885. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  24886. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  24887. * @param name defines the name of the mesh to create
  24888. * @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
  24889. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  24890. * @param scale is the value to scale the shape
  24891. * @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
  24892. * @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
  24893. * @param scene defines the hosting scene
  24894. * @param updatable defines if the mesh must be flagged as updatable
  24895. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24896. * @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)
  24897. * @returns a new Mesh
  24898. */
  24899. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  24900. /**
  24901. * Creates an custom extruded shape mesh.
  24902. * The custom extrusion is a parametric shape.
  24903. * It has no predefined shape. Its final shape will depend on the input parameters.
  24904. * Please consider using the same method from the MeshBuilder class instead
  24905. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  24906. * @param name defines the name of the mesh to create
  24907. * @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
  24908. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  24909. * @param scaleFunction is a custom Javascript function called on each path point
  24910. * @param rotationFunction is a custom Javascript function called on each path point
  24911. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  24912. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  24913. * @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
  24914. * @param scene defines the hosting scene
  24915. * @param updatable defines if the mesh must be flagged as updatable
  24916. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24917. * @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)
  24918. * @returns a new Mesh
  24919. */
  24920. 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;
  24921. /**
  24922. * Creates lathe mesh.
  24923. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  24924. * Please consider using the same method from the MeshBuilder class instead
  24925. * @param name defines the name of the mesh to create
  24926. * @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
  24927. * @param radius is the radius value of the lathe
  24928. * @param tessellation is the side number of the lathe.
  24929. * @param scene defines the hosting scene
  24930. * @param updatable defines if the mesh must be flagged as updatable
  24931. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24932. * @returns a new Mesh
  24933. */
  24934. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24935. /**
  24936. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  24937. * @param name defines the name of the mesh to create
  24938. * @param size sets the size (float) of both sides of the plane at once (default 1)
  24939. * @param scene defines the hosting scene
  24940. * @param updatable defines if the mesh must be flagged as updatable
  24941. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24942. * @returns a new Mesh
  24943. */
  24944. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24945. /**
  24946. * Creates a ground mesh.
  24947. * Please consider using the same method from the MeshBuilder class instead
  24948. * @param name defines the name of the mesh to create
  24949. * @param width set the width of the ground
  24950. * @param height set the height of the ground
  24951. * @param subdivisions sets the number of subdivisions per side
  24952. * @param scene defines the hosting scene
  24953. * @param updatable defines if the mesh must be flagged as updatable
  24954. * @returns a new Mesh
  24955. */
  24956. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  24957. /**
  24958. * Creates a tiled ground mesh.
  24959. * Please consider using the same method from the MeshBuilder class instead
  24960. * @param name defines the name of the mesh to create
  24961. * @param xmin set the ground minimum X coordinate
  24962. * @param zmin set the ground minimum Y coordinate
  24963. * @param xmax set the ground maximum X coordinate
  24964. * @param zmax set the ground maximum Z coordinate
  24965. * @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
  24966. * @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
  24967. * @param scene defines the hosting scene
  24968. * @param updatable defines if the mesh must be flagged as updatable
  24969. * @returns a new Mesh
  24970. */
  24971. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  24972. w: number;
  24973. h: number;
  24974. }, precision: {
  24975. w: number;
  24976. h: number;
  24977. }, scene: Scene, updatable?: boolean): Mesh;
  24978. /**
  24979. * Creates a ground mesh from a height map.
  24980. * Please consider using the same method from the MeshBuilder class instead
  24981. * @see http://doc.babylonjs.com/babylon101/height_map
  24982. * @param name defines the name of the mesh to create
  24983. * @param url sets the URL of the height map image resource
  24984. * @param width set the ground width size
  24985. * @param height set the ground height size
  24986. * @param subdivisions sets the number of subdivision per side
  24987. * @param minHeight is the minimum altitude on the ground
  24988. * @param maxHeight is the maximum altitude on the ground
  24989. * @param scene defines the hosting scene
  24990. * @param updatable defines if the mesh must be flagged as updatable
  24991. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  24992. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  24993. * @returns a new Mesh
  24994. */
  24995. 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;
  24996. /**
  24997. * Creates a tube mesh.
  24998. * The tube is a parametric shape.
  24999. * It has no predefined shape. Its final shape will depend on the input parameters.
  25000. * Please consider using the same method from the MeshBuilder class instead
  25001. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25002. * @param name defines the name of the mesh to create
  25003. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25004. * @param radius sets the tube radius size
  25005. * @param tessellation is the number of sides on the tubular surface
  25006. * @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
  25007. * @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
  25008. * @param scene defines the hosting scene
  25009. * @param updatable defines if the mesh must be flagged as updatable
  25010. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25011. * @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)
  25012. * @returns a new Mesh
  25013. */
  25014. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25015. (i: number, distance: number): number;
  25016. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25017. /**
  25018. * Creates a polyhedron mesh.
  25019. * Please consider using the same method from the MeshBuilder class instead.
  25020. * * 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
  25021. * * The parameter `size` (positive float, default 1) sets the polygon size
  25022. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25023. * * 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`
  25024. * * 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
  25025. * * 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)`)
  25026. * * 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
  25027. * * 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
  25028. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25029. * * If you create a double-sided mesh, you can choose what parts of 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
  25030. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25031. * @param name defines the name of the mesh to create
  25032. * @param options defines the options used to create the mesh
  25033. * @param scene defines the hosting scene
  25034. * @returns a new Mesh
  25035. */
  25036. static CreatePolyhedron(name: string, options: {
  25037. type?: number;
  25038. size?: number;
  25039. sizeX?: number;
  25040. sizeY?: number;
  25041. sizeZ?: number;
  25042. custom?: any;
  25043. faceUV?: Vector4[];
  25044. faceColors?: Color4[];
  25045. updatable?: boolean;
  25046. sideOrientation?: number;
  25047. }, scene: Scene): Mesh;
  25048. /**
  25049. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25050. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25051. * * 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`)
  25052. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25053. * * 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
  25054. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25055. * * If you create a double-sided mesh, you can choose what parts of 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
  25056. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25057. * @param name defines the name of the mesh
  25058. * @param options defines the options used to create the mesh
  25059. * @param scene defines the hosting scene
  25060. * @returns a new Mesh
  25061. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25062. */
  25063. static CreateIcoSphere(name: string, options: {
  25064. radius?: number;
  25065. flat?: boolean;
  25066. subdivisions?: number;
  25067. sideOrientation?: number;
  25068. updatable?: boolean;
  25069. }, scene: Scene): Mesh;
  25070. /**
  25071. * Creates a decal mesh.
  25072. * Please consider using the same method from the MeshBuilder class instead.
  25073. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25074. * @param name defines the name of the mesh
  25075. * @param sourceMesh defines the mesh receiving the decal
  25076. * @param position sets the position of the decal in world coordinates
  25077. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25078. * @param size sets the decal scaling
  25079. * @param angle sets the angle to rotate the decal
  25080. * @returns a new Mesh
  25081. */
  25082. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25083. /**
  25084. * Prepare internal position array for software CPU skinning
  25085. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25086. */
  25087. setPositionsForCPUSkinning(): Float32Array;
  25088. /**
  25089. * Prepare internal normal array for software CPU skinning
  25090. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25091. */
  25092. setNormalsForCPUSkinning(): Float32Array;
  25093. /**
  25094. * Updates the vertex buffer by applying transformation from the bones
  25095. * @param skeleton defines the skeleton to apply to current mesh
  25096. * @returns the current mesh
  25097. */
  25098. applySkeleton(skeleton: Skeleton): Mesh;
  25099. /**
  25100. * 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
  25101. * @param meshes defines the list of meshes to scan
  25102. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25103. */
  25104. static MinMax(meshes: AbstractMesh[]): {
  25105. min: Vector3;
  25106. max: Vector3;
  25107. };
  25108. /**
  25109. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25110. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25111. * @returns a vector3
  25112. */
  25113. static Center(meshesOrMinMaxVector: {
  25114. min: Vector3;
  25115. max: Vector3;
  25116. } | AbstractMesh[]): Vector3;
  25117. /**
  25118. * Merge the array of meshes into a single mesh for performance reasons.
  25119. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25120. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25121. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25122. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25123. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25124. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25125. * @returns a new mesh
  25126. */
  25127. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25128. /** @hidden */
  25129. addInstance(instance: InstancedMesh): void;
  25130. /** @hidden */
  25131. removeInstance(instance: InstancedMesh): void;
  25132. }
  25133. }
  25134. declare module "babylonjs/Cameras/camera" {
  25135. import { SmartArray } from "babylonjs/Misc/smartArray";
  25136. import { Observable } from "babylonjs/Misc/observable";
  25137. import { Nullable } from "babylonjs/types";
  25138. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25139. import { Scene } from "babylonjs/scene";
  25140. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25141. import { Node } from "babylonjs/node";
  25142. import { Mesh } from "babylonjs/Meshes/mesh";
  25143. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25144. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25145. import { Viewport } from "babylonjs/Maths/math.viewport";
  25146. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25147. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25148. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25149. import { Ray } from "babylonjs/Culling/ray";
  25150. /**
  25151. * This is the base class of all the camera used in the application.
  25152. * @see http://doc.babylonjs.com/features/cameras
  25153. */
  25154. export class Camera extends Node {
  25155. /** @hidden */
  25156. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25157. /**
  25158. * This is the default projection mode used by the cameras.
  25159. * It helps recreating a feeling of perspective and better appreciate depth.
  25160. * This is the best way to simulate real life cameras.
  25161. */
  25162. static readonly PERSPECTIVE_CAMERA: number;
  25163. /**
  25164. * This helps creating camera with an orthographic mode.
  25165. * 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.
  25166. */
  25167. static readonly ORTHOGRAPHIC_CAMERA: number;
  25168. /**
  25169. * This is the default FOV mode for perspective cameras.
  25170. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25171. */
  25172. static readonly FOVMODE_VERTICAL_FIXED: number;
  25173. /**
  25174. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25175. */
  25176. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25177. /**
  25178. * This specifies ther is no need for a camera rig.
  25179. * Basically only one eye is rendered corresponding to the camera.
  25180. */
  25181. static readonly RIG_MODE_NONE: number;
  25182. /**
  25183. * Simulates a camera Rig with one blue eye and one red eye.
  25184. * This can be use with 3d blue and red glasses.
  25185. */
  25186. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25187. /**
  25188. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25189. */
  25190. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25191. /**
  25192. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25193. */
  25194. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25195. /**
  25196. * Defines that both eyes of the camera will be rendered over under each other.
  25197. */
  25198. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25199. /**
  25200. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25201. */
  25202. static readonly RIG_MODE_VR: number;
  25203. /**
  25204. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25205. */
  25206. static readonly RIG_MODE_WEBVR: number;
  25207. /**
  25208. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25209. */
  25210. static readonly RIG_MODE_CUSTOM: number;
  25211. /**
  25212. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25213. */
  25214. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25215. /**
  25216. * Define the input manager associated with the camera.
  25217. */
  25218. inputs: CameraInputsManager<Camera>;
  25219. /** @hidden */
  25220. _position: Vector3;
  25221. /**
  25222. * Define the current local position of the camera in the scene
  25223. */
  25224. position: Vector3;
  25225. /**
  25226. * The vector the camera should consider as up.
  25227. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25228. */
  25229. upVector: Vector3;
  25230. /**
  25231. * Define the current limit on the left side for an orthographic camera
  25232. * In scene unit
  25233. */
  25234. orthoLeft: Nullable<number>;
  25235. /**
  25236. * Define the current limit on the right side for an orthographic camera
  25237. * In scene unit
  25238. */
  25239. orthoRight: Nullable<number>;
  25240. /**
  25241. * Define the current limit on the bottom side for an orthographic camera
  25242. * In scene unit
  25243. */
  25244. orthoBottom: Nullable<number>;
  25245. /**
  25246. * Define the current limit on the top side for an orthographic camera
  25247. * In scene unit
  25248. */
  25249. orthoTop: Nullable<number>;
  25250. /**
  25251. * Field Of View is set in Radians. (default is 0.8)
  25252. */
  25253. fov: number;
  25254. /**
  25255. * Define the minimum distance the camera can see from.
  25256. * This is important to note that the depth buffer are not infinite and the closer it starts
  25257. * the more your scene might encounter depth fighting issue.
  25258. */
  25259. minZ: number;
  25260. /**
  25261. * Define the maximum distance the camera can see to.
  25262. * This is important to note that the depth buffer are not infinite and the further it end
  25263. * the more your scene might encounter depth fighting issue.
  25264. */
  25265. maxZ: number;
  25266. /**
  25267. * Define the default inertia of the camera.
  25268. * This helps giving a smooth feeling to the camera movement.
  25269. */
  25270. inertia: number;
  25271. /**
  25272. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25273. */
  25274. mode: number;
  25275. /**
  25276. * Define wether the camera is intermediate.
  25277. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25278. */
  25279. isIntermediate: boolean;
  25280. /**
  25281. * Define the viewport of the camera.
  25282. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25283. */
  25284. viewport: Viewport;
  25285. /**
  25286. * Restricts the camera to viewing objects with the same layerMask.
  25287. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25288. */
  25289. layerMask: number;
  25290. /**
  25291. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25292. */
  25293. fovMode: number;
  25294. /**
  25295. * Rig mode of the camera.
  25296. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25297. * This is normally controlled byt the camera themselves as internal use.
  25298. */
  25299. cameraRigMode: number;
  25300. /**
  25301. * Defines the distance between both "eyes" in case of a RIG
  25302. */
  25303. interaxialDistance: number;
  25304. /**
  25305. * Defines if stereoscopic rendering is done side by side or over under.
  25306. */
  25307. isStereoscopicSideBySide: boolean;
  25308. /**
  25309. * 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
  25310. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25311. * else in the scene. (Eg. security camera)
  25312. *
  25313. * 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)
  25314. */
  25315. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25316. /**
  25317. * When set, the camera will render to this render target instead of the default canvas
  25318. *
  25319. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25320. */
  25321. outputRenderTarget: Nullable<RenderTargetTexture>;
  25322. /**
  25323. * Observable triggered when the camera view matrix has changed.
  25324. */
  25325. onViewMatrixChangedObservable: Observable<Camera>;
  25326. /**
  25327. * Observable triggered when the camera Projection matrix has changed.
  25328. */
  25329. onProjectionMatrixChangedObservable: Observable<Camera>;
  25330. /**
  25331. * Observable triggered when the inputs have been processed.
  25332. */
  25333. onAfterCheckInputsObservable: Observable<Camera>;
  25334. /**
  25335. * Observable triggered when reset has been called and applied to the camera.
  25336. */
  25337. onRestoreStateObservable: Observable<Camera>;
  25338. /** @hidden */
  25339. _cameraRigParams: any;
  25340. /** @hidden */
  25341. _rigCameras: Camera[];
  25342. /** @hidden */
  25343. _rigPostProcess: Nullable<PostProcess>;
  25344. protected _webvrViewMatrix: Matrix;
  25345. /** @hidden */
  25346. _skipRendering: boolean;
  25347. /** @hidden */
  25348. _projectionMatrix: Matrix;
  25349. /** @hidden */
  25350. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25351. /** @hidden */
  25352. _activeMeshes: SmartArray<AbstractMesh>;
  25353. protected _globalPosition: Vector3;
  25354. /** @hidden */
  25355. _computedViewMatrix: Matrix;
  25356. private _doNotComputeProjectionMatrix;
  25357. private _transformMatrix;
  25358. private _frustumPlanes;
  25359. private _refreshFrustumPlanes;
  25360. private _storedFov;
  25361. private _stateStored;
  25362. /**
  25363. * Instantiates a new camera object.
  25364. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25365. * @see http://doc.babylonjs.com/features/cameras
  25366. * @param name Defines the name of the camera in the scene
  25367. * @param position Defines the position of the camera
  25368. * @param scene Defines the scene the camera belongs too
  25369. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25370. */
  25371. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25372. /**
  25373. * Store current camera state (fov, position, etc..)
  25374. * @returns the camera
  25375. */
  25376. storeState(): Camera;
  25377. /**
  25378. * Restores the camera state values if it has been stored. You must call storeState() first
  25379. */
  25380. protected _restoreStateValues(): boolean;
  25381. /**
  25382. * Restored camera state. You must call storeState() first.
  25383. * @returns true if restored and false otherwise
  25384. */
  25385. restoreState(): boolean;
  25386. /**
  25387. * Gets the class name of the camera.
  25388. * @returns the class name
  25389. */
  25390. getClassName(): string;
  25391. /** @hidden */
  25392. readonly _isCamera: boolean;
  25393. /**
  25394. * Gets a string representation of the camera useful for debug purpose.
  25395. * @param fullDetails Defines that a more verboe level of logging is required
  25396. * @returns the string representation
  25397. */
  25398. toString(fullDetails?: boolean): string;
  25399. /**
  25400. * Gets the current world space position of the camera.
  25401. */
  25402. readonly globalPosition: Vector3;
  25403. /**
  25404. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25405. * @returns the active meshe list
  25406. */
  25407. getActiveMeshes(): SmartArray<AbstractMesh>;
  25408. /**
  25409. * Check wether a mesh is part of the current active mesh list of the camera
  25410. * @param mesh Defines the mesh to check
  25411. * @returns true if active, false otherwise
  25412. */
  25413. isActiveMesh(mesh: Mesh): boolean;
  25414. /**
  25415. * Is this camera ready to be used/rendered
  25416. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25417. * @return true if the camera is ready
  25418. */
  25419. isReady(completeCheck?: boolean): boolean;
  25420. /** @hidden */
  25421. _initCache(): void;
  25422. /** @hidden */
  25423. _updateCache(ignoreParentClass?: boolean): void;
  25424. /** @hidden */
  25425. _isSynchronized(): boolean;
  25426. /** @hidden */
  25427. _isSynchronizedViewMatrix(): boolean;
  25428. /** @hidden */
  25429. _isSynchronizedProjectionMatrix(): boolean;
  25430. /**
  25431. * Attach the input controls to a specific dom element to get the input from.
  25432. * @param element Defines the element the controls should be listened from
  25433. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25434. */
  25435. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25436. /**
  25437. * Detach the current controls from the specified dom element.
  25438. * @param element Defines the element to stop listening the inputs from
  25439. */
  25440. detachControl(element: HTMLElement): void;
  25441. /**
  25442. * Update the camera state according to the different inputs gathered during the frame.
  25443. */
  25444. update(): void;
  25445. /** @hidden */
  25446. _checkInputs(): void;
  25447. /** @hidden */
  25448. readonly rigCameras: Camera[];
  25449. /**
  25450. * Gets the post process used by the rig cameras
  25451. */
  25452. readonly rigPostProcess: Nullable<PostProcess>;
  25453. /**
  25454. * Internal, gets the first post proces.
  25455. * @returns the first post process to be run on this camera.
  25456. */
  25457. _getFirstPostProcess(): Nullable<PostProcess>;
  25458. private _cascadePostProcessesToRigCams;
  25459. /**
  25460. * Attach a post process to the camera.
  25461. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25462. * @param postProcess The post process to attach to the camera
  25463. * @param insertAt The position of the post process in case several of them are in use in the scene
  25464. * @returns the position the post process has been inserted at
  25465. */
  25466. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25467. /**
  25468. * Detach a post process to the camera.
  25469. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25470. * @param postProcess The post process to detach from the camera
  25471. */
  25472. detachPostProcess(postProcess: PostProcess): void;
  25473. /**
  25474. * Gets the current world matrix of the camera
  25475. */
  25476. getWorldMatrix(): Matrix;
  25477. /** @hidden */
  25478. _getViewMatrix(): Matrix;
  25479. /**
  25480. * Gets the current view matrix of the camera.
  25481. * @param force forces the camera to recompute the matrix without looking at the cached state
  25482. * @returns the view matrix
  25483. */
  25484. getViewMatrix(force?: boolean): Matrix;
  25485. /**
  25486. * Freeze the projection matrix.
  25487. * It will prevent the cache check of the camera projection compute and can speed up perf
  25488. * if no parameter of the camera are meant to change
  25489. * @param projection Defines manually a projection if necessary
  25490. */
  25491. freezeProjectionMatrix(projection?: Matrix): void;
  25492. /**
  25493. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  25494. */
  25495. unfreezeProjectionMatrix(): void;
  25496. /**
  25497. * Gets the current projection matrix of the camera.
  25498. * @param force forces the camera to recompute the matrix without looking at the cached state
  25499. * @returns the projection matrix
  25500. */
  25501. getProjectionMatrix(force?: boolean): Matrix;
  25502. /**
  25503. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  25504. * @returns a Matrix
  25505. */
  25506. getTransformationMatrix(): Matrix;
  25507. private _updateFrustumPlanes;
  25508. /**
  25509. * Checks if a cullable object (mesh...) is in the camera frustum
  25510. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  25511. * @param target The object to check
  25512. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  25513. * @returns true if the object is in frustum otherwise false
  25514. */
  25515. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  25516. /**
  25517. * Checks if a cullable object (mesh...) is in the camera frustum
  25518. * Unlike isInFrustum this cheks the full bounding box
  25519. * @param target The object to check
  25520. * @returns true if the object is in frustum otherwise false
  25521. */
  25522. isCompletelyInFrustum(target: ICullable): boolean;
  25523. /**
  25524. * Gets a ray in the forward direction from the camera.
  25525. * @param length Defines the length of the ray to create
  25526. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  25527. * @param origin Defines the start point of the ray which defaults to the camera position
  25528. * @returns the forward ray
  25529. */
  25530. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  25531. /**
  25532. * Releases resources associated with this node.
  25533. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25534. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25535. */
  25536. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25537. /** @hidden */
  25538. _isLeftCamera: boolean;
  25539. /**
  25540. * Gets the left camera of a rig setup in case of Rigged Camera
  25541. */
  25542. readonly isLeftCamera: boolean;
  25543. /** @hidden */
  25544. _isRightCamera: boolean;
  25545. /**
  25546. * Gets the right camera of a rig setup in case of Rigged Camera
  25547. */
  25548. readonly isRightCamera: boolean;
  25549. /**
  25550. * Gets the left camera of a rig setup in case of Rigged Camera
  25551. */
  25552. readonly leftCamera: Nullable<FreeCamera>;
  25553. /**
  25554. * Gets the right camera of a rig setup in case of Rigged Camera
  25555. */
  25556. readonly rightCamera: Nullable<FreeCamera>;
  25557. /**
  25558. * Gets the left camera target of a rig setup in case of Rigged Camera
  25559. * @returns the target position
  25560. */
  25561. getLeftTarget(): Nullable<Vector3>;
  25562. /**
  25563. * Gets the right camera target of a rig setup in case of Rigged Camera
  25564. * @returns the target position
  25565. */
  25566. getRightTarget(): Nullable<Vector3>;
  25567. /**
  25568. * @hidden
  25569. */
  25570. setCameraRigMode(mode: number, rigParams: any): void;
  25571. /** @hidden */
  25572. static _setStereoscopicRigMode(camera: Camera): void;
  25573. /** @hidden */
  25574. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  25575. /** @hidden */
  25576. static _setVRRigMode(camera: Camera, rigParams: any): void;
  25577. /** @hidden */
  25578. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  25579. /** @hidden */
  25580. _getVRProjectionMatrix(): Matrix;
  25581. protected _updateCameraRotationMatrix(): void;
  25582. protected _updateWebVRCameraRotationMatrix(): void;
  25583. /**
  25584. * This function MUST be overwritten by the different WebVR cameras available.
  25585. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25586. * @hidden
  25587. */
  25588. _getWebVRProjectionMatrix(): Matrix;
  25589. /**
  25590. * This function MUST be overwritten by the different WebVR cameras available.
  25591. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25592. * @hidden
  25593. */
  25594. _getWebVRViewMatrix(): Matrix;
  25595. /** @hidden */
  25596. setCameraRigParameter(name: string, value: any): void;
  25597. /**
  25598. * needs to be overridden by children so sub has required properties to be copied
  25599. * @hidden
  25600. */
  25601. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  25602. /**
  25603. * May need to be overridden by children
  25604. * @hidden
  25605. */
  25606. _updateRigCameras(): void;
  25607. /** @hidden */
  25608. _setupInputs(): void;
  25609. /**
  25610. * Serialiaze the camera setup to a json represention
  25611. * @returns the JSON representation
  25612. */
  25613. serialize(): any;
  25614. /**
  25615. * Clones the current camera.
  25616. * @param name The cloned camera name
  25617. * @returns the cloned camera
  25618. */
  25619. clone(name: string): Camera;
  25620. /**
  25621. * Gets the direction of the camera relative to a given local axis.
  25622. * @param localAxis Defines the reference axis to provide a relative direction.
  25623. * @return the direction
  25624. */
  25625. getDirection(localAxis: Vector3): Vector3;
  25626. /**
  25627. * Returns the current camera absolute rotation
  25628. */
  25629. readonly absoluteRotation: Quaternion;
  25630. /**
  25631. * Gets the direction of the camera relative to a given local axis into a passed vector.
  25632. * @param localAxis Defines the reference axis to provide a relative direction.
  25633. * @param result Defines the vector to store the result in
  25634. */
  25635. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  25636. /**
  25637. * Gets a camera constructor for a given camera type
  25638. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  25639. * @param name The name of the camera the result will be able to instantiate
  25640. * @param scene The scene the result will construct the camera in
  25641. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  25642. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  25643. * @returns a factory method to construc the camera
  25644. */
  25645. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  25646. /**
  25647. * Compute the world matrix of the camera.
  25648. * @returns the camera workd matrix
  25649. */
  25650. computeWorldMatrix(): Matrix;
  25651. /**
  25652. * Parse a JSON and creates the camera from the parsed information
  25653. * @param parsedCamera The JSON to parse
  25654. * @param scene The scene to instantiate the camera in
  25655. * @returns the newly constructed camera
  25656. */
  25657. static Parse(parsedCamera: any, scene: Scene): Camera;
  25658. }
  25659. }
  25660. declare module "babylonjs/Meshes/Builders/discBuilder" {
  25661. import { Nullable } from "babylonjs/types";
  25662. import { Scene } from "babylonjs/scene";
  25663. import { Vector4 } from "babylonjs/Maths/math.vector";
  25664. import { Mesh } from "babylonjs/Meshes/mesh";
  25665. /**
  25666. * Class containing static functions to help procedurally build meshes
  25667. */
  25668. export class DiscBuilder {
  25669. /**
  25670. * Creates a plane polygonal mesh. By default, this is a disc
  25671. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  25672. * * 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
  25673. * * 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
  25674. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  25675. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25676. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25677. * @param name defines the name of the mesh
  25678. * @param options defines the options used to create the mesh
  25679. * @param scene defines the hosting scene
  25680. * @returns the plane polygonal mesh
  25681. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  25682. */
  25683. static CreateDisc(name: string, options: {
  25684. radius?: number;
  25685. tessellation?: number;
  25686. arc?: number;
  25687. updatable?: boolean;
  25688. sideOrientation?: number;
  25689. frontUVs?: Vector4;
  25690. backUVs?: Vector4;
  25691. }, scene?: Nullable<Scene>): Mesh;
  25692. }
  25693. }
  25694. declare module "babylonjs/Particles/solidParticleSystem" {
  25695. import { Vector3 } from "babylonjs/Maths/math.vector";
  25696. import { Mesh } from "babylonjs/Meshes/mesh";
  25697. import { Scene, IDisposable } from "babylonjs/scene";
  25698. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  25699. /**
  25700. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  25701. *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.
  25702. * The SPS is also a particle system. It provides some methods to manage the particles.
  25703. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  25704. *
  25705. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  25706. */
  25707. export class SolidParticleSystem implements IDisposable {
  25708. /**
  25709. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  25710. * Example : var p = SPS.particles[i];
  25711. */
  25712. particles: SolidParticle[];
  25713. /**
  25714. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  25715. */
  25716. nbParticles: number;
  25717. /**
  25718. * If the particles must ever face the camera (default false). Useful for planar particles.
  25719. */
  25720. billboard: boolean;
  25721. /**
  25722. * Recompute normals when adding a shape
  25723. */
  25724. recomputeNormals: boolean;
  25725. /**
  25726. * This a counter ofr your own usage. It's not set by any SPS functions.
  25727. */
  25728. counter: number;
  25729. /**
  25730. * The SPS name. This name is also given to the underlying mesh.
  25731. */
  25732. name: string;
  25733. /**
  25734. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  25735. */
  25736. mesh: Mesh;
  25737. /**
  25738. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  25739. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  25740. */
  25741. vars: any;
  25742. /**
  25743. * This array is populated when the SPS is set as 'pickable'.
  25744. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  25745. * Each element of this array is an object `{idx: int, faceId: int}`.
  25746. * `idx` is the picked particle index in the `SPS.particles` array
  25747. * `faceId` is the picked face index counted within this particle.
  25748. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  25749. */
  25750. pickedParticles: {
  25751. idx: number;
  25752. faceId: number;
  25753. }[];
  25754. /**
  25755. * This array is populated when `enableDepthSort` is set to true.
  25756. * Each element of this array is an instance of the class DepthSortedParticle.
  25757. */
  25758. depthSortedParticles: DepthSortedParticle[];
  25759. /**
  25760. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  25761. * @hidden
  25762. */
  25763. _bSphereOnly: boolean;
  25764. /**
  25765. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  25766. * @hidden
  25767. */
  25768. _bSphereRadiusFactor: number;
  25769. private _scene;
  25770. private _positions;
  25771. private _indices;
  25772. private _normals;
  25773. private _colors;
  25774. private _uvs;
  25775. private _indices32;
  25776. private _positions32;
  25777. private _normals32;
  25778. private _fixedNormal32;
  25779. private _colors32;
  25780. private _uvs32;
  25781. private _index;
  25782. private _updatable;
  25783. private _pickable;
  25784. private _isVisibilityBoxLocked;
  25785. private _alwaysVisible;
  25786. private _depthSort;
  25787. private _shapeCounter;
  25788. private _copy;
  25789. private _color;
  25790. private _computeParticleColor;
  25791. private _computeParticleTexture;
  25792. private _computeParticleRotation;
  25793. private _computeParticleVertex;
  25794. private _computeBoundingBox;
  25795. private _depthSortParticles;
  25796. private _camera;
  25797. private _mustUnrotateFixedNormals;
  25798. private _particlesIntersect;
  25799. private _needs32Bits;
  25800. /**
  25801. * Creates a SPS (Solid Particle System) object.
  25802. * @param name (String) is the SPS name, this will be the underlying mesh name.
  25803. * @param scene (Scene) is the scene in which the SPS is added.
  25804. * @param options defines the options of the sps e.g.
  25805. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  25806. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  25807. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  25808. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  25809. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  25810. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  25811. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  25812. */
  25813. constructor(name: string, scene: Scene, options?: {
  25814. updatable?: boolean;
  25815. isPickable?: boolean;
  25816. enableDepthSort?: boolean;
  25817. particleIntersection?: boolean;
  25818. boundingSphereOnly?: boolean;
  25819. bSphereRadiusFactor?: number;
  25820. });
  25821. /**
  25822. * Builds the SPS underlying mesh. Returns a standard Mesh.
  25823. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  25824. * @returns the created mesh
  25825. */
  25826. buildMesh(): Mesh;
  25827. /**
  25828. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  25829. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  25830. * Thus the particles generated from `digest()` have their property `position` set yet.
  25831. * @param mesh ( Mesh ) is the mesh to be digested
  25832. * @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
  25833. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  25834. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  25835. * @returns the current SPS
  25836. */
  25837. digest(mesh: Mesh, options?: {
  25838. facetNb?: number;
  25839. number?: number;
  25840. delta?: number;
  25841. }): SolidParticleSystem;
  25842. private _unrotateFixedNormals;
  25843. private _resetCopy;
  25844. private _meshBuilder;
  25845. private _posToShape;
  25846. private _uvsToShapeUV;
  25847. private _addParticle;
  25848. /**
  25849. * Adds some particles to the SPS from the model shape. Returns the shape id.
  25850. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  25851. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  25852. * @param nb (positive integer) the number of particles to be created from this model
  25853. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  25854. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  25855. * @returns the number of shapes in the system
  25856. */
  25857. addShape(mesh: Mesh, nb: number, options?: {
  25858. positionFunction?: any;
  25859. vertexFunction?: any;
  25860. }): number;
  25861. private _rebuildParticle;
  25862. /**
  25863. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  25864. * @returns the SPS.
  25865. */
  25866. rebuildMesh(): SolidParticleSystem;
  25867. /**
  25868. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  25869. * This method calls `updateParticle()` for each particle of the SPS.
  25870. * For an animated SPS, it is usually called within the render loop.
  25871. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  25872. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  25873. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  25874. * @returns the SPS.
  25875. */
  25876. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  25877. /**
  25878. * Disposes the SPS.
  25879. */
  25880. dispose(): void;
  25881. /**
  25882. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  25883. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25884. * @returns the SPS.
  25885. */
  25886. refreshVisibleSize(): SolidParticleSystem;
  25887. /**
  25888. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  25889. * @param size the size (float) of the visibility box
  25890. * note : this doesn't lock the SPS mesh bounding box.
  25891. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25892. */
  25893. setVisibilityBox(size: number): void;
  25894. /**
  25895. * Gets whether the SPS as always visible or not
  25896. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25897. */
  25898. /**
  25899. * Sets the SPS as always visible or not
  25900. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25901. */
  25902. isAlwaysVisible: boolean;
  25903. /**
  25904. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  25905. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25906. */
  25907. /**
  25908. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  25909. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25910. */
  25911. isVisibilityBoxLocked: boolean;
  25912. /**
  25913. * Tells to `setParticles()` to compute the particle rotations or not.
  25914. * Default value : true. The SPS is faster when it's set to false.
  25915. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  25916. */
  25917. /**
  25918. * Gets if `setParticles()` computes the particle rotations or not.
  25919. * Default value : true. The SPS is faster when it's set to false.
  25920. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  25921. */
  25922. computeParticleRotation: boolean;
  25923. /**
  25924. * Tells to `setParticles()` to compute the particle colors or not.
  25925. * Default value : true. The SPS is faster when it's set to false.
  25926. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  25927. */
  25928. /**
  25929. * Gets if `setParticles()` computes the particle colors or not.
  25930. * Default value : true. The SPS is faster when it's set to false.
  25931. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  25932. */
  25933. computeParticleColor: boolean;
  25934. /**
  25935. * Gets if `setParticles()` computes the particle textures or not.
  25936. * Default value : true. The SPS is faster when it's set to false.
  25937. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  25938. */
  25939. computeParticleTexture: boolean;
  25940. /**
  25941. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  25942. * Default value : false. The SPS is faster when it's set to false.
  25943. * Note : the particle custom vertex positions aren't stored values.
  25944. */
  25945. /**
  25946. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  25947. * Default value : false. The SPS is faster when it's set to false.
  25948. * Note : the particle custom vertex positions aren't stored values.
  25949. */
  25950. computeParticleVertex: boolean;
  25951. /**
  25952. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  25953. */
  25954. /**
  25955. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  25956. */
  25957. computeBoundingBox: boolean;
  25958. /**
  25959. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  25960. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  25961. * Default : `true`
  25962. */
  25963. /**
  25964. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  25965. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  25966. * Default : `true`
  25967. */
  25968. depthSortParticles: boolean;
  25969. /**
  25970. * This function does nothing. It may be overwritten to set all the particle first values.
  25971. * The SPS doesn't call this function, you may have to call it by your own.
  25972. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25973. */
  25974. initParticles(): void;
  25975. /**
  25976. * This function does nothing. It may be overwritten to recycle a particle.
  25977. * The SPS doesn't call this function, you may have to call it by your own.
  25978. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25979. * @param particle The particle to recycle
  25980. * @returns the recycled particle
  25981. */
  25982. recycleParticle(particle: SolidParticle): SolidParticle;
  25983. /**
  25984. * Updates a particle : this function should be overwritten by the user.
  25985. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  25986. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25987. * @example : just set a particle position or velocity and recycle conditions
  25988. * @param particle The particle to update
  25989. * @returns the updated particle
  25990. */
  25991. updateParticle(particle: SolidParticle): SolidParticle;
  25992. /**
  25993. * Updates a vertex of a particle : it can be overwritten by the user.
  25994. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  25995. * @param particle the current particle
  25996. * @param vertex the current index of the current particle
  25997. * @param pt the index of the current vertex in the particle shape
  25998. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  25999. * @example : just set a vertex particle position
  26000. * @returns the updated vertex
  26001. */
  26002. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26003. /**
  26004. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26005. * This does nothing and may be overwritten by the user.
  26006. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26007. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26008. * @param update the boolean update value actually passed to setParticles()
  26009. */
  26010. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26011. /**
  26012. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26013. * This will be passed three parameters.
  26014. * This does nothing and may be overwritten by the user.
  26015. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26016. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26017. * @param update the boolean update value actually passed to setParticles()
  26018. */
  26019. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26020. }
  26021. }
  26022. declare module "babylonjs/Particles/solidParticle" {
  26023. import { Nullable } from "babylonjs/types";
  26024. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26025. import { Color4 } from "babylonjs/Maths/math.color";
  26026. import { Mesh } from "babylonjs/Meshes/mesh";
  26027. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26028. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26029. import { Plane } from "babylonjs/Maths/math.plane";
  26030. /**
  26031. * Represents one particle of a solid particle system.
  26032. */
  26033. export class SolidParticle {
  26034. /**
  26035. * particle global index
  26036. */
  26037. idx: number;
  26038. /**
  26039. * The color of the particle
  26040. */
  26041. color: Nullable<Color4>;
  26042. /**
  26043. * The world space position of the particle.
  26044. */
  26045. position: Vector3;
  26046. /**
  26047. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26048. */
  26049. rotation: Vector3;
  26050. /**
  26051. * The world space rotation quaternion of the particle.
  26052. */
  26053. rotationQuaternion: Nullable<Quaternion>;
  26054. /**
  26055. * The scaling of the particle.
  26056. */
  26057. scaling: Vector3;
  26058. /**
  26059. * The uvs of the particle.
  26060. */
  26061. uvs: Vector4;
  26062. /**
  26063. * The current speed of the particle.
  26064. */
  26065. velocity: Vector3;
  26066. /**
  26067. * The pivot point in the particle local space.
  26068. */
  26069. pivot: Vector3;
  26070. /**
  26071. * Must the particle be translated from its pivot point in its local space ?
  26072. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26073. * Default : false
  26074. */
  26075. translateFromPivot: boolean;
  26076. /**
  26077. * Is the particle active or not ?
  26078. */
  26079. alive: boolean;
  26080. /**
  26081. * Is the particle visible or not ?
  26082. */
  26083. isVisible: boolean;
  26084. /**
  26085. * Index of this particle in the global "positions" array (Internal use)
  26086. * @hidden
  26087. */
  26088. _pos: number;
  26089. /**
  26090. * @hidden Index of this particle in the global "indices" array (Internal use)
  26091. */
  26092. _ind: number;
  26093. /**
  26094. * @hidden ModelShape of this particle (Internal use)
  26095. */
  26096. _model: ModelShape;
  26097. /**
  26098. * ModelShape id of this particle
  26099. */
  26100. shapeId: number;
  26101. /**
  26102. * Index of the particle in its shape id
  26103. */
  26104. idxInShape: number;
  26105. /**
  26106. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26107. */
  26108. _modelBoundingInfo: BoundingInfo;
  26109. /**
  26110. * @hidden Particle BoundingInfo object (Internal use)
  26111. */
  26112. _boundingInfo: BoundingInfo;
  26113. /**
  26114. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26115. */
  26116. _sps: SolidParticleSystem;
  26117. /**
  26118. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26119. */
  26120. _stillInvisible: boolean;
  26121. /**
  26122. * @hidden Last computed particle rotation matrix
  26123. */
  26124. _rotationMatrix: number[];
  26125. /**
  26126. * Parent particle Id, if any.
  26127. * Default null.
  26128. */
  26129. parentId: Nullable<number>;
  26130. /**
  26131. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26132. * The possible values are :
  26133. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26134. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26135. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26136. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26137. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26138. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26139. * */
  26140. cullingStrategy: number;
  26141. /**
  26142. * @hidden Internal global position in the SPS.
  26143. */
  26144. _globalPosition: Vector3;
  26145. /**
  26146. * Creates a Solid Particle object.
  26147. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26148. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  26149. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26150. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26151. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26152. * @param shapeId (integer) is the model shape identifier in the SPS.
  26153. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26154. * @param sps defines the sps it is associated to
  26155. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26156. */
  26157. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26158. /**
  26159. * Legacy support, changed scale to scaling
  26160. */
  26161. /**
  26162. * Legacy support, changed scale to scaling
  26163. */
  26164. scale: Vector3;
  26165. /**
  26166. * Legacy support, changed quaternion to rotationQuaternion
  26167. */
  26168. /**
  26169. * Legacy support, changed quaternion to rotationQuaternion
  26170. */
  26171. quaternion: Nullable<Quaternion>;
  26172. /**
  26173. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26174. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26175. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26176. * @returns true if it intersects
  26177. */
  26178. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26179. /**
  26180. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26181. * A particle is in the frustum if its bounding box intersects the frustum
  26182. * @param frustumPlanes defines the frustum to test
  26183. * @returns true if the particle is in the frustum planes
  26184. */
  26185. isInFrustum(frustumPlanes: Plane[]): boolean;
  26186. /**
  26187. * get the rotation matrix of the particle
  26188. * @hidden
  26189. */
  26190. getRotationMatrix(m: Matrix): void;
  26191. }
  26192. /**
  26193. * Represents the shape of the model used by one particle of a solid particle system.
  26194. * SPS internal tool, don't use it manually.
  26195. */
  26196. export class ModelShape {
  26197. /**
  26198. * The shape id
  26199. * @hidden
  26200. */
  26201. shapeID: number;
  26202. /**
  26203. * flat array of model positions (internal use)
  26204. * @hidden
  26205. */
  26206. _shape: Vector3[];
  26207. /**
  26208. * flat array of model UVs (internal use)
  26209. * @hidden
  26210. */
  26211. _shapeUV: number[];
  26212. /**
  26213. * length of the shape in the model indices array (internal use)
  26214. * @hidden
  26215. */
  26216. _indicesLength: number;
  26217. /**
  26218. * Custom position function (internal use)
  26219. * @hidden
  26220. */
  26221. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26222. /**
  26223. * Custom vertex function (internal use)
  26224. * @hidden
  26225. */
  26226. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26227. /**
  26228. * 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.
  26229. * SPS internal tool, don't use it manually.
  26230. * @hidden
  26231. */
  26232. constructor(id: number, shape: Vector3[], indicesLength: number, shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  26233. }
  26234. /**
  26235. * Represents a Depth Sorted Particle in the solid particle system.
  26236. */
  26237. export class DepthSortedParticle {
  26238. /**
  26239. * Index of the particle in the "indices" array
  26240. */
  26241. ind: number;
  26242. /**
  26243. * Length of the particle shape in the "indices" array
  26244. */
  26245. indicesLength: number;
  26246. /**
  26247. * Squared distance from the particle to the camera
  26248. */
  26249. sqDistance: number;
  26250. }
  26251. }
  26252. declare module "babylonjs/Collisions/meshCollisionData" {
  26253. import { Collider } from "babylonjs/Collisions/collider";
  26254. import { Vector3 } from "babylonjs/Maths/math.vector";
  26255. import { Nullable } from "babylonjs/types";
  26256. import { Observer } from "babylonjs/Misc/observable";
  26257. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26258. /**
  26259. * @hidden
  26260. */
  26261. export class _MeshCollisionData {
  26262. _checkCollisions: boolean;
  26263. _collisionMask: number;
  26264. _collisionGroup: number;
  26265. _collider: Nullable<Collider>;
  26266. _oldPositionForCollisions: Vector3;
  26267. _diffPositionForCollisions: Vector3;
  26268. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26269. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26270. }
  26271. }
  26272. declare module "babylonjs/Meshes/abstractMesh" {
  26273. import { Observable } from "babylonjs/Misc/observable";
  26274. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26275. import { Camera } from "babylonjs/Cameras/camera";
  26276. import { Scene, IDisposable } from "babylonjs/scene";
  26277. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26278. import { Node } from "babylonjs/node";
  26279. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26280. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26281. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26282. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26283. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26284. import { Material } from "babylonjs/Materials/material";
  26285. import { Light } from "babylonjs/Lights/light";
  26286. import { Skeleton } from "babylonjs/Bones/skeleton";
  26287. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26288. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26289. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26290. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26291. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26292. import { Plane } from "babylonjs/Maths/math.plane";
  26293. import { Ray } from "babylonjs/Culling/ray";
  26294. import { Collider } from "babylonjs/Collisions/collider";
  26295. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26296. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26297. /** @hidden */
  26298. class _FacetDataStorage {
  26299. facetPositions: Vector3[];
  26300. facetNormals: Vector3[];
  26301. facetPartitioning: number[][];
  26302. facetNb: number;
  26303. partitioningSubdivisions: number;
  26304. partitioningBBoxRatio: number;
  26305. facetDataEnabled: boolean;
  26306. facetParameters: any;
  26307. bbSize: Vector3;
  26308. subDiv: {
  26309. max: number;
  26310. X: number;
  26311. Y: number;
  26312. Z: number;
  26313. };
  26314. facetDepthSort: boolean;
  26315. facetDepthSortEnabled: boolean;
  26316. depthSortedIndices: IndicesArray;
  26317. depthSortedFacets: {
  26318. ind: number;
  26319. sqDistance: number;
  26320. }[];
  26321. facetDepthSortFunction: (f1: {
  26322. ind: number;
  26323. sqDistance: number;
  26324. }, f2: {
  26325. ind: number;
  26326. sqDistance: number;
  26327. }) => number;
  26328. facetDepthSortFrom: Vector3;
  26329. facetDepthSortOrigin: Vector3;
  26330. invertedMatrix: Matrix;
  26331. }
  26332. /**
  26333. * @hidden
  26334. **/
  26335. class _InternalAbstractMeshDataInfo {
  26336. _hasVertexAlpha: boolean;
  26337. _useVertexColors: boolean;
  26338. _numBoneInfluencers: number;
  26339. _applyFog: boolean;
  26340. _receiveShadows: boolean;
  26341. _facetData: _FacetDataStorage;
  26342. _visibility: number;
  26343. _skeleton: Nullable<Skeleton>;
  26344. _layerMask: number;
  26345. _computeBonesUsingShaders: boolean;
  26346. _isActive: boolean;
  26347. _onlyForInstances: boolean;
  26348. _isActiveIntermediate: boolean;
  26349. _onlyForInstancesIntermediate: boolean;
  26350. }
  26351. /**
  26352. * Class used to store all common mesh properties
  26353. */
  26354. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  26355. /** No occlusion */
  26356. static OCCLUSION_TYPE_NONE: number;
  26357. /** Occlusion set to optimisitic */
  26358. static OCCLUSION_TYPE_OPTIMISTIC: number;
  26359. /** Occlusion set to strict */
  26360. static OCCLUSION_TYPE_STRICT: number;
  26361. /** Use an accurante occlusion algorithm */
  26362. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  26363. /** Use a conservative occlusion algorithm */
  26364. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  26365. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  26366. * Test order :
  26367. * Is the bounding sphere outside the frustum ?
  26368. * If not, are the bounding box vertices outside the frustum ?
  26369. * It not, then the cullable object is in the frustum.
  26370. */
  26371. static readonly CULLINGSTRATEGY_STANDARD: number;
  26372. /** Culling strategy : Bounding Sphere Only.
  26373. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  26374. * It's also less accurate than the standard because some not visible objects can still be selected.
  26375. * Test : is the bounding sphere outside the frustum ?
  26376. * If not, then the cullable object is in the frustum.
  26377. */
  26378. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  26379. /** Culling strategy : Optimistic Inclusion.
  26380. * This in an inclusion test first, then the standard exclusion test.
  26381. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  26382. * 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.
  26383. * Anyway, it's as accurate as the standard strategy.
  26384. * Test :
  26385. * Is the cullable object bounding sphere center in the frustum ?
  26386. * If not, apply the default culling strategy.
  26387. */
  26388. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  26389. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  26390. * This in an inclusion test first, then the bounding sphere only exclusion test.
  26391. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  26392. * 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.
  26393. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  26394. * Test :
  26395. * Is the cullable object bounding sphere center in the frustum ?
  26396. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  26397. */
  26398. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  26399. /**
  26400. * No billboard
  26401. */
  26402. static readonly BILLBOARDMODE_NONE: number;
  26403. /** Billboard on X axis */
  26404. static readonly BILLBOARDMODE_X: number;
  26405. /** Billboard on Y axis */
  26406. static readonly BILLBOARDMODE_Y: number;
  26407. /** Billboard on Z axis */
  26408. static readonly BILLBOARDMODE_Z: number;
  26409. /** Billboard on all axes */
  26410. static readonly BILLBOARDMODE_ALL: number;
  26411. /** Billboard on using position instead of orientation */
  26412. static readonly BILLBOARDMODE_USE_POSITION: number;
  26413. /** @hidden */
  26414. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  26415. /**
  26416. * The culling strategy to use to check whether the mesh must be rendered or not.
  26417. * This value can be changed at any time and will be used on the next render mesh selection.
  26418. * The possible values are :
  26419. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26420. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26421. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26422. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26423. * Please read each static variable documentation to get details about the culling process.
  26424. * */
  26425. cullingStrategy: number;
  26426. /**
  26427. * Gets the number of facets in the mesh
  26428. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26429. */
  26430. readonly facetNb: number;
  26431. /**
  26432. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  26433. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26434. */
  26435. partitioningSubdivisions: number;
  26436. /**
  26437. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  26438. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  26439. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26440. */
  26441. partitioningBBoxRatio: number;
  26442. /**
  26443. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  26444. * Works only for updatable meshes.
  26445. * Doesn't work with multi-materials
  26446. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26447. */
  26448. mustDepthSortFacets: boolean;
  26449. /**
  26450. * The location (Vector3) where the facet depth sort must be computed from.
  26451. * By default, the active camera position.
  26452. * Used only when facet depth sort is enabled
  26453. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26454. */
  26455. facetDepthSortFrom: Vector3;
  26456. /**
  26457. * gets a boolean indicating if facetData is enabled
  26458. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26459. */
  26460. readonly isFacetDataEnabled: boolean;
  26461. /** @hidden */
  26462. _updateNonUniformScalingState(value: boolean): boolean;
  26463. /**
  26464. * An event triggered when this mesh collides with another one
  26465. */
  26466. onCollideObservable: Observable<AbstractMesh>;
  26467. /** Set a function to call when this mesh collides with another one */
  26468. onCollide: () => void;
  26469. /**
  26470. * An event triggered when the collision's position changes
  26471. */
  26472. onCollisionPositionChangeObservable: Observable<Vector3>;
  26473. /** Set a function to call when the collision's position changes */
  26474. onCollisionPositionChange: () => void;
  26475. /**
  26476. * An event triggered when material is changed
  26477. */
  26478. onMaterialChangedObservable: Observable<AbstractMesh>;
  26479. /**
  26480. * Gets or sets the orientation for POV movement & rotation
  26481. */
  26482. definedFacingForward: boolean;
  26483. /** @hidden */
  26484. _occlusionQuery: Nullable<WebGLQuery>;
  26485. /** @hidden */
  26486. _renderingGroup: Nullable<RenderingGroup>;
  26487. /**
  26488. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26489. */
  26490. /**
  26491. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26492. */
  26493. visibility: number;
  26494. /** Gets or sets the alpha index used to sort transparent meshes
  26495. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  26496. */
  26497. alphaIndex: number;
  26498. /**
  26499. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  26500. */
  26501. isVisible: boolean;
  26502. /**
  26503. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  26504. */
  26505. isPickable: boolean;
  26506. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  26507. showSubMeshesBoundingBox: boolean;
  26508. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  26509. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  26510. */
  26511. isBlocker: boolean;
  26512. /**
  26513. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  26514. */
  26515. enablePointerMoveEvents: boolean;
  26516. /**
  26517. * Specifies the rendering group id for this mesh (0 by default)
  26518. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  26519. */
  26520. renderingGroupId: number;
  26521. private _material;
  26522. /** Gets or sets current material */
  26523. material: Nullable<Material>;
  26524. /**
  26525. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  26526. * @see http://doc.babylonjs.com/babylon101/shadows
  26527. */
  26528. receiveShadows: boolean;
  26529. /** Defines color to use when rendering outline */
  26530. outlineColor: Color3;
  26531. /** Define width to use when rendering outline */
  26532. outlineWidth: number;
  26533. /** Defines color to use when rendering overlay */
  26534. overlayColor: Color3;
  26535. /** Defines alpha to use when rendering overlay */
  26536. overlayAlpha: number;
  26537. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  26538. hasVertexAlpha: boolean;
  26539. /** 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) */
  26540. useVertexColors: boolean;
  26541. /**
  26542. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  26543. */
  26544. computeBonesUsingShaders: boolean;
  26545. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  26546. numBoneInfluencers: number;
  26547. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  26548. applyFog: boolean;
  26549. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  26550. useOctreeForRenderingSelection: boolean;
  26551. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  26552. useOctreeForPicking: boolean;
  26553. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  26554. useOctreeForCollisions: boolean;
  26555. /**
  26556. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  26557. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  26558. */
  26559. layerMask: number;
  26560. /**
  26561. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  26562. */
  26563. alwaysSelectAsActiveMesh: boolean;
  26564. /**
  26565. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  26566. */
  26567. doNotSyncBoundingInfo: boolean;
  26568. /**
  26569. * Gets or sets the current action manager
  26570. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  26571. */
  26572. actionManager: Nullable<AbstractActionManager>;
  26573. private _meshCollisionData;
  26574. /**
  26575. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  26576. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26577. */
  26578. ellipsoid: Vector3;
  26579. /**
  26580. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  26581. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26582. */
  26583. ellipsoidOffset: Vector3;
  26584. /**
  26585. * Gets or sets a collision mask used to mask collisions (default is -1).
  26586. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26587. */
  26588. collisionMask: number;
  26589. /**
  26590. * Gets or sets the current collision group mask (-1 by default).
  26591. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26592. */
  26593. collisionGroup: number;
  26594. /**
  26595. * Defines edge width used when edgesRenderer is enabled
  26596. * @see https://www.babylonjs-playground.com/#10OJSG#13
  26597. */
  26598. edgesWidth: number;
  26599. /**
  26600. * Defines edge color used when edgesRenderer is enabled
  26601. * @see https://www.babylonjs-playground.com/#10OJSG#13
  26602. */
  26603. edgesColor: Color4;
  26604. /** @hidden */
  26605. _edgesRenderer: Nullable<IEdgesRenderer>;
  26606. /** @hidden */
  26607. _masterMesh: Nullable<AbstractMesh>;
  26608. /** @hidden */
  26609. _boundingInfo: Nullable<BoundingInfo>;
  26610. /** @hidden */
  26611. _renderId: number;
  26612. /**
  26613. * Gets or sets the list of subMeshes
  26614. * @see http://doc.babylonjs.com/how_to/multi_materials
  26615. */
  26616. subMeshes: SubMesh[];
  26617. /** @hidden */
  26618. _intersectionsInProgress: AbstractMesh[];
  26619. /** @hidden */
  26620. _unIndexed: boolean;
  26621. /** @hidden */
  26622. _lightSources: Light[];
  26623. /** Gets the list of lights affecting that mesh */
  26624. readonly lightSources: Light[];
  26625. /** @hidden */
  26626. readonly _positions: Nullable<Vector3[]>;
  26627. /** @hidden */
  26628. _waitingData: {
  26629. lods: Nullable<any>;
  26630. actions: Nullable<any>;
  26631. freezeWorldMatrix: Nullable<boolean>;
  26632. };
  26633. /** @hidden */
  26634. _bonesTransformMatrices: Nullable<Float32Array>;
  26635. /** @hidden */
  26636. _transformMatrixTexture: Nullable<RawTexture>;
  26637. /**
  26638. * Gets or sets a skeleton to apply skining transformations
  26639. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  26640. */
  26641. skeleton: Nullable<Skeleton>;
  26642. /**
  26643. * An event triggered when the mesh is rebuilt.
  26644. */
  26645. onRebuildObservable: Observable<AbstractMesh>;
  26646. /**
  26647. * Creates a new AbstractMesh
  26648. * @param name defines the name of the mesh
  26649. * @param scene defines the hosting scene
  26650. */
  26651. constructor(name: string, scene?: Nullable<Scene>);
  26652. /**
  26653. * Returns the string "AbstractMesh"
  26654. * @returns "AbstractMesh"
  26655. */
  26656. getClassName(): string;
  26657. /**
  26658. * Gets a string representation of the current mesh
  26659. * @param fullDetails defines a boolean indicating if full details must be included
  26660. * @returns a string representation of the current mesh
  26661. */
  26662. toString(fullDetails?: boolean): string;
  26663. /**
  26664. * @hidden
  26665. */
  26666. protected _getEffectiveParent(): Nullable<Node>;
  26667. /** @hidden */
  26668. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  26669. /** @hidden */
  26670. _rebuild(): void;
  26671. /** @hidden */
  26672. _resyncLightSources(): void;
  26673. /** @hidden */
  26674. _resyncLighSource(light: Light): void;
  26675. /** @hidden */
  26676. _unBindEffect(): void;
  26677. /** @hidden */
  26678. _removeLightSource(light: Light, dispose: boolean): void;
  26679. private _markSubMeshesAsDirty;
  26680. /** @hidden */
  26681. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  26682. /** @hidden */
  26683. _markSubMeshesAsAttributesDirty(): void;
  26684. /** @hidden */
  26685. _markSubMeshesAsMiscDirty(): void;
  26686. /**
  26687. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  26688. */
  26689. scaling: Vector3;
  26690. /**
  26691. * Returns true if the mesh is blocked. Implemented by child classes
  26692. */
  26693. readonly isBlocked: boolean;
  26694. /**
  26695. * Returns the mesh itself by default. Implemented by child classes
  26696. * @param camera defines the camera to use to pick the right LOD level
  26697. * @returns the currentAbstractMesh
  26698. */
  26699. getLOD(camera: Camera): Nullable<AbstractMesh>;
  26700. /**
  26701. * Returns 0 by default. Implemented by child classes
  26702. * @returns an integer
  26703. */
  26704. getTotalVertices(): number;
  26705. /**
  26706. * Returns a positive integer : the total number of indices in this mesh geometry.
  26707. * @returns the numner of indices or zero if the mesh has no geometry.
  26708. */
  26709. getTotalIndices(): number;
  26710. /**
  26711. * Returns null by default. Implemented by child classes
  26712. * @returns null
  26713. */
  26714. getIndices(): Nullable<IndicesArray>;
  26715. /**
  26716. * Returns the array of the requested vertex data kind. Implemented by child classes
  26717. * @param kind defines the vertex data kind to use
  26718. * @returns null
  26719. */
  26720. getVerticesData(kind: string): Nullable<FloatArray>;
  26721. /**
  26722. * Sets the vertex data of the mesh geometry for the requested `kind`.
  26723. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  26724. * Note that a new underlying VertexBuffer object is created each call.
  26725. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  26726. * @param kind defines vertex data kind:
  26727. * * VertexBuffer.PositionKind
  26728. * * VertexBuffer.UVKind
  26729. * * VertexBuffer.UV2Kind
  26730. * * VertexBuffer.UV3Kind
  26731. * * VertexBuffer.UV4Kind
  26732. * * VertexBuffer.UV5Kind
  26733. * * VertexBuffer.UV6Kind
  26734. * * VertexBuffer.ColorKind
  26735. * * VertexBuffer.MatricesIndicesKind
  26736. * * VertexBuffer.MatricesIndicesExtraKind
  26737. * * VertexBuffer.MatricesWeightsKind
  26738. * * VertexBuffer.MatricesWeightsExtraKind
  26739. * @param data defines the data source
  26740. * @param updatable defines if the data must be flagged as updatable (or static)
  26741. * @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
  26742. * @returns the current mesh
  26743. */
  26744. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  26745. /**
  26746. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  26747. * If the mesh has no geometry, it is simply returned as it is.
  26748. * @param kind defines vertex data kind:
  26749. * * VertexBuffer.PositionKind
  26750. * * VertexBuffer.UVKind
  26751. * * VertexBuffer.UV2Kind
  26752. * * VertexBuffer.UV3Kind
  26753. * * VertexBuffer.UV4Kind
  26754. * * VertexBuffer.UV5Kind
  26755. * * VertexBuffer.UV6Kind
  26756. * * VertexBuffer.ColorKind
  26757. * * VertexBuffer.MatricesIndicesKind
  26758. * * VertexBuffer.MatricesIndicesExtraKind
  26759. * * VertexBuffer.MatricesWeightsKind
  26760. * * VertexBuffer.MatricesWeightsExtraKind
  26761. * @param data defines the data source
  26762. * @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
  26763. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  26764. * @returns the current mesh
  26765. */
  26766. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  26767. /**
  26768. * Sets the mesh indices,
  26769. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  26770. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  26771. * @param totalVertices Defines the total number of vertices
  26772. * @returns the current mesh
  26773. */
  26774. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  26775. /**
  26776. * Gets a boolean indicating if specific vertex data is present
  26777. * @param kind defines the vertex data kind to use
  26778. * @returns true is data kind is present
  26779. */
  26780. isVerticesDataPresent(kind: string): boolean;
  26781. /**
  26782. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  26783. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  26784. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  26785. * @returns a BoundingInfo
  26786. */
  26787. getBoundingInfo(): BoundingInfo;
  26788. /**
  26789. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  26790. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  26791. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  26792. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  26793. * @returns the current mesh
  26794. */
  26795. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  26796. /**
  26797. * Overwrite the current bounding info
  26798. * @param boundingInfo defines the new bounding info
  26799. * @returns the current mesh
  26800. */
  26801. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  26802. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  26803. readonly useBones: boolean;
  26804. /** @hidden */
  26805. _preActivate(): void;
  26806. /** @hidden */
  26807. _preActivateForIntermediateRendering(renderId: number): void;
  26808. /** @hidden */
  26809. _activate(renderId: number, intermediateRendering: boolean): boolean;
  26810. /** @hidden */
  26811. _postActivate(): void;
  26812. /** @hidden */
  26813. _freeze(): void;
  26814. /** @hidden */
  26815. _unFreeze(): void;
  26816. /**
  26817. * Gets the current world matrix
  26818. * @returns a Matrix
  26819. */
  26820. getWorldMatrix(): Matrix;
  26821. /** @hidden */
  26822. _getWorldMatrixDeterminant(): number;
  26823. /**
  26824. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  26825. */
  26826. readonly isAnInstance: boolean;
  26827. /**
  26828. * Gets a boolean indicating if this mesh has instances
  26829. */
  26830. readonly hasInstances: boolean;
  26831. /**
  26832. * Perform relative position change from the point of view of behind the front of the mesh.
  26833. * This is performed taking into account the meshes current rotation, so you do not have to care.
  26834. * Supports definition of mesh facing forward or backward
  26835. * @param amountRight defines the distance on the right axis
  26836. * @param amountUp defines the distance on the up axis
  26837. * @param amountForward defines the distance on the forward axis
  26838. * @returns the current mesh
  26839. */
  26840. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  26841. /**
  26842. * Calculate relative position change from the point of view of behind the front of the mesh.
  26843. * This is performed taking into account the meshes current rotation, so you do not have to care.
  26844. * Supports definition of mesh facing forward or backward
  26845. * @param amountRight defines the distance on the right axis
  26846. * @param amountUp defines the distance on the up axis
  26847. * @param amountForward defines the distance on the forward axis
  26848. * @returns the new displacement vector
  26849. */
  26850. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  26851. /**
  26852. * Perform relative rotation change from the point of view of behind the front of the mesh.
  26853. * Supports definition of mesh facing forward or backward
  26854. * @param flipBack defines the flip
  26855. * @param twirlClockwise defines the twirl
  26856. * @param tiltRight defines the tilt
  26857. * @returns the current mesh
  26858. */
  26859. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  26860. /**
  26861. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  26862. * Supports definition of mesh facing forward or backward.
  26863. * @param flipBack defines the flip
  26864. * @param twirlClockwise defines the twirl
  26865. * @param tiltRight defines the tilt
  26866. * @returns the new rotation vector
  26867. */
  26868. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  26869. /**
  26870. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  26871. * This means the mesh underlying bounding box and sphere are recomputed.
  26872. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  26873. * @returns the current mesh
  26874. */
  26875. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  26876. /** @hidden */
  26877. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  26878. /** @hidden */
  26879. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  26880. /** @hidden */
  26881. _updateBoundingInfo(): AbstractMesh;
  26882. /** @hidden */
  26883. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  26884. /** @hidden */
  26885. protected _afterComputeWorldMatrix(): void;
  26886. /** @hidden */
  26887. readonly _effectiveMesh: AbstractMesh;
  26888. /**
  26889. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  26890. * A mesh is in the frustum if its bounding box intersects the frustum
  26891. * @param frustumPlanes defines the frustum to test
  26892. * @returns true if the mesh is in the frustum planes
  26893. */
  26894. isInFrustum(frustumPlanes: Plane[]): boolean;
  26895. /**
  26896. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  26897. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  26898. * @param frustumPlanes defines the frustum to test
  26899. * @returns true if the mesh is completely in the frustum planes
  26900. */
  26901. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26902. /**
  26903. * True if the mesh intersects another mesh or a SolidParticle object
  26904. * @param mesh defines a target mesh or SolidParticle to test
  26905. * @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)
  26906. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  26907. * @returns true if there is an intersection
  26908. */
  26909. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  26910. /**
  26911. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  26912. * @param point defines the point to test
  26913. * @returns true if there is an intersection
  26914. */
  26915. intersectsPoint(point: Vector3): boolean;
  26916. /**
  26917. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  26918. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26919. */
  26920. checkCollisions: boolean;
  26921. /**
  26922. * Gets Collider object used to compute collisions (not physics)
  26923. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26924. */
  26925. readonly collider: Nullable<Collider>;
  26926. /**
  26927. * Move the mesh using collision engine
  26928. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26929. * @param displacement defines the requested displacement vector
  26930. * @returns the current mesh
  26931. */
  26932. moveWithCollisions(displacement: Vector3): AbstractMesh;
  26933. private _onCollisionPositionChange;
  26934. /** @hidden */
  26935. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  26936. /** @hidden */
  26937. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  26938. /** @hidden */
  26939. _checkCollision(collider: Collider): AbstractMesh;
  26940. /** @hidden */
  26941. _generatePointsArray(): boolean;
  26942. /**
  26943. * Checks if the passed Ray intersects with the mesh
  26944. * @param ray defines the ray to use
  26945. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  26946. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26947. * @returns the picking info
  26948. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  26949. */
  26950. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  26951. /**
  26952. * Clones the current mesh
  26953. * @param name defines the mesh name
  26954. * @param newParent defines the new mesh parent
  26955. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  26956. * @returns the new mesh
  26957. */
  26958. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  26959. /**
  26960. * Disposes all the submeshes of the current meshnp
  26961. * @returns the current mesh
  26962. */
  26963. releaseSubMeshes(): AbstractMesh;
  26964. /**
  26965. * Releases resources associated with this abstract mesh.
  26966. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  26967. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  26968. */
  26969. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  26970. /**
  26971. * Adds the passed mesh as a child to the current mesh
  26972. * @param mesh defines the child mesh
  26973. * @returns the current mesh
  26974. */
  26975. addChild(mesh: AbstractMesh): AbstractMesh;
  26976. /**
  26977. * Removes the passed mesh from the current mesh children list
  26978. * @param mesh defines the child mesh
  26979. * @returns the current mesh
  26980. */
  26981. removeChild(mesh: AbstractMesh): AbstractMesh;
  26982. /** @hidden */
  26983. private _initFacetData;
  26984. /**
  26985. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  26986. * This method can be called within the render loop.
  26987. * 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
  26988. * @returns the current mesh
  26989. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26990. */
  26991. updateFacetData(): AbstractMesh;
  26992. /**
  26993. * Returns the facetLocalNormals array.
  26994. * The normals are expressed in the mesh local spac
  26995. * @returns an array of Vector3
  26996. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26997. */
  26998. getFacetLocalNormals(): Vector3[];
  26999. /**
  27000. * Returns the facetLocalPositions array.
  27001. * The facet positions are expressed in the mesh local space
  27002. * @returns an array of Vector3
  27003. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27004. */
  27005. getFacetLocalPositions(): Vector3[];
  27006. /**
  27007. * Returns the facetLocalPartioning array
  27008. * @returns an array of array of numbers
  27009. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27010. */
  27011. getFacetLocalPartitioning(): number[][];
  27012. /**
  27013. * Returns the i-th facet position in the world system.
  27014. * This method allocates a new Vector3 per call
  27015. * @param i defines the facet index
  27016. * @returns a new Vector3
  27017. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27018. */
  27019. getFacetPosition(i: number): Vector3;
  27020. /**
  27021. * Sets the reference Vector3 with the i-th facet position in the world system
  27022. * @param i defines the facet index
  27023. * @param ref defines the target vector
  27024. * @returns the current mesh
  27025. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27026. */
  27027. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27028. /**
  27029. * Returns the i-th facet normal in the world system.
  27030. * This method allocates a new Vector3 per call
  27031. * @param i defines the facet index
  27032. * @returns a new Vector3
  27033. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27034. */
  27035. getFacetNormal(i: number): Vector3;
  27036. /**
  27037. * Sets the reference Vector3 with the i-th facet normal in the world system
  27038. * @param i defines the facet index
  27039. * @param ref defines the target vector
  27040. * @returns the current mesh
  27041. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27042. */
  27043. getFacetNormalToRef(i: number, ref: Vector3): this;
  27044. /**
  27045. * 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)
  27046. * @param x defines x coordinate
  27047. * @param y defines y coordinate
  27048. * @param z defines z coordinate
  27049. * @returns the array of facet indexes
  27050. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27051. */
  27052. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27053. /**
  27054. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27055. * @param projected sets as the (x,y,z) world projection on the facet
  27056. * @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
  27057. * @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
  27058. * @param x defines x coordinate
  27059. * @param y defines y coordinate
  27060. * @param z defines z coordinate
  27061. * @returns the face index if found (or null instead)
  27062. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27063. */
  27064. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27065. /**
  27066. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27067. * @param projected sets as the (x,y,z) local projection on the facet
  27068. * @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
  27069. * @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
  27070. * @param x defines x coordinate
  27071. * @param y defines y coordinate
  27072. * @param z defines z coordinate
  27073. * @returns the face index if found (or null instead)
  27074. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27075. */
  27076. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27077. /**
  27078. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27079. * @returns the parameters
  27080. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27081. */
  27082. getFacetDataParameters(): any;
  27083. /**
  27084. * Disables the feature FacetData and frees the related memory
  27085. * @returns the current mesh
  27086. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27087. */
  27088. disableFacetData(): AbstractMesh;
  27089. /**
  27090. * Updates the AbstractMesh indices array
  27091. * @param indices defines the data source
  27092. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27093. * @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)
  27094. * @returns the current mesh
  27095. */
  27096. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27097. /**
  27098. * Creates new normals data for the mesh
  27099. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27100. * @returns the current mesh
  27101. */
  27102. createNormals(updatable: boolean): AbstractMesh;
  27103. /**
  27104. * Align the mesh with a normal
  27105. * @param normal defines the normal to use
  27106. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27107. * @returns the current mesh
  27108. */
  27109. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27110. /** @hidden */
  27111. _checkOcclusionQuery(): boolean;
  27112. /**
  27113. * Disables the mesh edge rendering mode
  27114. * @returns the currentAbstractMesh
  27115. */
  27116. disableEdgesRendering(): AbstractMesh;
  27117. /**
  27118. * Enables the edge rendering mode on the mesh.
  27119. * This mode makes the mesh edges visible
  27120. * @param epsilon defines the maximal distance between two angles to detect a face
  27121. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27122. * @returns the currentAbstractMesh
  27123. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27124. */
  27125. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27126. }
  27127. }
  27128. declare module "babylonjs/Actions/actionEvent" {
  27129. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27130. import { Nullable } from "babylonjs/types";
  27131. import { Sprite } from "babylonjs/Sprites/sprite";
  27132. import { Scene } from "babylonjs/scene";
  27133. import { Vector2 } from "babylonjs/Maths/math.vector";
  27134. /**
  27135. * Interface used to define ActionEvent
  27136. */
  27137. export interface IActionEvent {
  27138. /** The mesh or sprite that triggered the action */
  27139. source: any;
  27140. /** The X mouse cursor position at the time of the event */
  27141. pointerX: number;
  27142. /** The Y mouse cursor position at the time of the event */
  27143. pointerY: number;
  27144. /** The mesh that is currently pointed at (can be null) */
  27145. meshUnderPointer: Nullable<AbstractMesh>;
  27146. /** the original (browser) event that triggered the ActionEvent */
  27147. sourceEvent?: any;
  27148. /** additional data for the event */
  27149. additionalData?: any;
  27150. }
  27151. /**
  27152. * ActionEvent is the event being sent when an action is triggered.
  27153. */
  27154. export class ActionEvent implements IActionEvent {
  27155. /** The mesh or sprite that triggered the action */
  27156. source: any;
  27157. /** The X mouse cursor position at the time of the event */
  27158. pointerX: number;
  27159. /** The Y mouse cursor position at the time of the event */
  27160. pointerY: number;
  27161. /** The mesh that is currently pointed at (can be null) */
  27162. meshUnderPointer: Nullable<AbstractMesh>;
  27163. /** the original (browser) event that triggered the ActionEvent */
  27164. sourceEvent?: any;
  27165. /** additional data for the event */
  27166. additionalData?: any;
  27167. /**
  27168. * Creates a new ActionEvent
  27169. * @param source The mesh or sprite that triggered the action
  27170. * @param pointerX The X mouse cursor position at the time of the event
  27171. * @param pointerY The Y mouse cursor position at the time of the event
  27172. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27173. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27174. * @param additionalData additional data for the event
  27175. */
  27176. constructor(
  27177. /** The mesh or sprite that triggered the action */
  27178. source: any,
  27179. /** The X mouse cursor position at the time of the event */
  27180. pointerX: number,
  27181. /** The Y mouse cursor position at the time of the event */
  27182. pointerY: number,
  27183. /** The mesh that is currently pointed at (can be null) */
  27184. meshUnderPointer: Nullable<AbstractMesh>,
  27185. /** the original (browser) event that triggered the ActionEvent */
  27186. sourceEvent?: any,
  27187. /** additional data for the event */
  27188. additionalData?: any);
  27189. /**
  27190. * Helper function to auto-create an ActionEvent from a source mesh.
  27191. * @param source The source mesh that triggered the event
  27192. * @param evt The original (browser) event
  27193. * @param additionalData additional data for the event
  27194. * @returns the new ActionEvent
  27195. */
  27196. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27197. /**
  27198. * Helper function to auto-create an ActionEvent from a source sprite
  27199. * @param source The source sprite that triggered the event
  27200. * @param scene Scene associated with the sprite
  27201. * @param evt The original (browser) event
  27202. * @param additionalData additional data for the event
  27203. * @returns the new ActionEvent
  27204. */
  27205. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27206. /**
  27207. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27208. * @param scene the scene where the event occurred
  27209. * @param evt The original (browser) event
  27210. * @returns the new ActionEvent
  27211. */
  27212. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27213. /**
  27214. * Helper function to auto-create an ActionEvent from a primitive
  27215. * @param prim defines the target primitive
  27216. * @param pointerPos defines the pointer position
  27217. * @param evt The original (browser) event
  27218. * @param additionalData additional data for the event
  27219. * @returns the new ActionEvent
  27220. */
  27221. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27222. }
  27223. }
  27224. declare module "babylonjs/Actions/abstractActionManager" {
  27225. import { IDisposable } from "babylonjs/scene";
  27226. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27227. import { IAction } from "babylonjs/Actions/action";
  27228. import { Nullable } from "babylonjs/types";
  27229. /**
  27230. * Abstract class used to decouple action Manager from scene and meshes.
  27231. * Do not instantiate.
  27232. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27233. */
  27234. export abstract class AbstractActionManager implements IDisposable {
  27235. /** Gets the list of active triggers */
  27236. static Triggers: {
  27237. [key: string]: number;
  27238. };
  27239. /** Gets the cursor to use when hovering items */
  27240. hoverCursor: string;
  27241. /** Gets the list of actions */
  27242. actions: IAction[];
  27243. /**
  27244. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27245. */
  27246. isRecursive: boolean;
  27247. /**
  27248. * Releases all associated resources
  27249. */
  27250. abstract dispose(): void;
  27251. /**
  27252. * Does this action manager has pointer triggers
  27253. */
  27254. abstract readonly hasPointerTriggers: boolean;
  27255. /**
  27256. * Does this action manager has pick triggers
  27257. */
  27258. abstract readonly hasPickTriggers: boolean;
  27259. /**
  27260. * Process a specific trigger
  27261. * @param trigger defines the trigger to process
  27262. * @param evt defines the event details to be processed
  27263. */
  27264. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27265. /**
  27266. * Does this action manager handles actions of any of the given triggers
  27267. * @param triggers defines the triggers to be tested
  27268. * @return a boolean indicating whether one (or more) of the triggers is handled
  27269. */
  27270. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27271. /**
  27272. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27273. * speed.
  27274. * @param triggerA defines the trigger to be tested
  27275. * @param triggerB defines the trigger to be tested
  27276. * @return a boolean indicating whether one (or more) of the triggers is handled
  27277. */
  27278. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27279. /**
  27280. * Does this action manager handles actions of a given trigger
  27281. * @param trigger defines the trigger to be tested
  27282. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27283. * @return whether the trigger is handled
  27284. */
  27285. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27286. /**
  27287. * Serialize this manager to a JSON object
  27288. * @param name defines the property name to store this manager
  27289. * @returns a JSON representation of this manager
  27290. */
  27291. abstract serialize(name: string): any;
  27292. /**
  27293. * Registers an action to this action manager
  27294. * @param action defines the action to be registered
  27295. * @return the action amended (prepared) after registration
  27296. */
  27297. abstract registerAction(action: IAction): Nullable<IAction>;
  27298. /**
  27299. * Unregisters an action to this action manager
  27300. * @param action defines the action to be unregistered
  27301. * @return a boolean indicating whether the action has been unregistered
  27302. */
  27303. abstract unregisterAction(action: IAction): Boolean;
  27304. /**
  27305. * Does exist one action manager with at least one trigger
  27306. **/
  27307. static readonly HasTriggers: boolean;
  27308. /**
  27309. * Does exist one action manager with at least one pick trigger
  27310. **/
  27311. static readonly HasPickTriggers: boolean;
  27312. /**
  27313. * Does exist one action manager that handles actions of a given trigger
  27314. * @param trigger defines the trigger to be tested
  27315. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27316. **/
  27317. static HasSpecificTrigger(trigger: number): boolean;
  27318. }
  27319. }
  27320. declare module "babylonjs/node" {
  27321. import { Scene } from "babylonjs/scene";
  27322. import { Nullable } from "babylonjs/types";
  27323. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  27324. import { Engine } from "babylonjs/Engines/engine";
  27325. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  27326. import { Observable } from "babylonjs/Misc/observable";
  27327. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  27328. import { IInspectable } from "babylonjs/Misc/iInspectable";
  27329. import { Animatable } from "babylonjs/Animations/animatable";
  27330. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27331. import { Animation } from "babylonjs/Animations/animation";
  27332. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27333. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27334. /**
  27335. * Defines how a node can be built from a string name.
  27336. */
  27337. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  27338. /**
  27339. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  27340. */
  27341. export class Node implements IBehaviorAware<Node> {
  27342. /** @hidden */
  27343. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  27344. private static _NodeConstructors;
  27345. /**
  27346. * Add a new node constructor
  27347. * @param type defines the type name of the node to construct
  27348. * @param constructorFunc defines the constructor function
  27349. */
  27350. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  27351. /**
  27352. * Returns a node constructor based on type name
  27353. * @param type defines the type name
  27354. * @param name defines the new node name
  27355. * @param scene defines the hosting scene
  27356. * @param options defines optional options to transmit to constructors
  27357. * @returns the new constructor or null
  27358. */
  27359. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  27360. /**
  27361. * Gets or sets the name of the node
  27362. */
  27363. name: string;
  27364. /**
  27365. * Gets or sets the id of the node
  27366. */
  27367. id: string;
  27368. /**
  27369. * Gets or sets the unique id of the node
  27370. */
  27371. uniqueId: number;
  27372. /**
  27373. * Gets or sets a string used to store user defined state for the node
  27374. */
  27375. state: string;
  27376. /**
  27377. * Gets or sets an object used to store user defined information for the node
  27378. */
  27379. metadata: any;
  27380. /**
  27381. * For internal use only. Please do not use.
  27382. */
  27383. reservedDataStore: any;
  27384. /**
  27385. * List of inspectable custom properties (used by the Inspector)
  27386. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  27387. */
  27388. inspectableCustomProperties: IInspectable[];
  27389. /**
  27390. * Gets or sets a boolean used to define if the node must be serialized
  27391. */
  27392. doNotSerialize: boolean;
  27393. /** @hidden */
  27394. _isDisposed: boolean;
  27395. /**
  27396. * Gets a list of Animations associated with the node
  27397. */
  27398. animations: import("babylonjs/Animations/animation").Animation[];
  27399. protected _ranges: {
  27400. [name: string]: Nullable<AnimationRange>;
  27401. };
  27402. /**
  27403. * Callback raised when the node is ready to be used
  27404. */
  27405. onReady: Nullable<(node: Node) => void>;
  27406. private _isEnabled;
  27407. private _isParentEnabled;
  27408. private _isReady;
  27409. /** @hidden */
  27410. _currentRenderId: number;
  27411. private _parentUpdateId;
  27412. /** @hidden */
  27413. _childUpdateId: number;
  27414. /** @hidden */
  27415. _waitingParentId: Nullable<string>;
  27416. /** @hidden */
  27417. _scene: Scene;
  27418. /** @hidden */
  27419. _cache: any;
  27420. private _parentNode;
  27421. private _children;
  27422. /** @hidden */
  27423. _worldMatrix: Matrix;
  27424. /** @hidden */
  27425. _worldMatrixDeterminant: number;
  27426. /** @hidden */
  27427. _worldMatrixDeterminantIsDirty: boolean;
  27428. /** @hidden */
  27429. private _sceneRootNodesIndex;
  27430. /**
  27431. * Gets a boolean indicating if the node has been disposed
  27432. * @returns true if the node was disposed
  27433. */
  27434. isDisposed(): boolean;
  27435. /**
  27436. * Gets or sets the parent of the node (without keeping the current position in the scene)
  27437. * @see https://doc.babylonjs.com/how_to/parenting
  27438. */
  27439. parent: Nullable<Node>;
  27440. private addToSceneRootNodes;
  27441. private removeFromSceneRootNodes;
  27442. private _animationPropertiesOverride;
  27443. /**
  27444. * Gets or sets the animation properties override
  27445. */
  27446. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  27447. /**
  27448. * Gets a string idenfifying the name of the class
  27449. * @returns "Node" string
  27450. */
  27451. getClassName(): string;
  27452. /** @hidden */
  27453. readonly _isNode: boolean;
  27454. /**
  27455. * An event triggered when the mesh is disposed
  27456. */
  27457. onDisposeObservable: Observable<Node>;
  27458. private _onDisposeObserver;
  27459. /**
  27460. * Sets a callback that will be raised when the node will be disposed
  27461. */
  27462. onDispose: () => void;
  27463. /**
  27464. * Creates a new Node
  27465. * @param name the name and id to be given to this node
  27466. * @param scene the scene this node will be added to
  27467. * @param addToRootNodes the node will be added to scene.rootNodes
  27468. */
  27469. constructor(name: string, scene?: Nullable<Scene>, addToRootNodes?: boolean);
  27470. /**
  27471. * Gets the scene of the node
  27472. * @returns a scene
  27473. */
  27474. getScene(): Scene;
  27475. /**
  27476. * Gets the engine of the node
  27477. * @returns a Engine
  27478. */
  27479. getEngine(): Engine;
  27480. private _behaviors;
  27481. /**
  27482. * Attach a behavior to the node
  27483. * @see http://doc.babylonjs.com/features/behaviour
  27484. * @param behavior defines the behavior to attach
  27485. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  27486. * @returns the current Node
  27487. */
  27488. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  27489. /**
  27490. * Remove an attached behavior
  27491. * @see http://doc.babylonjs.com/features/behaviour
  27492. * @param behavior defines the behavior to attach
  27493. * @returns the current Node
  27494. */
  27495. removeBehavior(behavior: Behavior<Node>): Node;
  27496. /**
  27497. * Gets the list of attached behaviors
  27498. * @see http://doc.babylonjs.com/features/behaviour
  27499. */
  27500. readonly behaviors: Behavior<Node>[];
  27501. /**
  27502. * Gets an attached behavior by name
  27503. * @param name defines the name of the behavior to look for
  27504. * @see http://doc.babylonjs.com/features/behaviour
  27505. * @returns null if behavior was not found else the requested behavior
  27506. */
  27507. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  27508. /**
  27509. * Returns the latest update of the World matrix
  27510. * @returns a Matrix
  27511. */
  27512. getWorldMatrix(): Matrix;
  27513. /** @hidden */
  27514. _getWorldMatrixDeterminant(): number;
  27515. /**
  27516. * Returns directly the latest state of the mesh World matrix.
  27517. * A Matrix is returned.
  27518. */
  27519. readonly worldMatrixFromCache: Matrix;
  27520. /** @hidden */
  27521. _initCache(): void;
  27522. /** @hidden */
  27523. updateCache(force?: boolean): void;
  27524. /** @hidden */
  27525. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27526. /** @hidden */
  27527. _updateCache(ignoreParentClass?: boolean): void;
  27528. /** @hidden */
  27529. _isSynchronized(): boolean;
  27530. /** @hidden */
  27531. _markSyncedWithParent(): void;
  27532. /** @hidden */
  27533. isSynchronizedWithParent(): boolean;
  27534. /** @hidden */
  27535. isSynchronized(): boolean;
  27536. /**
  27537. * Is this node ready to be used/rendered
  27538. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  27539. * @return true if the node is ready
  27540. */
  27541. isReady(completeCheck?: boolean): boolean;
  27542. /**
  27543. * Is this node enabled?
  27544. * 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
  27545. * @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
  27546. * @return whether this node (and its parent) is enabled
  27547. */
  27548. isEnabled(checkAncestors?: boolean): boolean;
  27549. /** @hidden */
  27550. protected _syncParentEnabledState(): void;
  27551. /**
  27552. * Set the enabled state of this node
  27553. * @param value defines the new enabled state
  27554. */
  27555. setEnabled(value: boolean): void;
  27556. /**
  27557. * Is this node a descendant of the given node?
  27558. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  27559. * @param ancestor defines the parent node to inspect
  27560. * @returns a boolean indicating if this node is a descendant of the given node
  27561. */
  27562. isDescendantOf(ancestor: Node): boolean;
  27563. /** @hidden */
  27564. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  27565. /**
  27566. * Will return all nodes that have this node as ascendant
  27567. * @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
  27568. * @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
  27569. * @return all children nodes of all types
  27570. */
  27571. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  27572. /**
  27573. * Get all child-meshes of this node
  27574. * @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)
  27575. * @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
  27576. * @returns an array of AbstractMesh
  27577. */
  27578. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  27579. /**
  27580. * Get all direct children of this node
  27581. * @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
  27582. * @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)
  27583. * @returns an array of Node
  27584. */
  27585. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  27586. /** @hidden */
  27587. _setReady(state: boolean): void;
  27588. /**
  27589. * Get an animation by name
  27590. * @param name defines the name of the animation to look for
  27591. * @returns null if not found else the requested animation
  27592. */
  27593. getAnimationByName(name: string): Nullable<Animation>;
  27594. /**
  27595. * Creates an animation range for this node
  27596. * @param name defines the name of the range
  27597. * @param from defines the starting key
  27598. * @param to defines the end key
  27599. */
  27600. createAnimationRange(name: string, from: number, to: number): void;
  27601. /**
  27602. * Delete a specific animation range
  27603. * @param name defines the name of the range to delete
  27604. * @param deleteFrames defines if animation frames from the range must be deleted as well
  27605. */
  27606. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  27607. /**
  27608. * Get an animation range by name
  27609. * @param name defines the name of the animation range to look for
  27610. * @returns null if not found else the requested animation range
  27611. */
  27612. getAnimationRange(name: string): Nullable<AnimationRange>;
  27613. /**
  27614. * Gets the list of all animation ranges defined on this node
  27615. * @returns an array
  27616. */
  27617. getAnimationRanges(): Nullable<AnimationRange>[];
  27618. /**
  27619. * Will start the animation sequence
  27620. * @param name defines the range frames for animation sequence
  27621. * @param loop defines if the animation should loop (false by default)
  27622. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  27623. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  27624. * @returns the object created for this animation. If range does not exist, it will return null
  27625. */
  27626. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  27627. /**
  27628. * Serialize animation ranges into a JSON compatible object
  27629. * @returns serialization object
  27630. */
  27631. serializeAnimationRanges(): any;
  27632. /**
  27633. * Computes the world matrix of the node
  27634. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  27635. * @returns the world matrix
  27636. */
  27637. computeWorldMatrix(force?: boolean): Matrix;
  27638. /**
  27639. * Releases resources associated with this node.
  27640. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27641. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27642. */
  27643. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27644. /**
  27645. * Parse animation range data from a serialization object and store them into a given node
  27646. * @param node defines where to store the animation ranges
  27647. * @param parsedNode defines the serialization object to read data from
  27648. * @param scene defines the hosting scene
  27649. */
  27650. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  27651. /**
  27652. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  27653. * @param includeDescendants Include bounding info from descendants as well (true by default)
  27654. * @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
  27655. * @returns the new bounding vectors
  27656. */
  27657. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  27658. min: Vector3;
  27659. max: Vector3;
  27660. };
  27661. }
  27662. }
  27663. declare module "babylonjs/Animations/animation" {
  27664. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  27665. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  27666. import { Color3 } from "babylonjs/Maths/math.color";
  27667. import { Nullable } from "babylonjs/types";
  27668. import { Scene } from "babylonjs/scene";
  27669. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  27670. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27671. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  27672. import { Node } from "babylonjs/node";
  27673. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27674. import { Size } from "babylonjs/Maths/math.size";
  27675. import { Animatable } from "babylonjs/Animations/animatable";
  27676. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  27677. /**
  27678. * @hidden
  27679. */
  27680. export class _IAnimationState {
  27681. key: number;
  27682. repeatCount: number;
  27683. workValue?: any;
  27684. loopMode?: number;
  27685. offsetValue?: any;
  27686. highLimitValue?: any;
  27687. }
  27688. /**
  27689. * Class used to store any kind of animation
  27690. */
  27691. export class Animation {
  27692. /**Name of the animation */
  27693. name: string;
  27694. /**Property to animate */
  27695. targetProperty: string;
  27696. /**The frames per second of the animation */
  27697. framePerSecond: number;
  27698. /**The data type of the animation */
  27699. dataType: number;
  27700. /**The loop mode of the animation */
  27701. loopMode?: number | undefined;
  27702. /**Specifies if blending should be enabled */
  27703. enableBlending?: boolean | undefined;
  27704. /**
  27705. * Use matrix interpolation instead of using direct key value when animating matrices
  27706. */
  27707. static AllowMatricesInterpolation: boolean;
  27708. /**
  27709. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  27710. */
  27711. static AllowMatrixDecomposeForInterpolation: boolean;
  27712. /**
  27713. * Stores the key frames of the animation
  27714. */
  27715. private _keys;
  27716. /**
  27717. * Stores the easing function of the animation
  27718. */
  27719. private _easingFunction;
  27720. /**
  27721. * @hidden Internal use only
  27722. */
  27723. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  27724. /**
  27725. * The set of event that will be linked to this animation
  27726. */
  27727. private _events;
  27728. /**
  27729. * Stores an array of target property paths
  27730. */
  27731. targetPropertyPath: string[];
  27732. /**
  27733. * Stores the blending speed of the animation
  27734. */
  27735. blendingSpeed: number;
  27736. /**
  27737. * Stores the animation ranges for the animation
  27738. */
  27739. private _ranges;
  27740. /**
  27741. * @hidden Internal use
  27742. */
  27743. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  27744. /**
  27745. * Sets up an animation
  27746. * @param property The property to animate
  27747. * @param animationType The animation type to apply
  27748. * @param framePerSecond The frames per second of the animation
  27749. * @param easingFunction The easing function used in the animation
  27750. * @returns The created animation
  27751. */
  27752. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  27753. /**
  27754. * Create and start an animation on a node
  27755. * @param name defines the name of the global animation that will be run on all nodes
  27756. * @param node defines the root node where the animation will take place
  27757. * @param targetProperty defines property to animate
  27758. * @param framePerSecond defines the number of frame per second yo use
  27759. * @param totalFrame defines the number of frames in total
  27760. * @param from defines the initial value
  27761. * @param to defines the final value
  27762. * @param loopMode defines which loop mode you want to use (off by default)
  27763. * @param easingFunction defines the easing function to use (linear by default)
  27764. * @param onAnimationEnd defines the callback to call when animation end
  27765. * @returns the animatable created for this animation
  27766. */
  27767. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  27768. /**
  27769. * Create and start an animation on a node and its descendants
  27770. * @param name defines the name of the global animation that will be run on all nodes
  27771. * @param node defines the root node where the animation will take place
  27772. * @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
  27773. * @param targetProperty defines property to animate
  27774. * @param framePerSecond defines the number of frame per second to use
  27775. * @param totalFrame defines the number of frames in total
  27776. * @param from defines the initial value
  27777. * @param to defines the final value
  27778. * @param loopMode defines which loop mode you want to use (off by default)
  27779. * @param easingFunction defines the easing function to use (linear by default)
  27780. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  27781. * @returns the list of animatables created for all nodes
  27782. * @example https://www.babylonjs-playground.com/#MH0VLI
  27783. */
  27784. 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[]>;
  27785. /**
  27786. * Creates a new animation, merges it with the existing animations and starts it
  27787. * @param name Name of the animation
  27788. * @param node Node which contains the scene that begins the animations
  27789. * @param targetProperty Specifies which property to animate
  27790. * @param framePerSecond The frames per second of the animation
  27791. * @param totalFrame The total number of frames
  27792. * @param from The frame at the beginning of the animation
  27793. * @param to The frame at the end of the animation
  27794. * @param loopMode Specifies the loop mode of the animation
  27795. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  27796. * @param onAnimationEnd Callback to run once the animation is complete
  27797. * @returns Nullable animation
  27798. */
  27799. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  27800. /**
  27801. * Transition property of an host to the target Value
  27802. * @param property The property to transition
  27803. * @param targetValue The target Value of the property
  27804. * @param host The object where the property to animate belongs
  27805. * @param scene Scene used to run the animation
  27806. * @param frameRate Framerate (in frame/s) to use
  27807. * @param transition The transition type we want to use
  27808. * @param duration The duration of the animation, in milliseconds
  27809. * @param onAnimationEnd Callback trigger at the end of the animation
  27810. * @returns Nullable animation
  27811. */
  27812. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  27813. /**
  27814. * Return the array of runtime animations currently using this animation
  27815. */
  27816. readonly runtimeAnimations: RuntimeAnimation[];
  27817. /**
  27818. * Specifies if any of the runtime animations are currently running
  27819. */
  27820. readonly hasRunningRuntimeAnimations: boolean;
  27821. /**
  27822. * Initializes the animation
  27823. * @param name Name of the animation
  27824. * @param targetProperty Property to animate
  27825. * @param framePerSecond The frames per second of the animation
  27826. * @param dataType The data type of the animation
  27827. * @param loopMode The loop mode of the animation
  27828. * @param enableBlending Specifies if blending should be enabled
  27829. */
  27830. constructor(
  27831. /**Name of the animation */
  27832. name: string,
  27833. /**Property to animate */
  27834. targetProperty: string,
  27835. /**The frames per second of the animation */
  27836. framePerSecond: number,
  27837. /**The data type of the animation */
  27838. dataType: number,
  27839. /**The loop mode of the animation */
  27840. loopMode?: number | undefined,
  27841. /**Specifies if blending should be enabled */
  27842. enableBlending?: boolean | undefined);
  27843. /**
  27844. * Converts the animation to a string
  27845. * @param fullDetails support for multiple levels of logging within scene loading
  27846. * @returns String form of the animation
  27847. */
  27848. toString(fullDetails?: boolean): string;
  27849. /**
  27850. * Add an event to this animation
  27851. * @param event Event to add
  27852. */
  27853. addEvent(event: AnimationEvent): void;
  27854. /**
  27855. * Remove all events found at the given frame
  27856. * @param frame The frame to remove events from
  27857. */
  27858. removeEvents(frame: number): void;
  27859. /**
  27860. * Retrieves all the events from the animation
  27861. * @returns Events from the animation
  27862. */
  27863. getEvents(): AnimationEvent[];
  27864. /**
  27865. * Creates an animation range
  27866. * @param name Name of the animation range
  27867. * @param from Starting frame of the animation range
  27868. * @param to Ending frame of the animation
  27869. */
  27870. createRange(name: string, from: number, to: number): void;
  27871. /**
  27872. * Deletes an animation range by name
  27873. * @param name Name of the animation range to delete
  27874. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  27875. */
  27876. deleteRange(name: string, deleteFrames?: boolean): void;
  27877. /**
  27878. * Gets the animation range by name, or null if not defined
  27879. * @param name Name of the animation range
  27880. * @returns Nullable animation range
  27881. */
  27882. getRange(name: string): Nullable<AnimationRange>;
  27883. /**
  27884. * Gets the key frames from the animation
  27885. * @returns The key frames of the animation
  27886. */
  27887. getKeys(): Array<IAnimationKey>;
  27888. /**
  27889. * Gets the highest frame rate of the animation
  27890. * @returns Highest frame rate of the animation
  27891. */
  27892. getHighestFrame(): number;
  27893. /**
  27894. * Gets the easing function of the animation
  27895. * @returns Easing function of the animation
  27896. */
  27897. getEasingFunction(): IEasingFunction;
  27898. /**
  27899. * Sets the easing function of the animation
  27900. * @param easingFunction A custom mathematical formula for animation
  27901. */
  27902. setEasingFunction(easingFunction: EasingFunction): void;
  27903. /**
  27904. * Interpolates a scalar linearly
  27905. * @param startValue Start value of the animation curve
  27906. * @param endValue End value of the animation curve
  27907. * @param gradient Scalar amount to interpolate
  27908. * @returns Interpolated scalar value
  27909. */
  27910. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  27911. /**
  27912. * Interpolates a scalar cubically
  27913. * @param startValue Start value of the animation curve
  27914. * @param outTangent End tangent of the animation
  27915. * @param endValue End value of the animation curve
  27916. * @param inTangent Start tangent of the animation curve
  27917. * @param gradient Scalar amount to interpolate
  27918. * @returns Interpolated scalar value
  27919. */
  27920. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  27921. /**
  27922. * Interpolates a quaternion using a spherical linear interpolation
  27923. * @param startValue Start value of the animation curve
  27924. * @param endValue End value of the animation curve
  27925. * @param gradient Scalar amount to interpolate
  27926. * @returns Interpolated quaternion value
  27927. */
  27928. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  27929. /**
  27930. * Interpolates a quaternion cubically
  27931. * @param startValue Start value of the animation curve
  27932. * @param outTangent End tangent of the animation curve
  27933. * @param endValue End value of the animation curve
  27934. * @param inTangent Start tangent of the animation curve
  27935. * @param gradient Scalar amount to interpolate
  27936. * @returns Interpolated quaternion value
  27937. */
  27938. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  27939. /**
  27940. * Interpolates a Vector3 linearl
  27941. * @param startValue Start value of the animation curve
  27942. * @param endValue End value of the animation curve
  27943. * @param gradient Scalar amount to interpolate
  27944. * @returns Interpolated scalar value
  27945. */
  27946. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  27947. /**
  27948. * Interpolates a Vector3 cubically
  27949. * @param startValue Start value of the animation curve
  27950. * @param outTangent End tangent of the animation
  27951. * @param endValue End value of the animation curve
  27952. * @param inTangent Start tangent of the animation curve
  27953. * @param gradient Scalar amount to interpolate
  27954. * @returns InterpolatedVector3 value
  27955. */
  27956. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  27957. /**
  27958. * Interpolates a Vector2 linearly
  27959. * @param startValue Start value of the animation curve
  27960. * @param endValue End value of the animation curve
  27961. * @param gradient Scalar amount to interpolate
  27962. * @returns Interpolated Vector2 value
  27963. */
  27964. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  27965. /**
  27966. * Interpolates a Vector2 cubically
  27967. * @param startValue Start value of the animation curve
  27968. * @param outTangent End tangent of the animation
  27969. * @param endValue End value of the animation curve
  27970. * @param inTangent Start tangent of the animation curve
  27971. * @param gradient Scalar amount to interpolate
  27972. * @returns Interpolated Vector2 value
  27973. */
  27974. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  27975. /**
  27976. * Interpolates a size linearly
  27977. * @param startValue Start value of the animation curve
  27978. * @param endValue End value of the animation curve
  27979. * @param gradient Scalar amount to interpolate
  27980. * @returns Interpolated Size value
  27981. */
  27982. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  27983. /**
  27984. * Interpolates a Color3 linearly
  27985. * @param startValue Start value of the animation curve
  27986. * @param endValue End value of the animation curve
  27987. * @param gradient Scalar amount to interpolate
  27988. * @returns Interpolated Color3 value
  27989. */
  27990. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  27991. /**
  27992. * @hidden Internal use only
  27993. */
  27994. _getKeyValue(value: any): any;
  27995. /**
  27996. * @hidden Internal use only
  27997. */
  27998. _interpolate(currentFrame: number, state: _IAnimationState): any;
  27999. /**
  28000. * Defines the function to use to interpolate matrices
  28001. * @param startValue defines the start matrix
  28002. * @param endValue defines the end matrix
  28003. * @param gradient defines the gradient between both matrices
  28004. * @param result defines an optional target matrix where to store the interpolation
  28005. * @returns the interpolated matrix
  28006. */
  28007. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28008. /**
  28009. * Makes a copy of the animation
  28010. * @returns Cloned animation
  28011. */
  28012. clone(): Animation;
  28013. /**
  28014. * Sets the key frames of the animation
  28015. * @param values The animation key frames to set
  28016. */
  28017. setKeys(values: Array<IAnimationKey>): void;
  28018. /**
  28019. * Serializes the animation to an object
  28020. * @returns Serialized object
  28021. */
  28022. serialize(): any;
  28023. /**
  28024. * Float animation type
  28025. */
  28026. private static _ANIMATIONTYPE_FLOAT;
  28027. /**
  28028. * Vector3 animation type
  28029. */
  28030. private static _ANIMATIONTYPE_VECTOR3;
  28031. /**
  28032. * Quaternion animation type
  28033. */
  28034. private static _ANIMATIONTYPE_QUATERNION;
  28035. /**
  28036. * Matrix animation type
  28037. */
  28038. private static _ANIMATIONTYPE_MATRIX;
  28039. /**
  28040. * Color3 animation type
  28041. */
  28042. private static _ANIMATIONTYPE_COLOR3;
  28043. /**
  28044. * Vector2 animation type
  28045. */
  28046. private static _ANIMATIONTYPE_VECTOR2;
  28047. /**
  28048. * Size animation type
  28049. */
  28050. private static _ANIMATIONTYPE_SIZE;
  28051. /**
  28052. * Relative Loop Mode
  28053. */
  28054. private static _ANIMATIONLOOPMODE_RELATIVE;
  28055. /**
  28056. * Cycle Loop Mode
  28057. */
  28058. private static _ANIMATIONLOOPMODE_CYCLE;
  28059. /**
  28060. * Constant Loop Mode
  28061. */
  28062. private static _ANIMATIONLOOPMODE_CONSTANT;
  28063. /**
  28064. * Get the float animation type
  28065. */
  28066. static readonly ANIMATIONTYPE_FLOAT: number;
  28067. /**
  28068. * Get the Vector3 animation type
  28069. */
  28070. static readonly ANIMATIONTYPE_VECTOR3: number;
  28071. /**
  28072. * Get the Vector2 animation type
  28073. */
  28074. static readonly ANIMATIONTYPE_VECTOR2: number;
  28075. /**
  28076. * Get the Size animation type
  28077. */
  28078. static readonly ANIMATIONTYPE_SIZE: number;
  28079. /**
  28080. * Get the Quaternion animation type
  28081. */
  28082. static readonly ANIMATIONTYPE_QUATERNION: number;
  28083. /**
  28084. * Get the Matrix animation type
  28085. */
  28086. static readonly ANIMATIONTYPE_MATRIX: number;
  28087. /**
  28088. * Get the Color3 animation type
  28089. */
  28090. static readonly ANIMATIONTYPE_COLOR3: number;
  28091. /**
  28092. * Get the Relative Loop Mode
  28093. */
  28094. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28095. /**
  28096. * Get the Cycle Loop Mode
  28097. */
  28098. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28099. /**
  28100. * Get the Constant Loop Mode
  28101. */
  28102. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28103. /** @hidden */
  28104. static _UniversalLerp(left: any, right: any, amount: number): any;
  28105. /**
  28106. * Parses an animation object and creates an animation
  28107. * @param parsedAnimation Parsed animation object
  28108. * @returns Animation object
  28109. */
  28110. static Parse(parsedAnimation: any): Animation;
  28111. /**
  28112. * Appends the serialized animations from the source animations
  28113. * @param source Source containing the animations
  28114. * @param destination Target to store the animations
  28115. */
  28116. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28117. }
  28118. }
  28119. declare module "babylonjs/Animations/animatable.interface" {
  28120. import { Nullable } from "babylonjs/types";
  28121. import { Animation } from "babylonjs/Animations/animation";
  28122. /**
  28123. * Interface containing an array of animations
  28124. */
  28125. export interface IAnimatable {
  28126. /**
  28127. * Array of animations
  28128. */
  28129. animations: Nullable<Array<Animation>>;
  28130. }
  28131. }
  28132. declare module "babylonjs/Materials/fresnelParameters" {
  28133. import { Color3 } from "babylonjs/Maths/math.color";
  28134. /**
  28135. * This represents all the required information to add a fresnel effect on a material:
  28136. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28137. */
  28138. export class FresnelParameters {
  28139. private _isEnabled;
  28140. /**
  28141. * Define if the fresnel effect is enable or not.
  28142. */
  28143. isEnabled: boolean;
  28144. /**
  28145. * Define the color used on edges (grazing angle)
  28146. */
  28147. leftColor: Color3;
  28148. /**
  28149. * Define the color used on center
  28150. */
  28151. rightColor: Color3;
  28152. /**
  28153. * Define bias applied to computed fresnel term
  28154. */
  28155. bias: number;
  28156. /**
  28157. * Defined the power exponent applied to fresnel term
  28158. */
  28159. power: number;
  28160. /**
  28161. * Clones the current fresnel and its valuues
  28162. * @returns a clone fresnel configuration
  28163. */
  28164. clone(): FresnelParameters;
  28165. /**
  28166. * Serializes the current fresnel parameters to a JSON representation.
  28167. * @return the JSON serialization
  28168. */
  28169. serialize(): any;
  28170. /**
  28171. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28172. * @param parsedFresnelParameters Define the JSON representation
  28173. * @returns the parsed parameters
  28174. */
  28175. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28176. }
  28177. }
  28178. declare module "babylonjs/Misc/decorators" {
  28179. import { Nullable } from "babylonjs/types";
  28180. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28181. import { Scene } from "babylonjs/scene";
  28182. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28183. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28184. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28185. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28186. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28187. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28188. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28189. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28190. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28191. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28192. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28193. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28194. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28195. /**
  28196. * Decorator used to define property that can be serialized as reference to a camera
  28197. * @param sourceName defines the name of the property to decorate
  28198. */
  28199. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28200. /**
  28201. * Class used to help serialization objects
  28202. */
  28203. export class SerializationHelper {
  28204. /** @hidden */
  28205. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28206. /** @hidden */
  28207. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28208. /** @hidden */
  28209. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28210. /** @hidden */
  28211. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28212. /**
  28213. * Appends the serialized animations from the source animations
  28214. * @param source Source containing the animations
  28215. * @param destination Target to store the animations
  28216. */
  28217. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28218. /**
  28219. * Static function used to serialized a specific entity
  28220. * @param entity defines the entity to serialize
  28221. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28222. * @returns a JSON compatible object representing the serialization of the entity
  28223. */
  28224. static Serialize<T>(entity: T, serializationObject?: any): any;
  28225. /**
  28226. * Creates a new entity from a serialization data object
  28227. * @param creationFunction defines a function used to instanciated the new entity
  28228. * @param source defines the source serialization data
  28229. * @param scene defines the hosting scene
  28230. * @param rootUrl defines the root url for resources
  28231. * @returns a new entity
  28232. */
  28233. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28234. /**
  28235. * Clones an object
  28236. * @param creationFunction defines the function used to instanciate the new object
  28237. * @param source defines the source object
  28238. * @returns the cloned object
  28239. */
  28240. static Clone<T>(creationFunction: () => T, source: T): T;
  28241. /**
  28242. * Instanciates a new object based on a source one (some data will be shared between both object)
  28243. * @param creationFunction defines the function used to instanciate the new object
  28244. * @param source defines the source object
  28245. * @returns the new object
  28246. */
  28247. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28248. }
  28249. }
  28250. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  28251. import { Nullable } from "babylonjs/types";
  28252. /**
  28253. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  28254. */
  28255. export interface CubeMapInfo {
  28256. /**
  28257. * The pixel array for the front face.
  28258. * This is stored in format, left to right, up to down format.
  28259. */
  28260. front: Nullable<ArrayBufferView>;
  28261. /**
  28262. * The pixel array for the back face.
  28263. * This is stored in format, left to right, up to down format.
  28264. */
  28265. back: Nullable<ArrayBufferView>;
  28266. /**
  28267. * The pixel array for the left face.
  28268. * This is stored in format, left to right, up to down format.
  28269. */
  28270. left: Nullable<ArrayBufferView>;
  28271. /**
  28272. * The pixel array for the right face.
  28273. * This is stored in format, left to right, up to down format.
  28274. */
  28275. right: Nullable<ArrayBufferView>;
  28276. /**
  28277. * The pixel array for the up face.
  28278. * This is stored in format, left to right, up to down format.
  28279. */
  28280. up: Nullable<ArrayBufferView>;
  28281. /**
  28282. * The pixel array for the down face.
  28283. * This is stored in format, left to right, up to down format.
  28284. */
  28285. down: Nullable<ArrayBufferView>;
  28286. /**
  28287. * The size of the cubemap stored.
  28288. *
  28289. * Each faces will be size * size pixels.
  28290. */
  28291. size: number;
  28292. /**
  28293. * The format of the texture.
  28294. *
  28295. * RGBA, RGB.
  28296. */
  28297. format: number;
  28298. /**
  28299. * The type of the texture data.
  28300. *
  28301. * UNSIGNED_INT, FLOAT.
  28302. */
  28303. type: number;
  28304. /**
  28305. * Specifies whether the texture is in gamma space.
  28306. */
  28307. gammaSpace: boolean;
  28308. }
  28309. /**
  28310. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  28311. */
  28312. export class PanoramaToCubeMapTools {
  28313. private static FACE_FRONT;
  28314. private static FACE_BACK;
  28315. private static FACE_RIGHT;
  28316. private static FACE_LEFT;
  28317. private static FACE_DOWN;
  28318. private static FACE_UP;
  28319. /**
  28320. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  28321. *
  28322. * @param float32Array The source data.
  28323. * @param inputWidth The width of the input panorama.
  28324. * @param inputHeight The height of the input panorama.
  28325. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  28326. * @return The cubemap data
  28327. */
  28328. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  28329. private static CreateCubemapTexture;
  28330. private static CalcProjectionSpherical;
  28331. }
  28332. }
  28333. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  28334. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28335. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28336. import { Nullable } from "babylonjs/types";
  28337. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  28338. /**
  28339. * Helper class dealing with the extraction of spherical polynomial dataArray
  28340. * from a cube map.
  28341. */
  28342. export class CubeMapToSphericalPolynomialTools {
  28343. private static FileFaces;
  28344. /**
  28345. * Converts a texture to the according Spherical Polynomial data.
  28346. * This extracts the first 3 orders only as they are the only one used in the lighting.
  28347. *
  28348. * @param texture The texture to extract the information from.
  28349. * @return The Spherical Polynomial data.
  28350. */
  28351. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  28352. /**
  28353. * Converts a cubemap to the according Spherical Polynomial data.
  28354. * This extracts the first 3 orders only as they are the only one used in the lighting.
  28355. *
  28356. * @param cubeInfo The Cube map to extract the information from.
  28357. * @return The Spherical Polynomial data.
  28358. */
  28359. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  28360. }
  28361. }
  28362. declare module "babylonjs/Misc/guid" {
  28363. /**
  28364. * Class used to manipulate GUIDs
  28365. */
  28366. export class GUID {
  28367. /**
  28368. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28369. * Be aware Math.random() could cause collisions, but:
  28370. * "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"
  28371. * @returns a pseudo random id
  28372. */
  28373. static RandomId(): string;
  28374. }
  28375. }
  28376. declare module "babylonjs/Materials/Textures/baseTexture" {
  28377. import { Observable } from "babylonjs/Misc/observable";
  28378. import { Nullable } from "babylonjs/types";
  28379. import { Scene } from "babylonjs/scene";
  28380. import { Matrix } from "babylonjs/Maths/math.vector";
  28381. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28382. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28383. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28384. import { ISize } from "babylonjs/Maths/math.size";
  28385. /**
  28386. * Base class of all the textures in babylon.
  28387. * It groups all the common properties the materials, post process, lights... might need
  28388. * in order to make a correct use of the texture.
  28389. */
  28390. export class BaseTexture implements IAnimatable {
  28391. /**
  28392. * Default anisotropic filtering level for the application.
  28393. * It is set to 4 as a good tradeoff between perf and quality.
  28394. */
  28395. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28396. /**
  28397. * Gets or sets the unique id of the texture
  28398. */
  28399. uniqueId: number;
  28400. /**
  28401. * Define the name of the texture.
  28402. */
  28403. name: string;
  28404. /**
  28405. * Gets or sets an object used to store user defined information.
  28406. */
  28407. metadata: any;
  28408. /**
  28409. * For internal use only. Please do not use.
  28410. */
  28411. reservedDataStore: any;
  28412. private _hasAlpha;
  28413. /**
  28414. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28415. */
  28416. hasAlpha: boolean;
  28417. /**
  28418. * Defines if the alpha value should be determined via the rgb values.
  28419. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28420. */
  28421. getAlphaFromRGB: boolean;
  28422. /**
  28423. * Intensity or strength of the texture.
  28424. * It is commonly used by materials to fine tune the intensity of the texture
  28425. */
  28426. level: number;
  28427. /**
  28428. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28429. * This is part of the texture as textures usually maps to one uv set.
  28430. */
  28431. coordinatesIndex: number;
  28432. private _coordinatesMode;
  28433. /**
  28434. * How a texture is mapped.
  28435. *
  28436. * | Value | Type | Description |
  28437. * | ----- | ----------------------------------- | ----------- |
  28438. * | 0 | EXPLICIT_MODE | |
  28439. * | 1 | SPHERICAL_MODE | |
  28440. * | 2 | PLANAR_MODE | |
  28441. * | 3 | CUBIC_MODE | |
  28442. * | 4 | PROJECTION_MODE | |
  28443. * | 5 | SKYBOX_MODE | |
  28444. * | 6 | INVCUBIC_MODE | |
  28445. * | 7 | EQUIRECTANGULAR_MODE | |
  28446. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28447. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28448. */
  28449. coordinatesMode: number;
  28450. /**
  28451. * | Value | Type | Description |
  28452. * | ----- | ------------------ | ----------- |
  28453. * | 0 | CLAMP_ADDRESSMODE | |
  28454. * | 1 | WRAP_ADDRESSMODE | |
  28455. * | 2 | MIRROR_ADDRESSMODE | |
  28456. */
  28457. wrapU: number;
  28458. /**
  28459. * | Value | Type | Description |
  28460. * | ----- | ------------------ | ----------- |
  28461. * | 0 | CLAMP_ADDRESSMODE | |
  28462. * | 1 | WRAP_ADDRESSMODE | |
  28463. * | 2 | MIRROR_ADDRESSMODE | |
  28464. */
  28465. wrapV: number;
  28466. /**
  28467. * | Value | Type | Description |
  28468. * | ----- | ------------------ | ----------- |
  28469. * | 0 | CLAMP_ADDRESSMODE | |
  28470. * | 1 | WRAP_ADDRESSMODE | |
  28471. * | 2 | MIRROR_ADDRESSMODE | |
  28472. */
  28473. wrapR: number;
  28474. /**
  28475. * With compliant hardware and browser (supporting anisotropic filtering)
  28476. * this defines the level of anisotropic filtering in the texture.
  28477. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  28478. */
  28479. anisotropicFilteringLevel: number;
  28480. /**
  28481. * Define if the texture is a cube texture or if false a 2d texture.
  28482. */
  28483. isCube: boolean;
  28484. /**
  28485. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  28486. */
  28487. is3D: boolean;
  28488. /**
  28489. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  28490. * HDR texture are usually stored in linear space.
  28491. * This only impacts the PBR and Background materials
  28492. */
  28493. gammaSpace: boolean;
  28494. /**
  28495. * Gets or sets whether or not the texture contains RGBD data.
  28496. */
  28497. isRGBD: boolean;
  28498. /**
  28499. * Is Z inverted in the texture (useful in a cube texture).
  28500. */
  28501. invertZ: boolean;
  28502. /**
  28503. * Are mip maps generated for this texture or not.
  28504. */
  28505. readonly noMipmap: boolean;
  28506. /**
  28507. * @hidden
  28508. */
  28509. lodLevelInAlpha: boolean;
  28510. /**
  28511. * With prefiltered texture, defined the offset used during the prefiltering steps.
  28512. */
  28513. lodGenerationOffset: number;
  28514. /**
  28515. * With prefiltered texture, defined the scale used during the prefiltering steps.
  28516. */
  28517. lodGenerationScale: number;
  28518. /**
  28519. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  28520. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  28521. * average roughness values.
  28522. */
  28523. linearSpecularLOD: boolean;
  28524. /**
  28525. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  28526. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  28527. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  28528. */
  28529. irradianceTexture: Nullable<BaseTexture>;
  28530. /**
  28531. * Define if the texture is a render target.
  28532. */
  28533. isRenderTarget: boolean;
  28534. /**
  28535. * Define the unique id of the texture in the scene.
  28536. */
  28537. readonly uid: string;
  28538. /**
  28539. * Return a string representation of the texture.
  28540. * @returns the texture as a string
  28541. */
  28542. toString(): string;
  28543. /**
  28544. * Get the class name of the texture.
  28545. * @returns "BaseTexture"
  28546. */
  28547. getClassName(): string;
  28548. /**
  28549. * Define the list of animation attached to the texture.
  28550. */
  28551. animations: import("babylonjs/Animations/animation").Animation[];
  28552. /**
  28553. * An event triggered when the texture is disposed.
  28554. */
  28555. onDisposeObservable: Observable<BaseTexture>;
  28556. private _onDisposeObserver;
  28557. /**
  28558. * Callback triggered when the texture has been disposed.
  28559. * Kept for back compatibility, you can use the onDisposeObservable instead.
  28560. */
  28561. onDispose: () => void;
  28562. /**
  28563. * Define the current state of the loading sequence when in delayed load mode.
  28564. */
  28565. delayLoadState: number;
  28566. private _scene;
  28567. /** @hidden */
  28568. _texture: Nullable<InternalTexture>;
  28569. private _uid;
  28570. /**
  28571. * Define if the texture is preventinga material to render or not.
  28572. * If not and the texture is not ready, the engine will use a default black texture instead.
  28573. */
  28574. readonly isBlocking: boolean;
  28575. /**
  28576. * Instantiates a new BaseTexture.
  28577. * Base class of all the textures in babylon.
  28578. * It groups all the common properties the materials, post process, lights... might need
  28579. * in order to make a correct use of the texture.
  28580. * @param scene Define the scene the texture blongs to
  28581. */
  28582. constructor(scene: Nullable<Scene>);
  28583. /**
  28584. * Get the scene the texture belongs to.
  28585. * @returns the scene or null if undefined
  28586. */
  28587. getScene(): Nullable<Scene>;
  28588. /**
  28589. * Get the texture transform matrix used to offset tile the texture for istance.
  28590. * @returns the transformation matrix
  28591. */
  28592. getTextureMatrix(): Matrix;
  28593. /**
  28594. * Get the texture reflection matrix used to rotate/transform the reflection.
  28595. * @returns the reflection matrix
  28596. */
  28597. getReflectionTextureMatrix(): Matrix;
  28598. /**
  28599. * Get the underlying lower level texture from Babylon.
  28600. * @returns the insternal texture
  28601. */
  28602. getInternalTexture(): Nullable<InternalTexture>;
  28603. /**
  28604. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  28605. * @returns true if ready or not blocking
  28606. */
  28607. isReadyOrNotBlocking(): boolean;
  28608. /**
  28609. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  28610. * @returns true if fully ready
  28611. */
  28612. isReady(): boolean;
  28613. private _cachedSize;
  28614. /**
  28615. * Get the size of the texture.
  28616. * @returns the texture size.
  28617. */
  28618. getSize(): ISize;
  28619. /**
  28620. * Get the base size of the texture.
  28621. * It can be different from the size if the texture has been resized for POT for instance
  28622. * @returns the base size
  28623. */
  28624. getBaseSize(): ISize;
  28625. /**
  28626. * Update the sampling mode of the texture.
  28627. * Default is Trilinear mode.
  28628. *
  28629. * | Value | Type | Description |
  28630. * | ----- | ------------------ | ----------- |
  28631. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  28632. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  28633. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  28634. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  28635. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  28636. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  28637. * | 7 | NEAREST_LINEAR | |
  28638. * | 8 | NEAREST_NEAREST | |
  28639. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  28640. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  28641. * | 11 | LINEAR_LINEAR | |
  28642. * | 12 | LINEAR_NEAREST | |
  28643. *
  28644. * > _mag_: magnification filter (close to the viewer)
  28645. * > _min_: minification filter (far from the viewer)
  28646. * > _mip_: filter used between mip map levels
  28647. *@param samplingMode Define the new sampling mode of the texture
  28648. */
  28649. updateSamplingMode(samplingMode: number): void;
  28650. /**
  28651. * Scales the texture if is `canRescale()`
  28652. * @param ratio the resize factor we want to use to rescale
  28653. */
  28654. scale(ratio: number): void;
  28655. /**
  28656. * Get if the texture can rescale.
  28657. */
  28658. readonly canRescale: boolean;
  28659. /** @hidden */
  28660. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  28661. /** @hidden */
  28662. _rebuild(): void;
  28663. /**
  28664. * Triggers the load sequence in delayed load mode.
  28665. */
  28666. delayLoad(): void;
  28667. /**
  28668. * Clones the texture.
  28669. * @returns the cloned texture
  28670. */
  28671. clone(): Nullable<BaseTexture>;
  28672. /**
  28673. * Get the texture underlying type (INT, FLOAT...)
  28674. */
  28675. readonly textureType: number;
  28676. /**
  28677. * Get the texture underlying format (RGB, RGBA...)
  28678. */
  28679. readonly textureFormat: number;
  28680. /**
  28681. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  28682. * This will returns an RGBA array buffer containing either in values (0-255) or
  28683. * float values (0-1) depending of the underlying buffer type.
  28684. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  28685. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  28686. * @param buffer defines a user defined buffer to fill with data (can be null)
  28687. * @returns The Array buffer containing the pixels data.
  28688. */
  28689. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  28690. /**
  28691. * Release and destroy the underlying lower level texture aka internalTexture.
  28692. */
  28693. releaseInternalTexture(): void;
  28694. /**
  28695. * Get the polynomial representation of the texture data.
  28696. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  28697. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  28698. */
  28699. sphericalPolynomial: Nullable<SphericalPolynomial>;
  28700. /** @hidden */
  28701. readonly _lodTextureHigh: Nullable<BaseTexture>;
  28702. /** @hidden */
  28703. readonly _lodTextureMid: Nullable<BaseTexture>;
  28704. /** @hidden */
  28705. readonly _lodTextureLow: Nullable<BaseTexture>;
  28706. /**
  28707. * Dispose the texture and release its associated resources.
  28708. */
  28709. dispose(): void;
  28710. /**
  28711. * Serialize the texture into a JSON representation that can be parsed later on.
  28712. * @returns the JSON representation of the texture
  28713. */
  28714. serialize(): any;
  28715. /**
  28716. * Helper function to be called back once a list of texture contains only ready textures.
  28717. * @param textures Define the list of textures to wait for
  28718. * @param callback Define the callback triggered once the entire list will be ready
  28719. */
  28720. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  28721. }
  28722. }
  28723. declare module "babylonjs/Materials/Textures/internalTexture" {
  28724. import { Observable } from "babylonjs/Misc/observable";
  28725. import { Nullable, int } from "babylonjs/types";
  28726. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28727. import { Engine } from "babylonjs/Engines/engine";
  28728. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28729. /**
  28730. * Class used to store data associated with WebGL texture data for the engine
  28731. * This class should not be used directly
  28732. */
  28733. export class InternalTexture {
  28734. /** @hidden */
  28735. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  28736. /**
  28737. * The source of the texture data is unknown
  28738. */
  28739. static DATASOURCE_UNKNOWN: number;
  28740. /**
  28741. * Texture data comes from an URL
  28742. */
  28743. static DATASOURCE_URL: number;
  28744. /**
  28745. * Texture data is only used for temporary storage
  28746. */
  28747. static DATASOURCE_TEMP: number;
  28748. /**
  28749. * Texture data comes from raw data (ArrayBuffer)
  28750. */
  28751. static DATASOURCE_RAW: number;
  28752. /**
  28753. * Texture content is dynamic (video or dynamic texture)
  28754. */
  28755. static DATASOURCE_DYNAMIC: number;
  28756. /**
  28757. * Texture content is generated by rendering to it
  28758. */
  28759. static DATASOURCE_RENDERTARGET: number;
  28760. /**
  28761. * Texture content is part of a multi render target process
  28762. */
  28763. static DATASOURCE_MULTIRENDERTARGET: number;
  28764. /**
  28765. * Texture data comes from a cube data file
  28766. */
  28767. static DATASOURCE_CUBE: number;
  28768. /**
  28769. * Texture data comes from a raw cube data
  28770. */
  28771. static DATASOURCE_CUBERAW: number;
  28772. /**
  28773. * Texture data come from a prefiltered cube data file
  28774. */
  28775. static DATASOURCE_CUBEPREFILTERED: number;
  28776. /**
  28777. * Texture content is raw 3D data
  28778. */
  28779. static DATASOURCE_RAW3D: number;
  28780. /**
  28781. * Texture content is a depth texture
  28782. */
  28783. static DATASOURCE_DEPTHTEXTURE: number;
  28784. /**
  28785. * Texture data comes from a raw cube data encoded with RGBD
  28786. */
  28787. static DATASOURCE_CUBERAW_RGBD: number;
  28788. /**
  28789. * Defines if the texture is ready
  28790. */
  28791. isReady: boolean;
  28792. /**
  28793. * Defines if the texture is a cube texture
  28794. */
  28795. isCube: boolean;
  28796. /**
  28797. * Defines if the texture contains 3D data
  28798. */
  28799. is3D: boolean;
  28800. /**
  28801. * Defines if the texture contains multiview data
  28802. */
  28803. isMultiview: boolean;
  28804. /**
  28805. * Gets the URL used to load this texture
  28806. */
  28807. url: string;
  28808. /**
  28809. * Gets the sampling mode of the texture
  28810. */
  28811. samplingMode: number;
  28812. /**
  28813. * Gets a boolean indicating if the texture needs mipmaps generation
  28814. */
  28815. generateMipMaps: boolean;
  28816. /**
  28817. * Gets the number of samples used by the texture (WebGL2+ only)
  28818. */
  28819. samples: number;
  28820. /**
  28821. * Gets the type of the texture (int, float...)
  28822. */
  28823. type: number;
  28824. /**
  28825. * Gets the format of the texture (RGB, RGBA...)
  28826. */
  28827. format: number;
  28828. /**
  28829. * Observable called when the texture is loaded
  28830. */
  28831. onLoadedObservable: Observable<InternalTexture>;
  28832. /**
  28833. * Gets the width of the texture
  28834. */
  28835. width: number;
  28836. /**
  28837. * Gets the height of the texture
  28838. */
  28839. height: number;
  28840. /**
  28841. * Gets the depth of the texture
  28842. */
  28843. depth: number;
  28844. /**
  28845. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  28846. */
  28847. baseWidth: number;
  28848. /**
  28849. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  28850. */
  28851. baseHeight: number;
  28852. /**
  28853. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  28854. */
  28855. baseDepth: number;
  28856. /**
  28857. * Gets a boolean indicating if the texture is inverted on Y axis
  28858. */
  28859. invertY: boolean;
  28860. /** @hidden */
  28861. _invertVScale: boolean;
  28862. /** @hidden */
  28863. _associatedChannel: number;
  28864. /** @hidden */
  28865. _dataSource: number;
  28866. /** @hidden */
  28867. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>;
  28868. /** @hidden */
  28869. _bufferView: Nullable<ArrayBufferView>;
  28870. /** @hidden */
  28871. _bufferViewArray: Nullable<ArrayBufferView[]>;
  28872. /** @hidden */
  28873. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  28874. /** @hidden */
  28875. _size: number;
  28876. /** @hidden */
  28877. _extension: string;
  28878. /** @hidden */
  28879. _files: Nullable<string[]>;
  28880. /** @hidden */
  28881. _workingCanvas: Nullable<HTMLCanvasElement>;
  28882. /** @hidden */
  28883. _workingContext: Nullable<CanvasRenderingContext2D>;
  28884. /** @hidden */
  28885. _framebuffer: Nullable<WebGLFramebuffer>;
  28886. /** @hidden */
  28887. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  28888. /** @hidden */
  28889. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  28890. /** @hidden */
  28891. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  28892. /** @hidden */
  28893. _attachments: Nullable<number[]>;
  28894. /** @hidden */
  28895. _cachedCoordinatesMode: Nullable<number>;
  28896. /** @hidden */
  28897. _cachedWrapU: Nullable<number>;
  28898. /** @hidden */
  28899. _cachedWrapV: Nullable<number>;
  28900. /** @hidden */
  28901. _cachedWrapR: Nullable<number>;
  28902. /** @hidden */
  28903. _cachedAnisotropicFilteringLevel: Nullable<number>;
  28904. /** @hidden */
  28905. _isDisabled: boolean;
  28906. /** @hidden */
  28907. _compression: Nullable<string>;
  28908. /** @hidden */
  28909. _generateStencilBuffer: boolean;
  28910. /** @hidden */
  28911. _generateDepthBuffer: boolean;
  28912. /** @hidden */
  28913. _comparisonFunction: number;
  28914. /** @hidden */
  28915. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  28916. /** @hidden */
  28917. _lodGenerationScale: number;
  28918. /** @hidden */
  28919. _lodGenerationOffset: number;
  28920. /** @hidden */
  28921. _colorTextureArray: Nullable<WebGLTexture>;
  28922. /** @hidden */
  28923. _depthStencilTextureArray: Nullable<WebGLTexture>;
  28924. /** @hidden */
  28925. _lodTextureHigh: Nullable<BaseTexture>;
  28926. /** @hidden */
  28927. _lodTextureMid: Nullable<BaseTexture>;
  28928. /** @hidden */
  28929. _lodTextureLow: Nullable<BaseTexture>;
  28930. /** @hidden */
  28931. _isRGBD: boolean;
  28932. /** @hidden */
  28933. _linearSpecularLOD: boolean;
  28934. /** @hidden */
  28935. _irradianceTexture: Nullable<BaseTexture>;
  28936. /** @hidden */
  28937. _webGLTexture: Nullable<WebGLTexture>;
  28938. /** @hidden */
  28939. _references: number;
  28940. private _engine;
  28941. /**
  28942. * Gets the Engine the texture belongs to.
  28943. * @returns The babylon engine
  28944. */
  28945. getEngine(): Engine;
  28946. /**
  28947. * Gets the data source type of the texture (can be one of the InternalTexture.DATASOURCE_XXXX)
  28948. */
  28949. readonly dataSource: number;
  28950. /**
  28951. * Creates a new InternalTexture
  28952. * @param engine defines the engine to use
  28953. * @param dataSource defines the type of data that will be used
  28954. * @param delayAllocation if the texture allocation should be delayed (default: false)
  28955. */
  28956. constructor(engine: Engine, dataSource: number, delayAllocation?: boolean);
  28957. /**
  28958. * Increments the number of references (ie. the number of Texture that point to it)
  28959. */
  28960. incrementReferences(): void;
  28961. /**
  28962. * Change the size of the texture (not the size of the content)
  28963. * @param width defines the new width
  28964. * @param height defines the new height
  28965. * @param depth defines the new depth (1 by default)
  28966. */
  28967. updateSize(width: int, height: int, depth?: int): void;
  28968. /** @hidden */
  28969. _rebuild(): void;
  28970. /** @hidden */
  28971. _swapAndDie(target: InternalTexture): void;
  28972. /**
  28973. * Dispose the current allocated resources
  28974. */
  28975. dispose(): void;
  28976. }
  28977. }
  28978. declare module "babylonjs/Materials/effect" {
  28979. import { Observable } from "babylonjs/Misc/observable";
  28980. import { Nullable } from "babylonjs/types";
  28981. import { IDisposable } from "babylonjs/scene";
  28982. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  28983. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  28984. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  28985. import { Engine } from "babylonjs/Engines/engine";
  28986. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28987. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28988. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  28989. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  28990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28991. /**
  28992. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  28993. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  28994. */
  28995. export class EffectFallbacks {
  28996. private _defines;
  28997. private _currentRank;
  28998. private _maxRank;
  28999. private _mesh;
  29000. /**
  29001. * Removes the fallback from the bound mesh.
  29002. */
  29003. unBindMesh(): void;
  29004. /**
  29005. * Adds a fallback on the specified property.
  29006. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  29007. * @param define The name of the define in the shader
  29008. */
  29009. addFallback(rank: number, define: string): void;
  29010. /**
  29011. * Sets the mesh to use CPU skinning when needing to fallback.
  29012. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  29013. * @param mesh The mesh to use the fallbacks.
  29014. */
  29015. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  29016. /**
  29017. * Checks to see if more fallbacks are still availible.
  29018. */
  29019. readonly hasMoreFallbacks: boolean;
  29020. /**
  29021. * Removes the defines that should be removed when falling back.
  29022. * @param currentDefines defines the current define statements for the shader.
  29023. * @param effect defines the current effect we try to compile
  29024. * @returns The resulting defines with defines of the current rank removed.
  29025. */
  29026. reduce(currentDefines: string, effect: Effect): string;
  29027. }
  29028. /**
  29029. * Options to be used when creating an effect.
  29030. */
  29031. export class EffectCreationOptions {
  29032. /**
  29033. * Atrributes that will be used in the shader.
  29034. */
  29035. attributes: string[];
  29036. /**
  29037. * Uniform varible names that will be set in the shader.
  29038. */
  29039. uniformsNames: string[];
  29040. /**
  29041. * Uniform buffer varible names that will be set in the shader.
  29042. */
  29043. uniformBuffersNames: string[];
  29044. /**
  29045. * Sampler texture variable names that will be set in the shader.
  29046. */
  29047. samplers: string[];
  29048. /**
  29049. * Define statements that will be set in the shader.
  29050. */
  29051. defines: any;
  29052. /**
  29053. * Possible fallbacks for this effect to improve performance when needed.
  29054. */
  29055. fallbacks: Nullable<EffectFallbacks>;
  29056. /**
  29057. * Callback that will be called when the shader is compiled.
  29058. */
  29059. onCompiled: Nullable<(effect: Effect) => void>;
  29060. /**
  29061. * Callback that will be called if an error occurs during shader compilation.
  29062. */
  29063. onError: Nullable<(effect: Effect, errors: string) => void>;
  29064. /**
  29065. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29066. */
  29067. indexParameters: any;
  29068. /**
  29069. * Max number of lights that can be used in the shader.
  29070. */
  29071. maxSimultaneousLights: number;
  29072. /**
  29073. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29074. */
  29075. transformFeedbackVaryings: Nullable<string[]>;
  29076. }
  29077. /**
  29078. * Effect containing vertex and fragment shader that can be executed on an object.
  29079. */
  29080. export class Effect implements IDisposable {
  29081. /**
  29082. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29083. */
  29084. static ShadersRepository: string;
  29085. /**
  29086. * Name of the effect.
  29087. */
  29088. name: any;
  29089. /**
  29090. * String container all the define statements that should be set on the shader.
  29091. */
  29092. defines: string;
  29093. /**
  29094. * Callback that will be called when the shader is compiled.
  29095. */
  29096. onCompiled: Nullable<(effect: Effect) => void>;
  29097. /**
  29098. * Callback that will be called if an error occurs during shader compilation.
  29099. */
  29100. onError: Nullable<(effect: Effect, errors: string) => void>;
  29101. /**
  29102. * Callback that will be called when effect is bound.
  29103. */
  29104. onBind: Nullable<(effect: Effect) => void>;
  29105. /**
  29106. * Unique ID of the effect.
  29107. */
  29108. uniqueId: number;
  29109. /**
  29110. * Observable that will be called when the shader is compiled.
  29111. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29112. */
  29113. onCompileObservable: Observable<Effect>;
  29114. /**
  29115. * Observable that will be called if an error occurs during shader compilation.
  29116. */
  29117. onErrorObservable: Observable<Effect>;
  29118. /** @hidden */
  29119. _onBindObservable: Nullable<Observable<Effect>>;
  29120. /**
  29121. * Observable that will be called when effect is bound.
  29122. */
  29123. readonly onBindObservable: Observable<Effect>;
  29124. /** @hidden */
  29125. _bonesComputationForcedToCPU: boolean;
  29126. private static _uniqueIdSeed;
  29127. private _engine;
  29128. private _uniformBuffersNames;
  29129. private _uniformsNames;
  29130. private _samplerList;
  29131. private _samplers;
  29132. private _isReady;
  29133. private _compilationError;
  29134. private _attributesNames;
  29135. private _attributes;
  29136. private _uniforms;
  29137. /**
  29138. * Key for the effect.
  29139. * @hidden
  29140. */
  29141. _key: string;
  29142. private _indexParameters;
  29143. private _fallbacks;
  29144. private _vertexSourceCode;
  29145. private _fragmentSourceCode;
  29146. private _vertexSourceCodeOverride;
  29147. private _fragmentSourceCodeOverride;
  29148. private _transformFeedbackVaryings;
  29149. /**
  29150. * Compiled shader to webGL program.
  29151. * @hidden
  29152. */
  29153. _pipelineContext: Nullable<IPipelineContext>;
  29154. private _valueCache;
  29155. private static _baseCache;
  29156. /**
  29157. * Instantiates an effect.
  29158. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29159. * @param baseName Name of the effect.
  29160. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29161. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29162. * @param samplers List of sampler variables that will be passed to the shader.
  29163. * @param engine Engine to be used to render the effect
  29164. * @param defines Define statements to be added to the shader.
  29165. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29166. * @param onCompiled Callback that will be called when the shader is compiled.
  29167. * @param onError Callback that will be called if an error occurs during shader compilation.
  29168. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29169. */
  29170. constructor(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: Nullable<string[]>, engine?: Engine, defines?: Nullable<string>, fallbacks?: Nullable<EffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  29171. private _useFinalCode;
  29172. /**
  29173. * Unique key for this effect
  29174. */
  29175. readonly key: string;
  29176. /**
  29177. * If the effect has been compiled and prepared.
  29178. * @returns if the effect is compiled and prepared.
  29179. */
  29180. isReady(): boolean;
  29181. private _isReadyInternal;
  29182. /**
  29183. * The engine the effect was initialized with.
  29184. * @returns the engine.
  29185. */
  29186. getEngine(): Engine;
  29187. /**
  29188. * The pipeline context for this effect
  29189. * @returns the associated pipeline context
  29190. */
  29191. getPipelineContext(): Nullable<IPipelineContext>;
  29192. /**
  29193. * The set of names of attribute variables for the shader.
  29194. * @returns An array of attribute names.
  29195. */
  29196. getAttributesNames(): string[];
  29197. /**
  29198. * Returns the attribute at the given index.
  29199. * @param index The index of the attribute.
  29200. * @returns The location of the attribute.
  29201. */
  29202. getAttributeLocation(index: number): number;
  29203. /**
  29204. * Returns the attribute based on the name of the variable.
  29205. * @param name of the attribute to look up.
  29206. * @returns the attribute location.
  29207. */
  29208. getAttributeLocationByName(name: string): number;
  29209. /**
  29210. * The number of attributes.
  29211. * @returns the numnber of attributes.
  29212. */
  29213. getAttributesCount(): number;
  29214. /**
  29215. * Gets the index of a uniform variable.
  29216. * @param uniformName of the uniform to look up.
  29217. * @returns the index.
  29218. */
  29219. getUniformIndex(uniformName: string): number;
  29220. /**
  29221. * Returns the attribute based on the name of the variable.
  29222. * @param uniformName of the uniform to look up.
  29223. * @returns the location of the uniform.
  29224. */
  29225. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29226. /**
  29227. * Returns an array of sampler variable names
  29228. * @returns The array of sampler variable neames.
  29229. */
  29230. getSamplers(): string[];
  29231. /**
  29232. * The error from the last compilation.
  29233. * @returns the error string.
  29234. */
  29235. getCompilationError(): string;
  29236. /**
  29237. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29238. * @param func The callback to be used.
  29239. */
  29240. executeWhenCompiled(func: (effect: Effect) => void): void;
  29241. private _checkIsReady;
  29242. /** @hidden */
  29243. _loadVertexShader(vertex: any, callback: (data: any) => void): void;
  29244. /** @hidden */
  29245. _loadFragmentShader(fragment: any, callback: (data: any) => void): void;
  29246. /** @hidden */
  29247. _dumpShadersSource(vertexCode: string, fragmentCode: string, defines: string): void;
  29248. /**
  29249. * Recompiles the webGL program
  29250. * @param vertexSourceCode The source code for the vertex shader.
  29251. * @param fragmentSourceCode The source code for the fragment shader.
  29252. * @param onCompiled Callback called when completed.
  29253. * @param onError Callback called on error.
  29254. * @hidden
  29255. */
  29256. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29257. /**
  29258. * Prepares the effect
  29259. * @hidden
  29260. */
  29261. _prepareEffect(): void;
  29262. private _processCompilationErrors;
  29263. /**
  29264. * Checks if the effect is supported. (Must be called after compilation)
  29265. */
  29266. readonly isSupported: boolean;
  29267. /**
  29268. * Binds a texture to the engine to be used as output of the shader.
  29269. * @param channel Name of the output variable.
  29270. * @param texture Texture to bind.
  29271. * @hidden
  29272. */
  29273. _bindTexture(channel: string, texture: InternalTexture): void;
  29274. /**
  29275. * Sets a texture on the engine to be used in the shader.
  29276. * @param channel Name of the sampler variable.
  29277. * @param texture Texture to set.
  29278. */
  29279. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29280. /**
  29281. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29282. * @param channel Name of the sampler variable.
  29283. * @param texture Texture to set.
  29284. */
  29285. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29286. /**
  29287. * Sets an array of textures on the engine to be used in the shader.
  29288. * @param channel Name of the variable.
  29289. * @param textures Textures to set.
  29290. */
  29291. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29292. /**
  29293. * 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)
  29294. * @param channel Name of the sampler variable.
  29295. * @param postProcess Post process to get the input texture from.
  29296. */
  29297. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29298. /**
  29299. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29300. * 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)
  29301. * @param channel Name of the sampler variable.
  29302. * @param postProcess Post process to get the output texture from.
  29303. */
  29304. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29305. /** @hidden */
  29306. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29307. /** @hidden */
  29308. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29309. /** @hidden */
  29310. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29311. /** @hidden */
  29312. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29313. /**
  29314. * Binds a buffer to a uniform.
  29315. * @param buffer Buffer to bind.
  29316. * @param name Name of the uniform variable to bind to.
  29317. */
  29318. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29319. /**
  29320. * Binds block to a uniform.
  29321. * @param blockName Name of the block to bind.
  29322. * @param index Index to bind.
  29323. */
  29324. bindUniformBlock(blockName: string, index: number): void;
  29325. /**
  29326. * Sets an interger value on a uniform variable.
  29327. * @param uniformName Name of the variable.
  29328. * @param value Value to be set.
  29329. * @returns this effect.
  29330. */
  29331. setInt(uniformName: string, value: number): Effect;
  29332. /**
  29333. * Sets an int array on a uniform variable.
  29334. * @param uniformName Name of the variable.
  29335. * @param array array to be set.
  29336. * @returns this effect.
  29337. */
  29338. setIntArray(uniformName: string, array: Int32Array): Effect;
  29339. /**
  29340. * 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)
  29341. * @param uniformName Name of the variable.
  29342. * @param array array to be set.
  29343. * @returns this effect.
  29344. */
  29345. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29346. /**
  29347. * 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)
  29348. * @param uniformName Name of the variable.
  29349. * @param array array to be set.
  29350. * @returns this effect.
  29351. */
  29352. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29353. /**
  29354. * 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)
  29355. * @param uniformName Name of the variable.
  29356. * @param array array to be set.
  29357. * @returns this effect.
  29358. */
  29359. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29360. /**
  29361. * Sets an float array on a uniform variable.
  29362. * @param uniformName Name of the variable.
  29363. * @param array array to be set.
  29364. * @returns this effect.
  29365. */
  29366. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29367. /**
  29368. * 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)
  29369. * @param uniformName Name of the variable.
  29370. * @param array array to be set.
  29371. * @returns this effect.
  29372. */
  29373. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29374. /**
  29375. * 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)
  29376. * @param uniformName Name of the variable.
  29377. * @param array array to be set.
  29378. * @returns this effect.
  29379. */
  29380. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29381. /**
  29382. * 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)
  29383. * @param uniformName Name of the variable.
  29384. * @param array array to be set.
  29385. * @returns this effect.
  29386. */
  29387. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29388. /**
  29389. * Sets an array on a uniform variable.
  29390. * @param uniformName Name of the variable.
  29391. * @param array array to be set.
  29392. * @returns this effect.
  29393. */
  29394. setArray(uniformName: string, array: number[]): Effect;
  29395. /**
  29396. * 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)
  29397. * @param uniformName Name of the variable.
  29398. * @param array array to be set.
  29399. * @returns this effect.
  29400. */
  29401. setArray2(uniformName: string, array: number[]): Effect;
  29402. /**
  29403. * 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)
  29404. * @param uniformName Name of the variable.
  29405. * @param array array to be set.
  29406. * @returns this effect.
  29407. */
  29408. setArray3(uniformName: string, array: number[]): Effect;
  29409. /**
  29410. * 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)
  29411. * @param uniformName Name of the variable.
  29412. * @param array array to be set.
  29413. * @returns this effect.
  29414. */
  29415. setArray4(uniformName: string, array: number[]): Effect;
  29416. /**
  29417. * Sets matrices on a uniform variable.
  29418. * @param uniformName Name of the variable.
  29419. * @param matrices matrices to be set.
  29420. * @returns this effect.
  29421. */
  29422. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29423. /**
  29424. * Sets matrix on a uniform variable.
  29425. * @param uniformName Name of the variable.
  29426. * @param matrix matrix to be set.
  29427. * @returns this effect.
  29428. */
  29429. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29430. /**
  29431. * 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)
  29432. * @param uniformName Name of the variable.
  29433. * @param matrix matrix to be set.
  29434. * @returns this effect.
  29435. */
  29436. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29437. /**
  29438. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29439. * @param uniformName Name of the variable.
  29440. * @param matrix matrix to be set.
  29441. * @returns this effect.
  29442. */
  29443. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29444. /**
  29445. * Sets a float on a uniform variable.
  29446. * @param uniformName Name of the variable.
  29447. * @param value value to be set.
  29448. * @returns this effect.
  29449. */
  29450. setFloat(uniformName: string, value: number): Effect;
  29451. /**
  29452. * Sets a boolean on a uniform variable.
  29453. * @param uniformName Name of the variable.
  29454. * @param bool value to be set.
  29455. * @returns this effect.
  29456. */
  29457. setBool(uniformName: string, bool: boolean): Effect;
  29458. /**
  29459. * Sets a Vector2 on a uniform variable.
  29460. * @param uniformName Name of the variable.
  29461. * @param vector2 vector2 to be set.
  29462. * @returns this effect.
  29463. */
  29464. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29465. /**
  29466. * Sets a float2 on a uniform variable.
  29467. * @param uniformName Name of the variable.
  29468. * @param x First float in float2.
  29469. * @param y Second float in float2.
  29470. * @returns this effect.
  29471. */
  29472. setFloat2(uniformName: string, x: number, y: number): Effect;
  29473. /**
  29474. * Sets a Vector3 on a uniform variable.
  29475. * @param uniformName Name of the variable.
  29476. * @param vector3 Value to be set.
  29477. * @returns this effect.
  29478. */
  29479. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29480. /**
  29481. * Sets a float3 on a uniform variable.
  29482. * @param uniformName Name of the variable.
  29483. * @param x First float in float3.
  29484. * @param y Second float in float3.
  29485. * @param z Third float in float3.
  29486. * @returns this effect.
  29487. */
  29488. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29489. /**
  29490. * Sets a Vector4 on a uniform variable.
  29491. * @param uniformName Name of the variable.
  29492. * @param vector4 Value to be set.
  29493. * @returns this effect.
  29494. */
  29495. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29496. /**
  29497. * Sets a float4 on a uniform variable.
  29498. * @param uniformName Name of the variable.
  29499. * @param x First float in float4.
  29500. * @param y Second float in float4.
  29501. * @param z Third float in float4.
  29502. * @param w Fourth float in float4.
  29503. * @returns this effect.
  29504. */
  29505. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29506. /**
  29507. * Sets a Color3 on a uniform variable.
  29508. * @param uniformName Name of the variable.
  29509. * @param color3 Value to be set.
  29510. * @returns this effect.
  29511. */
  29512. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29513. /**
  29514. * Sets a Color4 on a uniform variable.
  29515. * @param uniformName Name of the variable.
  29516. * @param color3 Value to be set.
  29517. * @param alpha Alpha value to be set.
  29518. * @returns this effect.
  29519. */
  29520. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29521. /**
  29522. * Sets a Color4 on a uniform variable
  29523. * @param uniformName defines the name of the variable
  29524. * @param color4 defines the value to be set
  29525. * @returns this effect.
  29526. */
  29527. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29528. /** Release all associated resources */
  29529. dispose(): void;
  29530. /**
  29531. * This function will add a new shader to the shader store
  29532. * @param name the name of the shader
  29533. * @param pixelShader optional pixel shader content
  29534. * @param vertexShader optional vertex shader content
  29535. */
  29536. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29537. /**
  29538. * Store of each shader (The can be looked up using effect.key)
  29539. */
  29540. static ShadersStore: {
  29541. [key: string]: string;
  29542. };
  29543. /**
  29544. * Store of each included file for a shader (The can be looked up using effect.key)
  29545. */
  29546. static IncludesShadersStore: {
  29547. [key: string]: string;
  29548. };
  29549. /**
  29550. * Resets the cache of effects.
  29551. */
  29552. static ResetCache(): void;
  29553. }
  29554. }
  29555. declare module "babylonjs/Materials/uniformBuffer" {
  29556. import { Nullable, FloatArray } from "babylonjs/types";
  29557. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  29558. import { Engine } from "babylonjs/Engines/engine";
  29559. import { Effect } from "babylonjs/Materials/effect";
  29560. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29561. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29562. import { Color3 } from "babylonjs/Maths/math.color";
  29563. /**
  29564. * Uniform buffer objects.
  29565. *
  29566. * Handles blocks of uniform on the GPU.
  29567. *
  29568. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  29569. *
  29570. * For more information, please refer to :
  29571. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  29572. */
  29573. export class UniformBuffer {
  29574. private _engine;
  29575. private _buffer;
  29576. private _data;
  29577. private _bufferData;
  29578. private _dynamic?;
  29579. private _uniformLocations;
  29580. private _uniformSizes;
  29581. private _uniformLocationPointer;
  29582. private _needSync;
  29583. private _noUBO;
  29584. private _currentEffect;
  29585. private static _MAX_UNIFORM_SIZE;
  29586. private static _tempBuffer;
  29587. /**
  29588. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  29589. * This is dynamic to allow compat with webgl 1 and 2.
  29590. * You will need to pass the name of the uniform as well as the value.
  29591. */
  29592. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  29593. /**
  29594. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  29595. * This is dynamic to allow compat with webgl 1 and 2.
  29596. * You will need to pass the name of the uniform as well as the value.
  29597. */
  29598. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  29599. /**
  29600. * Lambda to Update a single float in a uniform buffer.
  29601. * This is dynamic to allow compat with webgl 1 and 2.
  29602. * You will need to pass the name of the uniform as well as the value.
  29603. */
  29604. updateFloat: (name: string, x: number) => void;
  29605. /**
  29606. * Lambda to Update a vec2 of float in a uniform buffer.
  29607. * This is dynamic to allow compat with webgl 1 and 2.
  29608. * You will need to pass the name of the uniform as well as the value.
  29609. */
  29610. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  29611. /**
  29612. * Lambda to Update a vec3 of float in a uniform buffer.
  29613. * This is dynamic to allow compat with webgl 1 and 2.
  29614. * You will need to pass the name of the uniform as well as the value.
  29615. */
  29616. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  29617. /**
  29618. * Lambda to Update a vec4 of float in a uniform buffer.
  29619. * This is dynamic to allow compat with webgl 1 and 2.
  29620. * You will need to pass the name of the uniform as well as the value.
  29621. */
  29622. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  29623. /**
  29624. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  29625. * This is dynamic to allow compat with webgl 1 and 2.
  29626. * You will need to pass the name of the uniform as well as the value.
  29627. */
  29628. updateMatrix: (name: string, mat: Matrix) => void;
  29629. /**
  29630. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  29631. * This is dynamic to allow compat with webgl 1 and 2.
  29632. * You will need to pass the name of the uniform as well as the value.
  29633. */
  29634. updateVector3: (name: string, vector: Vector3) => void;
  29635. /**
  29636. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  29637. * This is dynamic to allow compat with webgl 1 and 2.
  29638. * You will need to pass the name of the uniform as well as the value.
  29639. */
  29640. updateVector4: (name: string, vector: Vector4) => void;
  29641. /**
  29642. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  29643. * This is dynamic to allow compat with webgl 1 and 2.
  29644. * You will need to pass the name of the uniform as well as the value.
  29645. */
  29646. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  29647. /**
  29648. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  29649. * This is dynamic to allow compat with webgl 1 and 2.
  29650. * You will need to pass the name of the uniform as well as the value.
  29651. */
  29652. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  29653. /**
  29654. * Instantiates a new Uniform buffer objects.
  29655. *
  29656. * Handles blocks of uniform on the GPU.
  29657. *
  29658. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  29659. *
  29660. * For more information, please refer to :
  29661. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  29662. * @param engine Define the engine the buffer is associated with
  29663. * @param data Define the data contained in the buffer
  29664. * @param dynamic Define if the buffer is updatable
  29665. */
  29666. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  29667. /**
  29668. * Indicates if the buffer is using the WebGL2 UBO implementation,
  29669. * or just falling back on setUniformXXX calls.
  29670. */
  29671. readonly useUbo: boolean;
  29672. /**
  29673. * Indicates if the WebGL underlying uniform buffer is in sync
  29674. * with the javascript cache data.
  29675. */
  29676. readonly isSync: boolean;
  29677. /**
  29678. * Indicates if the WebGL underlying uniform buffer is dynamic.
  29679. * Also, a dynamic UniformBuffer will disable cache verification and always
  29680. * update the underlying WebGL uniform buffer to the GPU.
  29681. * @returns if Dynamic, otherwise false
  29682. */
  29683. isDynamic(): boolean;
  29684. /**
  29685. * The data cache on JS side.
  29686. * @returns the underlying data as a float array
  29687. */
  29688. getData(): Float32Array;
  29689. /**
  29690. * The underlying WebGL Uniform buffer.
  29691. * @returns the webgl buffer
  29692. */
  29693. getBuffer(): Nullable<DataBuffer>;
  29694. /**
  29695. * std140 layout specifies how to align data within an UBO structure.
  29696. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  29697. * for specs.
  29698. */
  29699. private _fillAlignment;
  29700. /**
  29701. * Adds an uniform in the buffer.
  29702. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  29703. * for the layout to be correct !
  29704. * @param name Name of the uniform, as used in the uniform block in the shader.
  29705. * @param size Data size, or data directly.
  29706. */
  29707. addUniform(name: string, size: number | number[]): void;
  29708. /**
  29709. * Adds a Matrix 4x4 to the uniform buffer.
  29710. * @param name Name of the uniform, as used in the uniform block in the shader.
  29711. * @param mat A 4x4 matrix.
  29712. */
  29713. addMatrix(name: string, mat: Matrix): void;
  29714. /**
  29715. * Adds a vec2 to the uniform buffer.
  29716. * @param name Name of the uniform, as used in the uniform block in the shader.
  29717. * @param x Define the x component value of the vec2
  29718. * @param y Define the y component value of the vec2
  29719. */
  29720. addFloat2(name: string, x: number, y: number): void;
  29721. /**
  29722. * Adds a vec3 to the uniform buffer.
  29723. * @param name Name of the uniform, as used in the uniform block in the shader.
  29724. * @param x Define the x component value of the vec3
  29725. * @param y Define the y component value of the vec3
  29726. * @param z Define the z component value of the vec3
  29727. */
  29728. addFloat3(name: string, x: number, y: number, z: number): void;
  29729. /**
  29730. * Adds a vec3 to the uniform buffer.
  29731. * @param name Name of the uniform, as used in the uniform block in the shader.
  29732. * @param color Define the vec3 from a Color
  29733. */
  29734. addColor3(name: string, color: Color3): void;
  29735. /**
  29736. * Adds a vec4 to the uniform buffer.
  29737. * @param name Name of the uniform, as used in the uniform block in the shader.
  29738. * @param color Define the rgb components from a Color
  29739. * @param alpha Define the a component of the vec4
  29740. */
  29741. addColor4(name: string, color: Color3, alpha: number): void;
  29742. /**
  29743. * Adds a vec3 to the uniform buffer.
  29744. * @param name Name of the uniform, as used in the uniform block in the shader.
  29745. * @param vector Define the vec3 components from a Vector
  29746. */
  29747. addVector3(name: string, vector: Vector3): void;
  29748. /**
  29749. * Adds a Matrix 3x3 to the uniform buffer.
  29750. * @param name Name of the uniform, as used in the uniform block in the shader.
  29751. */
  29752. addMatrix3x3(name: string): void;
  29753. /**
  29754. * Adds a Matrix 2x2 to the uniform buffer.
  29755. * @param name Name of the uniform, as used in the uniform block in the shader.
  29756. */
  29757. addMatrix2x2(name: string): void;
  29758. /**
  29759. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  29760. */
  29761. create(): void;
  29762. /** @hidden */
  29763. _rebuild(): void;
  29764. /**
  29765. * Updates the WebGL Uniform Buffer on the GPU.
  29766. * If the `dynamic` flag is set to true, no cache comparison is done.
  29767. * Otherwise, the buffer will be updated only if the cache differs.
  29768. */
  29769. update(): void;
  29770. /**
  29771. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  29772. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  29773. * @param data Define the flattened data
  29774. * @param size Define the size of the data.
  29775. */
  29776. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  29777. private _valueCache;
  29778. private _cacheMatrix;
  29779. private _updateMatrix3x3ForUniform;
  29780. private _updateMatrix3x3ForEffect;
  29781. private _updateMatrix2x2ForEffect;
  29782. private _updateMatrix2x2ForUniform;
  29783. private _updateFloatForEffect;
  29784. private _updateFloatForUniform;
  29785. private _updateFloat2ForEffect;
  29786. private _updateFloat2ForUniform;
  29787. private _updateFloat3ForEffect;
  29788. private _updateFloat3ForUniform;
  29789. private _updateFloat4ForEffect;
  29790. private _updateFloat4ForUniform;
  29791. private _updateMatrixForEffect;
  29792. private _updateMatrixForUniform;
  29793. private _updateVector3ForEffect;
  29794. private _updateVector3ForUniform;
  29795. private _updateVector4ForEffect;
  29796. private _updateVector4ForUniform;
  29797. private _updateColor3ForEffect;
  29798. private _updateColor3ForUniform;
  29799. private _updateColor4ForEffect;
  29800. private _updateColor4ForUniform;
  29801. /**
  29802. * Sets a sampler uniform on the effect.
  29803. * @param name Define the name of the sampler.
  29804. * @param texture Define the texture to set in the sampler
  29805. */
  29806. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  29807. /**
  29808. * Directly updates the value of the uniform in the cache AND on the GPU.
  29809. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  29810. * @param data Define the flattened data
  29811. */
  29812. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  29813. /**
  29814. * Binds this uniform buffer to an effect.
  29815. * @param effect Define the effect to bind the buffer to
  29816. * @param name Name of the uniform block in the shader.
  29817. */
  29818. bindToEffect(effect: Effect, name: string): void;
  29819. /**
  29820. * Disposes the uniform buffer.
  29821. */
  29822. dispose(): void;
  29823. }
  29824. }
  29825. declare module "babylonjs/Audio/analyser" {
  29826. import { Scene } from "babylonjs/scene";
  29827. /**
  29828. * Class used to work with sound analyzer using fast fourier transform (FFT)
  29829. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29830. */
  29831. export class Analyser {
  29832. /**
  29833. * Gets or sets the smoothing
  29834. * @ignorenaming
  29835. */
  29836. SMOOTHING: number;
  29837. /**
  29838. * Gets or sets the FFT table size
  29839. * @ignorenaming
  29840. */
  29841. FFT_SIZE: number;
  29842. /**
  29843. * Gets or sets the bar graph amplitude
  29844. * @ignorenaming
  29845. */
  29846. BARGRAPHAMPLITUDE: number;
  29847. /**
  29848. * Gets or sets the position of the debug canvas
  29849. * @ignorenaming
  29850. */
  29851. DEBUGCANVASPOS: {
  29852. x: number;
  29853. y: number;
  29854. };
  29855. /**
  29856. * Gets or sets the debug canvas size
  29857. * @ignorenaming
  29858. */
  29859. DEBUGCANVASSIZE: {
  29860. width: number;
  29861. height: number;
  29862. };
  29863. private _byteFreqs;
  29864. private _byteTime;
  29865. private _floatFreqs;
  29866. private _webAudioAnalyser;
  29867. private _debugCanvas;
  29868. private _debugCanvasContext;
  29869. private _scene;
  29870. private _registerFunc;
  29871. private _audioEngine;
  29872. /**
  29873. * Creates a new analyser
  29874. * @param scene defines hosting scene
  29875. */
  29876. constructor(scene: Scene);
  29877. /**
  29878. * Get the number of data values you will have to play with for the visualization
  29879. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  29880. * @returns a number
  29881. */
  29882. getFrequencyBinCount(): number;
  29883. /**
  29884. * Gets the current frequency data as a byte array
  29885. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  29886. * @returns a Uint8Array
  29887. */
  29888. getByteFrequencyData(): Uint8Array;
  29889. /**
  29890. * Gets the current waveform as a byte array
  29891. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  29892. * @returns a Uint8Array
  29893. */
  29894. getByteTimeDomainData(): Uint8Array;
  29895. /**
  29896. * Gets the current frequency data as a float array
  29897. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  29898. * @returns a Float32Array
  29899. */
  29900. getFloatFrequencyData(): Float32Array;
  29901. /**
  29902. * Renders the debug canvas
  29903. */
  29904. drawDebugCanvas(): void;
  29905. /**
  29906. * Stops rendering the debug canvas and removes it
  29907. */
  29908. stopDebugCanvas(): void;
  29909. /**
  29910. * Connects two audio nodes
  29911. * @param inputAudioNode defines first node to connect
  29912. * @param outputAudioNode defines second node to connect
  29913. */
  29914. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  29915. /**
  29916. * Releases all associated resources
  29917. */
  29918. dispose(): void;
  29919. }
  29920. }
  29921. declare module "babylonjs/Audio/audioEngine" {
  29922. import { IDisposable } from "babylonjs/scene";
  29923. import { Analyser } from "babylonjs/Audio/analyser";
  29924. import { Nullable } from "babylonjs/types";
  29925. import { Observable } from "babylonjs/Misc/observable";
  29926. /**
  29927. * This represents an audio engine and it is responsible
  29928. * to play, synchronize and analyse sounds throughout the application.
  29929. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29930. */
  29931. export interface IAudioEngine extends IDisposable {
  29932. /**
  29933. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  29934. */
  29935. readonly canUseWebAudio: boolean;
  29936. /**
  29937. * Gets the current AudioContext if available.
  29938. */
  29939. readonly audioContext: Nullable<AudioContext>;
  29940. /**
  29941. * The master gain node defines the global audio volume of your audio engine.
  29942. */
  29943. readonly masterGain: GainNode;
  29944. /**
  29945. * Gets whether or not mp3 are supported by your browser.
  29946. */
  29947. readonly isMP3supported: boolean;
  29948. /**
  29949. * Gets whether or not ogg are supported by your browser.
  29950. */
  29951. readonly isOGGsupported: boolean;
  29952. /**
  29953. * Defines if Babylon should emit a warning if WebAudio is not supported.
  29954. * @ignoreNaming
  29955. */
  29956. WarnedWebAudioUnsupported: boolean;
  29957. /**
  29958. * Defines if the audio engine relies on a custom unlocked button.
  29959. * In this case, the embedded button will not be displayed.
  29960. */
  29961. useCustomUnlockedButton: boolean;
  29962. /**
  29963. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  29964. */
  29965. readonly unlocked: boolean;
  29966. /**
  29967. * Event raised when audio has been unlocked on the browser.
  29968. */
  29969. onAudioUnlockedObservable: Observable<AudioEngine>;
  29970. /**
  29971. * Event raised when audio has been locked on the browser.
  29972. */
  29973. onAudioLockedObservable: Observable<AudioEngine>;
  29974. /**
  29975. * Flags the audio engine in Locked state.
  29976. * This happens due to new browser policies preventing audio to autoplay.
  29977. */
  29978. lock(): void;
  29979. /**
  29980. * Unlocks the audio engine once a user action has been done on the dom.
  29981. * This is helpful to resume play once browser policies have been satisfied.
  29982. */
  29983. unlock(): void;
  29984. }
  29985. /**
  29986. * This represents the default audio engine used in babylon.
  29987. * It is responsible to play, synchronize and analyse sounds throughout the application.
  29988. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29989. */
  29990. export class AudioEngine implements IAudioEngine {
  29991. private _audioContext;
  29992. private _audioContextInitialized;
  29993. private _muteButton;
  29994. private _hostElement;
  29995. /**
  29996. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  29997. */
  29998. canUseWebAudio: boolean;
  29999. /**
  30000. * The master gain node defines the global audio volume of your audio engine.
  30001. */
  30002. masterGain: GainNode;
  30003. /**
  30004. * Defines if Babylon should emit a warning if WebAudio is not supported.
  30005. * @ignoreNaming
  30006. */
  30007. WarnedWebAudioUnsupported: boolean;
  30008. /**
  30009. * Gets whether or not mp3 are supported by your browser.
  30010. */
  30011. isMP3supported: boolean;
  30012. /**
  30013. * Gets whether or not ogg are supported by your browser.
  30014. */
  30015. isOGGsupported: boolean;
  30016. /**
  30017. * Gets whether audio has been unlocked on the device.
  30018. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  30019. * a user interaction has happened.
  30020. */
  30021. unlocked: boolean;
  30022. /**
  30023. * Defines if the audio engine relies on a custom unlocked button.
  30024. * In this case, the embedded button will not be displayed.
  30025. */
  30026. useCustomUnlockedButton: boolean;
  30027. /**
  30028. * Event raised when audio has been unlocked on the browser.
  30029. */
  30030. onAudioUnlockedObservable: Observable<AudioEngine>;
  30031. /**
  30032. * Event raised when audio has been locked on the browser.
  30033. */
  30034. onAudioLockedObservable: Observable<AudioEngine>;
  30035. /**
  30036. * Gets the current AudioContext if available.
  30037. */
  30038. readonly audioContext: Nullable<AudioContext>;
  30039. private _connectedAnalyser;
  30040. /**
  30041. * Instantiates a new audio engine.
  30042. *
  30043. * There should be only one per page as some browsers restrict the number
  30044. * of audio contexts you can create.
  30045. * @param hostElement defines the host element where to display the mute icon if necessary
  30046. */
  30047. constructor(hostElement?: Nullable<HTMLElement>);
  30048. /**
  30049. * Flags the audio engine in Locked state.
  30050. * This happens due to new browser policies preventing audio to autoplay.
  30051. */
  30052. lock(): void;
  30053. /**
  30054. * Unlocks the audio engine once a user action has been done on the dom.
  30055. * This is helpful to resume play once browser policies have been satisfied.
  30056. */
  30057. unlock(): void;
  30058. private _resumeAudioContext;
  30059. private _initializeAudioContext;
  30060. private _tryToRun;
  30061. private _triggerRunningState;
  30062. private _triggerSuspendedState;
  30063. private _displayMuteButton;
  30064. private _moveButtonToTopLeft;
  30065. private _onResize;
  30066. private _hideMuteButton;
  30067. /**
  30068. * Destroy and release the resources associated with the audio ccontext.
  30069. */
  30070. dispose(): void;
  30071. /**
  30072. * Gets the global volume sets on the master gain.
  30073. * @returns the global volume if set or -1 otherwise
  30074. */
  30075. getGlobalVolume(): number;
  30076. /**
  30077. * Sets the global volume of your experience (sets on the master gain).
  30078. * @param newVolume Defines the new global volume of the application
  30079. */
  30080. setGlobalVolume(newVolume: number): void;
  30081. /**
  30082. * Connect the audio engine to an audio analyser allowing some amazing
  30083. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  30084. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  30085. * @param analyser The analyser to connect to the engine
  30086. */
  30087. connectToAnalyser(analyser: Analyser): void;
  30088. }
  30089. }
  30090. declare module "babylonjs/Loading/loadingScreen" {
  30091. /**
  30092. * Interface used to present a loading screen while loading a scene
  30093. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  30094. */
  30095. export interface ILoadingScreen {
  30096. /**
  30097. * Function called to display the loading screen
  30098. */
  30099. displayLoadingUI: () => void;
  30100. /**
  30101. * Function called to hide the loading screen
  30102. */
  30103. hideLoadingUI: () => void;
  30104. /**
  30105. * Gets or sets the color to use for the background
  30106. */
  30107. loadingUIBackgroundColor: string;
  30108. /**
  30109. * Gets or sets the text to display while loading
  30110. */
  30111. loadingUIText: string;
  30112. }
  30113. /**
  30114. * Class used for the default loading screen
  30115. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  30116. */
  30117. export class DefaultLoadingScreen implements ILoadingScreen {
  30118. private _renderingCanvas;
  30119. private _loadingText;
  30120. private _loadingDivBackgroundColor;
  30121. private _loadingDiv;
  30122. private _loadingTextDiv;
  30123. /** Gets or sets the logo url to use for the default loading screen */
  30124. static DefaultLogoUrl: string;
  30125. /** Gets or sets the spinner url to use for the default loading screen */
  30126. static DefaultSpinnerUrl: string;
  30127. /**
  30128. * Creates a new default loading screen
  30129. * @param _renderingCanvas defines the canvas used to render the scene
  30130. * @param _loadingText defines the default text to display
  30131. * @param _loadingDivBackgroundColor defines the default background color
  30132. */
  30133. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  30134. /**
  30135. * Function called to display the loading screen
  30136. */
  30137. displayLoadingUI(): void;
  30138. /**
  30139. * Function called to hide the loading screen
  30140. */
  30141. hideLoadingUI(): void;
  30142. /**
  30143. * Gets or sets the text to display while loading
  30144. */
  30145. loadingUIText: string;
  30146. /**
  30147. * Gets or sets the color to use for the background
  30148. */
  30149. loadingUIBackgroundColor: string;
  30150. private _resizeLoadingUI;
  30151. }
  30152. }
  30153. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  30154. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30155. import { Engine } from "babylonjs/Engines/engine";
  30156. import { Nullable } from "babylonjs/types";
  30157. /** @hidden */
  30158. export class WebGLPipelineContext implements IPipelineContext {
  30159. engine: Engine;
  30160. program: Nullable<WebGLProgram>;
  30161. context?: WebGLRenderingContext;
  30162. vertexShader?: WebGLShader;
  30163. fragmentShader?: WebGLShader;
  30164. isParallelCompiled: boolean;
  30165. onCompiled?: () => void;
  30166. transformFeedback?: WebGLTransformFeedback | null;
  30167. readonly isAsync: boolean;
  30168. readonly isReady: boolean;
  30169. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  30170. }
  30171. }
  30172. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  30173. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30174. /** @hidden */
  30175. export class WebGLDataBuffer extends DataBuffer {
  30176. private _buffer;
  30177. constructor(resource: WebGLBuffer);
  30178. readonly underlyingResource: any;
  30179. }
  30180. }
  30181. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  30182. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30183. /** @hidden */
  30184. export class WebGL2ShaderProcessor implements IShaderProcessor {
  30185. attributeProcessor(attribute: string): string;
  30186. varyingProcessor(varying: string, isFragment: boolean): string;
  30187. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  30188. }
  30189. }
  30190. declare module "babylonjs/Misc/perfCounter" {
  30191. /**
  30192. * This class is used to track a performance counter which is number based.
  30193. * The user has access to many properties which give statistics of different nature.
  30194. *
  30195. * The implementer can track two kinds of Performance Counter: time and count.
  30196. * 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.
  30197. * 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.
  30198. */
  30199. export class PerfCounter {
  30200. /**
  30201. * Gets or sets a global boolean to turn on and off all the counters
  30202. */
  30203. static Enabled: boolean;
  30204. /**
  30205. * Returns the smallest value ever
  30206. */
  30207. readonly min: number;
  30208. /**
  30209. * Returns the biggest value ever
  30210. */
  30211. readonly max: number;
  30212. /**
  30213. * Returns the average value since the performance counter is running
  30214. */
  30215. readonly average: number;
  30216. /**
  30217. * Returns the average value of the last second the counter was monitored
  30218. */
  30219. readonly lastSecAverage: number;
  30220. /**
  30221. * Returns the current value
  30222. */
  30223. readonly current: number;
  30224. /**
  30225. * Gets the accumulated total
  30226. */
  30227. readonly total: number;
  30228. /**
  30229. * Gets the total value count
  30230. */
  30231. readonly count: number;
  30232. /**
  30233. * Creates a new counter
  30234. */
  30235. constructor();
  30236. /**
  30237. * Call this method to start monitoring a new frame.
  30238. * 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.
  30239. */
  30240. fetchNewFrame(): void;
  30241. /**
  30242. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  30243. * @param newCount the count value to add to the monitored count
  30244. * @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.
  30245. */
  30246. addCount(newCount: number, fetchResult: boolean): void;
  30247. /**
  30248. * Start monitoring this performance counter
  30249. */
  30250. beginMonitoring(): void;
  30251. /**
  30252. * Compute the time lapsed since the previous beginMonitoring() call.
  30253. * @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
  30254. */
  30255. endMonitoring(newFrame?: boolean): void;
  30256. private _fetchResult;
  30257. private _startMonitoringTime;
  30258. private _min;
  30259. private _max;
  30260. private _average;
  30261. private _current;
  30262. private _totalValueCount;
  30263. private _totalAccumulated;
  30264. private _lastSecAverage;
  30265. private _lastSecAccumulated;
  30266. private _lastSecTime;
  30267. private _lastSecValueCount;
  30268. }
  30269. }
  30270. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  30271. /**
  30272. * Interface for any object that can request an animation frame
  30273. */
  30274. export interface ICustomAnimationFrameRequester {
  30275. /**
  30276. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  30277. */
  30278. renderFunction?: Function;
  30279. /**
  30280. * Called to request the next frame to render to
  30281. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  30282. */
  30283. requestAnimationFrame: Function;
  30284. /**
  30285. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  30286. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  30287. */
  30288. requestID?: number;
  30289. }
  30290. }
  30291. declare module "babylonjs/Materials/Textures/videoTexture" {
  30292. import { Observable } from "babylonjs/Misc/observable";
  30293. import { Nullable } from "babylonjs/types";
  30294. import { Scene } from "babylonjs/scene";
  30295. import { Texture } from "babylonjs/Materials/Textures/texture";
  30296. /**
  30297. * Settings for finer control over video usage
  30298. */
  30299. export interface VideoTextureSettings {
  30300. /**
  30301. * Applies `autoplay` to video, if specified
  30302. */
  30303. autoPlay?: boolean;
  30304. /**
  30305. * Applies `loop` to video, if specified
  30306. */
  30307. loop?: boolean;
  30308. /**
  30309. * Automatically updates internal texture from video at every frame in the render loop
  30310. */
  30311. autoUpdateTexture: boolean;
  30312. /**
  30313. * Image src displayed during the video loading or until the user interacts with the video.
  30314. */
  30315. poster?: string;
  30316. }
  30317. /**
  30318. * If you want to display a video in your scene, this is the special texture for that.
  30319. * This special texture works similar to other textures, with the exception of a few parameters.
  30320. * @see https://doc.babylonjs.com/how_to/video_texture
  30321. */
  30322. export class VideoTexture extends Texture {
  30323. /**
  30324. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  30325. */
  30326. readonly autoUpdateTexture: boolean;
  30327. /**
  30328. * The video instance used by the texture internally
  30329. */
  30330. readonly video: HTMLVideoElement;
  30331. private _onUserActionRequestedObservable;
  30332. /**
  30333. * Event triggerd when a dom action is required by the user to play the video.
  30334. * This happens due to recent changes in browser policies preventing video to auto start.
  30335. */
  30336. readonly onUserActionRequestedObservable: Observable<Texture>;
  30337. private _generateMipMaps;
  30338. private _engine;
  30339. private _stillImageCaptured;
  30340. private _displayingPosterTexture;
  30341. private _settings;
  30342. private _createInternalTextureOnEvent;
  30343. private _frameId;
  30344. /**
  30345. * Creates a video texture.
  30346. * If you want to display a video in your scene, this is the special texture for that.
  30347. * This special texture works similar to other textures, with the exception of a few parameters.
  30348. * @see https://doc.babylonjs.com/how_to/video_texture
  30349. * @param name optional name, will detect from video source, if not defined
  30350. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  30351. * @param scene is obviously the current scene.
  30352. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  30353. * @param invertY is false by default but can be used to invert video on Y axis
  30354. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  30355. * @param settings allows finer control over video usage
  30356. */
  30357. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  30358. private _getName;
  30359. private _getVideo;
  30360. private _createInternalTexture;
  30361. private reset;
  30362. /**
  30363. * @hidden Internal method to initiate `update`.
  30364. */
  30365. _rebuild(): void;
  30366. /**
  30367. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  30368. */
  30369. update(): void;
  30370. /**
  30371. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  30372. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  30373. */
  30374. updateTexture(isVisible: boolean): void;
  30375. protected _updateInternalTexture: () => void;
  30376. /**
  30377. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  30378. * @param url New url.
  30379. */
  30380. updateURL(url: string): void;
  30381. /**
  30382. * Dispose the texture and release its associated resources.
  30383. */
  30384. dispose(): void;
  30385. /**
  30386. * Creates a video texture straight from a stream.
  30387. * @param scene Define the scene the texture should be created in
  30388. * @param stream Define the stream the texture should be created from
  30389. * @returns The created video texture as a promise
  30390. */
  30391. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  30392. /**
  30393. * Creates a video texture straight from your WebCam video feed.
  30394. * @param scene Define the scene the texture should be created in
  30395. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30396. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30397. * @returns The created video texture as a promise
  30398. */
  30399. static CreateFromWebCamAsync(scene: Scene, constraints: {
  30400. minWidth: number;
  30401. maxWidth: number;
  30402. minHeight: number;
  30403. maxHeight: number;
  30404. deviceId: string;
  30405. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  30406. /**
  30407. * Creates a video texture straight from your WebCam video feed.
  30408. * @param scene Define the scene the texture should be created in
  30409. * @param onReady Define a callback to triggered once the texture will be ready
  30410. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30411. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30412. */
  30413. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  30414. minWidth: number;
  30415. maxWidth: number;
  30416. minHeight: number;
  30417. maxHeight: number;
  30418. deviceId: string;
  30419. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  30420. }
  30421. }
  30422. declare module "babylonjs/Engines/engine" {
  30423. import { Observable } from "babylonjs/Misc/observable";
  30424. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  30425. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  30426. import { Scene } from "babylonjs/scene";
  30427. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  30428. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30429. import { Effect, EffectCreationOptions, EffectFallbacks } from "babylonjs/Materials/effect";
  30430. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  30431. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30432. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30433. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  30434. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  30435. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  30436. import { _DepthCullingState, _StencilState, _AlphaState } from "babylonjs/States/index";
  30437. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  30438. import { WebRequest } from "babylonjs/Misc/webRequest";
  30439. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30440. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30441. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30442. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  30443. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  30444. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  30445. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  30446. import { Material } from "babylonjs/Materials/material";
  30447. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30448. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30449. /**
  30450. * Defines the interface used by objects containing a viewport (like a camera)
  30451. */
  30452. interface IViewportOwnerLike {
  30453. /**
  30454. * Gets or sets the viewport
  30455. */
  30456. viewport: IViewportLike;
  30457. }
  30458. /**
  30459. * Interface for attribute information associated with buffer instanciation
  30460. */
  30461. export class InstancingAttributeInfo {
  30462. /**
  30463. * Index/offset of the attribute in the vertex shader
  30464. */
  30465. index: number;
  30466. /**
  30467. * size of the attribute, 1, 2, 3 or 4
  30468. */
  30469. attributeSize: number;
  30470. /**
  30471. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  30472. * default is FLOAT
  30473. */
  30474. attribyteType: number;
  30475. /**
  30476. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  30477. */
  30478. normalized: boolean;
  30479. /**
  30480. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  30481. */
  30482. offset: number;
  30483. /**
  30484. * Name of the GLSL attribute, for debugging purpose only
  30485. */
  30486. attributeName: string;
  30487. }
  30488. /**
  30489. * Define options used to create a depth texture
  30490. */
  30491. export class DepthTextureCreationOptions {
  30492. /** Specifies whether or not a stencil should be allocated in the texture */
  30493. generateStencil?: boolean;
  30494. /** Specifies whether or not bilinear filtering is enable on the texture */
  30495. bilinearFiltering?: boolean;
  30496. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  30497. comparisonFunction?: number;
  30498. /** Specifies if the created texture is a cube texture */
  30499. isCube?: boolean;
  30500. }
  30501. /**
  30502. * Class used to describe the capabilities of the engine relatively to the current browser
  30503. */
  30504. export class EngineCapabilities {
  30505. /** Maximum textures units per fragment shader */
  30506. maxTexturesImageUnits: number;
  30507. /** Maximum texture units per vertex shader */
  30508. maxVertexTextureImageUnits: number;
  30509. /** Maximum textures units in the entire pipeline */
  30510. maxCombinedTexturesImageUnits: number;
  30511. /** Maximum texture size */
  30512. maxTextureSize: number;
  30513. /** Maximum cube texture size */
  30514. maxCubemapTextureSize: number;
  30515. /** Maximum render texture size */
  30516. maxRenderTextureSize: number;
  30517. /** Maximum number of vertex attributes */
  30518. maxVertexAttribs: number;
  30519. /** Maximum number of varyings */
  30520. maxVaryingVectors: number;
  30521. /** Maximum number of uniforms per vertex shader */
  30522. maxVertexUniformVectors: number;
  30523. /** Maximum number of uniforms per fragment shader */
  30524. maxFragmentUniformVectors: number;
  30525. /** Defines if standard derivates (dx/dy) are supported */
  30526. standardDerivatives: boolean;
  30527. /** Defines if s3tc texture compression is supported */
  30528. s3tc: Nullable<WEBGL_compressed_texture_s3tc>;
  30529. /** Defines if pvrtc texture compression is supported */
  30530. pvrtc: any;
  30531. /** Defines if etc1 texture compression is supported */
  30532. etc1: any;
  30533. /** Defines if etc2 texture compression is supported */
  30534. etc2: any;
  30535. /** Defines if astc texture compression is supported */
  30536. astc: any;
  30537. /** Defines if float textures are supported */
  30538. textureFloat: boolean;
  30539. /** Defines if vertex array objects are supported */
  30540. vertexArrayObject: boolean;
  30541. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  30542. textureAnisotropicFilterExtension: Nullable<EXT_texture_filter_anisotropic>;
  30543. /** Gets the maximum level of anisotropy supported */
  30544. maxAnisotropy: number;
  30545. /** Defines if instancing is supported */
  30546. instancedArrays: boolean;
  30547. /** Defines if 32 bits indices are supported */
  30548. uintIndices: boolean;
  30549. /** Defines if high precision shaders are supported */
  30550. highPrecisionShaderSupported: boolean;
  30551. /** Defines if depth reading in the fragment shader is supported */
  30552. fragmentDepthSupported: boolean;
  30553. /** Defines if float texture linear filtering is supported*/
  30554. textureFloatLinearFiltering: boolean;
  30555. /** Defines if rendering to float textures is supported */
  30556. textureFloatRender: boolean;
  30557. /** Defines if half float textures are supported*/
  30558. textureHalfFloat: boolean;
  30559. /** Defines if half float texture linear filtering is supported*/
  30560. textureHalfFloatLinearFiltering: boolean;
  30561. /** Defines if rendering to half float textures is supported */
  30562. textureHalfFloatRender: boolean;
  30563. /** Defines if textureLOD shader command is supported */
  30564. textureLOD: boolean;
  30565. /** Defines if draw buffers extension is supported */
  30566. drawBuffersExtension: boolean;
  30567. /** Defines if depth textures are supported */
  30568. depthTextureExtension: boolean;
  30569. /** Defines if float color buffer are supported */
  30570. colorBufferFloat: boolean;
  30571. /** Gets disjoint timer query extension (null if not supported) */
  30572. timerQuery: EXT_disjoint_timer_query;
  30573. /** Defines if timestamp can be used with timer query */
  30574. canUseTimestampForTimerQuery: boolean;
  30575. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  30576. multiview: any;
  30577. /** Function used to let the system compiles shaders in background */
  30578. parallelShaderCompile: {
  30579. COMPLETION_STATUS_KHR: number;
  30580. };
  30581. /** Max number of texture samples for MSAA */
  30582. maxMSAASamples: number;
  30583. }
  30584. /** Interface defining initialization parameters for Engine class */
  30585. export interface EngineOptions extends WebGLContextAttributes {
  30586. /**
  30587. * Defines if the engine should no exceed a specified device ratio
  30588. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  30589. */
  30590. limitDeviceRatio?: number;
  30591. /**
  30592. * Defines if webvr should be enabled automatically
  30593. * @see http://doc.babylonjs.com/how_to/webvr_camera
  30594. */
  30595. autoEnableWebVR?: boolean;
  30596. /**
  30597. * Defines if webgl2 should be turned off even if supported
  30598. * @see http://doc.babylonjs.com/features/webgl2
  30599. */
  30600. disableWebGL2Support?: boolean;
  30601. /**
  30602. * Defines if webaudio should be initialized as well
  30603. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30604. */
  30605. audioEngine?: boolean;
  30606. /**
  30607. * Defines if animations should run using a deterministic lock step
  30608. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  30609. */
  30610. deterministicLockstep?: boolean;
  30611. /** Defines the maximum steps to use with deterministic lock step mode */
  30612. lockstepMaxSteps?: number;
  30613. /**
  30614. * Defines that engine should ignore context lost events
  30615. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  30616. */
  30617. doNotHandleContextLost?: boolean;
  30618. /**
  30619. * Defines that engine should ignore modifying touch action attribute and style
  30620. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  30621. */
  30622. doNotHandleTouchAction?: boolean;
  30623. /**
  30624. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  30625. */
  30626. useHighPrecisionFloats?: boolean;
  30627. }
  30628. /**
  30629. * Defines the interface used by display changed events
  30630. */
  30631. export interface IDisplayChangedEventArgs {
  30632. /** Gets the vrDisplay object (if any) */
  30633. vrDisplay: Nullable<any>;
  30634. /** Gets a boolean indicating if webVR is supported */
  30635. vrSupported: boolean;
  30636. }
  30637. /**
  30638. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  30639. */
  30640. export class Engine {
  30641. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  30642. static ExceptionList: ({
  30643. key: string;
  30644. capture: string;
  30645. captureConstraint: number;
  30646. targets: string[];
  30647. } | {
  30648. key: string;
  30649. capture: null;
  30650. captureConstraint: null;
  30651. targets: string[];
  30652. })[];
  30653. /** Gets the list of created engines */
  30654. static readonly Instances: Engine[];
  30655. /**
  30656. * Gets the latest created engine
  30657. */
  30658. static readonly LastCreatedEngine: Nullable<Engine>;
  30659. /**
  30660. * Gets the latest created scene
  30661. */
  30662. static readonly LastCreatedScene: Nullable<Scene>;
  30663. /**
  30664. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  30665. * @param flag defines which part of the materials must be marked as dirty
  30666. * @param predicate defines a predicate used to filter which materials should be affected
  30667. */
  30668. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  30669. /** @hidden */
  30670. static _TextureLoaders: IInternalTextureLoader[];
  30671. /** Defines that alpha blending is disabled */
  30672. static readonly ALPHA_DISABLE: number;
  30673. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  30674. static readonly ALPHA_ADD: number;
  30675. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  30676. static readonly ALPHA_COMBINE: number;
  30677. /** Defines that alpha blending to DEST - SRC * DEST */
  30678. static readonly ALPHA_SUBTRACT: number;
  30679. /** Defines that alpha blending to SRC * DEST */
  30680. static readonly ALPHA_MULTIPLY: number;
  30681. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  30682. static readonly ALPHA_MAXIMIZED: number;
  30683. /** Defines that alpha blending to SRC + DEST */
  30684. static readonly ALPHA_ONEONE: number;
  30685. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  30686. static readonly ALPHA_PREMULTIPLIED: number;
  30687. /**
  30688. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  30689. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  30690. */
  30691. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  30692. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  30693. static readonly ALPHA_INTERPOLATE: number;
  30694. /**
  30695. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  30696. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  30697. */
  30698. static readonly ALPHA_SCREENMODE: number;
  30699. /** Defines that the ressource is not delayed*/
  30700. static readonly DELAYLOADSTATE_NONE: number;
  30701. /** Defines that the ressource was successfully delay loaded */
  30702. static readonly DELAYLOADSTATE_LOADED: number;
  30703. /** Defines that the ressource is currently delay loading */
  30704. static readonly DELAYLOADSTATE_LOADING: number;
  30705. /** Defines that the ressource is delayed and has not started loading */
  30706. static readonly DELAYLOADSTATE_NOTLOADED: number;
  30707. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  30708. static readonly NEVER: number;
  30709. /** 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 */
  30710. static readonly ALWAYS: number;
  30711. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  30712. static readonly LESS: number;
  30713. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  30714. static readonly EQUAL: number;
  30715. /** 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 */
  30716. static readonly LEQUAL: number;
  30717. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  30718. static readonly GREATER: number;
  30719. /** 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 */
  30720. static readonly GEQUAL: number;
  30721. /** 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 */
  30722. static readonly NOTEQUAL: number;
  30723. /** Passed to stencilOperation to specify that stencil value must be kept */
  30724. static readonly KEEP: number;
  30725. /** Passed to stencilOperation to specify that stencil value must be replaced */
  30726. static readonly REPLACE: number;
  30727. /** Passed to stencilOperation to specify that stencil value must be incremented */
  30728. static readonly INCR: number;
  30729. /** Passed to stencilOperation to specify that stencil value must be decremented */
  30730. static readonly DECR: number;
  30731. /** Passed to stencilOperation to specify that stencil value must be inverted */
  30732. static readonly INVERT: number;
  30733. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  30734. static readonly INCR_WRAP: number;
  30735. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  30736. static readonly DECR_WRAP: number;
  30737. /** Texture is not repeating outside of 0..1 UVs */
  30738. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  30739. /** Texture is repeating outside of 0..1 UVs */
  30740. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  30741. /** Texture is repeating and mirrored */
  30742. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  30743. /** ALPHA */
  30744. static readonly TEXTUREFORMAT_ALPHA: number;
  30745. /** LUMINANCE */
  30746. static readonly TEXTUREFORMAT_LUMINANCE: number;
  30747. /** LUMINANCE_ALPHA */
  30748. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  30749. /** RGB */
  30750. static readonly TEXTUREFORMAT_RGB: number;
  30751. /** RGBA */
  30752. static readonly TEXTUREFORMAT_RGBA: number;
  30753. /** RED */
  30754. static readonly TEXTUREFORMAT_RED: number;
  30755. /** RED (2nd reference) */
  30756. static readonly TEXTUREFORMAT_R: number;
  30757. /** RG */
  30758. static readonly TEXTUREFORMAT_RG: number;
  30759. /** RED_INTEGER */
  30760. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  30761. /** RED_INTEGER (2nd reference) */
  30762. static readonly TEXTUREFORMAT_R_INTEGER: number;
  30763. /** RG_INTEGER */
  30764. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  30765. /** RGB_INTEGER */
  30766. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  30767. /** RGBA_INTEGER */
  30768. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  30769. /** UNSIGNED_BYTE */
  30770. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  30771. /** UNSIGNED_BYTE (2nd reference) */
  30772. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  30773. /** FLOAT */
  30774. static readonly TEXTURETYPE_FLOAT: number;
  30775. /** HALF_FLOAT */
  30776. static readonly TEXTURETYPE_HALF_FLOAT: number;
  30777. /** BYTE */
  30778. static readonly TEXTURETYPE_BYTE: number;
  30779. /** SHORT */
  30780. static readonly TEXTURETYPE_SHORT: number;
  30781. /** UNSIGNED_SHORT */
  30782. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  30783. /** INT */
  30784. static readonly TEXTURETYPE_INT: number;
  30785. /** UNSIGNED_INT */
  30786. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  30787. /** UNSIGNED_SHORT_4_4_4_4 */
  30788. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  30789. /** UNSIGNED_SHORT_5_5_5_1 */
  30790. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  30791. /** UNSIGNED_SHORT_5_6_5 */
  30792. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  30793. /** UNSIGNED_INT_2_10_10_10_REV */
  30794. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  30795. /** UNSIGNED_INT_24_8 */
  30796. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  30797. /** UNSIGNED_INT_10F_11F_11F_REV */
  30798. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  30799. /** UNSIGNED_INT_5_9_9_9_REV */
  30800. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  30801. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  30802. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  30803. /** nearest is mag = nearest and min = nearest and mip = linear */
  30804. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  30805. /** Bilinear is mag = linear and min = linear and mip = nearest */
  30806. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  30807. /** Trilinear is mag = linear and min = linear and mip = linear */
  30808. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  30809. /** nearest is mag = nearest and min = nearest and mip = linear */
  30810. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  30811. /** Bilinear is mag = linear and min = linear and mip = nearest */
  30812. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  30813. /** Trilinear is mag = linear and min = linear and mip = linear */
  30814. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  30815. /** mag = nearest and min = nearest and mip = nearest */
  30816. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  30817. /** mag = nearest and min = linear and mip = nearest */
  30818. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  30819. /** mag = nearest and min = linear and mip = linear */
  30820. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  30821. /** mag = nearest and min = linear and mip = none */
  30822. static readonly TEXTURE_NEAREST_LINEAR: number;
  30823. /** mag = nearest and min = nearest and mip = none */
  30824. static readonly TEXTURE_NEAREST_NEAREST: number;
  30825. /** mag = linear and min = nearest and mip = nearest */
  30826. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  30827. /** mag = linear and min = nearest and mip = linear */
  30828. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  30829. /** mag = linear and min = linear and mip = none */
  30830. static readonly TEXTURE_LINEAR_LINEAR: number;
  30831. /** mag = linear and min = nearest and mip = none */
  30832. static readonly TEXTURE_LINEAR_NEAREST: number;
  30833. /** Explicit coordinates mode */
  30834. static readonly TEXTURE_EXPLICIT_MODE: number;
  30835. /** Spherical coordinates mode */
  30836. static readonly TEXTURE_SPHERICAL_MODE: number;
  30837. /** Planar coordinates mode */
  30838. static readonly TEXTURE_PLANAR_MODE: number;
  30839. /** Cubic coordinates mode */
  30840. static readonly TEXTURE_CUBIC_MODE: number;
  30841. /** Projection coordinates mode */
  30842. static readonly TEXTURE_PROJECTION_MODE: number;
  30843. /** Skybox coordinates mode */
  30844. static readonly TEXTURE_SKYBOX_MODE: number;
  30845. /** Inverse Cubic coordinates mode */
  30846. static readonly TEXTURE_INVCUBIC_MODE: number;
  30847. /** Equirectangular coordinates mode */
  30848. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  30849. /** Equirectangular Fixed coordinates mode */
  30850. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  30851. /** Equirectangular Fixed Mirrored coordinates mode */
  30852. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  30853. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  30854. static readonly SCALEMODE_FLOOR: number;
  30855. /** Defines that texture rescaling will look for the nearest power of 2 size */
  30856. static readonly SCALEMODE_NEAREST: number;
  30857. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  30858. static readonly SCALEMODE_CEILING: number;
  30859. /**
  30860. * Returns the current npm package of the sdk
  30861. */
  30862. static readonly NpmPackage: string;
  30863. /**
  30864. * Returns the current version of the framework
  30865. */
  30866. static readonly Version: string;
  30867. /**
  30868. * Returns a string describing the current engine
  30869. */
  30870. readonly description: string;
  30871. /**
  30872. * Gets or sets the epsilon value used by collision engine
  30873. */
  30874. static CollisionsEpsilon: number;
  30875. /**
  30876. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30877. */
  30878. static ShadersRepository: string;
  30879. /**
  30880. * Method called to create the default loading screen.
  30881. * This can be overriden in your own app.
  30882. * @param canvas The rendering canvas element
  30883. * @returns The loading screen
  30884. */
  30885. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  30886. /**
  30887. * Method called to create the default rescale post process on each engine.
  30888. */
  30889. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  30890. /** @hidden */
  30891. _shaderProcessor: IShaderProcessor;
  30892. /**
  30893. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30894. */
  30895. forcePOTTextures: boolean;
  30896. /**
  30897. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30898. */
  30899. isFullscreen: boolean;
  30900. /**
  30901. * Gets a boolean indicating if the pointer is currently locked
  30902. */
  30903. isPointerLock: boolean;
  30904. /**
  30905. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30906. */
  30907. cullBackFaces: boolean;
  30908. /**
  30909. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30910. */
  30911. renderEvenInBackground: boolean;
  30912. /**
  30913. * Gets or sets a boolean indicating that cache can be kept between frames
  30914. */
  30915. preventCacheWipeBetweenFrames: boolean;
  30916. /**
  30917. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  30918. **/
  30919. enableOfflineSupport: boolean;
  30920. /**
  30921. * 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)
  30922. **/
  30923. disableManifestCheck: boolean;
  30924. /**
  30925. * Gets the list of created scenes
  30926. */
  30927. scenes: Scene[];
  30928. /**
  30929. * Event raised when a new scene is created
  30930. */
  30931. onNewSceneAddedObservable: Observable<Scene>;
  30932. /**
  30933. * Gets the list of created postprocesses
  30934. */
  30935. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  30936. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30937. validateShaderPrograms: boolean;
  30938. /**
  30939. * Observable event triggered each time the rendering canvas is resized
  30940. */
  30941. onResizeObservable: Observable<Engine>;
  30942. /**
  30943. * Observable event triggered each time the canvas loses focus
  30944. */
  30945. onCanvasBlurObservable: Observable<Engine>;
  30946. /**
  30947. * Observable event triggered each time the canvas gains focus
  30948. */
  30949. onCanvasFocusObservable: Observable<Engine>;
  30950. /**
  30951. * Observable event triggered each time the canvas receives pointerout event
  30952. */
  30953. onCanvasPointerOutObservable: Observable<PointerEvent>;
  30954. /**
  30955. * Observable event triggered before each texture is initialized
  30956. */
  30957. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30958. /**
  30959. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30960. */
  30961. disableUniformBuffers: boolean;
  30962. /** @hidden */
  30963. _uniformBuffers: UniformBuffer[];
  30964. /**
  30965. * Gets a boolean indicating that the engine supports uniform buffers
  30966. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30967. */
  30968. readonly supportsUniformBuffers: boolean;
  30969. /**
  30970. * Observable raised when the engine begins a new frame
  30971. */
  30972. onBeginFrameObservable: Observable<Engine>;
  30973. /**
  30974. * If set, will be used to request the next animation frame for the render loop
  30975. */
  30976. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  30977. /**
  30978. * Observable raised when the engine ends the current frame
  30979. */
  30980. onEndFrameObservable: Observable<Engine>;
  30981. /**
  30982. * Observable raised when the engine is about to compile a shader
  30983. */
  30984. onBeforeShaderCompilationObservable: Observable<Engine>;
  30985. /**
  30986. * Observable raised when the engine has jsut compiled a shader
  30987. */
  30988. onAfterShaderCompilationObservable: Observable<Engine>;
  30989. /** @hidden */
  30990. _gl: WebGLRenderingContext;
  30991. private _renderingCanvas;
  30992. private _windowIsBackground;
  30993. protected _webGLVersion: number;
  30994. protected _highPrecisionShadersAllowed: boolean;
  30995. /** @hidden */
  30996. readonly _shouldUseHighPrecisionShader: boolean;
  30997. /**
  30998. * Gets a boolean indicating that only power of 2 textures are supported
  30999. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  31000. */
  31001. readonly needPOTTextures: boolean;
  31002. /** @hidden */
  31003. _badOS: boolean;
  31004. /** @hidden */
  31005. _badDesktopOS: boolean;
  31006. /**
  31007. * Gets the audio engine
  31008. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31009. * @ignorenaming
  31010. */
  31011. static audioEngine: IAudioEngine;
  31012. /**
  31013. * Default AudioEngine factory responsible of creating the Audio Engine.
  31014. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  31015. */
  31016. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  31017. /**
  31018. * Default offline support factory responsible of creating a tool used to store data locally.
  31019. * By default, this will create a Database object if the workload has been embedded.
  31020. */
  31021. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  31022. private _onFocus;
  31023. private _onBlur;
  31024. private _onCanvasPointerOut;
  31025. private _onCanvasBlur;
  31026. private _onCanvasFocus;
  31027. private _onFullscreenChange;
  31028. private _onPointerLockChange;
  31029. private _hardwareScalingLevel;
  31030. /** @hidden */
  31031. _caps: EngineCapabilities;
  31032. private _pointerLockRequested;
  31033. private _isStencilEnable;
  31034. protected _colorWrite: boolean;
  31035. private _loadingScreen;
  31036. /** @hidden */
  31037. _drawCalls: PerfCounter;
  31038. private _glVersion;
  31039. private _glRenderer;
  31040. private _glVendor;
  31041. private _videoTextureSupported;
  31042. private _renderingQueueLaunched;
  31043. private _activeRenderLoops;
  31044. private _deterministicLockstep;
  31045. private _lockstepMaxSteps;
  31046. /**
  31047. * Observable signaled when a context lost event is raised
  31048. */
  31049. onContextLostObservable: Observable<Engine>;
  31050. /**
  31051. * Observable signaled when a context restored event is raised
  31052. */
  31053. onContextRestoredObservable: Observable<Engine>;
  31054. private _onContextLost;
  31055. private _onContextRestored;
  31056. private _contextWasLost;
  31057. /** @hidden */
  31058. _doNotHandleContextLost: boolean;
  31059. /**
  31060. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  31061. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  31062. */
  31063. doNotHandleContextLost: boolean;
  31064. private _performanceMonitor;
  31065. private _fps;
  31066. private _deltaTime;
  31067. /**
  31068. * Turn this value on if you want to pause FPS computation when in background
  31069. */
  31070. disablePerformanceMonitorInBackground: boolean;
  31071. /**
  31072. * Gets the performance monitor attached to this engine
  31073. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  31074. */
  31075. readonly performanceMonitor: PerformanceMonitor;
  31076. /**
  31077. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  31078. */
  31079. disableVertexArrayObjects: boolean;
  31080. /** @hidden */
  31081. protected _depthCullingState: _DepthCullingState;
  31082. /** @hidden */
  31083. protected _stencilState: _StencilState;
  31084. /** @hidden */
  31085. protected _alphaState: _AlphaState;
  31086. /** @hidden */
  31087. protected _alphaMode: number;
  31088. /** @hidden */
  31089. _internalTexturesCache: InternalTexture[];
  31090. /** @hidden */
  31091. protected _activeChannel: number;
  31092. private _currentTextureChannel;
  31093. /** @hidden */
  31094. protected _boundTexturesCache: {
  31095. [key: string]: Nullable<InternalTexture>;
  31096. };
  31097. /** @hidden */
  31098. protected _currentEffect: Nullable<Effect>;
  31099. /** @hidden */
  31100. protected _currentProgram: Nullable<WebGLProgram>;
  31101. private _compiledEffects;
  31102. private _vertexAttribArraysEnabled;
  31103. /** @hidden */
  31104. protected _cachedViewport: Nullable<IViewportLike>;
  31105. private _cachedVertexArrayObject;
  31106. /** @hidden */
  31107. protected _cachedVertexBuffers: any;
  31108. /** @hidden */
  31109. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  31110. /** @hidden */
  31111. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  31112. /** @hidden */
  31113. _currentRenderTarget: Nullable<InternalTexture>;
  31114. private _uintIndicesCurrentlySet;
  31115. private _currentBoundBuffer;
  31116. /** @hidden */
  31117. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  31118. private _currentBufferPointers;
  31119. private _currentInstanceLocations;
  31120. private _currentInstanceBuffers;
  31121. private _textureUnits;
  31122. /** @hidden */
  31123. _workingCanvas: Nullable<HTMLCanvasElement>;
  31124. /** @hidden */
  31125. _workingContext: Nullable<CanvasRenderingContext2D>;
  31126. private _rescalePostProcess;
  31127. private _dummyFramebuffer;
  31128. private _externalData;
  31129. /** @hidden */
  31130. _bindedRenderFunction: any;
  31131. private _vaoRecordInProgress;
  31132. private _mustWipeVertexAttributes;
  31133. private _emptyTexture;
  31134. private _emptyCubeTexture;
  31135. private _emptyTexture3D;
  31136. /** @hidden */
  31137. _frameHandler: number;
  31138. private _nextFreeTextureSlots;
  31139. private _maxSimultaneousTextures;
  31140. private _activeRequests;
  31141. private _texturesSupported;
  31142. /** @hidden */
  31143. _textureFormatInUse: Nullable<string>;
  31144. /**
  31145. * Gets the list of texture formats supported
  31146. */
  31147. readonly texturesSupported: Array<string>;
  31148. /**
  31149. * Gets the list of texture formats in use
  31150. */
  31151. readonly textureFormatInUse: Nullable<string>;
  31152. /**
  31153. * Gets the current viewport
  31154. */
  31155. readonly currentViewport: Nullable<IViewportLike>;
  31156. /**
  31157. * Gets the default empty texture
  31158. */
  31159. readonly emptyTexture: InternalTexture;
  31160. /**
  31161. * Gets the default empty 3D texture
  31162. */
  31163. readonly emptyTexture3D: InternalTexture;
  31164. /**
  31165. * Gets the default empty cube texture
  31166. */
  31167. readonly emptyCubeTexture: InternalTexture;
  31168. /**
  31169. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  31170. */
  31171. readonly premultipliedAlpha: boolean;
  31172. /**
  31173. * Creates a new engine
  31174. * @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
  31175. * @param antialias defines enable antialiasing (default: false)
  31176. * @param options defines further options to be sent to the getContext() function
  31177. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  31178. */
  31179. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  31180. /**
  31181. * Initializes a webVR display and starts listening to display change events
  31182. * The onVRDisplayChangedObservable will be notified upon these changes
  31183. * @returns The onVRDisplayChangedObservable
  31184. */
  31185. initWebVR(): Observable<IDisplayChangedEventArgs>;
  31186. /** @hidden */
  31187. _prepareVRComponent(): void;
  31188. /** @hidden */
  31189. _connectVREvents(canvas: HTMLCanvasElement, document: any): void;
  31190. /** @hidden */
  31191. _submitVRFrame(): void;
  31192. /**
  31193. * Call this function to leave webVR mode
  31194. * Will do nothing if webVR is not supported or if there is no webVR device
  31195. * @see http://doc.babylonjs.com/how_to/webvr_camera
  31196. */
  31197. disableVR(): void;
  31198. /**
  31199. * Gets a boolean indicating that the system is in VR mode and is presenting
  31200. * @returns true if VR mode is engaged
  31201. */
  31202. isVRPresenting(): boolean;
  31203. /** @hidden */
  31204. _requestVRFrame(): void;
  31205. private _disableTouchAction;
  31206. private _rebuildInternalTextures;
  31207. private _rebuildEffects;
  31208. /**
  31209. * Gets a boolean indicating if all created effects are ready
  31210. * @returns true if all effects are ready
  31211. */
  31212. areAllEffectsReady(): boolean;
  31213. private _rebuildBuffers;
  31214. private _initGLContext;
  31215. /**
  31216. * Gets version of the current webGL context
  31217. */
  31218. readonly webGLVersion: number;
  31219. /**
  31220. * Gets a string idenfifying the name of the class
  31221. * @returns "Engine" string
  31222. */
  31223. getClassName(): string;
  31224. /**
  31225. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  31226. */
  31227. readonly isStencilEnable: boolean;
  31228. /** @hidden */
  31229. _prepareWorkingCanvas(): void;
  31230. /**
  31231. * Reset the texture cache to empty state
  31232. */
  31233. resetTextureCache(): void;
  31234. /**
  31235. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  31236. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  31237. * @returns true if engine is in deterministic lock step mode
  31238. */
  31239. isDeterministicLockStep(): boolean;
  31240. /**
  31241. * Gets the max steps when engine is running in deterministic lock step
  31242. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  31243. * @returns the max steps
  31244. */
  31245. getLockstepMaxSteps(): number;
  31246. /**
  31247. * Gets an object containing information about the current webGL context
  31248. * @returns an object containing the vender, the renderer and the version of the current webGL context
  31249. */
  31250. getGlInfo(): {
  31251. vendor: string;
  31252. renderer: string;
  31253. version: string;
  31254. };
  31255. /**
  31256. * Gets current aspect ratio
  31257. * @param viewportOwner defines the camera to use to get the aspect ratio
  31258. * @param useScreen defines if screen size must be used (or the current render target if any)
  31259. * @returns a number defining the aspect ratio
  31260. */
  31261. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  31262. /**
  31263. * Gets current screen aspect ratio
  31264. * @returns a number defining the aspect ratio
  31265. */
  31266. getScreenAspectRatio(): number;
  31267. /**
  31268. * Gets the current render width
  31269. * @param useScreen defines if screen size must be used (or the current render target if any)
  31270. * @returns a number defining the current render width
  31271. */
  31272. getRenderWidth(useScreen?: boolean): number;
  31273. /**
  31274. * Gets the current render height
  31275. * @param useScreen defines if screen size must be used (or the current render target if any)
  31276. * @returns a number defining the current render height
  31277. */
  31278. getRenderHeight(useScreen?: boolean): number;
  31279. /**
  31280. * Gets the HTML canvas attached with the current webGL context
  31281. * @returns a HTML canvas
  31282. */
  31283. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  31284. /**
  31285. * Gets host window
  31286. * @returns the host window object
  31287. */
  31288. getHostWindow(): Window;
  31289. /**
  31290. * Gets host document
  31291. * @returns the host document object
  31292. */
  31293. getHostDocument(): Document;
  31294. /**
  31295. * Gets the client rect of the HTML canvas attached with the current webGL context
  31296. * @returns a client rectanglee
  31297. */
  31298. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  31299. /**
  31300. * Defines the hardware scaling level.
  31301. * By default the hardware scaling level is computed from the window device ratio.
  31302. * 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.
  31303. * @param level defines the level to use
  31304. */
  31305. setHardwareScalingLevel(level: number): void;
  31306. /**
  31307. * Gets the current hardware scaling level.
  31308. * By default the hardware scaling level is computed from the window device ratio.
  31309. * 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.
  31310. * @returns a number indicating the current hardware scaling level
  31311. */
  31312. getHardwareScalingLevel(): number;
  31313. /**
  31314. * Gets the list of loaded textures
  31315. * @returns an array containing all loaded textures
  31316. */
  31317. getLoadedTexturesCache(): InternalTexture[];
  31318. /**
  31319. * Gets the object containing all engine capabilities
  31320. * @returns the EngineCapabilities object
  31321. */
  31322. getCaps(): EngineCapabilities;
  31323. /**
  31324. * Gets the current depth function
  31325. * @returns a number defining the depth function
  31326. */
  31327. getDepthFunction(): Nullable<number>;
  31328. /**
  31329. * Sets the current depth function
  31330. * @param depthFunc defines the function to use
  31331. */
  31332. setDepthFunction(depthFunc: number): void;
  31333. /**
  31334. * Sets the current depth function to GREATER
  31335. */
  31336. setDepthFunctionToGreater(): void;
  31337. /**
  31338. * Sets the current depth function to GEQUAL
  31339. */
  31340. setDepthFunctionToGreaterOrEqual(): void;
  31341. /**
  31342. * Sets the current depth function to LESS
  31343. */
  31344. setDepthFunctionToLess(): void;
  31345. private _cachedStencilBuffer;
  31346. private _cachedStencilFunction;
  31347. private _cachedStencilMask;
  31348. private _cachedStencilOperationPass;
  31349. private _cachedStencilOperationFail;
  31350. private _cachedStencilOperationDepthFail;
  31351. private _cachedStencilReference;
  31352. /**
  31353. * Caches the the state of the stencil buffer
  31354. */
  31355. cacheStencilState(): void;
  31356. /**
  31357. * Restores the state of the stencil buffer
  31358. */
  31359. restoreStencilState(): void;
  31360. /**
  31361. * Sets the current depth function to LEQUAL
  31362. */
  31363. setDepthFunctionToLessOrEqual(): void;
  31364. /**
  31365. * Gets a boolean indicating if stencil buffer is enabled
  31366. * @returns the current stencil buffer state
  31367. */
  31368. getStencilBuffer(): boolean;
  31369. /**
  31370. * Enable or disable the stencil buffer
  31371. * @param enable defines if the stencil buffer must be enabled or disabled
  31372. */
  31373. setStencilBuffer(enable: boolean): void;
  31374. /**
  31375. * Gets the current stencil mask
  31376. * @returns a number defining the new stencil mask to use
  31377. */
  31378. getStencilMask(): number;
  31379. /**
  31380. * Sets the current stencil mask
  31381. * @param mask defines the new stencil mask to use
  31382. */
  31383. setStencilMask(mask: number): void;
  31384. /**
  31385. * Gets the current stencil function
  31386. * @returns a number defining the stencil function to use
  31387. */
  31388. getStencilFunction(): number;
  31389. /**
  31390. * Gets the current stencil reference value
  31391. * @returns a number defining the stencil reference value to use
  31392. */
  31393. getStencilFunctionReference(): number;
  31394. /**
  31395. * Gets the current stencil mask
  31396. * @returns a number defining the stencil mask to use
  31397. */
  31398. getStencilFunctionMask(): number;
  31399. /**
  31400. * Sets the current stencil function
  31401. * @param stencilFunc defines the new stencil function to use
  31402. */
  31403. setStencilFunction(stencilFunc: number): void;
  31404. /**
  31405. * Sets the current stencil reference
  31406. * @param reference defines the new stencil reference to use
  31407. */
  31408. setStencilFunctionReference(reference: number): void;
  31409. /**
  31410. * Sets the current stencil mask
  31411. * @param mask defines the new stencil mask to use
  31412. */
  31413. setStencilFunctionMask(mask: number): void;
  31414. /**
  31415. * Gets the current stencil operation when stencil fails
  31416. * @returns a number defining stencil operation to use when stencil fails
  31417. */
  31418. getStencilOperationFail(): number;
  31419. /**
  31420. * Gets the current stencil operation when depth fails
  31421. * @returns a number defining stencil operation to use when depth fails
  31422. */
  31423. getStencilOperationDepthFail(): number;
  31424. /**
  31425. * Gets the current stencil operation when stencil passes
  31426. * @returns a number defining stencil operation to use when stencil passes
  31427. */
  31428. getStencilOperationPass(): number;
  31429. /**
  31430. * Sets the stencil operation to use when stencil fails
  31431. * @param operation defines the stencil operation to use when stencil fails
  31432. */
  31433. setStencilOperationFail(operation: number): void;
  31434. /**
  31435. * Sets the stencil operation to use when depth fails
  31436. * @param operation defines the stencil operation to use when depth fails
  31437. */
  31438. setStencilOperationDepthFail(operation: number): void;
  31439. /**
  31440. * Sets the stencil operation to use when stencil passes
  31441. * @param operation defines the stencil operation to use when stencil passes
  31442. */
  31443. setStencilOperationPass(operation: number): void;
  31444. /**
  31445. * Sets a boolean indicating if the dithering state is enabled or disabled
  31446. * @param value defines the dithering state
  31447. */
  31448. setDitheringState(value: boolean): void;
  31449. /**
  31450. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  31451. * @param value defines the rasterizer state
  31452. */
  31453. setRasterizerState(value: boolean): void;
  31454. /**
  31455. * stop executing a render loop function and remove it from the execution array
  31456. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  31457. */
  31458. stopRenderLoop(renderFunction?: () => void): void;
  31459. /** @hidden */
  31460. _renderLoop(): void;
  31461. /**
  31462. * Can be used to override the current requestAnimationFrame requester.
  31463. * @hidden
  31464. */
  31465. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  31466. /**
  31467. * Register and execute a render loop. The engine can have more than one render function
  31468. * @param renderFunction defines the function to continuously execute
  31469. */
  31470. runRenderLoop(renderFunction: () => void): void;
  31471. /**
  31472. * Toggle full screen mode
  31473. * @param requestPointerLock defines if a pointer lock should be requested from the user
  31474. */
  31475. switchFullscreen(requestPointerLock: boolean): void;
  31476. /**
  31477. * Enters full screen mode
  31478. * @param requestPointerLock defines if a pointer lock should be requested from the user
  31479. */
  31480. enterFullscreen(requestPointerLock: boolean): void;
  31481. /**
  31482. * Exits full screen mode
  31483. */
  31484. exitFullscreen(): void;
  31485. /**
  31486. * Enters Pointerlock mode
  31487. */
  31488. enterPointerlock(): void;
  31489. /**
  31490. * Exits Pointerlock mode
  31491. */
  31492. exitPointerlock(): void;
  31493. /**
  31494. * Clear the current render buffer or the current render target (if any is set up)
  31495. * @param color defines the color to use
  31496. * @param backBuffer defines if the back buffer must be cleared
  31497. * @param depth defines if the depth buffer must be cleared
  31498. * @param stencil defines if the stencil buffer must be cleared
  31499. */
  31500. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  31501. /**
  31502. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  31503. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  31504. * @param y defines the y-coordinate of the corner of the clear rectangle
  31505. * @param width defines the width of the clear rectangle
  31506. * @param height defines the height of the clear rectangle
  31507. * @param clearColor defines the clear color
  31508. */
  31509. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  31510. /**
  31511. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  31512. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  31513. * @param y defines the y-coordinate of the corner of the clear rectangle
  31514. * @param width defines the width of the clear rectangle
  31515. * @param height defines the height of the clear rectangle
  31516. */
  31517. enableScissor(x: number, y: number, width: number, height: number): void;
  31518. /**
  31519. * Disable previously set scissor test rectangle
  31520. */
  31521. disableScissor(): void;
  31522. private _viewportCached;
  31523. /** @hidden */
  31524. _viewport(x: number, y: number, width: number, height: number): void;
  31525. /**
  31526. * Set the WebGL's viewport
  31527. * @param viewport defines the viewport element to be used
  31528. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  31529. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  31530. */
  31531. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  31532. /**
  31533. * Directly set the WebGL Viewport
  31534. * @param x defines the x coordinate of the viewport (in screen space)
  31535. * @param y defines the y coordinate of the viewport (in screen space)
  31536. * @param width defines the width of the viewport (in screen space)
  31537. * @param height defines the height of the viewport (in screen space)
  31538. * @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
  31539. */
  31540. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  31541. /**
  31542. * Begin a new frame
  31543. */
  31544. beginFrame(): void;
  31545. /**
  31546. * Enf the current frame
  31547. */
  31548. endFrame(): void;
  31549. /**
  31550. * Resize the view according to the canvas' size
  31551. */
  31552. resize(): void;
  31553. /**
  31554. * Force a specific size of the canvas
  31555. * @param width defines the new canvas' width
  31556. * @param height defines the new canvas' height
  31557. */
  31558. setSize(width: number, height: number): void;
  31559. /**
  31560. * Binds the frame buffer to the specified texture.
  31561. * @param texture The texture to render to or null for the default canvas
  31562. * @param faceIndex The face of the texture to render to in case of cube texture
  31563. * @param requiredWidth The width of the target to render to
  31564. * @param requiredHeight The height of the target to render to
  31565. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  31566. * @param depthStencilTexture The depth stencil texture to use to render
  31567. * @param lodLevel defines le lod level to bind to the frame buffer
  31568. */
  31569. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  31570. /** @hidden */
  31571. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  31572. /**
  31573. * Unbind the current render target texture from the webGL context
  31574. * @param texture defines the render target texture to unbind
  31575. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  31576. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  31577. */
  31578. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  31579. /**
  31580. * Force the mipmap generation for the given render target texture
  31581. * @param texture defines the render target texture to use
  31582. */
  31583. generateMipMapsForCubemap(texture: InternalTexture): void;
  31584. /**
  31585. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  31586. */
  31587. flushFramebuffer(): void;
  31588. /**
  31589. * Unbind the current render target and bind the default framebuffer
  31590. */
  31591. restoreDefaultFramebuffer(): void;
  31592. /**
  31593. * Create an uniform buffer
  31594. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31595. * @param elements defines the content of the uniform buffer
  31596. * @returns the webGL uniform buffer
  31597. */
  31598. createUniformBuffer(elements: FloatArray): DataBuffer;
  31599. /**
  31600. * Create a dynamic uniform buffer
  31601. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31602. * @param elements defines the content of the uniform buffer
  31603. * @returns the webGL uniform buffer
  31604. */
  31605. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  31606. /**
  31607. * Update an existing uniform buffer
  31608. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31609. * @param uniformBuffer defines the target uniform buffer
  31610. * @param elements defines the content to update
  31611. * @param offset defines the offset in the uniform buffer where update should start
  31612. * @param count defines the size of the data to update
  31613. */
  31614. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  31615. private _resetVertexBufferBinding;
  31616. /**
  31617. * Creates a vertex buffer
  31618. * @param data the data for the vertex buffer
  31619. * @returns the new WebGL static buffer
  31620. */
  31621. createVertexBuffer(data: DataArray): DataBuffer;
  31622. /**
  31623. * Creates a dynamic vertex buffer
  31624. * @param data the data for the dynamic vertex buffer
  31625. * @returns the new WebGL dynamic buffer
  31626. */
  31627. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  31628. /**
  31629. * Update a dynamic index buffer
  31630. * @param indexBuffer defines the target index buffer
  31631. * @param indices defines the data to update
  31632. * @param offset defines the offset in the target index buffer where update should start
  31633. */
  31634. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  31635. /**
  31636. * Updates a dynamic vertex buffer.
  31637. * @param vertexBuffer the vertex buffer to update
  31638. * @param data the data used to update the vertex buffer
  31639. * @param byteOffset the byte offset of the data
  31640. * @param byteLength the byte length of the data
  31641. */
  31642. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  31643. private _resetIndexBufferBinding;
  31644. /**
  31645. * Creates a new index buffer
  31646. * @param indices defines the content of the index buffer
  31647. * @param updatable defines if the index buffer must be updatable
  31648. * @returns a new webGL buffer
  31649. */
  31650. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  31651. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  31652. /**
  31653. * Bind a webGL buffer to the webGL context
  31654. * @param buffer defines the buffer to bind
  31655. */
  31656. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  31657. /**
  31658. * Bind an uniform buffer to the current webGL context
  31659. * @param buffer defines the buffer to bind
  31660. */
  31661. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  31662. /**
  31663. * Bind a buffer to the current webGL context at a given location
  31664. * @param buffer defines the buffer to bind
  31665. * @param location defines the index where to bind the buffer
  31666. */
  31667. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  31668. /**
  31669. * Bind a specific block at a given index in a specific shader program
  31670. * @param pipelineContext defines the pipeline context to use
  31671. * @param blockName defines the block name
  31672. * @param index defines the index where to bind the block
  31673. */
  31674. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  31675. private bindIndexBuffer;
  31676. private bindBuffer;
  31677. /**
  31678. * update the bound buffer with the given data
  31679. * @param data defines the data to update
  31680. */
  31681. updateArrayBuffer(data: Float32Array): void;
  31682. private _vertexAttribPointer;
  31683. private _bindIndexBufferWithCache;
  31684. private _bindVertexBuffersAttributes;
  31685. /**
  31686. * Records a vertex array object
  31687. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  31688. * @param vertexBuffers defines the list of vertex buffers to store
  31689. * @param indexBuffer defines the index buffer to store
  31690. * @param effect defines the effect to store
  31691. * @returns the new vertex array object
  31692. */
  31693. recordVertexArrayObject(vertexBuffers: {
  31694. [key: string]: VertexBuffer;
  31695. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  31696. /**
  31697. * Bind a specific vertex array object
  31698. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  31699. * @param vertexArrayObject defines the vertex array object to bind
  31700. * @param indexBuffer defines the index buffer to bind
  31701. */
  31702. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  31703. /**
  31704. * Bind webGl buffers directly to the webGL context
  31705. * @param vertexBuffer defines the vertex buffer to bind
  31706. * @param indexBuffer defines the index buffer to bind
  31707. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  31708. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  31709. * @param effect defines the effect associated with the vertex buffer
  31710. */
  31711. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  31712. private _unbindVertexArrayObject;
  31713. /**
  31714. * Bind a list of vertex buffers to the webGL context
  31715. * @param vertexBuffers defines the list of vertex buffers to bind
  31716. * @param indexBuffer defines the index buffer to bind
  31717. * @param effect defines the effect associated with the vertex buffers
  31718. */
  31719. bindBuffers(vertexBuffers: {
  31720. [key: string]: Nullable<VertexBuffer>;
  31721. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  31722. /**
  31723. * Unbind all instance attributes
  31724. */
  31725. unbindInstanceAttributes(): void;
  31726. /**
  31727. * Release and free the memory of a vertex array object
  31728. * @param vao defines the vertex array object to delete
  31729. */
  31730. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  31731. /** @hidden */
  31732. _releaseBuffer(buffer: DataBuffer): boolean;
  31733. protected _deleteBuffer(buffer: DataBuffer): void;
  31734. /**
  31735. * Creates a webGL buffer to use with instanciation
  31736. * @param capacity defines the size of the buffer
  31737. * @returns the webGL buffer
  31738. */
  31739. createInstancesBuffer(capacity: number): DataBuffer;
  31740. /**
  31741. * Delete a webGL buffer used with instanciation
  31742. * @param buffer defines the webGL buffer to delete
  31743. */
  31744. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  31745. /**
  31746. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  31747. * @param instancesBuffer defines the webGL buffer to update and bind
  31748. * @param data defines the data to store in the buffer
  31749. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  31750. */
  31751. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  31752. /**
  31753. * Apply all cached states (depth, culling, stencil and alpha)
  31754. */
  31755. applyStates(): void;
  31756. /**
  31757. * Send a draw order
  31758. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  31759. * @param indexStart defines the starting index
  31760. * @param indexCount defines the number of index to draw
  31761. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31762. */
  31763. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  31764. /**
  31765. * Draw a list of points
  31766. * @param verticesStart defines the index of first vertex to draw
  31767. * @param verticesCount defines the count of vertices to draw
  31768. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31769. */
  31770. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31771. /**
  31772. * Draw a list of unindexed primitives
  31773. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  31774. * @param verticesStart defines the index of first vertex to draw
  31775. * @param verticesCount defines the count of vertices to draw
  31776. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31777. */
  31778. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31779. /**
  31780. * Draw a list of indexed primitives
  31781. * @param fillMode defines the primitive to use
  31782. * @param indexStart defines the starting index
  31783. * @param indexCount defines the number of index to draw
  31784. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31785. */
  31786. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  31787. /**
  31788. * Draw a list of unindexed primitives
  31789. * @param fillMode defines the primitive to use
  31790. * @param verticesStart defines the index of first vertex to draw
  31791. * @param verticesCount defines the count of vertices to draw
  31792. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31793. */
  31794. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31795. private _drawMode;
  31796. /** @hidden */
  31797. _releaseEffect(effect: Effect): void;
  31798. /** @hidden */
  31799. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  31800. /**
  31801. * Create a new effect (used to store vertex/fragment shaders)
  31802. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  31803. * @param attributesNamesOrOptions defines either a list of attribute names or an EffectCreationOptions object
  31804. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  31805. * @param samplers defines an array of string used to represent textures
  31806. * @param defines defines the string containing the defines to use to compile the shaders
  31807. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  31808. * @param onCompiled defines a function to call when the effect creation is successful
  31809. * @param onError defines a function to call when the effect creation has failed
  31810. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  31811. * @returns the new Effect
  31812. */
  31813. createEffect(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: string[], defines?: string, fallbacks?: EffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  31814. protected static _concatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  31815. private _compileShader;
  31816. private _compileRawShader;
  31817. /**
  31818. * Directly creates a webGL program
  31819. * @param pipelineContext defines the pipeline context to attach to
  31820. * @param vertexCode defines the vertex shader code to use
  31821. * @param fragmentCode defines the fragment shader code to use
  31822. * @param context defines the webGL context to use (if not set, the current one will be used)
  31823. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  31824. * @returns the new webGL program
  31825. */
  31826. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  31827. /**
  31828. * Creates a webGL program
  31829. * @param pipelineContext defines the pipeline context to attach to
  31830. * @param vertexCode defines the vertex shader code to use
  31831. * @param fragmentCode defines the fragment shader code to use
  31832. * @param defines defines the string containing the defines to use to compile the shaders
  31833. * @param context defines the webGL context to use (if not set, the current one will be used)
  31834. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  31835. * @returns the new webGL program
  31836. */
  31837. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  31838. /**
  31839. * Creates a new pipeline context
  31840. * @returns the new pipeline
  31841. */
  31842. createPipelineContext(): IPipelineContext;
  31843. private _createShaderProgram;
  31844. private _finalizePipelineContext;
  31845. /** @hidden */
  31846. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  31847. /** @hidden */
  31848. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  31849. /** @hidden */
  31850. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  31851. /**
  31852. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  31853. * @param pipelineContext defines the pipeline context to use
  31854. * @param uniformsNames defines the list of uniform names
  31855. * @returns an array of webGL uniform locations
  31856. */
  31857. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  31858. /**
  31859. * Gets the lsit of active attributes for a given webGL program
  31860. * @param pipelineContext defines the pipeline context to use
  31861. * @param attributesNames defines the list of attribute names to get
  31862. * @returns an array of indices indicating the offset of each attribute
  31863. */
  31864. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  31865. /**
  31866. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  31867. * @param effect defines the effect to activate
  31868. */
  31869. enableEffect(effect: Nullable<Effect>): void;
  31870. /**
  31871. * Set the value of an uniform to an array of int32
  31872. * @param uniform defines the webGL uniform location where to store the value
  31873. * @param array defines the array of int32 to store
  31874. */
  31875. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31876. /**
  31877. * Set the value of an uniform to an array of int32 (stored as vec2)
  31878. * @param uniform defines the webGL uniform location where to store the value
  31879. * @param array defines the array of int32 to store
  31880. */
  31881. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31882. /**
  31883. * Set the value of an uniform to an array of int32 (stored as vec3)
  31884. * @param uniform defines the webGL uniform location where to store the value
  31885. * @param array defines the array of int32 to store
  31886. */
  31887. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31888. /**
  31889. * Set the value of an uniform to an array of int32 (stored as vec4)
  31890. * @param uniform defines the webGL uniform location where to store the value
  31891. * @param array defines the array of int32 to store
  31892. */
  31893. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31894. /**
  31895. * Set the value of an uniform to an array of float32
  31896. * @param uniform defines the webGL uniform location where to store the value
  31897. * @param array defines the array of float32 to store
  31898. */
  31899. setFloatArray(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31900. /**
  31901. * Set the value of an uniform to an array of float32 (stored as vec2)
  31902. * @param uniform defines the webGL uniform location where to store the value
  31903. * @param array defines the array of float32 to store
  31904. */
  31905. setFloatArray2(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31906. /**
  31907. * Set the value of an uniform to an array of float32 (stored as vec3)
  31908. * @param uniform defines the webGL uniform location where to store the value
  31909. * @param array defines the array of float32 to store
  31910. */
  31911. setFloatArray3(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31912. /**
  31913. * Set the value of an uniform to an array of float32 (stored as vec4)
  31914. * @param uniform defines the webGL uniform location where to store the value
  31915. * @param array defines the array of float32 to store
  31916. */
  31917. setFloatArray4(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31918. /**
  31919. * Set the value of an uniform to an array of number
  31920. * @param uniform defines the webGL uniform location where to store the value
  31921. * @param array defines the array of number to store
  31922. */
  31923. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31924. /**
  31925. * Set the value of an uniform to an array of number (stored as vec2)
  31926. * @param uniform defines the webGL uniform location where to store the value
  31927. * @param array defines the array of number to store
  31928. */
  31929. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31930. /**
  31931. * Set the value of an uniform to an array of number (stored as vec3)
  31932. * @param uniform defines the webGL uniform location where to store the value
  31933. * @param array defines the array of number to store
  31934. */
  31935. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31936. /**
  31937. * Set the value of an uniform to an array of number (stored as vec4)
  31938. * @param uniform defines the webGL uniform location where to store the value
  31939. * @param array defines the array of number to store
  31940. */
  31941. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31942. /**
  31943. * Set the value of an uniform to an array of float32 (stored as matrices)
  31944. * @param uniform defines the webGL uniform location where to store the value
  31945. * @param matrices defines the array of float32 to store
  31946. */
  31947. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  31948. /**
  31949. * Set the value of an uniform to a matrix (3x3)
  31950. * @param uniform defines the webGL uniform location where to store the value
  31951. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  31952. */
  31953. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  31954. /**
  31955. * Set the value of an uniform to a matrix (2x2)
  31956. * @param uniform defines the webGL uniform location where to store the value
  31957. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  31958. */
  31959. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  31960. /**
  31961. * Set the value of an uniform to a number (int)
  31962. * @param uniform defines the webGL uniform location where to store the value
  31963. * @param value defines the int number to store
  31964. */
  31965. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  31966. /**
  31967. * Set the value of an uniform to a number (float)
  31968. * @param uniform defines the webGL uniform location where to store the value
  31969. * @param value defines the float number to store
  31970. */
  31971. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  31972. /**
  31973. * Set the value of an uniform to a vec2
  31974. * @param uniform defines the webGL uniform location where to store the value
  31975. * @param x defines the 1st component of the value
  31976. * @param y defines the 2nd component of the value
  31977. */
  31978. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  31979. /**
  31980. * Set the value of an uniform to a vec3
  31981. * @param uniform defines the webGL uniform location where to store the value
  31982. * @param x defines the 1st component of the value
  31983. * @param y defines the 2nd component of the value
  31984. * @param z defines the 3rd component of the value
  31985. */
  31986. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  31987. /**
  31988. * Set the value of an uniform to a boolean
  31989. * @param uniform defines the webGL uniform location where to store the value
  31990. * @param bool defines the boolean to store
  31991. */
  31992. setBool(uniform: Nullable<WebGLUniformLocation>, bool: number): void;
  31993. /**
  31994. * Set the value of an uniform to a vec4
  31995. * @param uniform defines the webGL uniform location where to store the value
  31996. * @param x defines the 1st component of the value
  31997. * @param y defines the 2nd component of the value
  31998. * @param z defines the 3rd component of the value
  31999. * @param w defines the 4th component of the value
  32000. */
  32001. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  32002. /**
  32003. * Sets a Color4 on a uniform variable
  32004. * @param uniform defines the uniform location
  32005. * @param color4 defines the value to be set
  32006. */
  32007. setDirectColor4(uniform: Nullable<WebGLUniformLocation>, color4: IColor4Like): void;
  32008. /**
  32009. * Set various states to the webGL context
  32010. * @param culling defines backface culling state
  32011. * @param zOffset defines the value to apply to zOffset (0 by default)
  32012. * @param force defines if states must be applied even if cache is up to date
  32013. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32014. */
  32015. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32016. /**
  32017. * Set the z offset to apply to current rendering
  32018. * @param value defines the offset to apply
  32019. */
  32020. setZOffset(value: number): void;
  32021. /**
  32022. * Gets the current value of the zOffset
  32023. * @returns the current zOffset state
  32024. */
  32025. getZOffset(): number;
  32026. /**
  32027. * Enable or disable depth buffering
  32028. * @param enable defines the state to set
  32029. */
  32030. setDepthBuffer(enable: boolean): void;
  32031. /**
  32032. * Gets a boolean indicating if depth writing is enabled
  32033. * @returns the current depth writing state
  32034. */
  32035. getDepthWrite(): boolean;
  32036. /**
  32037. * Enable or disable depth writing
  32038. * @param enable defines the state to set
  32039. */
  32040. setDepthWrite(enable: boolean): void;
  32041. /**
  32042. * Enable or disable color writing
  32043. * @param enable defines the state to set
  32044. */
  32045. setColorWrite(enable: boolean): void;
  32046. /**
  32047. * Gets a boolean indicating if color writing is enabled
  32048. * @returns the current color writing state
  32049. */
  32050. getColorWrite(): boolean;
  32051. /**
  32052. * Sets alpha constants used by some alpha blending modes
  32053. * @param r defines the red component
  32054. * @param g defines the green component
  32055. * @param b defines the blue component
  32056. * @param a defines the alpha component
  32057. */
  32058. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32059. /**
  32060. * Sets the current alpha mode
  32061. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32062. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32063. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32064. */
  32065. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32066. /**
  32067. * Gets the current alpha mode
  32068. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32069. * @returns the current alpha mode
  32070. */
  32071. getAlphaMode(): number;
  32072. /**
  32073. * Clears the list of texture accessible through engine.
  32074. * This can help preventing texture load conflict due to name collision.
  32075. */
  32076. clearInternalTexturesCache(): void;
  32077. /**
  32078. * Force the entire cache to be cleared
  32079. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  32080. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  32081. */
  32082. wipeCaches(bruteForce?: boolean): void;
  32083. /**
  32084. * Set the compressed texture format to use, based on the formats you have, and the formats
  32085. * supported by the hardware / browser.
  32086. *
  32087. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  32088. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  32089. * to API arguments needed to compressed textures. This puts the burden on the container
  32090. * generator to house the arcane code for determining these for current & future formats.
  32091. *
  32092. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  32093. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  32094. *
  32095. * Note: The result of this call is not taken into account when a texture is base64.
  32096. *
  32097. * @param formatsAvailable defines the list of those format families you have created
  32098. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  32099. *
  32100. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  32101. * @returns The extension selected.
  32102. */
  32103. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  32104. /** @hidden */
  32105. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  32106. min: number;
  32107. mag: number;
  32108. };
  32109. /** @hidden */
  32110. _createTexture(): WebGLTexture;
  32111. /**
  32112. * Usually called from Texture.ts.
  32113. * Passed information to create a WebGLTexture
  32114. * @param urlArg defines a value which contains one of the following:
  32115. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  32116. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  32117. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  32118. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  32119. * @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)
  32120. * @param scene needed for loading to the correct scene
  32121. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  32122. * @param onLoad optional callback to be called upon successful completion
  32123. * @param onError optional callback to be called upon failure
  32124. * @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
  32125. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  32126. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  32127. * @param forcedExtension defines the extension to use to pick the right loader
  32128. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  32129. * @returns a InternalTexture for assignment back into BABYLON.Texture
  32130. */
  32131. 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 | ArrayBufferView | HTMLImageElement | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>): InternalTexture;
  32132. /**
  32133. * @hidden
  32134. * Rescales a texture
  32135. * @param source input texutre
  32136. * @param destination destination texture
  32137. * @param scene scene to use to render the resize
  32138. * @param internalFormat format to use when resizing
  32139. * @param onComplete callback to be called when resize has completed
  32140. */
  32141. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<Scene>, internalFormat: number, onComplete: () => void): void;
  32142. private _unpackFlipYCached;
  32143. /**
  32144. * In case you are sharing the context with other applications, it might
  32145. * be interested to not cache the unpack flip y state to ensure a consistent
  32146. * value would be set.
  32147. */
  32148. enableUnpackFlipYCached: boolean;
  32149. /** @hidden */
  32150. _unpackFlipY(value: boolean): void;
  32151. /** @hidden */
  32152. _getUnpackAlignement(): number;
  32153. /**
  32154. * Creates a dynamic texture
  32155. * @param width defines the width of the texture
  32156. * @param height defines the height of the texture
  32157. * @param generateMipMaps defines if the engine should generate the mip levels
  32158. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  32159. * @returns the dynamic texture inside an InternalTexture
  32160. */
  32161. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  32162. /**
  32163. * Update the sampling mode of a given texture
  32164. * @param samplingMode defines the required sampling mode
  32165. * @param texture defines the texture to update
  32166. */
  32167. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  32168. /**
  32169. * Update the content of a dynamic texture
  32170. * @param texture defines the texture to update
  32171. * @param canvas defines the canvas containing the source
  32172. * @param invertY defines if data must be stored with Y axis inverted
  32173. * @param premulAlpha defines if alpha is stored as premultiplied
  32174. * @param format defines the format of the data
  32175. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  32176. */
  32177. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  32178. /**
  32179. * Update a video texture
  32180. * @param texture defines the texture to update
  32181. * @param video defines the video element to use
  32182. * @param invertY defines if data must be stored with Y axis inverted
  32183. */
  32184. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  32185. /**
  32186. * Updates a depth texture Comparison Mode and Function.
  32187. * If the comparison Function is equal to 0, the mode will be set to none.
  32188. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  32189. * @param texture The texture to set the comparison function for
  32190. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  32191. */
  32192. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  32193. /** @hidden */
  32194. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  32195. width: number;
  32196. height: number;
  32197. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  32198. /**
  32199. * Creates a depth stencil texture.
  32200. * This is only available in WebGL 2 or with the depth texture extension available.
  32201. * @param size The size of face edge in the texture.
  32202. * @param options The options defining the texture.
  32203. * @returns The texture
  32204. */
  32205. createDepthStencilTexture(size: number | {
  32206. width: number;
  32207. height: number;
  32208. }, options: DepthTextureCreationOptions): InternalTexture;
  32209. /**
  32210. * Creates a depth stencil texture.
  32211. * This is only available in WebGL 2 or with the depth texture extension available.
  32212. * @param size The size of face edge in the texture.
  32213. * @param options The options defining the texture.
  32214. * @returns The texture
  32215. */
  32216. private _createDepthStencilTexture;
  32217. /**
  32218. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  32219. * @param renderTarget The render target to set the frame buffer for
  32220. */
  32221. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  32222. /**
  32223. * Creates a new render target texture
  32224. * @param size defines the size of the texture
  32225. * @param options defines the options used to create the texture
  32226. * @returns a new render target texture stored in an InternalTexture
  32227. */
  32228. createRenderTargetTexture(size: number | {
  32229. width: number;
  32230. height: number;
  32231. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  32232. /** @hidden */
  32233. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  32234. /**
  32235. * Updates the sample count of a render target texture
  32236. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  32237. * @param texture defines the texture to update
  32238. * @param samples defines the sample count to set
  32239. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  32240. */
  32241. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  32242. /** @hidden */
  32243. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  32244. /** @hidden */
  32245. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  32246. /** @hidden */
  32247. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  32248. /** @hidden */
  32249. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  32250. /**
  32251. * @hidden
  32252. */
  32253. _setCubeMapTextureParams(loadMipmap: boolean): void;
  32254. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<Scene>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  32255. private _prepareWebGLTexture;
  32256. /** @hidden */
  32257. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32258. /** @hidden */
  32259. _releaseFramebufferObjects(texture: InternalTexture): void;
  32260. /** @hidden */
  32261. _releaseTexture(texture: InternalTexture): void;
  32262. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  32263. protected _setProgram(program: WebGLProgram): void;
  32264. protected _boundUniforms: {
  32265. [key: number]: WebGLUniformLocation;
  32266. };
  32267. /**
  32268. * Binds an effect to the webGL context
  32269. * @param effect defines the effect to bind
  32270. */
  32271. bindSamplers(effect: Effect): void;
  32272. private _activateCurrentTexture;
  32273. /** @hidden */
  32274. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  32275. /** @hidden */
  32276. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  32277. /**
  32278. * Sets a texture to the webGL context from a postprocess
  32279. * @param channel defines the channel to use
  32280. * @param postProcess defines the source postprocess
  32281. */
  32282. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32283. /**
  32284. * Binds the output of the passed in post process to the texture channel specified
  32285. * @param channel The channel the texture should be bound to
  32286. * @param postProcess The post process which's output should be bound
  32287. */
  32288. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32289. /**
  32290. * Unbind all textures from the webGL context
  32291. */
  32292. unbindAllTextures(): void;
  32293. /**
  32294. * Sets a texture to the according uniform.
  32295. * @param channel The texture channel
  32296. * @param uniform The uniform to set
  32297. * @param texture The texture to apply
  32298. */
  32299. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  32300. /**
  32301. * Sets a depth stencil texture from a render target to the according uniform.
  32302. * @param channel The texture channel
  32303. * @param uniform The uniform to set
  32304. * @param texture The render target texture containing the depth stencil texture to apply
  32305. */
  32306. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32307. private _bindSamplerUniformToChannel;
  32308. private _getTextureWrapMode;
  32309. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  32310. /**
  32311. * Sets an array of texture to the webGL context
  32312. * @param channel defines the channel where the texture array must be set
  32313. * @param uniform defines the associated uniform location
  32314. * @param textures defines the array of textures to bind
  32315. */
  32316. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  32317. /** @hidden */
  32318. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  32319. private _setTextureParameterFloat;
  32320. private _setTextureParameterInteger;
  32321. /**
  32322. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32323. * @param x defines the x coordinate of the rectangle where pixels must be read
  32324. * @param y defines the y coordinate of the rectangle where pixels must be read
  32325. * @param width defines the width of the rectangle where pixels must be read
  32326. * @param height defines the height of the rectangle where pixels must be read
  32327. * @returns a Uint8Array containing RGBA colors
  32328. */
  32329. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32330. /**
  32331. * Add an externaly attached data from its key.
  32332. * This method call will fail and return false, if such key already exists.
  32333. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  32334. * @param key the unique key that identifies the data
  32335. * @param data the data object to associate to the key for this Engine instance
  32336. * @return true if no such key were already present and the data was added successfully, false otherwise
  32337. */
  32338. addExternalData<T>(key: string, data: T): boolean;
  32339. /**
  32340. * Get an externaly attached data from its key
  32341. * @param key the unique key that identifies the data
  32342. * @return the associated data, if present (can be null), or undefined if not present
  32343. */
  32344. getExternalData<T>(key: string): T;
  32345. /**
  32346. * Get an externaly attached data from its key, create it using a factory if it's not already present
  32347. * @param key the unique key that identifies the data
  32348. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  32349. * @return the associated data, can be null if the factory returned null.
  32350. */
  32351. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  32352. /**
  32353. * Remove an externaly attached data from the Engine instance
  32354. * @param key the unique key that identifies the data
  32355. * @return true if the data was successfully removed, false if it doesn't exist
  32356. */
  32357. removeExternalData(key: string): boolean;
  32358. /**
  32359. * Unbind all vertex attributes from the webGL context
  32360. */
  32361. unbindAllAttributes(): void;
  32362. /**
  32363. * 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
  32364. */
  32365. releaseEffects(): void;
  32366. /**
  32367. * Dispose and release all associated resources
  32368. */
  32369. dispose(): void;
  32370. /**
  32371. * Display the loading screen
  32372. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32373. */
  32374. displayLoadingUI(): void;
  32375. /**
  32376. * Hide the loading screen
  32377. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32378. */
  32379. hideLoadingUI(): void;
  32380. /**
  32381. * Gets the current loading screen object
  32382. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32383. */
  32384. /**
  32385. * Sets the current loading screen object
  32386. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32387. */
  32388. loadingScreen: ILoadingScreen;
  32389. /**
  32390. * Sets the current loading screen text
  32391. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32392. */
  32393. loadingUIText: string;
  32394. /**
  32395. * Sets the current loading screen background color
  32396. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32397. */
  32398. loadingUIBackgroundColor: string;
  32399. /**
  32400. * Attach a new callback raised when context lost event is fired
  32401. * @param callback defines the callback to call
  32402. */
  32403. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  32404. /**
  32405. * Attach a new callback raised when context restored event is fired
  32406. * @param callback defines the callback to call
  32407. */
  32408. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  32409. /**
  32410. * Gets the source code of the vertex shader associated with a specific webGL program
  32411. * @param program defines the program to use
  32412. * @returns a string containing the source code of the vertex shader associated with the program
  32413. */
  32414. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32415. /**
  32416. * Gets the source code of the fragment shader associated with a specific webGL program
  32417. * @param program defines the program to use
  32418. * @returns a string containing the source code of the fragment shader associated with the program
  32419. */
  32420. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32421. /**
  32422. * Get the current error code of the webGL context
  32423. * @returns the error code
  32424. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  32425. */
  32426. getError(): number;
  32427. /**
  32428. * Gets the current framerate
  32429. * @returns a number representing the framerate
  32430. */
  32431. getFps(): number;
  32432. /**
  32433. * Gets the time spent between current and previous frame
  32434. * @returns a number representing the delta time in ms
  32435. */
  32436. getDeltaTime(): number;
  32437. private _measureFps;
  32438. /** @hidden */
  32439. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  32440. private _canRenderToFloatFramebuffer;
  32441. private _canRenderToHalfFloatFramebuffer;
  32442. private _canRenderToFramebuffer;
  32443. /** @hidden */
  32444. _getWebGLTextureType(type: number): number;
  32445. /** @hidden */
  32446. _getInternalFormat(format: number): number;
  32447. /** @hidden */
  32448. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  32449. /** @hidden */
  32450. _getRGBAMultiSampleBufferFormat(type: number): number;
  32451. /** @hidden */
  32452. _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;
  32453. /** @hidden */
  32454. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32455. /**
  32456. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  32457. * @returns true if the engine can be created
  32458. * @ignorenaming
  32459. */
  32460. static isSupported(): boolean;
  32461. /**
  32462. * Find the next highest power of two.
  32463. * @param x Number to start search from.
  32464. * @return Next highest power of two.
  32465. */
  32466. static CeilingPOT(x: number): number;
  32467. /**
  32468. * Find the next lowest power of two.
  32469. * @param x Number to start search from.
  32470. * @return Next lowest power of two.
  32471. */
  32472. static FloorPOT(x: number): number;
  32473. /**
  32474. * Find the nearest power of two.
  32475. * @param x Number to start search from.
  32476. * @return Next nearest power of two.
  32477. */
  32478. static NearestPOT(x: number): number;
  32479. /**
  32480. * Get the closest exponent of two
  32481. * @param value defines the value to approximate
  32482. * @param max defines the maximum value to return
  32483. * @param mode defines how to define the closest value
  32484. * @returns closest exponent of two of the given value
  32485. */
  32486. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  32487. /**
  32488. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  32489. * @param func - the function to be called
  32490. * @param requester - the object that will request the next frame. Falls back to window.
  32491. * @returns frame number
  32492. */
  32493. static QueueNewFrame(func: () => void, requester?: any): number;
  32494. /**
  32495. * Ask the browser to promote the current element to pointerlock mode
  32496. * @param element defines the DOM element to promote
  32497. */
  32498. static _RequestPointerlock(element: HTMLElement): void;
  32499. /**
  32500. * Asks the browser to exit pointerlock mode
  32501. */
  32502. static _ExitPointerlock(): void;
  32503. /**
  32504. * Ask the browser to promote the current element to fullscreen rendering mode
  32505. * @param element defines the DOM element to promote
  32506. */
  32507. static _RequestFullscreen(element: HTMLElement): void;
  32508. /**
  32509. * Asks the browser to exit fullscreen mode
  32510. */
  32511. static _ExitFullscreen(): void;
  32512. }
  32513. }
  32514. declare module "babylonjs/Engines/engineStore" {
  32515. import { Nullable } from "babylonjs/types";
  32516. import { Engine } from "babylonjs/Engines/engine";
  32517. import { Scene } from "babylonjs/scene";
  32518. /**
  32519. * The engine store class is responsible to hold all the instances of Engine and Scene created
  32520. * during the life time of the application.
  32521. */
  32522. export class EngineStore {
  32523. /** Gets the list of created engines */
  32524. static Instances: import("babylonjs/Engines/engine").Engine[];
  32525. /** @hidden */
  32526. static _LastCreatedScene: Nullable<Scene>;
  32527. /**
  32528. * Gets the latest created engine
  32529. */
  32530. static readonly LastCreatedEngine: Nullable<Engine>;
  32531. /**
  32532. * Gets the latest created scene
  32533. */
  32534. static readonly LastCreatedScene: Nullable<Scene>;
  32535. /**
  32536. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32537. * @ignorenaming
  32538. */
  32539. static UseFallbackTexture: boolean;
  32540. /**
  32541. * Texture content used if a texture cannot loaded
  32542. * @ignorenaming
  32543. */
  32544. static FallbackTexture: string;
  32545. }
  32546. }
  32547. declare module "babylonjs/Misc/promise" {
  32548. /**
  32549. * Helper class that provides a small promise polyfill
  32550. */
  32551. export class PromisePolyfill {
  32552. /**
  32553. * Static function used to check if the polyfill is required
  32554. * If this is the case then the function will inject the polyfill to window.Promise
  32555. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  32556. */
  32557. static Apply(force?: boolean): void;
  32558. }
  32559. }
  32560. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  32561. /**
  32562. * Interface for screenshot methods with describe argument called `size` as object with options
  32563. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  32564. */
  32565. export interface IScreenshotSize {
  32566. /**
  32567. * number in pixels for canvas height
  32568. */
  32569. height?: number;
  32570. /**
  32571. * multiplier allowing render at a higher or lower resolution
  32572. * If value is defined then height and width will be ignored and taken from camera
  32573. */
  32574. precision?: number;
  32575. /**
  32576. * number in pixels for canvas width
  32577. */
  32578. width?: number;
  32579. }
  32580. }
  32581. declare module "babylonjs/Misc/tools" {
  32582. import { Nullable, float } from "babylonjs/types";
  32583. import { DomManagement } from "babylonjs/Misc/domManagement";
  32584. import { WebRequest } from "babylonjs/Misc/webRequest";
  32585. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  32586. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32587. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  32588. import { Camera } from "babylonjs/Cameras/camera";
  32589. import { Engine } from "babylonjs/Engines/engine";
  32590. interface IColor4Like {
  32591. r: float;
  32592. g: float;
  32593. b: float;
  32594. a: float;
  32595. }
  32596. /**
  32597. * Class containing a set of static utilities functions
  32598. */
  32599. export class Tools {
  32600. /**
  32601. * Gets or sets the base URL to use to load assets
  32602. */
  32603. static BaseUrl: string;
  32604. /**
  32605. * Enable/Disable Custom HTTP Request Headers globally.
  32606. * default = false
  32607. * @see CustomRequestHeaders
  32608. */
  32609. static UseCustomRequestHeaders: boolean;
  32610. /**
  32611. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  32612. * i.e. when loading files, where the server/service expects an Authorization header
  32613. */
  32614. static CustomRequestHeaders: {
  32615. [key: string]: string;
  32616. };
  32617. /**
  32618. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  32619. */
  32620. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  32621. /**
  32622. * Default behaviour for cors in the application.
  32623. * It can be a string if the expected behavior is identical in the entire app.
  32624. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  32625. */
  32626. static CorsBehavior: string | ((url: string | string[]) => string);
  32627. /**
  32628. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32629. * @ignorenaming
  32630. */
  32631. static UseFallbackTexture: boolean;
  32632. /**
  32633. * Use this object to register external classes like custom textures or material
  32634. * to allow the laoders to instantiate them
  32635. */
  32636. static RegisteredExternalClasses: {
  32637. [key: string]: Object;
  32638. };
  32639. /**
  32640. * Texture content used if a texture cannot loaded
  32641. * @ignorenaming
  32642. */
  32643. static fallbackTexture: string;
  32644. /**
  32645. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  32646. * @param u defines the coordinate on X axis
  32647. * @param v defines the coordinate on Y axis
  32648. * @param width defines the width of the source data
  32649. * @param height defines the height of the source data
  32650. * @param pixels defines the source byte array
  32651. * @param color defines the output color
  32652. */
  32653. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  32654. /**
  32655. * Interpolates between a and b via alpha
  32656. * @param a The lower value (returned when alpha = 0)
  32657. * @param b The upper value (returned when alpha = 1)
  32658. * @param alpha The interpolation-factor
  32659. * @return The mixed value
  32660. */
  32661. static Mix(a: number, b: number, alpha: number): number;
  32662. /**
  32663. * Tries to instantiate a new object from a given class name
  32664. * @param className defines the class name to instantiate
  32665. * @returns the new object or null if the system was not able to do the instantiation
  32666. */
  32667. static Instantiate(className: string): any;
  32668. /**
  32669. * Provides a slice function that will work even on IE
  32670. * @param data defines the array to slice
  32671. * @param start defines the start of the data (optional)
  32672. * @param end defines the end of the data (optional)
  32673. * @returns the new sliced array
  32674. */
  32675. static Slice<T>(data: T, start?: number, end?: number): T;
  32676. /**
  32677. * Polyfill for setImmediate
  32678. * @param action defines the action to execute after the current execution block
  32679. */
  32680. static SetImmediate(action: () => void): void;
  32681. /**
  32682. * Function indicating if a number is an exponent of 2
  32683. * @param value defines the value to test
  32684. * @returns true if the value is an exponent of 2
  32685. */
  32686. static IsExponentOfTwo(value: number): boolean;
  32687. private static _tmpFloatArray;
  32688. /**
  32689. * Returns the nearest 32-bit single precision float representation of a Number
  32690. * @param value A Number. If the parameter is of a different type, it will get converted
  32691. * to a number or to NaN if it cannot be converted
  32692. * @returns number
  32693. */
  32694. static FloatRound(value: number): number;
  32695. /**
  32696. * Extracts the filename from a path
  32697. * @param path defines the path to use
  32698. * @returns the filename
  32699. */
  32700. static GetFilename(path: string): string;
  32701. /**
  32702. * Extracts the "folder" part of a path (everything before the filename).
  32703. * @param uri The URI to extract the info from
  32704. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  32705. * @returns The "folder" part of the path
  32706. */
  32707. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  32708. /**
  32709. * Extracts text content from a DOM element hierarchy
  32710. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  32711. */
  32712. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  32713. /**
  32714. * Convert an angle in radians to degrees
  32715. * @param angle defines the angle to convert
  32716. * @returns the angle in degrees
  32717. */
  32718. static ToDegrees(angle: number): number;
  32719. /**
  32720. * Convert an angle in degrees to radians
  32721. * @param angle defines the angle to convert
  32722. * @returns the angle in radians
  32723. */
  32724. static ToRadians(angle: number): number;
  32725. /**
  32726. * Encode a buffer to a base64 string
  32727. * @param buffer defines the buffer to encode
  32728. * @returns the encoded string
  32729. */
  32730. static EncodeArrayBufferTobase64(buffer: ArrayBuffer): string;
  32731. /**
  32732. * Returns an array if obj is not an array
  32733. * @param obj defines the object to evaluate as an array
  32734. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  32735. * @returns either obj directly if obj is an array or a new array containing obj
  32736. */
  32737. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  32738. /**
  32739. * Gets the pointer prefix to use
  32740. * @returns "pointer" if touch is enabled. Else returns "mouse"
  32741. */
  32742. static GetPointerPrefix(): string;
  32743. /**
  32744. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  32745. * @param url define the url we are trying
  32746. * @param element define the dom element where to configure the cors policy
  32747. */
  32748. static SetCorsBehavior(url: string | string[], element: {
  32749. crossOrigin: string | null;
  32750. }): void;
  32751. /**
  32752. * Removes unwanted characters from an url
  32753. * @param url defines the url to clean
  32754. * @returns the cleaned url
  32755. */
  32756. static CleanUrl(url: string): string;
  32757. /**
  32758. * Gets or sets a function used to pre-process url before using them to load assets
  32759. */
  32760. static PreprocessUrl: (url: string) => string;
  32761. /**
  32762. * Loads an image as an HTMLImageElement.
  32763. * @param input url string, ArrayBuffer, or Blob to load
  32764. * @param onLoad callback called when the image successfully loads
  32765. * @param onError callback called when the image fails to load
  32766. * @param offlineProvider offline provider for caching
  32767. * @returns the HTMLImageElement of the loaded image
  32768. */
  32769. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  32770. /**
  32771. * Loads a file
  32772. * @param url url string, ArrayBuffer, or Blob to load
  32773. * @param onSuccess callback called when the file successfully loads
  32774. * @param onProgress callback called while file is loading (if the server supports this mode)
  32775. * @param offlineProvider defines the offline provider for caching
  32776. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  32777. * @param onError callback called when the file fails to load
  32778. * @returns a file request object
  32779. */
  32780. 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;
  32781. /**
  32782. * Loads a file from a url
  32783. * @param url the file url to load
  32784. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  32785. */
  32786. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  32787. /**
  32788. * Load a script (identified by an url). When the url returns, the
  32789. * content of this file is added into a new script element, attached to the DOM (body element)
  32790. * @param scriptUrl defines the url of the script to laod
  32791. * @param onSuccess defines the callback called when the script is loaded
  32792. * @param onError defines the callback to call if an error occurs
  32793. * @param scriptId defines the id of the script element
  32794. */
  32795. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  32796. /**
  32797. * Load an asynchronous script (identified by an url). When the url returns, the
  32798. * content of this file is added into a new script element, attached to the DOM (body element)
  32799. * @param scriptUrl defines the url of the script to laod
  32800. * @param scriptId defines the id of the script element
  32801. * @returns a promise request object
  32802. */
  32803. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  32804. /**
  32805. * Loads a file from a blob
  32806. * @param fileToLoad defines the blob to use
  32807. * @param callback defines the callback to call when data is loaded
  32808. * @param progressCallback defines the callback to call during loading process
  32809. * @returns a file request object
  32810. */
  32811. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  32812. /**
  32813. * Loads a file
  32814. * @param fileToLoad defines the file to load
  32815. * @param callback defines the callback to call when data is loaded
  32816. * @param progressCallBack defines the callback to call during loading process
  32817. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  32818. * @returns a file request object
  32819. */
  32820. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  32821. /**
  32822. * Creates a data url from a given string content
  32823. * @param content defines the content to convert
  32824. * @returns the new data url link
  32825. */
  32826. static FileAsURL(content: string): string;
  32827. /**
  32828. * Format the given number to a specific decimal format
  32829. * @param value defines the number to format
  32830. * @param decimals defines the number of decimals to use
  32831. * @returns the formatted string
  32832. */
  32833. static Format(value: number, decimals?: number): string;
  32834. /**
  32835. * Tries to copy an object by duplicating every property
  32836. * @param source defines the source object
  32837. * @param destination defines the target object
  32838. * @param doNotCopyList defines a list of properties to avoid
  32839. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  32840. */
  32841. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  32842. /**
  32843. * Gets a boolean indicating if the given object has no own property
  32844. * @param obj defines the object to test
  32845. * @returns true if object has no own property
  32846. */
  32847. static IsEmpty(obj: any): boolean;
  32848. /**
  32849. * Function used to register events at window level
  32850. * @param windowElement defines the Window object to use
  32851. * @param events defines the events to register
  32852. */
  32853. static RegisterTopRootEvents(windowElement: Window, events: {
  32854. name: string;
  32855. handler: Nullable<(e: FocusEvent) => any>;
  32856. }[]): void;
  32857. /**
  32858. * Function used to unregister events from window level
  32859. * @param windowElement defines the Window object to use
  32860. * @param events defines the events to unregister
  32861. */
  32862. static UnregisterTopRootEvents(windowElement: Window, events: {
  32863. name: string;
  32864. handler: Nullable<(e: FocusEvent) => any>;
  32865. }[]): void;
  32866. /**
  32867. * @ignore
  32868. */
  32869. static _ScreenshotCanvas: HTMLCanvasElement;
  32870. /**
  32871. * Dumps the current bound framebuffer
  32872. * @param width defines the rendering width
  32873. * @param height defines the rendering height
  32874. * @param engine defines the hosting engine
  32875. * @param successCallback defines the callback triggered once the data are available
  32876. * @param mimeType defines the mime type of the result
  32877. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  32878. */
  32879. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  32880. /**
  32881. * Converts the canvas data to blob.
  32882. * This acts as a polyfill for browsers not supporting the to blob function.
  32883. * @param canvas Defines the canvas to extract the data from
  32884. * @param successCallback Defines the callback triggered once the data are available
  32885. * @param mimeType Defines the mime type of the result
  32886. */
  32887. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  32888. /**
  32889. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  32890. * @param successCallback defines the callback triggered once the data are available
  32891. * @param mimeType defines the mime type of the result
  32892. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  32893. */
  32894. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  32895. /**
  32896. * Downloads a blob in the browser
  32897. * @param blob defines the blob to download
  32898. * @param fileName defines the name of the downloaded file
  32899. */
  32900. static Download(blob: Blob, fileName: string): void;
  32901. /**
  32902. * Captures a screenshot of the current rendering
  32903. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32904. * @param engine defines the rendering engine
  32905. * @param camera defines the source camera
  32906. * @param size This parameter can be set to a single number or to an object with the
  32907. * following (optional) properties: precision, width, height. If a single number is passed,
  32908. * it will be used for both width and height. If an object is passed, the screenshot size
  32909. * will be derived from the parameters. The precision property is a multiplier allowing
  32910. * rendering at a higher or lower resolution
  32911. * @param successCallback defines the callback receives a single parameter which contains the
  32912. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  32913. * src parameter of an <img> to display it
  32914. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  32915. * Check your browser for supported MIME types
  32916. */
  32917. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  32918. /**
  32919. * Captures a screenshot of the current rendering
  32920. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32921. * @param engine defines the rendering engine
  32922. * @param camera defines the source camera
  32923. * @param size This parameter can be set to a single number or to an object with the
  32924. * following (optional) properties: precision, width, height. If a single number is passed,
  32925. * it will be used for both width and height. If an object is passed, the screenshot size
  32926. * will be derived from the parameters. The precision property is a multiplier allowing
  32927. * rendering at a higher or lower resolution
  32928. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  32929. * Check your browser for supported MIME types
  32930. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  32931. * to the src parameter of an <img> to display it
  32932. */
  32933. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  32934. /**
  32935. * Generates an image screenshot from the specified camera.
  32936. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32937. * @param engine The engine to use for rendering
  32938. * @param camera The camera to use for rendering
  32939. * @param size This parameter can be set to a single number or to an object with the
  32940. * following (optional) properties: precision, width, height. If a single number is passed,
  32941. * it will be used for both width and height. If an object is passed, the screenshot size
  32942. * will be derived from the parameters. The precision property is a multiplier allowing
  32943. * rendering at a higher or lower resolution
  32944. * @param successCallback The callback receives a single parameter which contains the
  32945. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  32946. * src parameter of an <img> to display it
  32947. * @param mimeType The MIME type of the screenshot image (default: image/png).
  32948. * Check your browser for supported MIME types
  32949. * @param samples Texture samples (default: 1)
  32950. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  32951. * @param fileName A name for for the downloaded file.
  32952. */
  32953. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  32954. /**
  32955. * Generates an image screenshot from the specified camera.
  32956. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32957. * @param engine The engine to use for rendering
  32958. * @param camera The camera to use for rendering
  32959. * @param size This parameter can be set to a single number or to an object with the
  32960. * following (optional) properties: precision, width, height. If a single number is passed,
  32961. * it will be used for both width and height. If an object is passed, the screenshot size
  32962. * will be derived from the parameters. The precision property is a multiplier allowing
  32963. * rendering at a higher or lower resolution
  32964. * @param mimeType The MIME type of the screenshot image (default: image/png).
  32965. * Check your browser for supported MIME types
  32966. * @param samples Texture samples (default: 1)
  32967. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  32968. * @param fileName A name for for the downloaded file.
  32969. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  32970. * to the src parameter of an <img> to display it
  32971. */
  32972. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  32973. /**
  32974. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  32975. * Be aware Math.random() could cause collisions, but:
  32976. * "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"
  32977. * @returns a pseudo random id
  32978. */
  32979. static RandomId(): string;
  32980. /**
  32981. * Test if the given uri is a base64 string
  32982. * @param uri The uri to test
  32983. * @return True if the uri is a base64 string or false otherwise
  32984. */
  32985. static IsBase64(uri: string): boolean;
  32986. /**
  32987. * Decode the given base64 uri.
  32988. * @param uri The uri to decode
  32989. * @return The decoded base64 data.
  32990. */
  32991. static DecodeBase64(uri: string): ArrayBuffer;
  32992. /**
  32993. * Gets the absolute url.
  32994. * @param url the input url
  32995. * @return the absolute url
  32996. */
  32997. static GetAbsoluteUrl(url: string): string;
  32998. /**
  32999. * No log
  33000. */
  33001. static readonly NoneLogLevel: number;
  33002. /**
  33003. * Only message logs
  33004. */
  33005. static readonly MessageLogLevel: number;
  33006. /**
  33007. * Only warning logs
  33008. */
  33009. static readonly WarningLogLevel: number;
  33010. /**
  33011. * Only error logs
  33012. */
  33013. static readonly ErrorLogLevel: number;
  33014. /**
  33015. * All logs
  33016. */
  33017. static readonly AllLogLevel: number;
  33018. /**
  33019. * Gets a value indicating the number of loading errors
  33020. * @ignorenaming
  33021. */
  33022. static readonly errorsCount: number;
  33023. /**
  33024. * Callback called when a new log is added
  33025. */
  33026. static OnNewCacheEntry: (entry: string) => void;
  33027. /**
  33028. * Log a message to the console
  33029. * @param message defines the message to log
  33030. */
  33031. static Log(message: string): void;
  33032. /**
  33033. * Write a warning message to the console
  33034. * @param message defines the message to log
  33035. */
  33036. static Warn(message: string): void;
  33037. /**
  33038. * Write an error message to the console
  33039. * @param message defines the message to log
  33040. */
  33041. static Error(message: string): void;
  33042. /**
  33043. * Gets current log cache (list of logs)
  33044. */
  33045. static readonly LogCache: string;
  33046. /**
  33047. * Clears the log cache
  33048. */
  33049. static ClearLogCache(): void;
  33050. /**
  33051. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33052. */
  33053. static LogLevels: number;
  33054. /**
  33055. * Checks if the window object exists
  33056. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33057. */
  33058. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33059. /**
  33060. * No performance log
  33061. */
  33062. static readonly PerformanceNoneLogLevel: number;
  33063. /**
  33064. * Use user marks to log performance
  33065. */
  33066. static readonly PerformanceUserMarkLogLevel: number;
  33067. /**
  33068. * Log performance to the console
  33069. */
  33070. static readonly PerformanceConsoleLogLevel: number;
  33071. private static _performance;
  33072. /**
  33073. * Sets the current performance log level
  33074. */
  33075. static PerformanceLogLevel: number;
  33076. private static _StartPerformanceCounterDisabled;
  33077. private static _EndPerformanceCounterDisabled;
  33078. private static _StartUserMark;
  33079. private static _EndUserMark;
  33080. private static _StartPerformanceConsole;
  33081. private static _EndPerformanceConsole;
  33082. /**
  33083. * Starts a performance counter
  33084. */
  33085. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33086. /**
  33087. * Ends a specific performance coutner
  33088. */
  33089. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33090. /**
  33091. * Gets either window.performance.now() if supported or Date.now() else
  33092. */
  33093. static readonly Now: number;
  33094. /**
  33095. * This method will return the name of the class used to create the instance of the given object.
  33096. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33097. * @param object the object to get the class name from
  33098. * @param isType defines if the object is actually a type
  33099. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33100. */
  33101. static GetClassName(object: any, isType?: boolean): string;
  33102. /**
  33103. * Gets the first element of an array satisfying a given predicate
  33104. * @param array defines the array to browse
  33105. * @param predicate defines the predicate to use
  33106. * @returns null if not found or the element
  33107. */
  33108. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33109. /**
  33110. * This method will return the name of the full name of the class, including its owning module (if any).
  33111. * 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).
  33112. * @param object the object to get the class name from
  33113. * @param isType defines if the object is actually a type
  33114. * @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.
  33115. * @ignorenaming
  33116. */
  33117. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33118. /**
  33119. * Returns a promise that resolves after the given amount of time.
  33120. * @param delay Number of milliseconds to delay
  33121. * @returns Promise that resolves after the given amount of time
  33122. */
  33123. static DelayAsync(delay: number): Promise<void>;
  33124. }
  33125. /**
  33126. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33127. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33128. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33129. * @param name The name of the class, case should be preserved
  33130. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33131. */
  33132. export function className(name: string, module?: string): (target: Object) => void;
  33133. /**
  33134. * An implementation of a loop for asynchronous functions.
  33135. */
  33136. export class AsyncLoop {
  33137. /**
  33138. * Defines the number of iterations for the loop
  33139. */
  33140. iterations: number;
  33141. /**
  33142. * Defines the current index of the loop.
  33143. */
  33144. index: number;
  33145. private _done;
  33146. private _fn;
  33147. private _successCallback;
  33148. /**
  33149. * Constructor.
  33150. * @param iterations the number of iterations.
  33151. * @param func the function to run each iteration
  33152. * @param successCallback the callback that will be called upon succesful execution
  33153. * @param offset starting offset.
  33154. */
  33155. constructor(
  33156. /**
  33157. * Defines the number of iterations for the loop
  33158. */
  33159. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33160. /**
  33161. * Execute the next iteration. Must be called after the last iteration was finished.
  33162. */
  33163. executeNext(): void;
  33164. /**
  33165. * Break the loop and run the success callback.
  33166. */
  33167. breakLoop(): void;
  33168. /**
  33169. * Create and run an async loop.
  33170. * @param iterations the number of iterations.
  33171. * @param fn the function to run each iteration
  33172. * @param successCallback the callback that will be called upon succesful execution
  33173. * @param offset starting offset.
  33174. * @returns the created async loop object
  33175. */
  33176. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33177. /**
  33178. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33179. * @param iterations total number of iterations
  33180. * @param syncedIterations number of synchronous iterations in each async iteration.
  33181. * @param fn the function to call each iteration.
  33182. * @param callback a success call back that will be called when iterating stops.
  33183. * @param breakFunction a break condition (optional)
  33184. * @param timeout timeout settings for the setTimeout function. default - 0.
  33185. * @returns the created async loop object
  33186. */
  33187. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33188. }
  33189. }
  33190. declare module "babylonjs/Collisions/collisionCoordinator" {
  33191. import { Nullable } from "babylonjs/types";
  33192. import { Scene } from "babylonjs/scene";
  33193. import { Vector3 } from "babylonjs/Maths/math.vector";
  33194. import { Collider } from "babylonjs/Collisions/collider";
  33195. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33196. /** @hidden */
  33197. export interface ICollisionCoordinator {
  33198. createCollider(): Collider;
  33199. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33200. init(scene: Scene): void;
  33201. }
  33202. /** @hidden */
  33203. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33204. private _scene;
  33205. private _scaledPosition;
  33206. private _scaledVelocity;
  33207. private _finalPosition;
  33208. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33209. createCollider(): Collider;
  33210. init(scene: Scene): void;
  33211. private _collideWithWorld;
  33212. }
  33213. }
  33214. declare module "babylonjs/Inputs/scene.inputManager" {
  33215. import { Nullable } from "babylonjs/types";
  33216. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33217. import { Vector2 } from "babylonjs/Maths/math.vector";
  33218. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33219. import { Scene } from "babylonjs/scene";
  33220. /**
  33221. * Class used to manage all inputs for the scene.
  33222. */
  33223. export class InputManager {
  33224. /** The distance in pixel that you have to move to prevent some events */
  33225. static DragMovementThreshold: number;
  33226. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33227. static LongPressDelay: number;
  33228. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33229. static DoubleClickDelay: number;
  33230. /** If you need to check double click without raising a single click at first click, enable this flag */
  33231. static ExclusiveDoubleClickMode: boolean;
  33232. private _wheelEventName;
  33233. private _onPointerMove;
  33234. private _onPointerDown;
  33235. private _onPointerUp;
  33236. private _initClickEvent;
  33237. private _initActionManager;
  33238. private _delayedSimpleClick;
  33239. private _delayedSimpleClickTimeout;
  33240. private _previousDelayedSimpleClickTimeout;
  33241. private _meshPickProceed;
  33242. private _previousButtonPressed;
  33243. private _currentPickResult;
  33244. private _previousPickResult;
  33245. private _totalPointersPressed;
  33246. private _doubleClickOccured;
  33247. private _pointerOverMesh;
  33248. private _pickedDownMesh;
  33249. private _pickedUpMesh;
  33250. private _pointerX;
  33251. private _pointerY;
  33252. private _unTranslatedPointerX;
  33253. private _unTranslatedPointerY;
  33254. private _startingPointerPosition;
  33255. private _previousStartingPointerPosition;
  33256. private _startingPointerTime;
  33257. private _previousStartingPointerTime;
  33258. private _pointerCaptures;
  33259. private _onKeyDown;
  33260. private _onKeyUp;
  33261. private _onCanvasFocusObserver;
  33262. private _onCanvasBlurObserver;
  33263. private _scene;
  33264. /**
  33265. * Creates a new InputManager
  33266. * @param scene defines the hosting scene
  33267. */
  33268. constructor(scene: Scene);
  33269. /**
  33270. * Gets the mesh that is currently under the pointer
  33271. */
  33272. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33273. /**
  33274. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33275. */
  33276. readonly unTranslatedPointer: Vector2;
  33277. /**
  33278. * Gets or sets the current on-screen X position of the pointer
  33279. */
  33280. pointerX: number;
  33281. /**
  33282. * Gets or sets the current on-screen Y position of the pointer
  33283. */
  33284. pointerY: number;
  33285. private _updatePointerPosition;
  33286. private _processPointerMove;
  33287. private _setRayOnPointerInfo;
  33288. private _checkPrePointerObservable;
  33289. /**
  33290. * Use this method to simulate a pointer move on a mesh
  33291. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33292. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33293. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33294. */
  33295. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33296. /**
  33297. * Use this method to simulate a pointer down on a mesh
  33298. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33299. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33300. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33301. */
  33302. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33303. private _processPointerDown;
  33304. /** @hidden */
  33305. _isPointerSwiping(): boolean;
  33306. /**
  33307. * Use this method to simulate a pointer up on a mesh
  33308. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33309. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33310. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33311. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  33312. */
  33313. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  33314. private _processPointerUp;
  33315. /**
  33316. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  33317. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  33318. * @returns true if the pointer was captured
  33319. */
  33320. isPointerCaptured(pointerId?: number): boolean;
  33321. /**
  33322. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  33323. * @param attachUp defines if you want to attach events to pointerup
  33324. * @param attachDown defines if you want to attach events to pointerdown
  33325. * @param attachMove defines if you want to attach events to pointermove
  33326. */
  33327. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  33328. /**
  33329. * Detaches all event handlers
  33330. */
  33331. detachControl(): void;
  33332. /**
  33333. * Force the value of meshUnderPointer
  33334. * @param mesh defines the mesh to use
  33335. */
  33336. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  33337. /**
  33338. * Gets the mesh under the pointer
  33339. * @returns a Mesh or null if no mesh is under the pointer
  33340. */
  33341. getPointerOverMesh(): Nullable<AbstractMesh>;
  33342. }
  33343. }
  33344. declare module "babylonjs/Misc/uniqueIdGenerator" {
  33345. /**
  33346. * Helper class used to generate session unique ID
  33347. */
  33348. export class UniqueIdGenerator {
  33349. private static _UniqueIdCounter;
  33350. /**
  33351. * Gets an unique (relatively to the current scene) Id
  33352. */
  33353. static readonly UniqueId: number;
  33354. }
  33355. }
  33356. declare module "babylonjs/Animations/animationGroup" {
  33357. import { Animatable } from "babylonjs/Animations/animatable";
  33358. import { Animation } from "babylonjs/Animations/animation";
  33359. import { Scene, IDisposable } from "babylonjs/scene";
  33360. import { Observable } from "babylonjs/Misc/observable";
  33361. import { Nullable } from "babylonjs/types";
  33362. import "babylonjs/Animations/animatable";
  33363. /**
  33364. * This class defines the direct association between an animation and a target
  33365. */
  33366. export class TargetedAnimation {
  33367. /**
  33368. * Animation to perform
  33369. */
  33370. animation: Animation;
  33371. /**
  33372. * Target to animate
  33373. */
  33374. target: any;
  33375. /**
  33376. * Serialize the object
  33377. * @returns the JSON object representing the current entity
  33378. */
  33379. serialize(): any;
  33380. }
  33381. /**
  33382. * Use this class to create coordinated animations on multiple targets
  33383. */
  33384. export class AnimationGroup implements IDisposable {
  33385. /** The name of the animation group */
  33386. name: string;
  33387. private _scene;
  33388. private _targetedAnimations;
  33389. private _animatables;
  33390. private _from;
  33391. private _to;
  33392. private _isStarted;
  33393. private _isPaused;
  33394. private _speedRatio;
  33395. private _loopAnimation;
  33396. /**
  33397. * Gets or sets the unique id of the node
  33398. */
  33399. uniqueId: number;
  33400. /**
  33401. * This observable will notify when one animation have ended
  33402. */
  33403. onAnimationEndObservable: Observable<TargetedAnimation>;
  33404. /**
  33405. * Observer raised when one animation loops
  33406. */
  33407. onAnimationLoopObservable: Observable<TargetedAnimation>;
  33408. /**
  33409. * This observable will notify when all animations have ended.
  33410. */
  33411. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  33412. /**
  33413. * This observable will notify when all animations have paused.
  33414. */
  33415. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  33416. /**
  33417. * This observable will notify when all animations are playing.
  33418. */
  33419. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  33420. /**
  33421. * Gets the first frame
  33422. */
  33423. readonly from: number;
  33424. /**
  33425. * Gets the last frame
  33426. */
  33427. readonly to: number;
  33428. /**
  33429. * Define if the animations are started
  33430. */
  33431. readonly isStarted: boolean;
  33432. /**
  33433. * Gets a value indicating that the current group is playing
  33434. */
  33435. readonly isPlaying: boolean;
  33436. /**
  33437. * Gets or sets the speed ratio to use for all animations
  33438. */
  33439. /**
  33440. * Gets or sets the speed ratio to use for all animations
  33441. */
  33442. speedRatio: number;
  33443. /**
  33444. * Gets or sets if all animations should loop or not
  33445. */
  33446. loopAnimation: boolean;
  33447. /**
  33448. * Gets the targeted animations for this animation group
  33449. */
  33450. readonly targetedAnimations: Array<TargetedAnimation>;
  33451. /**
  33452. * returning the list of animatables controlled by this animation group.
  33453. */
  33454. readonly animatables: Array<Animatable>;
  33455. /**
  33456. * Instantiates a new Animation Group.
  33457. * This helps managing several animations at once.
  33458. * @see http://doc.babylonjs.com/how_to/group
  33459. * @param name Defines the name of the group
  33460. * @param scene Defines the scene the group belongs to
  33461. */
  33462. constructor(
  33463. /** The name of the animation group */
  33464. name: string, scene?: Nullable<Scene>);
  33465. /**
  33466. * Add an animation (with its target) in the group
  33467. * @param animation defines the animation we want to add
  33468. * @param target defines the target of the animation
  33469. * @returns the TargetedAnimation object
  33470. */
  33471. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  33472. /**
  33473. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  33474. * It can add constant keys at begin or end
  33475. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  33476. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  33477. * @returns the animation group
  33478. */
  33479. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  33480. /**
  33481. * Start all animations on given targets
  33482. * @param loop defines if animations must loop
  33483. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  33484. * @param from defines the from key (optional)
  33485. * @param to defines the to key (optional)
  33486. * @returns the current animation group
  33487. */
  33488. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  33489. /**
  33490. * Pause all animations
  33491. * @returns the animation group
  33492. */
  33493. pause(): AnimationGroup;
  33494. /**
  33495. * Play all animations to initial state
  33496. * This function will start() the animations if they were not started or will restart() them if they were paused
  33497. * @param loop defines if animations must loop
  33498. * @returns the animation group
  33499. */
  33500. play(loop?: boolean): AnimationGroup;
  33501. /**
  33502. * Reset all animations to initial state
  33503. * @returns the animation group
  33504. */
  33505. reset(): AnimationGroup;
  33506. /**
  33507. * Restart animations from key 0
  33508. * @returns the animation group
  33509. */
  33510. restart(): AnimationGroup;
  33511. /**
  33512. * Stop all animations
  33513. * @returns the animation group
  33514. */
  33515. stop(): AnimationGroup;
  33516. /**
  33517. * Set animation weight for all animatables
  33518. * @param weight defines the weight to use
  33519. * @return the animationGroup
  33520. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33521. */
  33522. setWeightForAllAnimatables(weight: number): AnimationGroup;
  33523. /**
  33524. * Synchronize and normalize all animatables with a source animatable
  33525. * @param root defines the root animatable to synchronize with
  33526. * @return the animationGroup
  33527. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33528. */
  33529. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  33530. /**
  33531. * Goes to a specific frame in this animation group
  33532. * @param frame the frame number to go to
  33533. * @return the animationGroup
  33534. */
  33535. goToFrame(frame: number): AnimationGroup;
  33536. /**
  33537. * Dispose all associated resources
  33538. */
  33539. dispose(): void;
  33540. private _checkAnimationGroupEnded;
  33541. /**
  33542. * Clone the current animation group and returns a copy
  33543. * @param newName defines the name of the new group
  33544. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  33545. * @returns the new aniamtion group
  33546. */
  33547. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  33548. /**
  33549. * Serializes the animationGroup to an object
  33550. * @returns Serialized object
  33551. */
  33552. serialize(): any;
  33553. /**
  33554. * Returns a new AnimationGroup object parsed from the source provided.
  33555. * @param parsedAnimationGroup defines the source
  33556. * @param scene defines the scene that will receive the animationGroup
  33557. * @returns a new AnimationGroup
  33558. */
  33559. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  33560. /**
  33561. * Returns the string "AnimationGroup"
  33562. * @returns "AnimationGroup"
  33563. */
  33564. getClassName(): string;
  33565. /**
  33566. * Creates a detailled string about the object
  33567. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  33568. * @returns a string representing the object
  33569. */
  33570. toString(fullDetails?: boolean): string;
  33571. }
  33572. }
  33573. declare module "babylonjs/scene" {
  33574. import { Nullable } from "babylonjs/types";
  33575. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33576. import { Observable } from "babylonjs/Misc/observable";
  33577. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  33578. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  33579. import { Geometry } from "babylonjs/Meshes/geometry";
  33580. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33581. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33582. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33583. import { Mesh } from "babylonjs/Meshes/mesh";
  33584. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33585. import { Bone } from "babylonjs/Bones/bone";
  33586. import { Skeleton } from "babylonjs/Bones/skeleton";
  33587. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  33588. import { Camera } from "babylonjs/Cameras/camera";
  33589. import { AbstractScene } from "babylonjs/abstractScene";
  33590. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  33591. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  33592. import { Material } from "babylonjs/Materials/material";
  33593. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  33594. import { Effect } from "babylonjs/Materials/effect";
  33595. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  33596. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  33597. import { Light } from "babylonjs/Lights/light";
  33598. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33599. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  33600. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  33601. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  33602. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  33603. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  33604. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  33605. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  33606. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  33607. import { Engine } from "babylonjs/Engines/engine";
  33608. import { Node } from "babylonjs/node";
  33609. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  33610. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33611. import { WebRequest } from "babylonjs/Misc/webRequest";
  33612. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  33613. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  33614. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  33615. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  33616. import { Plane } from "babylonjs/Maths/math.plane";
  33617. import { Ray } from "babylonjs/Culling/ray";
  33618. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33619. import { Animation } from "babylonjs/Animations/animation";
  33620. import { Animatable } from "babylonjs/Animations/animatable";
  33621. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  33622. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  33623. import { Collider } from "babylonjs/Collisions/collider";
  33624. /**
  33625. * Define an interface for all classes that will hold resources
  33626. */
  33627. export interface IDisposable {
  33628. /**
  33629. * Releases all held resources
  33630. */
  33631. dispose(): void;
  33632. }
  33633. /** Interface defining initialization parameters for Scene class */
  33634. export interface SceneOptions {
  33635. /**
  33636. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  33637. * It will improve performance when the number of geometries becomes important.
  33638. */
  33639. useGeometryUniqueIdsMap?: boolean;
  33640. /**
  33641. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  33642. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  33643. */
  33644. useMaterialMeshMap?: boolean;
  33645. /**
  33646. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  33647. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  33648. */
  33649. useClonedMeshhMap?: boolean;
  33650. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  33651. virtual?: boolean;
  33652. }
  33653. /**
  33654. * Represents a scene to be rendered by the engine.
  33655. * @see http://doc.babylonjs.com/features/scene
  33656. */
  33657. export class Scene extends AbstractScene implements IAnimatable {
  33658. /** The fog is deactivated */
  33659. static readonly FOGMODE_NONE: number;
  33660. /** The fog density is following an exponential function */
  33661. static readonly FOGMODE_EXP: number;
  33662. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  33663. static readonly FOGMODE_EXP2: number;
  33664. /** The fog density is following a linear function. */
  33665. static readonly FOGMODE_LINEAR: number;
  33666. /**
  33667. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  33668. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  33669. */
  33670. static MinDeltaTime: number;
  33671. /**
  33672. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  33673. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  33674. */
  33675. static MaxDeltaTime: number;
  33676. /**
  33677. * Factory used to create the default material.
  33678. * @param name The name of the material to create
  33679. * @param scene The scene to create the material for
  33680. * @returns The default material
  33681. */
  33682. static DefaultMaterialFactory(scene: Scene): Material;
  33683. /**
  33684. * Factory used to create the a collision coordinator.
  33685. * @returns The collision coordinator
  33686. */
  33687. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  33688. /** @hidden */
  33689. _inputManager: InputManager;
  33690. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  33691. cameraToUseForPointers: Nullable<Camera>;
  33692. /** @hidden */
  33693. readonly _isScene: boolean;
  33694. /**
  33695. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  33696. */
  33697. autoClear: boolean;
  33698. /**
  33699. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  33700. */
  33701. autoClearDepthAndStencil: boolean;
  33702. /**
  33703. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  33704. */
  33705. clearColor: Color4;
  33706. /**
  33707. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  33708. */
  33709. ambientColor: Color3;
  33710. /**
  33711. * This is use to store the default BRDF lookup for PBR materials in your scene.
  33712. * It should only be one of the following (if not the default embedded one):
  33713. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  33714. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  33715. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  33716. * The material properties need to be setup according to the type of texture in use.
  33717. */
  33718. environmentBRDFTexture: BaseTexture;
  33719. /** @hidden */
  33720. protected _environmentTexture: Nullable<BaseTexture>;
  33721. /**
  33722. * Texture used in all pbr material as the reflection texture.
  33723. * As in the majority of the scene they are the same (exception for multi room and so on),
  33724. * this is easier to reference from here than from all the materials.
  33725. */
  33726. /**
  33727. * Texture used in all pbr material as the reflection texture.
  33728. * As in the majority of the scene they are the same (exception for multi room and so on),
  33729. * this is easier to set here than in all the materials.
  33730. */
  33731. environmentTexture: Nullable<BaseTexture>;
  33732. /** @hidden */
  33733. protected _environmentIntensity: number;
  33734. /**
  33735. * Intensity of the environment in all pbr material.
  33736. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  33737. * As in the majority of the scene they are the same (exception for multi room and so on),
  33738. * this is easier to reference from here than from all the materials.
  33739. */
  33740. /**
  33741. * Intensity of the environment in all pbr material.
  33742. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  33743. * As in the majority of the scene they are the same (exception for multi room and so on),
  33744. * this is easier to set here than in all the materials.
  33745. */
  33746. environmentIntensity: number;
  33747. /** @hidden */
  33748. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  33749. /**
  33750. * Default image processing configuration used either in the rendering
  33751. * Forward main pass or through the imageProcessingPostProcess if present.
  33752. * As in the majority of the scene they are the same (exception for multi camera),
  33753. * this is easier to reference from here than from all the materials and post process.
  33754. *
  33755. * No setter as we it is a shared configuration, you can set the values instead.
  33756. */
  33757. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  33758. private _forceWireframe;
  33759. /**
  33760. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  33761. */
  33762. forceWireframe: boolean;
  33763. private _forcePointsCloud;
  33764. /**
  33765. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  33766. */
  33767. forcePointsCloud: boolean;
  33768. /**
  33769. * Gets or sets the active clipplane 1
  33770. */
  33771. clipPlane: Nullable<Plane>;
  33772. /**
  33773. * Gets or sets the active clipplane 2
  33774. */
  33775. clipPlane2: Nullable<Plane>;
  33776. /**
  33777. * Gets or sets the active clipplane 3
  33778. */
  33779. clipPlane3: Nullable<Plane>;
  33780. /**
  33781. * Gets or sets the active clipplane 4
  33782. */
  33783. clipPlane4: Nullable<Plane>;
  33784. /**
  33785. * Gets or sets a boolean indicating if animations are enabled
  33786. */
  33787. animationsEnabled: boolean;
  33788. private _animationPropertiesOverride;
  33789. /**
  33790. * Gets or sets the animation properties override
  33791. */
  33792. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  33793. /**
  33794. * Gets or sets a boolean indicating if a constant deltatime has to be used
  33795. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  33796. */
  33797. useConstantAnimationDeltaTime: boolean;
  33798. /**
  33799. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  33800. * Please note that it requires to run a ray cast through the scene on every frame
  33801. */
  33802. constantlyUpdateMeshUnderPointer: boolean;
  33803. /**
  33804. * Defines the HTML cursor to use when hovering over interactive elements
  33805. */
  33806. hoverCursor: string;
  33807. /**
  33808. * Defines the HTML default cursor to use (empty by default)
  33809. */
  33810. defaultCursor: string;
  33811. /**
  33812. * This is used to call preventDefault() on pointer down
  33813. * in order to block unwanted artifacts like system double clicks
  33814. */
  33815. preventDefaultOnPointerDown: boolean;
  33816. /**
  33817. * This is used to call preventDefault() on pointer up
  33818. * in order to block unwanted artifacts like system double clicks
  33819. */
  33820. preventDefaultOnPointerUp: boolean;
  33821. /**
  33822. * Gets or sets user defined metadata
  33823. */
  33824. metadata: any;
  33825. /**
  33826. * For internal use only. Please do not use.
  33827. */
  33828. reservedDataStore: any;
  33829. /**
  33830. * Gets the name of the plugin used to load this scene (null by default)
  33831. */
  33832. loadingPluginName: string;
  33833. /**
  33834. * Use this array to add regular expressions used to disable offline support for specific urls
  33835. */
  33836. disableOfflineSupportExceptionRules: RegExp[];
  33837. /**
  33838. * An event triggered when the scene is disposed.
  33839. */
  33840. onDisposeObservable: Observable<Scene>;
  33841. private _onDisposeObserver;
  33842. /** Sets a function to be executed when this scene is disposed. */
  33843. onDispose: () => void;
  33844. /**
  33845. * An event triggered before rendering the scene (right after animations and physics)
  33846. */
  33847. onBeforeRenderObservable: Observable<Scene>;
  33848. private _onBeforeRenderObserver;
  33849. /** Sets a function to be executed before rendering this scene */
  33850. beforeRender: Nullable<() => void>;
  33851. /**
  33852. * An event triggered after rendering the scene
  33853. */
  33854. onAfterRenderObservable: Observable<Scene>;
  33855. /**
  33856. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  33857. */
  33858. onAfterRenderCameraObservable: Observable<Camera>;
  33859. private _onAfterRenderObserver;
  33860. /** Sets a function to be executed after rendering this scene */
  33861. afterRender: Nullable<() => void>;
  33862. /**
  33863. * An event triggered before animating the scene
  33864. */
  33865. onBeforeAnimationsObservable: Observable<Scene>;
  33866. /**
  33867. * An event triggered after animations processing
  33868. */
  33869. onAfterAnimationsObservable: Observable<Scene>;
  33870. /**
  33871. * An event triggered before draw calls are ready to be sent
  33872. */
  33873. onBeforeDrawPhaseObservable: Observable<Scene>;
  33874. /**
  33875. * An event triggered after draw calls have been sent
  33876. */
  33877. onAfterDrawPhaseObservable: Observable<Scene>;
  33878. /**
  33879. * An event triggered when the scene is ready
  33880. */
  33881. onReadyObservable: Observable<Scene>;
  33882. /**
  33883. * An event triggered before rendering a camera
  33884. */
  33885. onBeforeCameraRenderObservable: Observable<Camera>;
  33886. private _onBeforeCameraRenderObserver;
  33887. /** Sets a function to be executed before rendering a camera*/
  33888. beforeCameraRender: () => void;
  33889. /**
  33890. * An event triggered after rendering a camera
  33891. */
  33892. onAfterCameraRenderObservable: Observable<Camera>;
  33893. private _onAfterCameraRenderObserver;
  33894. /** Sets a function to be executed after rendering a camera*/
  33895. afterCameraRender: () => void;
  33896. /**
  33897. * An event triggered when active meshes evaluation is about to start
  33898. */
  33899. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  33900. /**
  33901. * An event triggered when active meshes evaluation is done
  33902. */
  33903. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  33904. /**
  33905. * An event triggered when particles rendering is about to start
  33906. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  33907. */
  33908. onBeforeParticlesRenderingObservable: Observable<Scene>;
  33909. /**
  33910. * An event triggered when particles rendering is done
  33911. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  33912. */
  33913. onAfterParticlesRenderingObservable: Observable<Scene>;
  33914. /**
  33915. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  33916. */
  33917. onDataLoadedObservable: Observable<Scene>;
  33918. /**
  33919. * An event triggered when a camera is created
  33920. */
  33921. onNewCameraAddedObservable: Observable<Camera>;
  33922. /**
  33923. * An event triggered when a camera is removed
  33924. */
  33925. onCameraRemovedObservable: Observable<Camera>;
  33926. /**
  33927. * An event triggered when a light is created
  33928. */
  33929. onNewLightAddedObservable: Observable<Light>;
  33930. /**
  33931. * An event triggered when a light is removed
  33932. */
  33933. onLightRemovedObservable: Observable<Light>;
  33934. /**
  33935. * An event triggered when a geometry is created
  33936. */
  33937. onNewGeometryAddedObservable: Observable<Geometry>;
  33938. /**
  33939. * An event triggered when a geometry is removed
  33940. */
  33941. onGeometryRemovedObservable: Observable<Geometry>;
  33942. /**
  33943. * An event triggered when a transform node is created
  33944. */
  33945. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  33946. /**
  33947. * An event triggered when a transform node is removed
  33948. */
  33949. onTransformNodeRemovedObservable: Observable<TransformNode>;
  33950. /**
  33951. * An event triggered when a mesh is created
  33952. */
  33953. onNewMeshAddedObservable: Observable<AbstractMesh>;
  33954. /**
  33955. * An event triggered when a mesh is removed
  33956. */
  33957. onMeshRemovedObservable: Observable<AbstractMesh>;
  33958. /**
  33959. * An event triggered when a skeleton is created
  33960. */
  33961. onNewSkeletonAddedObservable: Observable<Skeleton>;
  33962. /**
  33963. * An event triggered when a skeleton is removed
  33964. */
  33965. onSkeletonRemovedObservable: Observable<Skeleton>;
  33966. /**
  33967. * An event triggered when a material is created
  33968. */
  33969. onNewMaterialAddedObservable: Observable<Material>;
  33970. /**
  33971. * An event triggered when a material is removed
  33972. */
  33973. onMaterialRemovedObservable: Observable<Material>;
  33974. /**
  33975. * An event triggered when a texture is created
  33976. */
  33977. onNewTextureAddedObservable: Observable<BaseTexture>;
  33978. /**
  33979. * An event triggered when a texture is removed
  33980. */
  33981. onTextureRemovedObservable: Observable<BaseTexture>;
  33982. /**
  33983. * An event triggered when render targets are about to be rendered
  33984. * Can happen multiple times per frame.
  33985. */
  33986. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  33987. /**
  33988. * An event triggered when render targets were rendered.
  33989. * Can happen multiple times per frame.
  33990. */
  33991. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  33992. /**
  33993. * An event triggered before calculating deterministic simulation step
  33994. */
  33995. onBeforeStepObservable: Observable<Scene>;
  33996. /**
  33997. * An event triggered after calculating deterministic simulation step
  33998. */
  33999. onAfterStepObservable: Observable<Scene>;
  34000. /**
  34001. * An event triggered when the activeCamera property is updated
  34002. */
  34003. onActiveCameraChanged: Observable<Scene>;
  34004. /**
  34005. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34006. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34007. * 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)
  34008. */
  34009. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34010. /**
  34011. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34012. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34013. * 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)
  34014. */
  34015. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34016. /**
  34017. * This Observable will when a mesh has been imported into the scene.
  34018. */
  34019. onMeshImportedObservable: Observable<AbstractMesh>;
  34020. /**
  34021. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34022. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34023. */
  34024. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34025. /** @hidden */
  34026. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34027. /**
  34028. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34029. */
  34030. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34031. /**
  34032. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34033. */
  34034. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34035. /**
  34036. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34037. */
  34038. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34039. /** Callback called when a pointer move is detected */
  34040. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34041. /** Callback called when a pointer down is detected */
  34042. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34043. /** Callback called when a pointer up is detected */
  34044. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34045. /** Callback called when a pointer pick is detected */
  34046. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34047. /**
  34048. * 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).
  34049. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34050. */
  34051. onPrePointerObservable: Observable<PointerInfoPre>;
  34052. /**
  34053. * Observable event triggered each time an input event is received from the rendering canvas
  34054. */
  34055. onPointerObservable: Observable<PointerInfo>;
  34056. /**
  34057. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34058. */
  34059. readonly unTranslatedPointer: Vector2;
  34060. /**
  34061. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34062. */
  34063. static DragMovementThreshold: number;
  34064. /**
  34065. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34066. */
  34067. static LongPressDelay: number;
  34068. /**
  34069. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34070. */
  34071. static DoubleClickDelay: number;
  34072. /** If you need to check double click without raising a single click at first click, enable this flag */
  34073. static ExclusiveDoubleClickMode: boolean;
  34074. /** @hidden */
  34075. _mirroredCameraPosition: Nullable<Vector3>;
  34076. /**
  34077. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34078. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34079. */
  34080. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34081. /**
  34082. * Observable event triggered each time an keyboard event is received from the hosting window
  34083. */
  34084. onKeyboardObservable: Observable<KeyboardInfo>;
  34085. private _useRightHandedSystem;
  34086. /**
  34087. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34088. */
  34089. useRightHandedSystem: boolean;
  34090. private _timeAccumulator;
  34091. private _currentStepId;
  34092. private _currentInternalStep;
  34093. /**
  34094. * Sets the step Id used by deterministic lock step
  34095. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34096. * @param newStepId defines the step Id
  34097. */
  34098. setStepId(newStepId: number): void;
  34099. /**
  34100. * Gets the step Id used by deterministic lock step
  34101. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34102. * @returns the step Id
  34103. */
  34104. getStepId(): number;
  34105. /**
  34106. * Gets the internal step used by deterministic lock step
  34107. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34108. * @returns the internal step
  34109. */
  34110. getInternalStep(): number;
  34111. private _fogEnabled;
  34112. /**
  34113. * Gets or sets a boolean indicating if fog is enabled on this scene
  34114. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34115. * (Default is true)
  34116. */
  34117. fogEnabled: boolean;
  34118. private _fogMode;
  34119. /**
  34120. * Gets or sets the fog mode to use
  34121. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34122. * | mode | value |
  34123. * | --- | --- |
  34124. * | FOGMODE_NONE | 0 |
  34125. * | FOGMODE_EXP | 1 |
  34126. * | FOGMODE_EXP2 | 2 |
  34127. * | FOGMODE_LINEAR | 3 |
  34128. */
  34129. fogMode: number;
  34130. /**
  34131. * Gets or sets the fog color to use
  34132. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34133. * (Default is Color3(0.2, 0.2, 0.3))
  34134. */
  34135. fogColor: Color3;
  34136. /**
  34137. * Gets or sets the fog density to use
  34138. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34139. * (Default is 0.1)
  34140. */
  34141. fogDensity: number;
  34142. /**
  34143. * Gets or sets the fog start distance to use
  34144. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34145. * (Default is 0)
  34146. */
  34147. fogStart: number;
  34148. /**
  34149. * Gets or sets the fog end distance to use
  34150. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34151. * (Default is 1000)
  34152. */
  34153. fogEnd: number;
  34154. private _shadowsEnabled;
  34155. /**
  34156. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34157. */
  34158. shadowsEnabled: boolean;
  34159. private _lightsEnabled;
  34160. /**
  34161. * Gets or sets a boolean indicating if lights are enabled on this scene
  34162. */
  34163. lightsEnabled: boolean;
  34164. /** All of the active cameras added to this scene. */
  34165. activeCameras: Camera[];
  34166. /** @hidden */
  34167. _activeCamera: Nullable<Camera>;
  34168. /** Gets or sets the current active camera */
  34169. activeCamera: Nullable<Camera>;
  34170. private _defaultMaterial;
  34171. /** The default material used on meshes when no material is affected */
  34172. /** The default material used on meshes when no material is affected */
  34173. defaultMaterial: Material;
  34174. private _texturesEnabled;
  34175. /**
  34176. * Gets or sets a boolean indicating if textures are enabled on this scene
  34177. */
  34178. texturesEnabled: boolean;
  34179. /**
  34180. * Gets or sets a boolean indicating if particles are enabled on this scene
  34181. */
  34182. particlesEnabled: boolean;
  34183. /**
  34184. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34185. */
  34186. spritesEnabled: boolean;
  34187. private _skeletonsEnabled;
  34188. /**
  34189. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34190. */
  34191. skeletonsEnabled: boolean;
  34192. /**
  34193. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34194. */
  34195. lensFlaresEnabled: boolean;
  34196. /**
  34197. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34198. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34199. */
  34200. collisionsEnabled: boolean;
  34201. private _collisionCoordinator;
  34202. /** @hidden */
  34203. readonly collisionCoordinator: ICollisionCoordinator;
  34204. /**
  34205. * Defines the gravity applied to this scene (used only for collisions)
  34206. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34207. */
  34208. gravity: Vector3;
  34209. /**
  34210. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34211. */
  34212. postProcessesEnabled: boolean;
  34213. /**
  34214. * The list of postprocesses added to the scene
  34215. */
  34216. postProcesses: PostProcess[];
  34217. /**
  34218. * Gets the current postprocess manager
  34219. */
  34220. postProcessManager: PostProcessManager;
  34221. /**
  34222. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34223. */
  34224. renderTargetsEnabled: boolean;
  34225. /**
  34226. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34227. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34228. */
  34229. dumpNextRenderTargets: boolean;
  34230. /**
  34231. * The list of user defined render targets added to the scene
  34232. */
  34233. customRenderTargets: RenderTargetTexture[];
  34234. /**
  34235. * Defines if texture loading must be delayed
  34236. * If true, textures will only be loaded when they need to be rendered
  34237. */
  34238. useDelayedTextureLoading: boolean;
  34239. /**
  34240. * Gets the list of meshes imported to the scene through SceneLoader
  34241. */
  34242. importedMeshesFiles: String[];
  34243. /**
  34244. * Gets or sets a boolean indicating if probes are enabled on this scene
  34245. */
  34246. probesEnabled: boolean;
  34247. /**
  34248. * Gets or sets the current offline provider to use to store scene data
  34249. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34250. */
  34251. offlineProvider: IOfflineProvider;
  34252. /**
  34253. * Gets or sets the action manager associated with the scene
  34254. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34255. */
  34256. actionManager: AbstractActionManager;
  34257. private _meshesForIntersections;
  34258. /**
  34259. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34260. */
  34261. proceduralTexturesEnabled: boolean;
  34262. private _engine;
  34263. private _totalVertices;
  34264. /** @hidden */
  34265. _activeIndices: PerfCounter;
  34266. /** @hidden */
  34267. _activeParticles: PerfCounter;
  34268. /** @hidden */
  34269. _activeBones: PerfCounter;
  34270. private _animationRatio;
  34271. /** @hidden */
  34272. _animationTimeLast: number;
  34273. /** @hidden */
  34274. _animationTime: number;
  34275. /**
  34276. * Gets or sets a general scale for animation speed
  34277. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  34278. */
  34279. animationTimeScale: number;
  34280. /** @hidden */
  34281. _cachedMaterial: Nullable<Material>;
  34282. /** @hidden */
  34283. _cachedEffect: Nullable<Effect>;
  34284. /** @hidden */
  34285. _cachedVisibility: Nullable<number>;
  34286. private _renderId;
  34287. private _frameId;
  34288. private _executeWhenReadyTimeoutId;
  34289. private _intermediateRendering;
  34290. private _viewUpdateFlag;
  34291. private _projectionUpdateFlag;
  34292. /** @hidden */
  34293. _toBeDisposed: Nullable<IDisposable>[];
  34294. private _activeRequests;
  34295. /** @hidden */
  34296. _pendingData: any[];
  34297. private _isDisposed;
  34298. /**
  34299. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  34300. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  34301. */
  34302. dispatchAllSubMeshesOfActiveMeshes: boolean;
  34303. private _activeMeshes;
  34304. private _processedMaterials;
  34305. private _renderTargets;
  34306. /** @hidden */
  34307. _activeParticleSystems: SmartArray<IParticleSystem>;
  34308. private _activeSkeletons;
  34309. private _softwareSkinnedMeshes;
  34310. private _renderingManager;
  34311. /** @hidden */
  34312. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  34313. private _transformMatrix;
  34314. private _sceneUbo;
  34315. /** @hidden */
  34316. _viewMatrix: Matrix;
  34317. private _projectionMatrix;
  34318. /** @hidden */
  34319. _forcedViewPosition: Nullable<Vector3>;
  34320. /** @hidden */
  34321. _frustumPlanes: Plane[];
  34322. /**
  34323. * Gets the list of frustum planes (built from the active camera)
  34324. */
  34325. readonly frustumPlanes: Plane[];
  34326. /**
  34327. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  34328. * This is useful if there are more lights that the maximum simulteanous authorized
  34329. */
  34330. requireLightSorting: boolean;
  34331. /** @hidden */
  34332. readonly useMaterialMeshMap: boolean;
  34333. /** @hidden */
  34334. readonly useClonedMeshhMap: boolean;
  34335. private _externalData;
  34336. private _uid;
  34337. /**
  34338. * @hidden
  34339. * Backing store of defined scene components.
  34340. */
  34341. _components: ISceneComponent[];
  34342. /**
  34343. * @hidden
  34344. * Backing store of defined scene components.
  34345. */
  34346. _serializableComponents: ISceneSerializableComponent[];
  34347. /**
  34348. * List of components to register on the next registration step.
  34349. */
  34350. private _transientComponents;
  34351. /**
  34352. * Registers the transient components if needed.
  34353. */
  34354. private _registerTransientComponents;
  34355. /**
  34356. * @hidden
  34357. * Add a component to the scene.
  34358. * Note that the ccomponent could be registered on th next frame if this is called after
  34359. * the register component stage.
  34360. * @param component Defines the component to add to the scene
  34361. */
  34362. _addComponent(component: ISceneComponent): void;
  34363. /**
  34364. * @hidden
  34365. * Gets a component from the scene.
  34366. * @param name defines the name of the component to retrieve
  34367. * @returns the component or null if not present
  34368. */
  34369. _getComponent(name: string): Nullable<ISceneComponent>;
  34370. /**
  34371. * @hidden
  34372. * Defines the actions happening before camera updates.
  34373. */
  34374. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  34375. /**
  34376. * @hidden
  34377. * Defines the actions happening before clear the canvas.
  34378. */
  34379. _beforeClearStage: Stage<SimpleStageAction>;
  34380. /**
  34381. * @hidden
  34382. * Defines the actions when collecting render targets for the frame.
  34383. */
  34384. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34385. /**
  34386. * @hidden
  34387. * Defines the actions happening for one camera in the frame.
  34388. */
  34389. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34390. /**
  34391. * @hidden
  34392. * Defines the actions happening during the per mesh ready checks.
  34393. */
  34394. _isReadyForMeshStage: Stage<MeshStageAction>;
  34395. /**
  34396. * @hidden
  34397. * Defines the actions happening before evaluate active mesh checks.
  34398. */
  34399. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  34400. /**
  34401. * @hidden
  34402. * Defines the actions happening during the evaluate sub mesh checks.
  34403. */
  34404. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  34405. /**
  34406. * @hidden
  34407. * Defines the actions happening during the active mesh stage.
  34408. */
  34409. _activeMeshStage: Stage<ActiveMeshStageAction>;
  34410. /**
  34411. * @hidden
  34412. * Defines the actions happening during the per camera render target step.
  34413. */
  34414. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  34415. /**
  34416. * @hidden
  34417. * Defines the actions happening just before the active camera is drawing.
  34418. */
  34419. _beforeCameraDrawStage: Stage<CameraStageAction>;
  34420. /**
  34421. * @hidden
  34422. * Defines the actions happening just before a render target is drawing.
  34423. */
  34424. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34425. /**
  34426. * @hidden
  34427. * Defines the actions happening just before a rendering group is drawing.
  34428. */
  34429. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34430. /**
  34431. * @hidden
  34432. * Defines the actions happening just before a mesh is drawing.
  34433. */
  34434. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34435. /**
  34436. * @hidden
  34437. * Defines the actions happening just after a mesh has been drawn.
  34438. */
  34439. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34440. /**
  34441. * @hidden
  34442. * Defines the actions happening just after a rendering group has been drawn.
  34443. */
  34444. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34445. /**
  34446. * @hidden
  34447. * Defines the actions happening just after the active camera has been drawn.
  34448. */
  34449. _afterCameraDrawStage: Stage<CameraStageAction>;
  34450. /**
  34451. * @hidden
  34452. * Defines the actions happening just after a render target has been drawn.
  34453. */
  34454. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34455. /**
  34456. * @hidden
  34457. * Defines the actions happening just after rendering all cameras and computing intersections.
  34458. */
  34459. _afterRenderStage: Stage<SimpleStageAction>;
  34460. /**
  34461. * @hidden
  34462. * Defines the actions happening when a pointer move event happens.
  34463. */
  34464. _pointerMoveStage: Stage<PointerMoveStageAction>;
  34465. /**
  34466. * @hidden
  34467. * Defines the actions happening when a pointer down event happens.
  34468. */
  34469. _pointerDownStage: Stage<PointerUpDownStageAction>;
  34470. /**
  34471. * @hidden
  34472. * Defines the actions happening when a pointer up event happens.
  34473. */
  34474. _pointerUpStage: Stage<PointerUpDownStageAction>;
  34475. /**
  34476. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  34477. */
  34478. private geometriesByUniqueId;
  34479. /**
  34480. * Creates a new Scene
  34481. * @param engine defines the engine to use to render this scene
  34482. * @param options defines the scene options
  34483. */
  34484. constructor(engine: Engine, options?: SceneOptions);
  34485. /**
  34486. * Gets a string idenfifying the name of the class
  34487. * @returns "Scene" string
  34488. */
  34489. getClassName(): string;
  34490. private _defaultMeshCandidates;
  34491. /**
  34492. * @hidden
  34493. */
  34494. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  34495. private _defaultSubMeshCandidates;
  34496. /**
  34497. * @hidden
  34498. */
  34499. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  34500. /**
  34501. * Sets the default candidate providers for the scene.
  34502. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  34503. * and getCollidingSubMeshCandidates to their default function
  34504. */
  34505. setDefaultCandidateProviders(): void;
  34506. /**
  34507. * Gets the mesh that is currently under the pointer
  34508. */
  34509. readonly meshUnderPointer: Nullable<AbstractMesh>;
  34510. /**
  34511. * Gets or sets the current on-screen X position of the pointer
  34512. */
  34513. pointerX: number;
  34514. /**
  34515. * Gets or sets the current on-screen Y position of the pointer
  34516. */
  34517. pointerY: number;
  34518. /**
  34519. * Gets the cached material (ie. the latest rendered one)
  34520. * @returns the cached material
  34521. */
  34522. getCachedMaterial(): Nullable<Material>;
  34523. /**
  34524. * Gets the cached effect (ie. the latest rendered one)
  34525. * @returns the cached effect
  34526. */
  34527. getCachedEffect(): Nullable<Effect>;
  34528. /**
  34529. * Gets the cached visibility state (ie. the latest rendered one)
  34530. * @returns the cached visibility state
  34531. */
  34532. getCachedVisibility(): Nullable<number>;
  34533. /**
  34534. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  34535. * @param material defines the current material
  34536. * @param effect defines the current effect
  34537. * @param visibility defines the current visibility state
  34538. * @returns true if one parameter is not cached
  34539. */
  34540. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  34541. /**
  34542. * Gets the engine associated with the scene
  34543. * @returns an Engine
  34544. */
  34545. getEngine(): Engine;
  34546. /**
  34547. * Gets the total number of vertices rendered per frame
  34548. * @returns the total number of vertices rendered per frame
  34549. */
  34550. getTotalVertices(): number;
  34551. /**
  34552. * Gets the performance counter for total vertices
  34553. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34554. */
  34555. readonly totalVerticesPerfCounter: PerfCounter;
  34556. /**
  34557. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  34558. * @returns the total number of active indices rendered per frame
  34559. */
  34560. getActiveIndices(): number;
  34561. /**
  34562. * Gets the performance counter for active indices
  34563. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34564. */
  34565. readonly totalActiveIndicesPerfCounter: PerfCounter;
  34566. /**
  34567. * Gets the total number of active particles rendered per frame
  34568. * @returns the total number of active particles rendered per frame
  34569. */
  34570. getActiveParticles(): number;
  34571. /**
  34572. * Gets the performance counter for active particles
  34573. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34574. */
  34575. readonly activeParticlesPerfCounter: PerfCounter;
  34576. /**
  34577. * Gets the total number of active bones rendered per frame
  34578. * @returns the total number of active bones rendered per frame
  34579. */
  34580. getActiveBones(): number;
  34581. /**
  34582. * Gets the performance counter for active bones
  34583. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34584. */
  34585. readonly activeBonesPerfCounter: PerfCounter;
  34586. /**
  34587. * Gets the array of active meshes
  34588. * @returns an array of AbstractMesh
  34589. */
  34590. getActiveMeshes(): SmartArray<AbstractMesh>;
  34591. /**
  34592. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  34593. * @returns a number
  34594. */
  34595. getAnimationRatio(): number;
  34596. /**
  34597. * Gets an unique Id for the current render phase
  34598. * @returns a number
  34599. */
  34600. getRenderId(): number;
  34601. /**
  34602. * Gets an unique Id for the current frame
  34603. * @returns a number
  34604. */
  34605. getFrameId(): number;
  34606. /** Call this function if you want to manually increment the render Id*/
  34607. incrementRenderId(): void;
  34608. private _createUbo;
  34609. /**
  34610. * Use this method to simulate a pointer move on a mesh
  34611. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34612. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34613. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34614. * @returns the current scene
  34615. */
  34616. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  34617. /**
  34618. * Use this method to simulate a pointer down on a mesh
  34619. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34620. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34621. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34622. * @returns the current scene
  34623. */
  34624. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  34625. /**
  34626. * Use this method to simulate a pointer up on a mesh
  34627. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34628. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34629. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34630. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  34631. * @returns the current scene
  34632. */
  34633. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  34634. /**
  34635. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  34636. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  34637. * @returns true if the pointer was captured
  34638. */
  34639. isPointerCaptured(pointerId?: number): boolean;
  34640. /**
  34641. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  34642. * @param attachUp defines if you want to attach events to pointerup
  34643. * @param attachDown defines if you want to attach events to pointerdown
  34644. * @param attachMove defines if you want to attach events to pointermove
  34645. */
  34646. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  34647. /** Detaches all event handlers*/
  34648. detachControl(): void;
  34649. /**
  34650. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  34651. * Delay loaded resources are not taking in account
  34652. * @return true if all required resources are ready
  34653. */
  34654. isReady(): boolean;
  34655. /** Resets all cached information relative to material (including effect and visibility) */
  34656. resetCachedMaterial(): void;
  34657. /**
  34658. * Registers a function to be called before every frame render
  34659. * @param func defines the function to register
  34660. */
  34661. registerBeforeRender(func: () => void): void;
  34662. /**
  34663. * Unregisters a function called before every frame render
  34664. * @param func defines the function to unregister
  34665. */
  34666. unregisterBeforeRender(func: () => void): void;
  34667. /**
  34668. * Registers a function to be called after every frame render
  34669. * @param func defines the function to register
  34670. */
  34671. registerAfterRender(func: () => void): void;
  34672. /**
  34673. * Unregisters a function called after every frame render
  34674. * @param func defines the function to unregister
  34675. */
  34676. unregisterAfterRender(func: () => void): void;
  34677. private _executeOnceBeforeRender;
  34678. /**
  34679. * The provided function will run before render once and will be disposed afterwards.
  34680. * A timeout delay can be provided so that the function will be executed in N ms.
  34681. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  34682. * @param func The function to be executed.
  34683. * @param timeout optional delay in ms
  34684. */
  34685. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  34686. /** @hidden */
  34687. _addPendingData(data: any): void;
  34688. /** @hidden */
  34689. _removePendingData(data: any): void;
  34690. /**
  34691. * Returns the number of items waiting to be loaded
  34692. * @returns the number of items waiting to be loaded
  34693. */
  34694. getWaitingItemsCount(): number;
  34695. /**
  34696. * Returns a boolean indicating if the scene is still loading data
  34697. */
  34698. readonly isLoading: boolean;
  34699. /**
  34700. * Registers a function to be executed when the scene is ready
  34701. * @param {Function} func - the function to be executed
  34702. */
  34703. executeWhenReady(func: () => void): void;
  34704. /**
  34705. * Returns a promise that resolves when the scene is ready
  34706. * @returns A promise that resolves when the scene is ready
  34707. */
  34708. whenReadyAsync(): Promise<void>;
  34709. /** @hidden */
  34710. _checkIsReady(): void;
  34711. /**
  34712. * Gets all animatable attached to the scene
  34713. */
  34714. readonly animatables: Animatable[];
  34715. /**
  34716. * Resets the last animation time frame.
  34717. * Useful to override when animations start running when loading a scene for the first time.
  34718. */
  34719. resetLastAnimationTimeFrame(): void;
  34720. /**
  34721. * Gets the current view matrix
  34722. * @returns a Matrix
  34723. */
  34724. getViewMatrix(): Matrix;
  34725. /**
  34726. * Gets the current projection matrix
  34727. * @returns a Matrix
  34728. */
  34729. getProjectionMatrix(): Matrix;
  34730. /**
  34731. * Gets the current transform matrix
  34732. * @returns a Matrix made of View * Projection
  34733. */
  34734. getTransformMatrix(): Matrix;
  34735. /**
  34736. * Sets the current transform matrix
  34737. * @param viewL defines the View matrix to use
  34738. * @param projectionL defines the Projection matrix to use
  34739. * @param viewR defines the right View matrix to use (if provided)
  34740. * @param projectionR defines the right Projection matrix to use (if provided)
  34741. */
  34742. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  34743. /**
  34744. * Gets the uniform buffer used to store scene data
  34745. * @returns a UniformBuffer
  34746. */
  34747. getSceneUniformBuffer(): UniformBuffer;
  34748. /**
  34749. * Gets an unique (relatively to the current scene) Id
  34750. * @returns an unique number for the scene
  34751. */
  34752. getUniqueId(): number;
  34753. /**
  34754. * Add a mesh to the list of scene's meshes
  34755. * @param newMesh defines the mesh to add
  34756. * @param recursive if all child meshes should also be added to the scene
  34757. */
  34758. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  34759. /**
  34760. * Remove a mesh for the list of scene's meshes
  34761. * @param toRemove defines the mesh to remove
  34762. * @param recursive if all child meshes should also be removed from the scene
  34763. * @returns the index where the mesh was in the mesh list
  34764. */
  34765. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  34766. /**
  34767. * Add a transform node to the list of scene's transform nodes
  34768. * @param newTransformNode defines the transform node to add
  34769. */
  34770. addTransformNode(newTransformNode: TransformNode): void;
  34771. /**
  34772. * Remove a transform node for the list of scene's transform nodes
  34773. * @param toRemove defines the transform node to remove
  34774. * @returns the index where the transform node was in the transform node list
  34775. */
  34776. removeTransformNode(toRemove: TransformNode): number;
  34777. /**
  34778. * Remove a skeleton for the list of scene's skeletons
  34779. * @param toRemove defines the skeleton to remove
  34780. * @returns the index where the skeleton was in the skeleton list
  34781. */
  34782. removeSkeleton(toRemove: Skeleton): number;
  34783. /**
  34784. * Remove a morph target for the list of scene's morph targets
  34785. * @param toRemove defines the morph target to remove
  34786. * @returns the index where the morph target was in the morph target list
  34787. */
  34788. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  34789. /**
  34790. * Remove a light for the list of scene's lights
  34791. * @param toRemove defines the light to remove
  34792. * @returns the index where the light was in the light list
  34793. */
  34794. removeLight(toRemove: Light): number;
  34795. /**
  34796. * Remove a camera for the list of scene's cameras
  34797. * @param toRemove defines the camera to remove
  34798. * @returns the index where the camera was in the camera list
  34799. */
  34800. removeCamera(toRemove: Camera): number;
  34801. /**
  34802. * Remove a particle system for the list of scene's particle systems
  34803. * @param toRemove defines the particle system to remove
  34804. * @returns the index where the particle system was in the particle system list
  34805. */
  34806. removeParticleSystem(toRemove: IParticleSystem): number;
  34807. /**
  34808. * Remove a animation for the list of scene's animations
  34809. * @param toRemove defines the animation to remove
  34810. * @returns the index where the animation was in the animation list
  34811. */
  34812. removeAnimation(toRemove: Animation): number;
  34813. /**
  34814. * Will stop the animation of the given target
  34815. * @param target - the target
  34816. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  34817. * @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)
  34818. */
  34819. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  34820. /**
  34821. * Removes the given animation group from this scene.
  34822. * @param toRemove The animation group to remove
  34823. * @returns The index of the removed animation group
  34824. */
  34825. removeAnimationGroup(toRemove: AnimationGroup): number;
  34826. /**
  34827. * Removes the given multi-material from this scene.
  34828. * @param toRemove The multi-material to remove
  34829. * @returns The index of the removed multi-material
  34830. */
  34831. removeMultiMaterial(toRemove: MultiMaterial): number;
  34832. /**
  34833. * Removes the given material from this scene.
  34834. * @param toRemove The material to remove
  34835. * @returns The index of the removed material
  34836. */
  34837. removeMaterial(toRemove: Material): number;
  34838. /**
  34839. * Removes the given action manager from this scene.
  34840. * @param toRemove The action manager to remove
  34841. * @returns The index of the removed action manager
  34842. */
  34843. removeActionManager(toRemove: AbstractActionManager): number;
  34844. /**
  34845. * Removes the given texture from this scene.
  34846. * @param toRemove The texture to remove
  34847. * @returns The index of the removed texture
  34848. */
  34849. removeTexture(toRemove: BaseTexture): number;
  34850. /**
  34851. * Adds the given light to this scene
  34852. * @param newLight The light to add
  34853. */
  34854. addLight(newLight: Light): void;
  34855. /**
  34856. * Sorts the list list based on light priorities
  34857. */
  34858. sortLightsByPriority(): void;
  34859. /**
  34860. * Adds the given camera to this scene
  34861. * @param newCamera The camera to add
  34862. */
  34863. addCamera(newCamera: Camera): void;
  34864. /**
  34865. * Adds the given skeleton to this scene
  34866. * @param newSkeleton The skeleton to add
  34867. */
  34868. addSkeleton(newSkeleton: Skeleton): void;
  34869. /**
  34870. * Adds the given particle system to this scene
  34871. * @param newParticleSystem The particle system to add
  34872. */
  34873. addParticleSystem(newParticleSystem: IParticleSystem): void;
  34874. /**
  34875. * Adds the given animation to this scene
  34876. * @param newAnimation The animation to add
  34877. */
  34878. addAnimation(newAnimation: Animation): void;
  34879. /**
  34880. * Adds the given animation group to this scene.
  34881. * @param newAnimationGroup The animation group to add
  34882. */
  34883. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  34884. /**
  34885. * Adds the given multi-material to this scene
  34886. * @param newMultiMaterial The multi-material to add
  34887. */
  34888. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  34889. /**
  34890. * Adds the given material to this scene
  34891. * @param newMaterial The material to add
  34892. */
  34893. addMaterial(newMaterial: Material): void;
  34894. /**
  34895. * Adds the given morph target to this scene
  34896. * @param newMorphTargetManager The morph target to add
  34897. */
  34898. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  34899. /**
  34900. * Adds the given geometry to this scene
  34901. * @param newGeometry The geometry to add
  34902. */
  34903. addGeometry(newGeometry: Geometry): void;
  34904. /**
  34905. * Adds the given action manager to this scene
  34906. * @param newActionManager The action manager to add
  34907. */
  34908. addActionManager(newActionManager: AbstractActionManager): void;
  34909. /**
  34910. * Adds the given texture to this scene.
  34911. * @param newTexture The texture to add
  34912. */
  34913. addTexture(newTexture: BaseTexture): void;
  34914. /**
  34915. * Switch active camera
  34916. * @param newCamera defines the new active camera
  34917. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  34918. */
  34919. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  34920. /**
  34921. * sets the active camera of the scene using its ID
  34922. * @param id defines the camera's ID
  34923. * @return the new active camera or null if none found.
  34924. */
  34925. setActiveCameraByID(id: string): Nullable<Camera>;
  34926. /**
  34927. * sets the active camera of the scene using its name
  34928. * @param name defines the camera's name
  34929. * @returns the new active camera or null if none found.
  34930. */
  34931. setActiveCameraByName(name: string): Nullable<Camera>;
  34932. /**
  34933. * get an animation group using its name
  34934. * @param name defines the material's name
  34935. * @return the animation group or null if none found.
  34936. */
  34937. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  34938. /**
  34939. * Get a material using its unique id
  34940. * @param uniqueId defines the material's unique id
  34941. * @return the material or null if none found.
  34942. */
  34943. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  34944. /**
  34945. * get a material using its id
  34946. * @param id defines the material's ID
  34947. * @return the material or null if none found.
  34948. */
  34949. getMaterialByID(id: string): Nullable<Material>;
  34950. /**
  34951. * Gets a the last added material using a given id
  34952. * @param id defines the material's ID
  34953. * @return the last material with the given id or null if none found.
  34954. */
  34955. getLastMaterialByID(id: string): Nullable<Material>;
  34956. /**
  34957. * Gets a material using its name
  34958. * @param name defines the material's name
  34959. * @return the material or null if none found.
  34960. */
  34961. getMaterialByName(name: string): Nullable<Material>;
  34962. /**
  34963. * Get a texture using its unique id
  34964. * @param uniqueId defines the texture's unique id
  34965. * @return the texture or null if none found.
  34966. */
  34967. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  34968. /**
  34969. * Gets a camera using its id
  34970. * @param id defines the id to look for
  34971. * @returns the camera or null if not found
  34972. */
  34973. getCameraByID(id: string): Nullable<Camera>;
  34974. /**
  34975. * Gets a camera using its unique id
  34976. * @param uniqueId defines the unique id to look for
  34977. * @returns the camera or null if not found
  34978. */
  34979. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  34980. /**
  34981. * Gets a camera using its name
  34982. * @param name defines the camera's name
  34983. * @return the camera or null if none found.
  34984. */
  34985. getCameraByName(name: string): Nullable<Camera>;
  34986. /**
  34987. * Gets a bone using its id
  34988. * @param id defines the bone's id
  34989. * @return the bone or null if not found
  34990. */
  34991. getBoneByID(id: string): Nullable<Bone>;
  34992. /**
  34993. * Gets a bone using its id
  34994. * @param name defines the bone's name
  34995. * @return the bone or null if not found
  34996. */
  34997. getBoneByName(name: string): Nullable<Bone>;
  34998. /**
  34999. * Gets a light node using its name
  35000. * @param name defines the the light's name
  35001. * @return the light or null if none found.
  35002. */
  35003. getLightByName(name: string): Nullable<Light>;
  35004. /**
  35005. * Gets a light node using its id
  35006. * @param id defines the light's id
  35007. * @return the light or null if none found.
  35008. */
  35009. getLightByID(id: string): Nullable<Light>;
  35010. /**
  35011. * Gets a light node using its scene-generated unique ID
  35012. * @param uniqueId defines the light's unique id
  35013. * @return the light or null if none found.
  35014. */
  35015. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35016. /**
  35017. * Gets a particle system by id
  35018. * @param id defines the particle system id
  35019. * @return the corresponding system or null if none found
  35020. */
  35021. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35022. /**
  35023. * Gets a geometry using its ID
  35024. * @param id defines the geometry's id
  35025. * @return the geometry or null if none found.
  35026. */
  35027. getGeometryByID(id: string): Nullable<Geometry>;
  35028. private _getGeometryByUniqueID;
  35029. /**
  35030. * Add a new geometry to this scene
  35031. * @param geometry defines the geometry to be added to the scene.
  35032. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35033. * @return a boolean defining if the geometry was added or not
  35034. */
  35035. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35036. /**
  35037. * Removes an existing geometry
  35038. * @param geometry defines the geometry to be removed from the scene
  35039. * @return a boolean defining if the geometry was removed or not
  35040. */
  35041. removeGeometry(geometry: Geometry): boolean;
  35042. /**
  35043. * Gets the list of geometries attached to the scene
  35044. * @returns an array of Geometry
  35045. */
  35046. getGeometries(): Geometry[];
  35047. /**
  35048. * Gets the first added mesh found of a given ID
  35049. * @param id defines the id to search for
  35050. * @return the mesh found or null if not found at all
  35051. */
  35052. getMeshByID(id: string): Nullable<AbstractMesh>;
  35053. /**
  35054. * Gets a list of meshes using their id
  35055. * @param id defines the id to search for
  35056. * @returns a list of meshes
  35057. */
  35058. getMeshesByID(id: string): Array<AbstractMesh>;
  35059. /**
  35060. * Gets the first added transform node found of a given ID
  35061. * @param id defines the id to search for
  35062. * @return the found transform node or null if not found at all.
  35063. */
  35064. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35065. /**
  35066. * Gets a transform node with its auto-generated unique id
  35067. * @param uniqueId efines the unique id to search for
  35068. * @return the found transform node or null if not found at all.
  35069. */
  35070. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35071. /**
  35072. * Gets a list of transform nodes using their id
  35073. * @param id defines the id to search for
  35074. * @returns a list of transform nodes
  35075. */
  35076. getTransformNodesByID(id: string): Array<TransformNode>;
  35077. /**
  35078. * Gets a mesh with its auto-generated unique id
  35079. * @param uniqueId defines the unique id to search for
  35080. * @return the found mesh or null if not found at all.
  35081. */
  35082. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35083. /**
  35084. * Gets a the last added mesh using a given id
  35085. * @param id defines the id to search for
  35086. * @return the found mesh or null if not found at all.
  35087. */
  35088. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35089. /**
  35090. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35091. * @param id defines the id to search for
  35092. * @return the found node or null if not found at all
  35093. */
  35094. getLastEntryByID(id: string): Nullable<Node>;
  35095. /**
  35096. * Gets a node (Mesh, Camera, Light) using a given id
  35097. * @param id defines the id to search for
  35098. * @return the found node or null if not found at all
  35099. */
  35100. getNodeByID(id: string): Nullable<Node>;
  35101. /**
  35102. * Gets a node (Mesh, Camera, Light) using a given name
  35103. * @param name defines the name to search for
  35104. * @return the found node or null if not found at all.
  35105. */
  35106. getNodeByName(name: string): Nullable<Node>;
  35107. /**
  35108. * Gets a mesh using a given name
  35109. * @param name defines the name to search for
  35110. * @return the found mesh or null if not found at all.
  35111. */
  35112. getMeshByName(name: string): Nullable<AbstractMesh>;
  35113. /**
  35114. * Gets a transform node using a given name
  35115. * @param name defines the name to search for
  35116. * @return the found transform node or null if not found at all.
  35117. */
  35118. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35119. /**
  35120. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35121. * @param id defines the id to search for
  35122. * @return the found skeleton or null if not found at all.
  35123. */
  35124. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35125. /**
  35126. * Gets a skeleton using a given auto generated unique id
  35127. * @param uniqueId defines the unique id to search for
  35128. * @return the found skeleton or null if not found at all.
  35129. */
  35130. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35131. /**
  35132. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35133. * @param id defines the id to search for
  35134. * @return the found skeleton or null if not found at all.
  35135. */
  35136. getSkeletonById(id: string): Nullable<Skeleton>;
  35137. /**
  35138. * Gets a skeleton using a given name
  35139. * @param name defines the name to search for
  35140. * @return the found skeleton or null if not found at all.
  35141. */
  35142. getSkeletonByName(name: string): Nullable<Skeleton>;
  35143. /**
  35144. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35145. * @param id defines the id to search for
  35146. * @return the found morph target manager or null if not found at all.
  35147. */
  35148. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35149. /**
  35150. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35151. * @param id defines the id to search for
  35152. * @return the found morph target or null if not found at all.
  35153. */
  35154. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35155. /**
  35156. * Gets a boolean indicating if the given mesh is active
  35157. * @param mesh defines the mesh to look for
  35158. * @returns true if the mesh is in the active list
  35159. */
  35160. isActiveMesh(mesh: AbstractMesh): boolean;
  35161. /**
  35162. * Return a unique id as a string which can serve as an identifier for the scene
  35163. */
  35164. readonly uid: string;
  35165. /**
  35166. * Add an externaly attached data from its key.
  35167. * This method call will fail and return false, if such key already exists.
  35168. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35169. * @param key the unique key that identifies the data
  35170. * @param data the data object to associate to the key for this Engine instance
  35171. * @return true if no such key were already present and the data was added successfully, false otherwise
  35172. */
  35173. addExternalData<T>(key: string, data: T): boolean;
  35174. /**
  35175. * Get an externaly attached data from its key
  35176. * @param key the unique key that identifies the data
  35177. * @return the associated data, if present (can be null), or undefined if not present
  35178. */
  35179. getExternalData<T>(key: string): Nullable<T>;
  35180. /**
  35181. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35182. * @param key the unique key that identifies the data
  35183. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35184. * @return the associated data, can be null if the factory returned null.
  35185. */
  35186. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35187. /**
  35188. * Remove an externaly attached data from the Engine instance
  35189. * @param key the unique key that identifies the data
  35190. * @return true if the data was successfully removed, false if it doesn't exist
  35191. */
  35192. removeExternalData(key: string): boolean;
  35193. private _evaluateSubMesh;
  35194. /**
  35195. * Clear the processed materials smart array preventing retention point in material dispose.
  35196. */
  35197. freeProcessedMaterials(): void;
  35198. private _preventFreeActiveMeshesAndRenderingGroups;
  35199. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35200. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35201. * when disposing several meshes in a row or a hierarchy of meshes.
  35202. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35203. */
  35204. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35205. /**
  35206. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35207. */
  35208. freeActiveMeshes(): void;
  35209. /**
  35210. * Clear the info related to rendering groups preventing retention points during dispose.
  35211. */
  35212. freeRenderingGroups(): void;
  35213. /** @hidden */
  35214. _isInIntermediateRendering(): boolean;
  35215. /**
  35216. * Lambda returning the list of potentially active meshes.
  35217. */
  35218. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35219. /**
  35220. * Lambda returning the list of potentially active sub meshes.
  35221. */
  35222. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35223. /**
  35224. * Lambda returning the list of potentially intersecting sub meshes.
  35225. */
  35226. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35227. /**
  35228. * Lambda returning the list of potentially colliding sub meshes.
  35229. */
  35230. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35231. private _activeMeshesFrozen;
  35232. /**
  35233. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35234. * @returns the current scene
  35235. */
  35236. freezeActiveMeshes(): Scene;
  35237. /**
  35238. * Use this function to restart evaluating active meshes on every frame
  35239. * @returns the current scene
  35240. */
  35241. unfreezeActiveMeshes(): Scene;
  35242. private _evaluateActiveMeshes;
  35243. private _activeMesh;
  35244. /**
  35245. * Update the transform matrix to update from the current active camera
  35246. * @param force defines a boolean used to force the update even if cache is up to date
  35247. */
  35248. updateTransformMatrix(force?: boolean): void;
  35249. private _bindFrameBuffer;
  35250. /** @hidden */
  35251. _allowPostProcessClearColor: boolean;
  35252. /** @hidden */
  35253. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35254. private _processSubCameras;
  35255. private _checkIntersections;
  35256. /** @hidden */
  35257. _advancePhysicsEngineStep(step: number): void;
  35258. /**
  35259. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35260. */
  35261. getDeterministicFrameTime: () => number;
  35262. /** @hidden */
  35263. _animate(): void;
  35264. /** Execute all animations (for a frame) */
  35265. animate(): void;
  35266. /**
  35267. * Render the scene
  35268. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  35269. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  35270. */
  35271. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  35272. /**
  35273. * Freeze all materials
  35274. * A frozen material will not be updatable but should be faster to render
  35275. */
  35276. freezeMaterials(): void;
  35277. /**
  35278. * Unfreeze all materials
  35279. * A frozen material will not be updatable but should be faster to render
  35280. */
  35281. unfreezeMaterials(): void;
  35282. /**
  35283. * Releases all held ressources
  35284. */
  35285. dispose(): void;
  35286. /**
  35287. * Gets if the scene is already disposed
  35288. */
  35289. readonly isDisposed: boolean;
  35290. /**
  35291. * Call this function to reduce memory footprint of the scene.
  35292. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  35293. */
  35294. clearCachedVertexData(): void;
  35295. /**
  35296. * This function will remove the local cached buffer data from texture.
  35297. * It will save memory but will prevent the texture from being rebuilt
  35298. */
  35299. cleanCachedTextureBuffer(): void;
  35300. /**
  35301. * Get the world extend vectors with an optional filter
  35302. *
  35303. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  35304. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  35305. */
  35306. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  35307. min: Vector3;
  35308. max: Vector3;
  35309. };
  35310. /**
  35311. * Creates a ray that can be used to pick in the scene
  35312. * @param x defines the x coordinate of the origin (on-screen)
  35313. * @param y defines the y coordinate of the origin (on-screen)
  35314. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35315. * @param camera defines the camera to use for the picking
  35316. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35317. * @returns a Ray
  35318. */
  35319. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  35320. /**
  35321. * Creates a ray that can be used to pick in the scene
  35322. * @param x defines the x coordinate of the origin (on-screen)
  35323. * @param y defines the y coordinate of the origin (on-screen)
  35324. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35325. * @param result defines the ray where to store the picking ray
  35326. * @param camera defines the camera to use for the picking
  35327. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35328. * @returns the current scene
  35329. */
  35330. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  35331. /**
  35332. * Creates a ray that can be used to pick in the scene
  35333. * @param x defines the x coordinate of the origin (on-screen)
  35334. * @param y defines the y coordinate of the origin (on-screen)
  35335. * @param camera defines the camera to use for the picking
  35336. * @returns a Ray
  35337. */
  35338. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  35339. /**
  35340. * Creates a ray that can be used to pick in the scene
  35341. * @param x defines the x coordinate of the origin (on-screen)
  35342. * @param y defines the y coordinate of the origin (on-screen)
  35343. * @param result defines the ray where to store the picking ray
  35344. * @param camera defines the camera to use for the picking
  35345. * @returns the current scene
  35346. */
  35347. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  35348. /** Launch a ray to try to pick a mesh in the scene
  35349. * @param x position on screen
  35350. * @param y position on screen
  35351. * @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
  35352. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  35353. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35354. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35355. * @returns a PickingInfo
  35356. */
  35357. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35358. /** Use the given ray to pick a mesh in the scene
  35359. * @param ray The ray to use to pick meshes
  35360. * @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
  35361. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  35362. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35363. * @returns a PickingInfo
  35364. */
  35365. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35366. /**
  35367. * Launch a ray to try to pick a mesh in the scene
  35368. * @param x X position on screen
  35369. * @param y Y position on screen
  35370. * @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
  35371. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35372. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35373. * @returns an array of PickingInfo
  35374. */
  35375. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35376. /**
  35377. * Launch a ray to try to pick a mesh in the scene
  35378. * @param ray Ray to use
  35379. * @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
  35380. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35381. * @returns an array of PickingInfo
  35382. */
  35383. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35384. /**
  35385. * Force the value of meshUnderPointer
  35386. * @param mesh defines the mesh to use
  35387. */
  35388. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  35389. /**
  35390. * Gets the mesh under the pointer
  35391. * @returns a Mesh or null if no mesh is under the pointer
  35392. */
  35393. getPointerOverMesh(): Nullable<AbstractMesh>;
  35394. /** @hidden */
  35395. _rebuildGeometries(): void;
  35396. /** @hidden */
  35397. _rebuildTextures(): void;
  35398. private _getByTags;
  35399. /**
  35400. * Get a list of meshes by tags
  35401. * @param tagsQuery defines the tags query to use
  35402. * @param forEach defines a predicate used to filter results
  35403. * @returns an array of Mesh
  35404. */
  35405. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  35406. /**
  35407. * Get a list of cameras by tags
  35408. * @param tagsQuery defines the tags query to use
  35409. * @param forEach defines a predicate used to filter results
  35410. * @returns an array of Camera
  35411. */
  35412. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  35413. /**
  35414. * Get a list of lights by tags
  35415. * @param tagsQuery defines the tags query to use
  35416. * @param forEach defines a predicate used to filter results
  35417. * @returns an array of Light
  35418. */
  35419. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  35420. /**
  35421. * Get a list of materials by tags
  35422. * @param tagsQuery defines the tags query to use
  35423. * @param forEach defines a predicate used to filter results
  35424. * @returns an array of Material
  35425. */
  35426. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  35427. /**
  35428. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  35429. * This allowed control for front to back rendering or reversly depending of the special needs.
  35430. *
  35431. * @param renderingGroupId The rendering group id corresponding to its index
  35432. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  35433. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  35434. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  35435. */
  35436. 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;
  35437. /**
  35438. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  35439. *
  35440. * @param renderingGroupId The rendering group id corresponding to its index
  35441. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  35442. * @param depth Automatically clears depth between groups if true and autoClear is true.
  35443. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  35444. */
  35445. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  35446. /**
  35447. * Gets the current auto clear configuration for one rendering group of the rendering
  35448. * manager.
  35449. * @param index the rendering group index to get the information for
  35450. * @returns The auto clear setup for the requested rendering group
  35451. */
  35452. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  35453. private _blockMaterialDirtyMechanism;
  35454. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  35455. blockMaterialDirtyMechanism: boolean;
  35456. /**
  35457. * Will flag all materials as dirty to trigger new shader compilation
  35458. * @param flag defines the flag used to specify which material part must be marked as dirty
  35459. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  35460. */
  35461. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  35462. /** @hidden */
  35463. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  35464. /** @hidden */
  35465. _loadFileAsync(url: string, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35466. }
  35467. }
  35468. declare module "babylonjs/assetContainer" {
  35469. import { AbstractScene } from "babylonjs/abstractScene";
  35470. import { Scene } from "babylonjs/scene";
  35471. import { Mesh } from "babylonjs/Meshes/mesh";
  35472. /**
  35473. * Set of assets to keep when moving a scene into an asset container.
  35474. */
  35475. export class KeepAssets extends AbstractScene {
  35476. }
  35477. /**
  35478. * Container with a set of assets that can be added or removed from a scene.
  35479. */
  35480. export class AssetContainer extends AbstractScene {
  35481. /**
  35482. * The scene the AssetContainer belongs to.
  35483. */
  35484. scene: Scene;
  35485. /**
  35486. * Instantiates an AssetContainer.
  35487. * @param scene The scene the AssetContainer belongs to.
  35488. */
  35489. constructor(scene: Scene);
  35490. /**
  35491. * Adds all the assets from the container to the scene.
  35492. */
  35493. addAllToScene(): void;
  35494. /**
  35495. * Removes all the assets in the container from the scene
  35496. */
  35497. removeAllFromScene(): void;
  35498. /**
  35499. * Disposes all the assets in the container
  35500. */
  35501. dispose(): void;
  35502. private _moveAssets;
  35503. /**
  35504. * Removes all the assets contained in the scene and adds them to the container.
  35505. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  35506. */
  35507. moveAllFromScene(keepAssets?: KeepAssets): void;
  35508. /**
  35509. * 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.
  35510. * @returns the root mesh
  35511. */
  35512. createRootMesh(): Mesh;
  35513. }
  35514. }
  35515. declare module "babylonjs/abstractScene" {
  35516. import { Scene } from "babylonjs/scene";
  35517. import { Nullable } from "babylonjs/types";
  35518. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  35519. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35520. import { Geometry } from "babylonjs/Meshes/geometry";
  35521. import { Skeleton } from "babylonjs/Bones/skeleton";
  35522. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  35523. import { AssetContainer } from "babylonjs/assetContainer";
  35524. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  35525. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35526. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35527. import { Material } from "babylonjs/Materials/material";
  35528. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  35529. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  35530. import { Camera } from "babylonjs/Cameras/camera";
  35531. import { Light } from "babylonjs/Lights/light";
  35532. import { Node } from "babylonjs/node";
  35533. import { Animation } from "babylonjs/Animations/animation";
  35534. /**
  35535. * Defines how the parser contract is defined.
  35536. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  35537. */
  35538. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  35539. /**
  35540. * Defines how the individual parser contract is defined.
  35541. * These parser can parse an individual asset
  35542. */
  35543. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  35544. /**
  35545. * Base class of the scene acting as a container for the different elements composing a scene.
  35546. * This class is dynamically extended by the different components of the scene increasing
  35547. * flexibility and reducing coupling
  35548. */
  35549. export abstract class AbstractScene {
  35550. /**
  35551. * Stores the list of available parsers in the application.
  35552. */
  35553. private static _BabylonFileParsers;
  35554. /**
  35555. * Stores the list of available individual parsers in the application.
  35556. */
  35557. private static _IndividualBabylonFileParsers;
  35558. /**
  35559. * Adds a parser in the list of available ones
  35560. * @param name Defines the name of the parser
  35561. * @param parser Defines the parser to add
  35562. */
  35563. static AddParser(name: string, parser: BabylonFileParser): void;
  35564. /**
  35565. * Gets a general parser from the list of avaialble ones
  35566. * @param name Defines the name of the parser
  35567. * @returns the requested parser or null
  35568. */
  35569. static GetParser(name: string): Nullable<BabylonFileParser>;
  35570. /**
  35571. * Adds n individual parser in the list of available ones
  35572. * @param name Defines the name of the parser
  35573. * @param parser Defines the parser to add
  35574. */
  35575. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  35576. /**
  35577. * Gets an individual parser from the list of avaialble ones
  35578. * @param name Defines the name of the parser
  35579. * @returns the requested parser or null
  35580. */
  35581. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  35582. /**
  35583. * Parser json data and populate both a scene and its associated container object
  35584. * @param jsonData Defines the data to parse
  35585. * @param scene Defines the scene to parse the data for
  35586. * @param container Defines the container attached to the parsing sequence
  35587. * @param rootUrl Defines the root url of the data
  35588. */
  35589. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  35590. /**
  35591. * Gets the list of root nodes (ie. nodes with no parent)
  35592. */
  35593. rootNodes: Node[];
  35594. /** All of the cameras added to this scene
  35595. * @see http://doc.babylonjs.com/babylon101/cameras
  35596. */
  35597. cameras: Camera[];
  35598. /**
  35599. * All of the lights added to this scene
  35600. * @see http://doc.babylonjs.com/babylon101/lights
  35601. */
  35602. lights: Light[];
  35603. /**
  35604. * All of the (abstract) meshes added to this scene
  35605. */
  35606. meshes: AbstractMesh[];
  35607. /**
  35608. * The list of skeletons added to the scene
  35609. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  35610. */
  35611. skeletons: Skeleton[];
  35612. /**
  35613. * All of the particle systems added to this scene
  35614. * @see http://doc.babylonjs.com/babylon101/particles
  35615. */
  35616. particleSystems: IParticleSystem[];
  35617. /**
  35618. * Gets a list of Animations associated with the scene
  35619. */
  35620. animations: Animation[];
  35621. /**
  35622. * All of the animation groups added to this scene
  35623. * @see http://doc.babylonjs.com/how_to/group
  35624. */
  35625. animationGroups: AnimationGroup[];
  35626. /**
  35627. * All of the multi-materials added to this scene
  35628. * @see http://doc.babylonjs.com/how_to/multi_materials
  35629. */
  35630. multiMaterials: MultiMaterial[];
  35631. /**
  35632. * All of the materials added to this scene
  35633. * In the context of a Scene, it is not supposed to be modified manually.
  35634. * Any addition or removal should be done using the addMaterial and removeMAterial Scene methods.
  35635. * Note also that the order of the Material wihin the array is not significant and might change.
  35636. * @see http://doc.babylonjs.com/babylon101/materials
  35637. */
  35638. materials: Material[];
  35639. /**
  35640. * The list of morph target managers added to the scene
  35641. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  35642. */
  35643. morphTargetManagers: MorphTargetManager[];
  35644. /**
  35645. * The list of geometries used in the scene.
  35646. */
  35647. geometries: Geometry[];
  35648. /**
  35649. * All of the tranform nodes added to this scene
  35650. * In the context of a Scene, it is not supposed to be modified manually.
  35651. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  35652. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  35653. * @see http://doc.babylonjs.com/how_to/transformnode
  35654. */
  35655. transformNodes: TransformNode[];
  35656. /**
  35657. * ActionManagers available on the scene.
  35658. */
  35659. actionManagers: AbstractActionManager[];
  35660. /**
  35661. * Textures to keep.
  35662. */
  35663. textures: BaseTexture[];
  35664. /**
  35665. * Environment texture for the scene
  35666. */
  35667. environmentTexture: Nullable<BaseTexture>;
  35668. }
  35669. }
  35670. declare module "babylonjs/Audio/sound" {
  35671. import { Observable } from "babylonjs/Misc/observable";
  35672. import { Vector3 } from "babylonjs/Maths/math.vector";
  35673. import { Nullable } from "babylonjs/types";
  35674. import { Scene } from "babylonjs/scene";
  35675. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35676. /**
  35677. * Interface used to define options for Sound class
  35678. */
  35679. export interface ISoundOptions {
  35680. /**
  35681. * Does the sound autoplay once loaded.
  35682. */
  35683. autoplay?: boolean;
  35684. /**
  35685. * Does the sound loop after it finishes playing once.
  35686. */
  35687. loop?: boolean;
  35688. /**
  35689. * Sound's volume
  35690. */
  35691. volume?: number;
  35692. /**
  35693. * Is it a spatial sound?
  35694. */
  35695. spatialSound?: boolean;
  35696. /**
  35697. * Maximum distance to hear that sound
  35698. */
  35699. maxDistance?: number;
  35700. /**
  35701. * Uses user defined attenuation function
  35702. */
  35703. useCustomAttenuation?: boolean;
  35704. /**
  35705. * Define the roll off factor of spatial sounds.
  35706. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35707. */
  35708. rolloffFactor?: number;
  35709. /**
  35710. * Define the reference distance the sound should be heard perfectly.
  35711. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35712. */
  35713. refDistance?: number;
  35714. /**
  35715. * Define the distance attenuation model the sound will follow.
  35716. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35717. */
  35718. distanceModel?: string;
  35719. /**
  35720. * Defines the playback speed (1 by default)
  35721. */
  35722. playbackRate?: number;
  35723. /**
  35724. * Defines if the sound is from a streaming source
  35725. */
  35726. streaming?: boolean;
  35727. /**
  35728. * Defines an optional length (in seconds) inside the sound file
  35729. */
  35730. length?: number;
  35731. /**
  35732. * Defines an optional offset (in seconds) inside the sound file
  35733. */
  35734. offset?: number;
  35735. /**
  35736. * If true, URLs will not be required to state the audio file codec to use.
  35737. */
  35738. skipCodecCheck?: boolean;
  35739. }
  35740. /**
  35741. * Defines a sound that can be played in the application.
  35742. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  35743. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  35744. */
  35745. export class Sound {
  35746. /**
  35747. * The name of the sound in the scene.
  35748. */
  35749. name: string;
  35750. /**
  35751. * Does the sound autoplay once loaded.
  35752. */
  35753. autoplay: boolean;
  35754. /**
  35755. * Does the sound loop after it finishes playing once.
  35756. */
  35757. loop: boolean;
  35758. /**
  35759. * Does the sound use a custom attenuation curve to simulate the falloff
  35760. * happening when the source gets further away from the camera.
  35761. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  35762. */
  35763. useCustomAttenuation: boolean;
  35764. /**
  35765. * The sound track id this sound belongs to.
  35766. */
  35767. soundTrackId: number;
  35768. /**
  35769. * Is this sound currently played.
  35770. */
  35771. isPlaying: boolean;
  35772. /**
  35773. * Is this sound currently paused.
  35774. */
  35775. isPaused: boolean;
  35776. /**
  35777. * Does this sound enables spatial sound.
  35778. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35779. */
  35780. spatialSound: boolean;
  35781. /**
  35782. * Define the reference distance the sound should be heard perfectly.
  35783. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35784. */
  35785. refDistance: number;
  35786. /**
  35787. * Define the roll off factor of spatial sounds.
  35788. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35789. */
  35790. rolloffFactor: number;
  35791. /**
  35792. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  35793. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35794. */
  35795. maxDistance: number;
  35796. /**
  35797. * Define the distance attenuation model the sound will follow.
  35798. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35799. */
  35800. distanceModel: string;
  35801. /**
  35802. * @hidden
  35803. * Back Compat
  35804. **/
  35805. onended: () => any;
  35806. /**
  35807. * Observable event when the current playing sound finishes.
  35808. */
  35809. onEndedObservable: Observable<Sound>;
  35810. private _panningModel;
  35811. private _playbackRate;
  35812. private _streaming;
  35813. private _startTime;
  35814. private _startOffset;
  35815. private _position;
  35816. /** @hidden */
  35817. _positionInEmitterSpace: boolean;
  35818. private _localDirection;
  35819. private _volume;
  35820. private _isReadyToPlay;
  35821. private _isDirectional;
  35822. private _readyToPlayCallback;
  35823. private _audioBuffer;
  35824. private _soundSource;
  35825. private _streamingSource;
  35826. private _soundPanner;
  35827. private _soundGain;
  35828. private _inputAudioNode;
  35829. private _outputAudioNode;
  35830. private _coneInnerAngle;
  35831. private _coneOuterAngle;
  35832. private _coneOuterGain;
  35833. private _scene;
  35834. private _connectedTransformNode;
  35835. private _customAttenuationFunction;
  35836. private _registerFunc;
  35837. private _isOutputConnected;
  35838. private _htmlAudioElement;
  35839. private _urlType;
  35840. private _length?;
  35841. private _offset?;
  35842. /** @hidden */
  35843. static _SceneComponentInitialization: (scene: Scene) => void;
  35844. /**
  35845. * Create a sound and attach it to a scene
  35846. * @param name Name of your sound
  35847. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  35848. * @param scene defines the scene the sound belongs to
  35849. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  35850. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  35851. */
  35852. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  35853. /**
  35854. * Release the sound and its associated resources
  35855. */
  35856. dispose(): void;
  35857. /**
  35858. * Gets if the sounds is ready to be played or not.
  35859. * @returns true if ready, otherwise false
  35860. */
  35861. isReady(): boolean;
  35862. private _soundLoaded;
  35863. /**
  35864. * Sets the data of the sound from an audiobuffer
  35865. * @param audioBuffer The audioBuffer containing the data
  35866. */
  35867. setAudioBuffer(audioBuffer: AudioBuffer): void;
  35868. /**
  35869. * Updates the current sounds options such as maxdistance, loop...
  35870. * @param options A JSON object containing values named as the object properties
  35871. */
  35872. updateOptions(options: ISoundOptions): void;
  35873. private _createSpatialParameters;
  35874. private _updateSpatialParameters;
  35875. /**
  35876. * Switch the panning model to HRTF:
  35877. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  35878. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35879. */
  35880. switchPanningModelToHRTF(): void;
  35881. /**
  35882. * Switch the panning model to Equal Power:
  35883. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  35884. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35885. */
  35886. switchPanningModelToEqualPower(): void;
  35887. private _switchPanningModel;
  35888. /**
  35889. * Connect this sound to a sound track audio node like gain...
  35890. * @param soundTrackAudioNode the sound track audio node to connect to
  35891. */
  35892. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  35893. /**
  35894. * Transform this sound into a directional source
  35895. * @param coneInnerAngle Size of the inner cone in degree
  35896. * @param coneOuterAngle Size of the outer cone in degree
  35897. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  35898. */
  35899. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  35900. /**
  35901. * Gets or sets the inner angle for the directional cone.
  35902. */
  35903. /**
  35904. * Gets or sets the inner angle for the directional cone.
  35905. */
  35906. directionalConeInnerAngle: number;
  35907. /**
  35908. * Gets or sets the outer angle for the directional cone.
  35909. */
  35910. /**
  35911. * Gets or sets the outer angle for the directional cone.
  35912. */
  35913. directionalConeOuterAngle: number;
  35914. /**
  35915. * Sets the position of the emitter if spatial sound is enabled
  35916. * @param newPosition Defines the new posisiton
  35917. */
  35918. setPosition(newPosition: Vector3): void;
  35919. /**
  35920. * Sets the local direction of the emitter if spatial sound is enabled
  35921. * @param newLocalDirection Defines the new local direction
  35922. */
  35923. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  35924. private _updateDirection;
  35925. /** @hidden */
  35926. updateDistanceFromListener(): void;
  35927. /**
  35928. * Sets a new custom attenuation function for the sound.
  35929. * @param callback Defines the function used for the attenuation
  35930. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  35931. */
  35932. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  35933. /**
  35934. * Play the sound
  35935. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  35936. * @param offset (optional) Start the sound at a specific time in seconds
  35937. * @param length (optional) Sound duration (in seconds)
  35938. */
  35939. play(time?: number, offset?: number, length?: number): void;
  35940. private _onended;
  35941. /**
  35942. * Stop the sound
  35943. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  35944. */
  35945. stop(time?: number): void;
  35946. /**
  35947. * Put the sound in pause
  35948. */
  35949. pause(): void;
  35950. /**
  35951. * Sets a dedicated volume for this sounds
  35952. * @param newVolume Define the new volume of the sound
  35953. * @param time Define time for gradual change to new volume
  35954. */
  35955. setVolume(newVolume: number, time?: number): void;
  35956. /**
  35957. * Set the sound play back rate
  35958. * @param newPlaybackRate Define the playback rate the sound should be played at
  35959. */
  35960. setPlaybackRate(newPlaybackRate: number): void;
  35961. /**
  35962. * Gets the volume of the sound.
  35963. * @returns the volume of the sound
  35964. */
  35965. getVolume(): number;
  35966. /**
  35967. * Attach the sound to a dedicated mesh
  35968. * @param transformNode The transform node to connect the sound with
  35969. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  35970. */
  35971. attachToMesh(transformNode: TransformNode): void;
  35972. /**
  35973. * Detach the sound from the previously attached mesh
  35974. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  35975. */
  35976. detachFromMesh(): void;
  35977. private _onRegisterAfterWorldMatrixUpdate;
  35978. /**
  35979. * Clone the current sound in the scene.
  35980. * @returns the new sound clone
  35981. */
  35982. clone(): Nullable<Sound>;
  35983. /**
  35984. * Gets the current underlying audio buffer containing the data
  35985. * @returns the audio buffer
  35986. */
  35987. getAudioBuffer(): Nullable<AudioBuffer>;
  35988. /**
  35989. * Serializes the Sound in a JSON representation
  35990. * @returns the JSON representation of the sound
  35991. */
  35992. serialize(): any;
  35993. /**
  35994. * Parse a JSON representation of a sound to innstantiate in a given scene
  35995. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  35996. * @param scene Define the scene the new parsed sound should be created in
  35997. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  35998. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  35999. * @returns the newly parsed sound
  36000. */
  36001. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36002. }
  36003. }
  36004. declare module "babylonjs/Actions/directAudioActions" {
  36005. import { Action } from "babylonjs/Actions/action";
  36006. import { Condition } from "babylonjs/Actions/condition";
  36007. import { Sound } from "babylonjs/Audio/sound";
  36008. /**
  36009. * This defines an action helpful to play a defined sound on a triggered action.
  36010. */
  36011. export class PlaySoundAction extends Action {
  36012. private _sound;
  36013. /**
  36014. * Instantiate the action
  36015. * @param triggerOptions defines the trigger options
  36016. * @param sound defines the sound to play
  36017. * @param condition defines the trigger related conditions
  36018. */
  36019. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36020. /** @hidden */
  36021. _prepare(): void;
  36022. /**
  36023. * Execute the action and play the sound.
  36024. */
  36025. execute(): void;
  36026. /**
  36027. * Serializes the actions and its related information.
  36028. * @param parent defines the object to serialize in
  36029. * @returns the serialized object
  36030. */
  36031. serialize(parent: any): any;
  36032. }
  36033. /**
  36034. * This defines an action helpful to stop a defined sound on a triggered action.
  36035. */
  36036. export class StopSoundAction extends Action {
  36037. private _sound;
  36038. /**
  36039. * Instantiate the action
  36040. * @param triggerOptions defines the trigger options
  36041. * @param sound defines the sound to stop
  36042. * @param condition defines the trigger related conditions
  36043. */
  36044. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36045. /** @hidden */
  36046. _prepare(): void;
  36047. /**
  36048. * Execute the action and stop the sound.
  36049. */
  36050. execute(): void;
  36051. /**
  36052. * Serializes the actions and its related information.
  36053. * @param parent defines the object to serialize in
  36054. * @returns the serialized object
  36055. */
  36056. serialize(parent: any): any;
  36057. }
  36058. }
  36059. declare module "babylonjs/Actions/interpolateValueAction" {
  36060. import { Action } from "babylonjs/Actions/action";
  36061. import { Condition } from "babylonjs/Actions/condition";
  36062. import { Observable } from "babylonjs/Misc/observable";
  36063. /**
  36064. * This defines an action responsible to change the value of a property
  36065. * by interpolating between its current value and the newly set one once triggered.
  36066. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36067. */
  36068. export class InterpolateValueAction extends Action {
  36069. /**
  36070. * Defines the path of the property where the value should be interpolated
  36071. */
  36072. propertyPath: string;
  36073. /**
  36074. * Defines the target value at the end of the interpolation.
  36075. */
  36076. value: any;
  36077. /**
  36078. * Defines the time it will take for the property to interpolate to the value.
  36079. */
  36080. duration: number;
  36081. /**
  36082. * Defines if the other scene animations should be stopped when the action has been triggered
  36083. */
  36084. stopOtherAnimations?: boolean;
  36085. /**
  36086. * Defines a callback raised once the interpolation animation has been done.
  36087. */
  36088. onInterpolationDone?: () => void;
  36089. /**
  36090. * Observable triggered once the interpolation animation has been done.
  36091. */
  36092. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36093. private _target;
  36094. private _effectiveTarget;
  36095. private _property;
  36096. /**
  36097. * Instantiate the action
  36098. * @param triggerOptions defines the trigger options
  36099. * @param target defines the object containing the value to interpolate
  36100. * @param propertyPath defines the path to the property in the target object
  36101. * @param value defines the target value at the end of the interpolation
  36102. * @param duration deines the time it will take for the property to interpolate to the value.
  36103. * @param condition defines the trigger related conditions
  36104. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36105. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36106. */
  36107. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36108. /** @hidden */
  36109. _prepare(): void;
  36110. /**
  36111. * Execute the action starts the value interpolation.
  36112. */
  36113. execute(): void;
  36114. /**
  36115. * Serializes the actions and its related information.
  36116. * @param parent defines the object to serialize in
  36117. * @returns the serialized object
  36118. */
  36119. serialize(parent: any): any;
  36120. }
  36121. }
  36122. declare module "babylonjs/Actions/index" {
  36123. export * from "babylonjs/Actions/abstractActionManager";
  36124. export * from "babylonjs/Actions/action";
  36125. export * from "babylonjs/Actions/actionEvent";
  36126. export * from "babylonjs/Actions/actionManager";
  36127. export * from "babylonjs/Actions/condition";
  36128. export * from "babylonjs/Actions/directActions";
  36129. export * from "babylonjs/Actions/directAudioActions";
  36130. export * from "babylonjs/Actions/interpolateValueAction";
  36131. }
  36132. declare module "babylonjs/Animations/index" {
  36133. export * from "babylonjs/Animations/animatable";
  36134. export * from "babylonjs/Animations/animation";
  36135. export * from "babylonjs/Animations/animationGroup";
  36136. export * from "babylonjs/Animations/animationPropertiesOverride";
  36137. export * from "babylonjs/Animations/easing";
  36138. export * from "babylonjs/Animations/runtimeAnimation";
  36139. export * from "babylonjs/Animations/animationEvent";
  36140. export * from "babylonjs/Animations/animationGroup";
  36141. export * from "babylonjs/Animations/animationKey";
  36142. export * from "babylonjs/Animations/animationRange";
  36143. export * from "babylonjs/Animations/animatable.interface";
  36144. }
  36145. declare module "babylonjs/Audio/soundTrack" {
  36146. import { Sound } from "babylonjs/Audio/sound";
  36147. import { Analyser } from "babylonjs/Audio/analyser";
  36148. import { Scene } from "babylonjs/scene";
  36149. /**
  36150. * Options allowed during the creation of a sound track.
  36151. */
  36152. export interface ISoundTrackOptions {
  36153. /**
  36154. * The volume the sound track should take during creation
  36155. */
  36156. volume?: number;
  36157. /**
  36158. * Define if the sound track is the main sound track of the scene
  36159. */
  36160. mainTrack?: boolean;
  36161. }
  36162. /**
  36163. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36164. * It will be also used in a future release to apply effects on a specific track.
  36165. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36166. */
  36167. export class SoundTrack {
  36168. /**
  36169. * The unique identifier of the sound track in the scene.
  36170. */
  36171. id: number;
  36172. /**
  36173. * The list of sounds included in the sound track.
  36174. */
  36175. soundCollection: Array<Sound>;
  36176. private _outputAudioNode;
  36177. private _scene;
  36178. private _isMainTrack;
  36179. private _connectedAnalyser;
  36180. private _options;
  36181. private _isInitialized;
  36182. /**
  36183. * Creates a new sound track.
  36184. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36185. * @param scene Define the scene the sound track belongs to
  36186. * @param options
  36187. */
  36188. constructor(scene: Scene, options?: ISoundTrackOptions);
  36189. private _initializeSoundTrackAudioGraph;
  36190. /**
  36191. * Release the sound track and its associated resources
  36192. */
  36193. dispose(): void;
  36194. /**
  36195. * Adds a sound to this sound track
  36196. * @param sound define the cound to add
  36197. * @ignoreNaming
  36198. */
  36199. AddSound(sound: Sound): void;
  36200. /**
  36201. * Removes a sound to this sound track
  36202. * @param sound define the cound to remove
  36203. * @ignoreNaming
  36204. */
  36205. RemoveSound(sound: Sound): void;
  36206. /**
  36207. * Set a global volume for the full sound track.
  36208. * @param newVolume Define the new volume of the sound track
  36209. */
  36210. setVolume(newVolume: number): void;
  36211. /**
  36212. * Switch the panning model to HRTF:
  36213. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36214. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36215. */
  36216. switchPanningModelToHRTF(): void;
  36217. /**
  36218. * Switch the panning model to Equal Power:
  36219. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36220. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36221. */
  36222. switchPanningModelToEqualPower(): void;
  36223. /**
  36224. * Connect the sound track to an audio analyser allowing some amazing
  36225. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36226. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36227. * @param analyser The analyser to connect to the engine
  36228. */
  36229. connectToAnalyser(analyser: Analyser): void;
  36230. }
  36231. }
  36232. declare module "babylonjs/Audio/audioSceneComponent" {
  36233. import { Sound } from "babylonjs/Audio/sound";
  36234. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  36235. import { Nullable } from "babylonjs/types";
  36236. import { Vector3 } from "babylonjs/Maths/math.vector";
  36237. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  36238. import { Scene } from "babylonjs/scene";
  36239. import { AbstractScene } from "babylonjs/abstractScene";
  36240. import "babylonjs/Audio/audioEngine";
  36241. module "babylonjs/abstractScene" {
  36242. interface AbstractScene {
  36243. /**
  36244. * The list of sounds used in the scene.
  36245. */
  36246. sounds: Nullable<Array<Sound>>;
  36247. }
  36248. }
  36249. module "babylonjs/scene" {
  36250. interface Scene {
  36251. /**
  36252. * @hidden
  36253. * Backing field
  36254. */
  36255. _mainSoundTrack: SoundTrack;
  36256. /**
  36257. * The main sound track played by the scene.
  36258. * It cotains your primary collection of sounds.
  36259. */
  36260. mainSoundTrack: SoundTrack;
  36261. /**
  36262. * The list of sound tracks added to the scene
  36263. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36264. */
  36265. soundTracks: Nullable<Array<SoundTrack>>;
  36266. /**
  36267. * Gets a sound using a given name
  36268. * @param name defines the name to search for
  36269. * @return the found sound or null if not found at all.
  36270. */
  36271. getSoundByName(name: string): Nullable<Sound>;
  36272. /**
  36273. * Gets or sets if audio support is enabled
  36274. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36275. */
  36276. audioEnabled: boolean;
  36277. /**
  36278. * Gets or sets if audio will be output to headphones
  36279. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36280. */
  36281. headphone: boolean;
  36282. /**
  36283. * Gets or sets custom audio listener position provider
  36284. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36285. */
  36286. audioListenerPositionProvider: Nullable<() => Vector3>;
  36287. }
  36288. }
  36289. /**
  36290. * Defines the sound scene component responsible to manage any sounds
  36291. * in a given scene.
  36292. */
  36293. export class AudioSceneComponent implements ISceneSerializableComponent {
  36294. /**
  36295. * The component name helpfull to identify the component in the list of scene components.
  36296. */
  36297. readonly name: string;
  36298. /**
  36299. * The scene the component belongs to.
  36300. */
  36301. scene: Scene;
  36302. private _audioEnabled;
  36303. /**
  36304. * Gets whether audio is enabled or not.
  36305. * Please use related enable/disable method to switch state.
  36306. */
  36307. readonly audioEnabled: boolean;
  36308. private _headphone;
  36309. /**
  36310. * Gets whether audio is outputing to headphone or not.
  36311. * Please use the according Switch methods to change output.
  36312. */
  36313. readonly headphone: boolean;
  36314. private _audioListenerPositionProvider;
  36315. /**
  36316. * Gets the current audio listener position provider
  36317. */
  36318. /**
  36319. * Sets a custom listener position for all sounds in the scene
  36320. * By default, this is the position of the first active camera
  36321. */
  36322. audioListenerPositionProvider: Nullable<() => Vector3>;
  36323. /**
  36324. * Creates a new instance of the component for the given scene
  36325. * @param scene Defines the scene to register the component in
  36326. */
  36327. constructor(scene: Scene);
  36328. /**
  36329. * Registers the component in a given scene
  36330. */
  36331. register(): void;
  36332. /**
  36333. * Rebuilds the elements related to this component in case of
  36334. * context lost for instance.
  36335. */
  36336. rebuild(): void;
  36337. /**
  36338. * Serializes the component data to the specified json object
  36339. * @param serializationObject The object to serialize to
  36340. */
  36341. serialize(serializationObject: any): void;
  36342. /**
  36343. * Adds all the elements from the container to the scene
  36344. * @param container the container holding the elements
  36345. */
  36346. addFromContainer(container: AbstractScene): void;
  36347. /**
  36348. * Removes all the elements in the container from the scene
  36349. * @param container contains the elements to remove
  36350. * @param dispose if the removed element should be disposed (default: false)
  36351. */
  36352. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  36353. /**
  36354. * Disposes the component and the associated ressources.
  36355. */
  36356. dispose(): void;
  36357. /**
  36358. * Disables audio in the associated scene.
  36359. */
  36360. disableAudio(): void;
  36361. /**
  36362. * Enables audio in the associated scene.
  36363. */
  36364. enableAudio(): void;
  36365. /**
  36366. * Switch audio to headphone output.
  36367. */
  36368. switchAudioModeForHeadphones(): void;
  36369. /**
  36370. * Switch audio to normal speakers.
  36371. */
  36372. switchAudioModeForNormalSpeakers(): void;
  36373. private _afterRender;
  36374. }
  36375. }
  36376. declare module "babylonjs/Audio/weightedsound" {
  36377. import { Sound } from "babylonjs/Audio/sound";
  36378. /**
  36379. * Wraps one or more Sound objects and selects one with random weight for playback.
  36380. */
  36381. export class WeightedSound {
  36382. /** When true a Sound will be selected and played when the current playing Sound completes. */
  36383. loop: boolean;
  36384. private _coneInnerAngle;
  36385. private _coneOuterAngle;
  36386. private _volume;
  36387. /** A Sound is currently playing. */
  36388. isPlaying: boolean;
  36389. /** A Sound is currently paused. */
  36390. isPaused: boolean;
  36391. private _sounds;
  36392. private _weights;
  36393. private _currentIndex?;
  36394. /**
  36395. * Creates a new WeightedSound from the list of sounds given.
  36396. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  36397. * @param sounds Array of Sounds that will be selected from.
  36398. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  36399. */
  36400. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  36401. /**
  36402. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  36403. */
  36404. /**
  36405. * The size of cone in degress for a directional sound in which there will be no attenuation.
  36406. */
  36407. directionalConeInnerAngle: number;
  36408. /**
  36409. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36410. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36411. */
  36412. /**
  36413. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36414. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36415. */
  36416. directionalConeOuterAngle: number;
  36417. /**
  36418. * Playback volume.
  36419. */
  36420. /**
  36421. * Playback volume.
  36422. */
  36423. volume: number;
  36424. private _onended;
  36425. /**
  36426. * Suspend playback
  36427. */
  36428. pause(): void;
  36429. /**
  36430. * Stop playback
  36431. */
  36432. stop(): void;
  36433. /**
  36434. * Start playback.
  36435. * @param startOffset Position the clip head at a specific time in seconds.
  36436. */
  36437. play(startOffset?: number): void;
  36438. }
  36439. }
  36440. declare module "babylonjs/Audio/index" {
  36441. export * from "babylonjs/Audio/analyser";
  36442. export * from "babylonjs/Audio/audioEngine";
  36443. export * from "babylonjs/Audio/audioSceneComponent";
  36444. export * from "babylonjs/Audio/sound";
  36445. export * from "babylonjs/Audio/soundTrack";
  36446. export * from "babylonjs/Audio/weightedsound";
  36447. }
  36448. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  36449. import { Behavior } from "babylonjs/Behaviors/behavior";
  36450. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36451. import { BackEase } from "babylonjs/Animations/easing";
  36452. /**
  36453. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  36454. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  36455. */
  36456. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  36457. /**
  36458. * Gets the name of the behavior.
  36459. */
  36460. readonly name: string;
  36461. /**
  36462. * The easing function used by animations
  36463. */
  36464. static EasingFunction: BackEase;
  36465. /**
  36466. * The easing mode used by animations
  36467. */
  36468. static EasingMode: number;
  36469. /**
  36470. * The duration of the animation, in milliseconds
  36471. */
  36472. transitionDuration: number;
  36473. /**
  36474. * Length of the distance animated by the transition when lower radius is reached
  36475. */
  36476. lowerRadiusTransitionRange: number;
  36477. /**
  36478. * Length of the distance animated by the transition when upper radius is reached
  36479. */
  36480. upperRadiusTransitionRange: number;
  36481. private _autoTransitionRange;
  36482. /**
  36483. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36484. */
  36485. /**
  36486. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36487. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  36488. */
  36489. autoTransitionRange: boolean;
  36490. private _attachedCamera;
  36491. private _onAfterCheckInputsObserver;
  36492. private _onMeshTargetChangedObserver;
  36493. /**
  36494. * Initializes the behavior.
  36495. */
  36496. init(): void;
  36497. /**
  36498. * Attaches the behavior to its arc rotate camera.
  36499. * @param camera Defines the camera to attach the behavior to
  36500. */
  36501. attach(camera: ArcRotateCamera): void;
  36502. /**
  36503. * Detaches the behavior from its current arc rotate camera.
  36504. */
  36505. detach(): void;
  36506. private _radiusIsAnimating;
  36507. private _radiusBounceTransition;
  36508. private _animatables;
  36509. private _cachedWheelPrecision;
  36510. /**
  36511. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  36512. * @param radiusLimit The limit to check against.
  36513. * @return Bool to indicate if at limit.
  36514. */
  36515. private _isRadiusAtLimit;
  36516. /**
  36517. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  36518. * @param radiusDelta The delta by which to animate to. Can be negative.
  36519. */
  36520. private _applyBoundRadiusAnimation;
  36521. /**
  36522. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  36523. */
  36524. protected _clearAnimationLocks(): void;
  36525. /**
  36526. * Stops and removes all animations that have been applied to the camera
  36527. */
  36528. stopAllAnimations(): void;
  36529. }
  36530. }
  36531. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  36532. import { Behavior } from "babylonjs/Behaviors/behavior";
  36533. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36534. import { ExponentialEase } from "babylonjs/Animations/easing";
  36535. import { Nullable } from "babylonjs/types";
  36536. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36537. import { Vector3 } from "babylonjs/Maths/math.vector";
  36538. /**
  36539. * 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.
  36540. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  36541. */
  36542. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  36543. /**
  36544. * Gets the name of the behavior.
  36545. */
  36546. readonly name: string;
  36547. private _mode;
  36548. private _radiusScale;
  36549. private _positionScale;
  36550. private _defaultElevation;
  36551. private _elevationReturnTime;
  36552. private _elevationReturnWaitTime;
  36553. private _zoomStopsAnimation;
  36554. private _framingTime;
  36555. /**
  36556. * The easing function used by animations
  36557. */
  36558. static EasingFunction: ExponentialEase;
  36559. /**
  36560. * The easing mode used by animations
  36561. */
  36562. static EasingMode: number;
  36563. /**
  36564. * Sets the current mode used by the behavior
  36565. */
  36566. /**
  36567. * Gets current mode used by the behavior.
  36568. */
  36569. mode: number;
  36570. /**
  36571. * Sets the scale applied to the radius (1 by default)
  36572. */
  36573. /**
  36574. * Gets the scale applied to the radius
  36575. */
  36576. radiusScale: number;
  36577. /**
  36578. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  36579. */
  36580. /**
  36581. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  36582. */
  36583. positionScale: number;
  36584. /**
  36585. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  36586. * behaviour is triggered, in radians.
  36587. */
  36588. /**
  36589. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  36590. * behaviour is triggered, in radians.
  36591. */
  36592. defaultElevation: number;
  36593. /**
  36594. * Sets the time (in milliseconds) taken to return to the default beta position.
  36595. * Negative value indicates camera should not return to default.
  36596. */
  36597. /**
  36598. * Gets the time (in milliseconds) taken to return to the default beta position.
  36599. * Negative value indicates camera should not return to default.
  36600. */
  36601. elevationReturnTime: number;
  36602. /**
  36603. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  36604. */
  36605. /**
  36606. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  36607. */
  36608. elevationReturnWaitTime: number;
  36609. /**
  36610. * Sets the flag that indicates if user zooming should stop animation.
  36611. */
  36612. /**
  36613. * Gets the flag that indicates if user zooming should stop animation.
  36614. */
  36615. zoomStopsAnimation: boolean;
  36616. /**
  36617. * Sets the transition time when framing the mesh, in milliseconds
  36618. */
  36619. /**
  36620. * Gets the transition time when framing the mesh, in milliseconds
  36621. */
  36622. framingTime: number;
  36623. /**
  36624. * Define if the behavior should automatically change the configured
  36625. * camera limits and sensibilities.
  36626. */
  36627. autoCorrectCameraLimitsAndSensibility: boolean;
  36628. private _onPrePointerObservableObserver;
  36629. private _onAfterCheckInputsObserver;
  36630. private _onMeshTargetChangedObserver;
  36631. private _attachedCamera;
  36632. private _isPointerDown;
  36633. private _lastInteractionTime;
  36634. /**
  36635. * Initializes the behavior.
  36636. */
  36637. init(): void;
  36638. /**
  36639. * Attaches the behavior to its arc rotate camera.
  36640. * @param camera Defines the camera to attach the behavior to
  36641. */
  36642. attach(camera: ArcRotateCamera): void;
  36643. /**
  36644. * Detaches the behavior from its current arc rotate camera.
  36645. */
  36646. detach(): void;
  36647. private _animatables;
  36648. private _betaIsAnimating;
  36649. private _betaTransition;
  36650. private _radiusTransition;
  36651. private _vectorTransition;
  36652. /**
  36653. * Targets the given mesh and updates zoom level accordingly.
  36654. * @param mesh The mesh to target.
  36655. * @param radius Optional. If a cached radius position already exists, overrides default.
  36656. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36657. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36658. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36659. */
  36660. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36661. /**
  36662. * Targets the given mesh with its children and updates zoom level accordingly.
  36663. * @param mesh The mesh to target.
  36664. * @param radius Optional. If a cached radius position already exists, overrides default.
  36665. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36666. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36667. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36668. */
  36669. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36670. /**
  36671. * Targets the given meshes with their children and updates zoom level accordingly.
  36672. * @param meshes The mesh to target.
  36673. * @param radius Optional. If a cached radius position already exists, overrides default.
  36674. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36675. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36676. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36677. */
  36678. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36679. /**
  36680. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  36681. * @param minimumWorld Determines the smaller position of the bounding box extend
  36682. * @param maximumWorld Determines the bigger position of the bounding box extend
  36683. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36684. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36685. */
  36686. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36687. /**
  36688. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  36689. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  36690. * frustum width.
  36691. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  36692. * to fully enclose the mesh in the viewing frustum.
  36693. */
  36694. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  36695. /**
  36696. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  36697. * is automatically returned to its default position (expected to be above ground plane).
  36698. */
  36699. private _maintainCameraAboveGround;
  36700. /**
  36701. * Returns the frustum slope based on the canvas ratio and camera FOV
  36702. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  36703. */
  36704. private _getFrustumSlope;
  36705. /**
  36706. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  36707. */
  36708. private _clearAnimationLocks;
  36709. /**
  36710. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  36711. */
  36712. private _applyUserInteraction;
  36713. /**
  36714. * Stops and removes all animations that have been applied to the camera
  36715. */
  36716. stopAllAnimations(): void;
  36717. /**
  36718. * Gets a value indicating if the user is moving the camera
  36719. */
  36720. readonly isUserIsMoving: boolean;
  36721. /**
  36722. * The camera can move all the way towards the mesh.
  36723. */
  36724. static IgnoreBoundsSizeMode: number;
  36725. /**
  36726. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  36727. */
  36728. static FitFrustumSidesMode: number;
  36729. }
  36730. }
  36731. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  36732. import { Nullable } from "babylonjs/types";
  36733. import { Camera } from "babylonjs/Cameras/camera";
  36734. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  36735. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  36736. /**
  36737. * Base class for Camera Pointer Inputs.
  36738. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  36739. * for example usage.
  36740. */
  36741. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  36742. /**
  36743. * Defines the camera the input is attached to.
  36744. */
  36745. abstract camera: Camera;
  36746. /**
  36747. * Whether keyboard modifier keys are pressed at time of last mouse event.
  36748. */
  36749. protected _altKey: boolean;
  36750. protected _ctrlKey: boolean;
  36751. protected _metaKey: boolean;
  36752. protected _shiftKey: boolean;
  36753. /**
  36754. * Which mouse buttons were pressed at time of last mouse event.
  36755. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  36756. */
  36757. protected _buttonsPressed: number;
  36758. /**
  36759. * Defines the buttons associated with the input to handle camera move.
  36760. */
  36761. buttons: number[];
  36762. /**
  36763. * Attach the input controls to a specific dom element to get the input from.
  36764. * @param element Defines the element the controls should be listened from
  36765. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  36766. */
  36767. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  36768. /**
  36769. * Detach the current controls from the specified dom element.
  36770. * @param element Defines the element to stop listening the inputs from
  36771. */
  36772. detachControl(element: Nullable<HTMLElement>): void;
  36773. /**
  36774. * Gets the class name of the current input.
  36775. * @returns the class name
  36776. */
  36777. getClassName(): string;
  36778. /**
  36779. * Get the friendly name associated with the input class.
  36780. * @returns the input friendly name
  36781. */
  36782. getSimpleName(): string;
  36783. /**
  36784. * Called on pointer POINTERDOUBLETAP event.
  36785. * Override this method to provide functionality on POINTERDOUBLETAP event.
  36786. */
  36787. protected onDoubleTap(type: string): void;
  36788. /**
  36789. * Called on pointer POINTERMOVE event if only a single touch is active.
  36790. * Override this method to provide functionality.
  36791. */
  36792. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  36793. /**
  36794. * Called on pointer POINTERMOVE event if multiple touches are active.
  36795. * Override this method to provide functionality.
  36796. */
  36797. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  36798. /**
  36799. * Called on JS contextmenu event.
  36800. * Override this method to provide functionality.
  36801. */
  36802. protected onContextMenu(evt: PointerEvent): void;
  36803. /**
  36804. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  36805. * press.
  36806. * Override this method to provide functionality.
  36807. */
  36808. protected onButtonDown(evt: PointerEvent): void;
  36809. /**
  36810. * Called each time a new POINTERUP event occurs. Ie, for each button
  36811. * release.
  36812. * Override this method to provide functionality.
  36813. */
  36814. protected onButtonUp(evt: PointerEvent): void;
  36815. /**
  36816. * Called when window becomes inactive.
  36817. * Override this method to provide functionality.
  36818. */
  36819. protected onLostFocus(): void;
  36820. private _pointerInput;
  36821. private _observer;
  36822. private _onLostFocus;
  36823. private pointA;
  36824. private pointB;
  36825. }
  36826. }
  36827. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  36828. import { Nullable } from "babylonjs/types";
  36829. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36830. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  36831. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  36832. /**
  36833. * Manage the pointers inputs to control an arc rotate camera.
  36834. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36835. */
  36836. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  36837. /**
  36838. * Defines the camera the input is attached to.
  36839. */
  36840. camera: ArcRotateCamera;
  36841. /**
  36842. * Gets the class name of the current input.
  36843. * @returns the class name
  36844. */
  36845. getClassName(): string;
  36846. /**
  36847. * Defines the buttons associated with the input to handle camera move.
  36848. */
  36849. buttons: number[];
  36850. /**
  36851. * Defines the pointer angular sensibility along the X axis or how fast is
  36852. * the camera rotating.
  36853. */
  36854. angularSensibilityX: number;
  36855. /**
  36856. * Defines the pointer angular sensibility along the Y axis or how fast is
  36857. * the camera rotating.
  36858. */
  36859. angularSensibilityY: number;
  36860. /**
  36861. * Defines the pointer pinch precision or how fast is the camera zooming.
  36862. */
  36863. pinchPrecision: number;
  36864. /**
  36865. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  36866. * from 0.
  36867. * It defines the percentage of current camera.radius to use as delta when
  36868. * pinch zoom is used.
  36869. */
  36870. pinchDeltaPercentage: number;
  36871. /**
  36872. * Defines the pointer panning sensibility or how fast is the camera moving.
  36873. */
  36874. panningSensibility: number;
  36875. /**
  36876. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  36877. */
  36878. multiTouchPanning: boolean;
  36879. /**
  36880. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  36881. * zoom (pinch) through multitouch.
  36882. */
  36883. multiTouchPanAndZoom: boolean;
  36884. /**
  36885. * Revers pinch action direction.
  36886. */
  36887. pinchInwards: boolean;
  36888. private _isPanClick;
  36889. private _twoFingerActivityCount;
  36890. private _isPinching;
  36891. /**
  36892. * Called on pointer POINTERMOVE event if only a single touch is active.
  36893. */
  36894. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  36895. /**
  36896. * Called on pointer POINTERDOUBLETAP event.
  36897. */
  36898. protected onDoubleTap(type: string): void;
  36899. /**
  36900. * Called on pointer POINTERMOVE event if multiple touches are active.
  36901. */
  36902. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  36903. /**
  36904. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  36905. * press.
  36906. */
  36907. protected onButtonDown(evt: PointerEvent): void;
  36908. /**
  36909. * Called each time a new POINTERUP event occurs. Ie, for each button
  36910. * release.
  36911. */
  36912. protected onButtonUp(evt: PointerEvent): void;
  36913. /**
  36914. * Called when window becomes inactive.
  36915. */
  36916. protected onLostFocus(): void;
  36917. }
  36918. }
  36919. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  36920. import { Nullable } from "babylonjs/types";
  36921. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36922. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  36923. /**
  36924. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  36925. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36926. */
  36927. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  36928. /**
  36929. * Defines the camera the input is attached to.
  36930. */
  36931. camera: ArcRotateCamera;
  36932. /**
  36933. * Defines the list of key codes associated with the up action (increase alpha)
  36934. */
  36935. keysUp: number[];
  36936. /**
  36937. * Defines the list of key codes associated with the down action (decrease alpha)
  36938. */
  36939. keysDown: number[];
  36940. /**
  36941. * Defines the list of key codes associated with the left action (increase beta)
  36942. */
  36943. keysLeft: number[];
  36944. /**
  36945. * Defines the list of key codes associated with the right action (decrease beta)
  36946. */
  36947. keysRight: number[];
  36948. /**
  36949. * Defines the list of key codes associated with the reset action.
  36950. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  36951. */
  36952. keysReset: number[];
  36953. /**
  36954. * Defines the panning sensibility of the inputs.
  36955. * (How fast is the camera paning)
  36956. */
  36957. panningSensibility: number;
  36958. /**
  36959. * Defines the zooming sensibility of the inputs.
  36960. * (How fast is the camera zooming)
  36961. */
  36962. zoomingSensibility: number;
  36963. /**
  36964. * Defines wether maintaining the alt key down switch the movement mode from
  36965. * orientation to zoom.
  36966. */
  36967. useAltToZoom: boolean;
  36968. /**
  36969. * Rotation speed of the camera
  36970. */
  36971. angularSpeed: number;
  36972. private _keys;
  36973. private _ctrlPressed;
  36974. private _altPressed;
  36975. private _onCanvasBlurObserver;
  36976. private _onKeyboardObserver;
  36977. private _engine;
  36978. private _scene;
  36979. /**
  36980. * Attach the input controls to a specific dom element to get the input from.
  36981. * @param element Defines the element the controls should be listened from
  36982. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  36983. */
  36984. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  36985. /**
  36986. * Detach the current controls from the specified dom element.
  36987. * @param element Defines the element to stop listening the inputs from
  36988. */
  36989. detachControl(element: Nullable<HTMLElement>): void;
  36990. /**
  36991. * Update the current camera state depending on the inputs that have been used this frame.
  36992. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  36993. */
  36994. checkInputs(): void;
  36995. /**
  36996. * Gets the class name of the current intput.
  36997. * @returns the class name
  36998. */
  36999. getClassName(): string;
  37000. /**
  37001. * Get the friendly name associated with the input class.
  37002. * @returns the input friendly name
  37003. */
  37004. getSimpleName(): string;
  37005. }
  37006. }
  37007. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37008. import { Nullable } from "babylonjs/types";
  37009. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37010. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37011. /**
  37012. * Manage the mouse wheel inputs to control an arc rotate camera.
  37013. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37014. */
  37015. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37016. /**
  37017. * Defines the camera the input is attached to.
  37018. */
  37019. camera: ArcRotateCamera;
  37020. /**
  37021. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37022. */
  37023. wheelPrecision: number;
  37024. /**
  37025. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37026. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37027. */
  37028. wheelDeltaPercentage: number;
  37029. private _wheel;
  37030. private _observer;
  37031. private computeDeltaFromMouseWheelLegacyEvent;
  37032. /**
  37033. * Attach the input controls to a specific dom element to get the input from.
  37034. * @param element Defines the element the controls should be listened from
  37035. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37036. */
  37037. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37038. /**
  37039. * Detach the current controls from the specified dom element.
  37040. * @param element Defines the element to stop listening the inputs from
  37041. */
  37042. detachControl(element: Nullable<HTMLElement>): void;
  37043. /**
  37044. * Gets the class name of the current intput.
  37045. * @returns the class name
  37046. */
  37047. getClassName(): string;
  37048. /**
  37049. * Get the friendly name associated with the input class.
  37050. * @returns the input friendly name
  37051. */
  37052. getSimpleName(): string;
  37053. }
  37054. }
  37055. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37056. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37057. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37058. /**
  37059. * Default Inputs manager for the ArcRotateCamera.
  37060. * It groups all the default supported inputs for ease of use.
  37061. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37062. */
  37063. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37064. /**
  37065. * Instantiates a new ArcRotateCameraInputsManager.
  37066. * @param camera Defines the camera the inputs belong to
  37067. */
  37068. constructor(camera: ArcRotateCamera);
  37069. /**
  37070. * Add mouse wheel input support to the input manager.
  37071. * @returns the current input manager
  37072. */
  37073. addMouseWheel(): ArcRotateCameraInputsManager;
  37074. /**
  37075. * Add pointers input support to the input manager.
  37076. * @returns the current input manager
  37077. */
  37078. addPointers(): ArcRotateCameraInputsManager;
  37079. /**
  37080. * Add keyboard input support to the input manager.
  37081. * @returns the current input manager
  37082. */
  37083. addKeyboard(): ArcRotateCameraInputsManager;
  37084. }
  37085. }
  37086. declare module "babylonjs/Cameras/arcRotateCamera" {
  37087. import { Observable } from "babylonjs/Misc/observable";
  37088. import { Nullable } from "babylonjs/types";
  37089. import { Scene } from "babylonjs/scene";
  37090. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37091. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37092. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37093. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37094. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37095. import { Camera } from "babylonjs/Cameras/camera";
  37096. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37097. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37098. import { Collider } from "babylonjs/Collisions/collider";
  37099. /**
  37100. * This represents an orbital type of camera.
  37101. *
  37102. * 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.
  37103. * 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.
  37104. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37105. */
  37106. export class ArcRotateCamera extends TargetCamera {
  37107. /**
  37108. * Defines the rotation angle of the camera along the longitudinal axis.
  37109. */
  37110. alpha: number;
  37111. /**
  37112. * Defines the rotation angle of the camera along the latitudinal axis.
  37113. */
  37114. beta: number;
  37115. /**
  37116. * Defines the radius of the camera from it s target point.
  37117. */
  37118. radius: number;
  37119. protected _target: Vector3;
  37120. protected _targetHost: Nullable<AbstractMesh>;
  37121. /**
  37122. * Defines the target point of the camera.
  37123. * The camera looks towards it form the radius distance.
  37124. */
  37125. target: Vector3;
  37126. /**
  37127. * Define the current local position of the camera in the scene
  37128. */
  37129. position: Vector3;
  37130. protected _upVector: Vector3;
  37131. protected _upToYMatrix: Matrix;
  37132. protected _YToUpMatrix: Matrix;
  37133. /**
  37134. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37135. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37136. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37137. */
  37138. upVector: Vector3;
  37139. /**
  37140. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37141. */
  37142. setMatUp(): void;
  37143. /**
  37144. * Current inertia value on the longitudinal axis.
  37145. * The bigger this number the longer it will take for the camera to stop.
  37146. */
  37147. inertialAlphaOffset: number;
  37148. /**
  37149. * Current inertia value on the latitudinal axis.
  37150. * The bigger this number the longer it will take for the camera to stop.
  37151. */
  37152. inertialBetaOffset: number;
  37153. /**
  37154. * Current inertia value on the radius axis.
  37155. * The bigger this number the longer it will take for the camera to stop.
  37156. */
  37157. inertialRadiusOffset: number;
  37158. /**
  37159. * Minimum allowed angle on the longitudinal axis.
  37160. * This can help limiting how the Camera is able to move in the scene.
  37161. */
  37162. lowerAlphaLimit: Nullable<number>;
  37163. /**
  37164. * Maximum allowed angle on the longitudinal axis.
  37165. * This can help limiting how the Camera is able to move in the scene.
  37166. */
  37167. upperAlphaLimit: Nullable<number>;
  37168. /**
  37169. * Minimum allowed angle on the latitudinal axis.
  37170. * This can help limiting how the Camera is able to move in the scene.
  37171. */
  37172. lowerBetaLimit: number;
  37173. /**
  37174. * Maximum allowed angle on the latitudinal axis.
  37175. * This can help limiting how the Camera is able to move in the scene.
  37176. */
  37177. upperBetaLimit: number;
  37178. /**
  37179. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37180. * This can help limiting how the Camera is able to move in the scene.
  37181. */
  37182. lowerRadiusLimit: Nullable<number>;
  37183. /**
  37184. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37185. * This can help limiting how the Camera is able to move in the scene.
  37186. */
  37187. upperRadiusLimit: Nullable<number>;
  37188. /**
  37189. * Defines the current inertia value used during panning of the camera along the X axis.
  37190. */
  37191. inertialPanningX: number;
  37192. /**
  37193. * Defines the current inertia value used during panning of the camera along the Y axis.
  37194. */
  37195. inertialPanningY: number;
  37196. /**
  37197. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37198. * Basically if your fingers moves away from more than this distance you will be considered
  37199. * in pinch mode.
  37200. */
  37201. pinchToPanMaxDistance: number;
  37202. /**
  37203. * Defines the maximum distance the camera can pan.
  37204. * This could help keeping the cammera always in your scene.
  37205. */
  37206. panningDistanceLimit: Nullable<number>;
  37207. /**
  37208. * Defines the target of the camera before paning.
  37209. */
  37210. panningOriginTarget: Vector3;
  37211. /**
  37212. * Defines the value of the inertia used during panning.
  37213. * 0 would mean stop inertia and one would mean no decelleration at all.
  37214. */
  37215. panningInertia: number;
  37216. /**
  37217. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  37218. */
  37219. angularSensibilityX: number;
  37220. /**
  37221. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  37222. */
  37223. angularSensibilityY: number;
  37224. /**
  37225. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  37226. */
  37227. pinchPrecision: number;
  37228. /**
  37229. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  37230. * It will be used instead of pinchDeltaPrecision if different from 0.
  37231. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37232. */
  37233. pinchDeltaPercentage: number;
  37234. /**
  37235. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  37236. */
  37237. panningSensibility: number;
  37238. /**
  37239. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  37240. */
  37241. keysUp: number[];
  37242. /**
  37243. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  37244. */
  37245. keysDown: number[];
  37246. /**
  37247. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  37248. */
  37249. keysLeft: number[];
  37250. /**
  37251. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  37252. */
  37253. keysRight: number[];
  37254. /**
  37255. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37256. */
  37257. wheelPrecision: number;
  37258. /**
  37259. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  37260. * It will be used instead of pinchDeltaPrecision if different from 0.
  37261. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37262. */
  37263. wheelDeltaPercentage: number;
  37264. /**
  37265. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  37266. */
  37267. zoomOnFactor: number;
  37268. /**
  37269. * Defines a screen offset for the camera position.
  37270. */
  37271. targetScreenOffset: Vector2;
  37272. /**
  37273. * Allows the camera to be completely reversed.
  37274. * If false the camera can not arrive upside down.
  37275. */
  37276. allowUpsideDown: boolean;
  37277. /**
  37278. * Define if double tap/click is used to restore the previously saved state of the camera.
  37279. */
  37280. useInputToRestoreState: boolean;
  37281. /** @hidden */
  37282. _viewMatrix: Matrix;
  37283. /** @hidden */
  37284. _useCtrlForPanning: boolean;
  37285. /** @hidden */
  37286. _panningMouseButton: number;
  37287. /**
  37288. * Defines the input associated to the camera.
  37289. */
  37290. inputs: ArcRotateCameraInputsManager;
  37291. /** @hidden */
  37292. _reset: () => void;
  37293. /**
  37294. * Defines the allowed panning axis.
  37295. */
  37296. panningAxis: Vector3;
  37297. protected _localDirection: Vector3;
  37298. protected _transformedDirection: Vector3;
  37299. private _bouncingBehavior;
  37300. /**
  37301. * Gets the bouncing behavior of the camera if it has been enabled.
  37302. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37303. */
  37304. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  37305. /**
  37306. * Defines if the bouncing behavior of the camera is enabled on the camera.
  37307. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37308. */
  37309. useBouncingBehavior: boolean;
  37310. private _framingBehavior;
  37311. /**
  37312. * Gets the framing behavior of the camera if it has been enabled.
  37313. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37314. */
  37315. readonly framingBehavior: Nullable<FramingBehavior>;
  37316. /**
  37317. * Defines if the framing behavior of the camera is enabled on the camera.
  37318. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37319. */
  37320. useFramingBehavior: boolean;
  37321. private _autoRotationBehavior;
  37322. /**
  37323. * Gets the auto rotation behavior of the camera if it has been enabled.
  37324. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37325. */
  37326. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  37327. /**
  37328. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  37329. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37330. */
  37331. useAutoRotationBehavior: boolean;
  37332. /**
  37333. * Observable triggered when the mesh target has been changed on the camera.
  37334. */
  37335. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  37336. /**
  37337. * Event raised when the camera is colliding with a mesh.
  37338. */
  37339. onCollide: (collidedMesh: AbstractMesh) => void;
  37340. /**
  37341. * Defines whether the camera should check collision with the objects oh the scene.
  37342. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  37343. */
  37344. checkCollisions: boolean;
  37345. /**
  37346. * Defines the collision radius of the camera.
  37347. * This simulates a sphere around the camera.
  37348. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  37349. */
  37350. collisionRadius: Vector3;
  37351. protected _collider: Collider;
  37352. protected _previousPosition: Vector3;
  37353. protected _collisionVelocity: Vector3;
  37354. protected _newPosition: Vector3;
  37355. protected _previousAlpha: number;
  37356. protected _previousBeta: number;
  37357. protected _previousRadius: number;
  37358. protected _collisionTriggered: boolean;
  37359. protected _targetBoundingCenter: Nullable<Vector3>;
  37360. private _computationVector;
  37361. /**
  37362. * Instantiates a new ArcRotateCamera in a given scene
  37363. * @param name Defines the name of the camera
  37364. * @param alpha Defines the camera rotation along the logitudinal axis
  37365. * @param beta Defines the camera rotation along the latitudinal axis
  37366. * @param radius Defines the camera distance from its target
  37367. * @param target Defines the camera target
  37368. * @param scene Defines the scene the camera belongs to
  37369. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  37370. */
  37371. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  37372. /** @hidden */
  37373. _initCache(): void;
  37374. /** @hidden */
  37375. _updateCache(ignoreParentClass?: boolean): void;
  37376. protected _getTargetPosition(): Vector3;
  37377. private _storedAlpha;
  37378. private _storedBeta;
  37379. private _storedRadius;
  37380. private _storedTarget;
  37381. private _storedTargetScreenOffset;
  37382. /**
  37383. * Stores the current state of the camera (alpha, beta, radius and target)
  37384. * @returns the camera itself
  37385. */
  37386. storeState(): Camera;
  37387. /**
  37388. * @hidden
  37389. * Restored camera state. You must call storeState() first
  37390. */
  37391. _restoreStateValues(): boolean;
  37392. /** @hidden */
  37393. _isSynchronizedViewMatrix(): boolean;
  37394. /**
  37395. * Attached controls to the current camera.
  37396. * @param element Defines the element the controls should be listened from
  37397. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37398. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  37399. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  37400. */
  37401. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  37402. /**
  37403. * Detach the current controls from the camera.
  37404. * The camera will stop reacting to inputs.
  37405. * @param element Defines the element to stop listening the inputs from
  37406. */
  37407. detachControl(element: HTMLElement): void;
  37408. /** @hidden */
  37409. _checkInputs(): void;
  37410. protected _checkLimits(): void;
  37411. /**
  37412. * Rebuilds angles (alpha, beta) and radius from the give position and target
  37413. */
  37414. rebuildAnglesAndRadius(): void;
  37415. /**
  37416. * Use a position to define the current camera related information like aplha, beta and radius
  37417. * @param position Defines the position to set the camera at
  37418. */
  37419. setPosition(position: Vector3): void;
  37420. /**
  37421. * Defines the target the camera should look at.
  37422. * This will automatically adapt alpha beta and radius to fit within the new target.
  37423. * @param target Defines the new target as a Vector or a mesh
  37424. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  37425. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  37426. */
  37427. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  37428. /** @hidden */
  37429. _getViewMatrix(): Matrix;
  37430. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  37431. /**
  37432. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  37433. * @param meshes Defines the mesh to zoom on
  37434. * @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)
  37435. */
  37436. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  37437. /**
  37438. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  37439. * The target will be changed but the radius
  37440. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  37441. * @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)
  37442. */
  37443. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  37444. min: Vector3;
  37445. max: Vector3;
  37446. distance: number;
  37447. }, doNotUpdateMaxZ?: boolean): void;
  37448. /**
  37449. * @override
  37450. * Override Camera.createRigCamera
  37451. */
  37452. createRigCamera(name: string, cameraIndex: number): Camera;
  37453. /**
  37454. * @hidden
  37455. * @override
  37456. * Override Camera._updateRigCameras
  37457. */
  37458. _updateRigCameras(): void;
  37459. /**
  37460. * Destroy the camera and release the current resources hold by it.
  37461. */
  37462. dispose(): void;
  37463. /**
  37464. * Gets the current object class name.
  37465. * @return the class name
  37466. */
  37467. getClassName(): string;
  37468. }
  37469. }
  37470. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  37471. import { Behavior } from "babylonjs/Behaviors/behavior";
  37472. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37473. /**
  37474. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  37475. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37476. */
  37477. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  37478. /**
  37479. * Gets the name of the behavior.
  37480. */
  37481. readonly name: string;
  37482. private _zoomStopsAnimation;
  37483. private _idleRotationSpeed;
  37484. private _idleRotationWaitTime;
  37485. private _idleRotationSpinupTime;
  37486. /**
  37487. * Sets the flag that indicates if user zooming should stop animation.
  37488. */
  37489. /**
  37490. * Gets the flag that indicates if user zooming should stop animation.
  37491. */
  37492. zoomStopsAnimation: boolean;
  37493. /**
  37494. * Sets the default speed at which the camera rotates around the model.
  37495. */
  37496. /**
  37497. * Gets the default speed at which the camera rotates around the model.
  37498. */
  37499. idleRotationSpeed: number;
  37500. /**
  37501. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  37502. */
  37503. /**
  37504. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  37505. */
  37506. idleRotationWaitTime: number;
  37507. /**
  37508. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37509. */
  37510. /**
  37511. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37512. */
  37513. idleRotationSpinupTime: number;
  37514. /**
  37515. * Gets a value indicating if the camera is currently rotating because of this behavior
  37516. */
  37517. readonly rotationInProgress: boolean;
  37518. private _onPrePointerObservableObserver;
  37519. private _onAfterCheckInputsObserver;
  37520. private _attachedCamera;
  37521. private _isPointerDown;
  37522. private _lastFrameTime;
  37523. private _lastInteractionTime;
  37524. private _cameraRotationSpeed;
  37525. /**
  37526. * Initializes the behavior.
  37527. */
  37528. init(): void;
  37529. /**
  37530. * Attaches the behavior to its arc rotate camera.
  37531. * @param camera Defines the camera to attach the behavior to
  37532. */
  37533. attach(camera: ArcRotateCamera): void;
  37534. /**
  37535. * Detaches the behavior from its current arc rotate camera.
  37536. */
  37537. detach(): void;
  37538. /**
  37539. * Returns true if user is scrolling.
  37540. * @return true if user is scrolling.
  37541. */
  37542. private _userIsZooming;
  37543. private _lastFrameRadius;
  37544. private _shouldAnimationStopForInteraction;
  37545. /**
  37546. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37547. */
  37548. private _applyUserInteraction;
  37549. private _userIsMoving;
  37550. }
  37551. }
  37552. declare module "babylonjs/Behaviors/Cameras/index" {
  37553. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37554. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37555. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  37556. }
  37557. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  37558. import { Mesh } from "babylonjs/Meshes/mesh";
  37559. import { TransformNode } from "babylonjs/Meshes/transformNode";
  37560. import { Behavior } from "babylonjs/Behaviors/behavior";
  37561. /**
  37562. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  37563. */
  37564. export class AttachToBoxBehavior implements Behavior<Mesh> {
  37565. private ui;
  37566. /**
  37567. * The name of the behavior
  37568. */
  37569. name: string;
  37570. /**
  37571. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  37572. */
  37573. distanceAwayFromFace: number;
  37574. /**
  37575. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  37576. */
  37577. distanceAwayFromBottomOfFace: number;
  37578. private _faceVectors;
  37579. private _target;
  37580. private _scene;
  37581. private _onRenderObserver;
  37582. private _tmpMatrix;
  37583. private _tmpVector;
  37584. /**
  37585. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  37586. * @param ui The transform node that should be attched to the mesh
  37587. */
  37588. constructor(ui: TransformNode);
  37589. /**
  37590. * Initializes the behavior
  37591. */
  37592. init(): void;
  37593. private _closestFace;
  37594. private _zeroVector;
  37595. private _lookAtTmpMatrix;
  37596. private _lookAtToRef;
  37597. /**
  37598. * Attaches the AttachToBoxBehavior to the passed in mesh
  37599. * @param target The mesh that the specified node will be attached to
  37600. */
  37601. attach(target: Mesh): void;
  37602. /**
  37603. * Detaches the behavior from the mesh
  37604. */
  37605. detach(): void;
  37606. }
  37607. }
  37608. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  37609. import { Behavior } from "babylonjs/Behaviors/behavior";
  37610. import { Mesh } from "babylonjs/Meshes/mesh";
  37611. /**
  37612. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  37613. */
  37614. export class FadeInOutBehavior implements Behavior<Mesh> {
  37615. /**
  37616. * Time in milliseconds to delay before fading in (Default: 0)
  37617. */
  37618. delay: number;
  37619. /**
  37620. * Time in milliseconds for the mesh to fade in (Default: 300)
  37621. */
  37622. fadeInTime: number;
  37623. private _millisecondsPerFrame;
  37624. private _hovered;
  37625. private _hoverValue;
  37626. private _ownerNode;
  37627. /**
  37628. * Instatiates the FadeInOutBehavior
  37629. */
  37630. constructor();
  37631. /**
  37632. * The name of the behavior
  37633. */
  37634. readonly name: string;
  37635. /**
  37636. * Initializes the behavior
  37637. */
  37638. init(): void;
  37639. /**
  37640. * Attaches the fade behavior on the passed in mesh
  37641. * @param ownerNode The mesh that will be faded in/out once attached
  37642. */
  37643. attach(ownerNode: Mesh): void;
  37644. /**
  37645. * Detaches the behavior from the mesh
  37646. */
  37647. detach(): void;
  37648. /**
  37649. * Triggers the mesh to begin fading in or out
  37650. * @param value if the object should fade in or out (true to fade in)
  37651. */
  37652. fadeIn(value: boolean): void;
  37653. private _update;
  37654. private _setAllVisibility;
  37655. }
  37656. }
  37657. declare module "babylonjs/Misc/pivotTools" {
  37658. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37659. /**
  37660. * Class containing a set of static utilities functions for managing Pivots
  37661. * @hidden
  37662. */
  37663. export class PivotTools {
  37664. private static _PivotCached;
  37665. private static _OldPivotPoint;
  37666. private static _PivotTranslation;
  37667. private static _PivotTmpVector;
  37668. /** @hidden */
  37669. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  37670. /** @hidden */
  37671. static _RestorePivotPoint(mesh: AbstractMesh): void;
  37672. }
  37673. }
  37674. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  37675. import { Scene } from "babylonjs/scene";
  37676. import { Vector4 } from "babylonjs/Maths/math.vector";
  37677. import { Mesh } from "babylonjs/Meshes/mesh";
  37678. import { Nullable } from "babylonjs/types";
  37679. import { Plane } from "babylonjs/Maths/math.plane";
  37680. /**
  37681. * Class containing static functions to help procedurally build meshes
  37682. */
  37683. export class PlaneBuilder {
  37684. /**
  37685. * Creates a plane mesh
  37686. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  37687. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  37688. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  37689. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  37690. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  37691. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  37692. * @param name defines the name of the mesh
  37693. * @param options defines the options used to create the mesh
  37694. * @param scene defines the hosting scene
  37695. * @returns the plane mesh
  37696. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  37697. */
  37698. static CreatePlane(name: string, options: {
  37699. size?: number;
  37700. width?: number;
  37701. height?: number;
  37702. sideOrientation?: number;
  37703. frontUVs?: Vector4;
  37704. backUVs?: Vector4;
  37705. updatable?: boolean;
  37706. sourcePlane?: Plane;
  37707. }, scene?: Nullable<Scene>): Mesh;
  37708. }
  37709. }
  37710. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  37711. import { Behavior } from "babylonjs/Behaviors/behavior";
  37712. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37713. import { Observable } from "babylonjs/Misc/observable";
  37714. import { Vector3 } from "babylonjs/Maths/math.vector";
  37715. import { Ray } from "babylonjs/Culling/ray";
  37716. import "babylonjs/Meshes/Builders/planeBuilder";
  37717. /**
  37718. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  37719. */
  37720. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  37721. private static _AnyMouseID;
  37722. /**
  37723. * Abstract mesh the behavior is set on
  37724. */
  37725. attachedNode: AbstractMesh;
  37726. private _dragPlane;
  37727. private _scene;
  37728. private _pointerObserver;
  37729. private _beforeRenderObserver;
  37730. private static _planeScene;
  37731. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  37732. /**
  37733. * 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)
  37734. */
  37735. maxDragAngle: number;
  37736. /**
  37737. * @hidden
  37738. */
  37739. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  37740. /**
  37741. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  37742. */
  37743. currentDraggingPointerID: number;
  37744. /**
  37745. * The last position where the pointer hit the drag plane in world space
  37746. */
  37747. lastDragPosition: Vector3;
  37748. /**
  37749. * If the behavior is currently in a dragging state
  37750. */
  37751. dragging: boolean;
  37752. /**
  37753. * 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)
  37754. */
  37755. dragDeltaRatio: number;
  37756. /**
  37757. * If the drag plane orientation should be updated during the dragging (Default: true)
  37758. */
  37759. updateDragPlane: boolean;
  37760. private _debugMode;
  37761. private _moving;
  37762. /**
  37763. * Fires each time the attached mesh is dragged with the pointer
  37764. * * delta between last drag position and current drag position in world space
  37765. * * dragDistance along the drag axis
  37766. * * dragPlaneNormal normal of the current drag plane used during the drag
  37767. * * dragPlanePoint in world space where the drag intersects the drag plane
  37768. */
  37769. onDragObservable: Observable<{
  37770. delta: Vector3;
  37771. dragPlanePoint: Vector3;
  37772. dragPlaneNormal: Vector3;
  37773. dragDistance: number;
  37774. pointerId: number;
  37775. }>;
  37776. /**
  37777. * Fires each time a drag begins (eg. mouse down on mesh)
  37778. */
  37779. onDragStartObservable: Observable<{
  37780. dragPlanePoint: Vector3;
  37781. pointerId: number;
  37782. }>;
  37783. /**
  37784. * Fires each time a drag ends (eg. mouse release after drag)
  37785. */
  37786. onDragEndObservable: Observable<{
  37787. dragPlanePoint: Vector3;
  37788. pointerId: number;
  37789. }>;
  37790. /**
  37791. * If the attached mesh should be moved when dragged
  37792. */
  37793. moveAttached: boolean;
  37794. /**
  37795. * If the drag behavior will react to drag events (Default: true)
  37796. */
  37797. enabled: boolean;
  37798. /**
  37799. * If pointer events should start and release the drag (Default: true)
  37800. */
  37801. startAndReleaseDragOnPointerEvents: boolean;
  37802. /**
  37803. * If camera controls should be detached during the drag
  37804. */
  37805. detachCameraControls: boolean;
  37806. /**
  37807. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  37808. */
  37809. useObjectOrienationForDragging: boolean;
  37810. private _options;
  37811. /**
  37812. * Creates a pointer drag behavior that can be attached to a mesh
  37813. * @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)
  37814. */
  37815. constructor(options?: {
  37816. dragAxis?: Vector3;
  37817. dragPlaneNormal?: Vector3;
  37818. });
  37819. /**
  37820. * Predicate to determine if it is valid to move the object to a new position when it is moved
  37821. */
  37822. validateDrag: (targetPosition: Vector3) => boolean;
  37823. /**
  37824. * The name of the behavior
  37825. */
  37826. readonly name: string;
  37827. /**
  37828. * Initializes the behavior
  37829. */
  37830. init(): void;
  37831. private _tmpVector;
  37832. private _alternatePickedPoint;
  37833. private _worldDragAxis;
  37834. private _targetPosition;
  37835. private _attachedElement;
  37836. /**
  37837. * Attaches the drag behavior the passed in mesh
  37838. * @param ownerNode The mesh that will be dragged around once attached
  37839. * @param predicate Predicate to use for pick filtering
  37840. */
  37841. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  37842. /**
  37843. * Force relase the drag action by code.
  37844. */
  37845. releaseDrag(): void;
  37846. private _startDragRay;
  37847. private _lastPointerRay;
  37848. /**
  37849. * Simulates the start of a pointer drag event on the behavior
  37850. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  37851. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  37852. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  37853. */
  37854. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  37855. private _startDrag;
  37856. private _dragDelta;
  37857. private _moveDrag;
  37858. private _pickWithRayOnDragPlane;
  37859. private _pointA;
  37860. private _pointB;
  37861. private _pointC;
  37862. private _lineA;
  37863. private _lineB;
  37864. private _localAxis;
  37865. private _lookAt;
  37866. private _updateDragPlanePosition;
  37867. /**
  37868. * Detaches the behavior from the mesh
  37869. */
  37870. detach(): void;
  37871. }
  37872. }
  37873. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  37874. import { Mesh } from "babylonjs/Meshes/mesh";
  37875. import { Behavior } from "babylonjs/Behaviors/behavior";
  37876. /**
  37877. * A behavior that when attached to a mesh will allow the mesh to be scaled
  37878. */
  37879. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  37880. private _dragBehaviorA;
  37881. private _dragBehaviorB;
  37882. private _startDistance;
  37883. private _initialScale;
  37884. private _targetScale;
  37885. private _ownerNode;
  37886. private _sceneRenderObserver;
  37887. /**
  37888. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  37889. */
  37890. constructor();
  37891. /**
  37892. * The name of the behavior
  37893. */
  37894. readonly name: string;
  37895. /**
  37896. * Initializes the behavior
  37897. */
  37898. init(): void;
  37899. private _getCurrentDistance;
  37900. /**
  37901. * Attaches the scale behavior the passed in mesh
  37902. * @param ownerNode The mesh that will be scaled around once attached
  37903. */
  37904. attach(ownerNode: Mesh): void;
  37905. /**
  37906. * Detaches the behavior from the mesh
  37907. */
  37908. detach(): void;
  37909. }
  37910. }
  37911. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  37912. import { Behavior } from "babylonjs/Behaviors/behavior";
  37913. import { Mesh } from "babylonjs/Meshes/mesh";
  37914. import { Observable } from "babylonjs/Misc/observable";
  37915. /**
  37916. * 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
  37917. */
  37918. export class SixDofDragBehavior implements Behavior<Mesh> {
  37919. private static _virtualScene;
  37920. private _ownerNode;
  37921. private _sceneRenderObserver;
  37922. private _scene;
  37923. private _targetPosition;
  37924. private _virtualOriginMesh;
  37925. private _virtualDragMesh;
  37926. private _pointerObserver;
  37927. private _moving;
  37928. private _startingOrientation;
  37929. /**
  37930. * 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)
  37931. */
  37932. private zDragFactor;
  37933. /**
  37934. * If the object should rotate to face the drag origin
  37935. */
  37936. rotateDraggedObject: boolean;
  37937. /**
  37938. * If the behavior is currently in a dragging state
  37939. */
  37940. dragging: boolean;
  37941. /**
  37942. * 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)
  37943. */
  37944. dragDeltaRatio: number;
  37945. /**
  37946. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  37947. */
  37948. currentDraggingPointerID: number;
  37949. /**
  37950. * If camera controls should be detached during the drag
  37951. */
  37952. detachCameraControls: boolean;
  37953. /**
  37954. * Fires each time a drag starts
  37955. */
  37956. onDragStartObservable: Observable<{}>;
  37957. /**
  37958. * Fires each time a drag ends (eg. mouse release after drag)
  37959. */
  37960. onDragEndObservable: Observable<{}>;
  37961. /**
  37962. * 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
  37963. */
  37964. constructor();
  37965. /**
  37966. * The name of the behavior
  37967. */
  37968. readonly name: string;
  37969. /**
  37970. * Initializes the behavior
  37971. */
  37972. init(): void;
  37973. /**
  37974. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  37975. */
  37976. private readonly _pointerCamera;
  37977. /**
  37978. * Attaches the scale behavior the passed in mesh
  37979. * @param ownerNode The mesh that will be scaled around once attached
  37980. */
  37981. attach(ownerNode: Mesh): void;
  37982. /**
  37983. * Detaches the behavior from the mesh
  37984. */
  37985. detach(): void;
  37986. }
  37987. }
  37988. declare module "babylonjs/Behaviors/Meshes/index" {
  37989. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  37990. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  37991. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  37992. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  37993. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  37994. }
  37995. declare module "babylonjs/Behaviors/index" {
  37996. export * from "babylonjs/Behaviors/behavior";
  37997. export * from "babylonjs/Behaviors/Cameras/index";
  37998. export * from "babylonjs/Behaviors/Meshes/index";
  37999. }
  38000. declare module "babylonjs/Bones/boneIKController" {
  38001. import { Bone } from "babylonjs/Bones/bone";
  38002. import { Vector3 } from "babylonjs/Maths/math.vector";
  38003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38004. import { Nullable } from "babylonjs/types";
  38005. /**
  38006. * Class used to apply inverse kinematics to bones
  38007. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38008. */
  38009. export class BoneIKController {
  38010. private static _tmpVecs;
  38011. private static _tmpQuat;
  38012. private static _tmpMats;
  38013. /**
  38014. * Gets or sets the target mesh
  38015. */
  38016. targetMesh: AbstractMesh;
  38017. /** Gets or sets the mesh used as pole */
  38018. poleTargetMesh: AbstractMesh;
  38019. /**
  38020. * Gets or sets the bone used as pole
  38021. */
  38022. poleTargetBone: Nullable<Bone>;
  38023. /**
  38024. * Gets or sets the target position
  38025. */
  38026. targetPosition: Vector3;
  38027. /**
  38028. * Gets or sets the pole target position
  38029. */
  38030. poleTargetPosition: Vector3;
  38031. /**
  38032. * Gets or sets the pole target local offset
  38033. */
  38034. poleTargetLocalOffset: Vector3;
  38035. /**
  38036. * Gets or sets the pole angle
  38037. */
  38038. poleAngle: number;
  38039. /**
  38040. * Gets or sets the mesh associated with the controller
  38041. */
  38042. mesh: AbstractMesh;
  38043. /**
  38044. * 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)
  38045. */
  38046. slerpAmount: number;
  38047. private _bone1Quat;
  38048. private _bone1Mat;
  38049. private _bone2Ang;
  38050. private _bone1;
  38051. private _bone2;
  38052. private _bone1Length;
  38053. private _bone2Length;
  38054. private _maxAngle;
  38055. private _maxReach;
  38056. private _rightHandedSystem;
  38057. private _bendAxis;
  38058. private _slerping;
  38059. private _adjustRoll;
  38060. /**
  38061. * Gets or sets maximum allowed angle
  38062. */
  38063. maxAngle: number;
  38064. /**
  38065. * Creates a new BoneIKController
  38066. * @param mesh defines the mesh to control
  38067. * @param bone defines the bone to control
  38068. * @param options defines options to set up the controller
  38069. */
  38070. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38071. targetMesh?: AbstractMesh;
  38072. poleTargetMesh?: AbstractMesh;
  38073. poleTargetBone?: Bone;
  38074. poleTargetLocalOffset?: Vector3;
  38075. poleAngle?: number;
  38076. bendAxis?: Vector3;
  38077. maxAngle?: number;
  38078. slerpAmount?: number;
  38079. });
  38080. private _setMaxAngle;
  38081. /**
  38082. * Force the controller to update the bones
  38083. */
  38084. update(): void;
  38085. }
  38086. }
  38087. declare module "babylonjs/Bones/boneLookController" {
  38088. import { Vector3 } from "babylonjs/Maths/math.vector";
  38089. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38090. import { Bone } from "babylonjs/Bones/bone";
  38091. import { Space } from "babylonjs/Maths/math.axis";
  38092. /**
  38093. * Class used to make a bone look toward a point in space
  38094. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38095. */
  38096. export class BoneLookController {
  38097. private static _tmpVecs;
  38098. private static _tmpQuat;
  38099. private static _tmpMats;
  38100. /**
  38101. * The target Vector3 that the bone will look at
  38102. */
  38103. target: Vector3;
  38104. /**
  38105. * The mesh that the bone is attached to
  38106. */
  38107. mesh: AbstractMesh;
  38108. /**
  38109. * The bone that will be looking to the target
  38110. */
  38111. bone: Bone;
  38112. /**
  38113. * The up axis of the coordinate system that is used when the bone is rotated
  38114. */
  38115. upAxis: Vector3;
  38116. /**
  38117. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38118. */
  38119. upAxisSpace: Space;
  38120. /**
  38121. * Used to make an adjustment to the yaw of the bone
  38122. */
  38123. adjustYaw: number;
  38124. /**
  38125. * Used to make an adjustment to the pitch of the bone
  38126. */
  38127. adjustPitch: number;
  38128. /**
  38129. * Used to make an adjustment to the roll of the bone
  38130. */
  38131. adjustRoll: number;
  38132. /**
  38133. * 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)
  38134. */
  38135. slerpAmount: number;
  38136. private _minYaw;
  38137. private _maxYaw;
  38138. private _minPitch;
  38139. private _maxPitch;
  38140. private _minYawSin;
  38141. private _minYawCos;
  38142. private _maxYawSin;
  38143. private _maxYawCos;
  38144. private _midYawConstraint;
  38145. private _minPitchTan;
  38146. private _maxPitchTan;
  38147. private _boneQuat;
  38148. private _slerping;
  38149. private _transformYawPitch;
  38150. private _transformYawPitchInv;
  38151. private _firstFrameSkipped;
  38152. private _yawRange;
  38153. private _fowardAxis;
  38154. /**
  38155. * Gets or sets the minimum yaw angle that the bone can look to
  38156. */
  38157. minYaw: number;
  38158. /**
  38159. * Gets or sets the maximum yaw angle that the bone can look to
  38160. */
  38161. maxYaw: number;
  38162. /**
  38163. * Gets or sets the minimum pitch angle that the bone can look to
  38164. */
  38165. minPitch: number;
  38166. /**
  38167. * Gets or sets the maximum pitch angle that the bone can look to
  38168. */
  38169. maxPitch: number;
  38170. /**
  38171. * Create a BoneLookController
  38172. * @param mesh the mesh that the bone belongs to
  38173. * @param bone the bone that will be looking to the target
  38174. * @param target the target Vector3 to look at
  38175. * @param options optional settings:
  38176. * * maxYaw: the maximum angle the bone will yaw to
  38177. * * minYaw: the minimum angle the bone will yaw to
  38178. * * maxPitch: the maximum angle the bone will pitch to
  38179. * * minPitch: the minimum angle the bone will yaw to
  38180. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38181. * * upAxis: the up axis of the coordinate system
  38182. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38183. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38184. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38185. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38186. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38187. * * adjustRoll: used to make an adjustment to the roll of the bone
  38188. **/
  38189. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38190. maxYaw?: number;
  38191. minYaw?: number;
  38192. maxPitch?: number;
  38193. minPitch?: number;
  38194. slerpAmount?: number;
  38195. upAxis?: Vector3;
  38196. upAxisSpace?: Space;
  38197. yawAxis?: Vector3;
  38198. pitchAxis?: Vector3;
  38199. adjustYaw?: number;
  38200. adjustPitch?: number;
  38201. adjustRoll?: number;
  38202. });
  38203. /**
  38204. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38205. */
  38206. update(): void;
  38207. private _getAngleDiff;
  38208. private _getAngleBetween;
  38209. private _isAngleBetween;
  38210. }
  38211. }
  38212. declare module "babylonjs/Bones/index" {
  38213. export * from "babylonjs/Bones/bone";
  38214. export * from "babylonjs/Bones/boneIKController";
  38215. export * from "babylonjs/Bones/boneLookController";
  38216. export * from "babylonjs/Bones/skeleton";
  38217. }
  38218. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  38219. import { Nullable } from "babylonjs/types";
  38220. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38221. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38222. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  38223. /**
  38224. * Manage the gamepad inputs to control an arc rotate camera.
  38225. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38226. */
  38227. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  38228. /**
  38229. * Defines the camera the input is attached to.
  38230. */
  38231. camera: ArcRotateCamera;
  38232. /**
  38233. * Defines the gamepad the input is gathering event from.
  38234. */
  38235. gamepad: Nullable<Gamepad>;
  38236. /**
  38237. * Defines the gamepad rotation sensiblity.
  38238. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  38239. */
  38240. gamepadRotationSensibility: number;
  38241. /**
  38242. * Defines the gamepad move sensiblity.
  38243. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  38244. */
  38245. gamepadMoveSensibility: number;
  38246. private _onGamepadConnectedObserver;
  38247. private _onGamepadDisconnectedObserver;
  38248. /**
  38249. * Attach the input controls to a specific dom element to get the input from.
  38250. * @param element Defines the element the controls should be listened from
  38251. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38252. */
  38253. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38254. /**
  38255. * Detach the current controls from the specified dom element.
  38256. * @param element Defines the element to stop listening the inputs from
  38257. */
  38258. detachControl(element: Nullable<HTMLElement>): void;
  38259. /**
  38260. * Update the current camera state depending on the inputs that have been used this frame.
  38261. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38262. */
  38263. checkInputs(): void;
  38264. /**
  38265. * Gets the class name of the current intput.
  38266. * @returns the class name
  38267. */
  38268. getClassName(): string;
  38269. /**
  38270. * Get the friendly name associated with the input class.
  38271. * @returns the input friendly name
  38272. */
  38273. getSimpleName(): string;
  38274. }
  38275. }
  38276. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  38277. import { Nullable } from "babylonjs/types";
  38278. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38279. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38280. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  38281. interface ArcRotateCameraInputsManager {
  38282. /**
  38283. * Add orientation input support to the input manager.
  38284. * @returns the current input manager
  38285. */
  38286. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  38287. }
  38288. }
  38289. /**
  38290. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  38291. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38292. */
  38293. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  38294. /**
  38295. * Defines the camera the input is attached to.
  38296. */
  38297. camera: ArcRotateCamera;
  38298. /**
  38299. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  38300. */
  38301. alphaCorrection: number;
  38302. /**
  38303. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  38304. */
  38305. gammaCorrection: number;
  38306. private _alpha;
  38307. private _gamma;
  38308. private _dirty;
  38309. private _deviceOrientationHandler;
  38310. /**
  38311. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  38312. */
  38313. constructor();
  38314. /**
  38315. * Attach the input controls to a specific dom element to get the input from.
  38316. * @param element Defines the element the controls should be listened from
  38317. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38318. */
  38319. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38320. /** @hidden */
  38321. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  38322. /**
  38323. * Update the current camera state depending on the inputs that have been used this frame.
  38324. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38325. */
  38326. checkInputs(): void;
  38327. /**
  38328. * Detach the current controls from the specified dom element.
  38329. * @param element Defines the element to stop listening the inputs from
  38330. */
  38331. detachControl(element: Nullable<HTMLElement>): void;
  38332. /**
  38333. * Gets the class name of the current intput.
  38334. * @returns the class name
  38335. */
  38336. getClassName(): string;
  38337. /**
  38338. * Get the friendly name associated with the input class.
  38339. * @returns the input friendly name
  38340. */
  38341. getSimpleName(): string;
  38342. }
  38343. }
  38344. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  38345. import { Nullable } from "babylonjs/types";
  38346. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38347. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38348. /**
  38349. * Listen to mouse events to control the camera.
  38350. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38351. */
  38352. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  38353. /**
  38354. * Defines the camera the input is attached to.
  38355. */
  38356. camera: FlyCamera;
  38357. /**
  38358. * Defines if touch is enabled. (Default is true.)
  38359. */
  38360. touchEnabled: boolean;
  38361. /**
  38362. * Defines the buttons associated with the input to handle camera rotation.
  38363. */
  38364. buttons: number[];
  38365. /**
  38366. * Assign buttons for Yaw control.
  38367. */
  38368. buttonsYaw: number[];
  38369. /**
  38370. * Assign buttons for Pitch control.
  38371. */
  38372. buttonsPitch: number[];
  38373. /**
  38374. * Assign buttons for Roll control.
  38375. */
  38376. buttonsRoll: number[];
  38377. /**
  38378. * Detect if any button is being pressed while mouse is moved.
  38379. * -1 = Mouse locked.
  38380. * 0 = Left button.
  38381. * 1 = Middle Button.
  38382. * 2 = Right Button.
  38383. */
  38384. activeButton: number;
  38385. /**
  38386. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  38387. * Higher values reduce its sensitivity.
  38388. */
  38389. angularSensibility: number;
  38390. private _mousemoveCallback;
  38391. private _observer;
  38392. private _rollObserver;
  38393. private previousPosition;
  38394. private noPreventDefault;
  38395. private element;
  38396. /**
  38397. * Listen to mouse events to control the camera.
  38398. * @param touchEnabled Define if touch is enabled. (Default is true.)
  38399. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38400. */
  38401. constructor(touchEnabled?: boolean);
  38402. /**
  38403. * Attach the mouse control to the HTML DOM element.
  38404. * @param element Defines the element that listens to the input events.
  38405. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  38406. */
  38407. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38408. /**
  38409. * Detach the current controls from the specified dom element.
  38410. * @param element Defines the element to stop listening the inputs from
  38411. */
  38412. detachControl(element: Nullable<HTMLElement>): void;
  38413. /**
  38414. * Gets the class name of the current input.
  38415. * @returns the class name.
  38416. */
  38417. getClassName(): string;
  38418. /**
  38419. * Get the friendly name associated with the input class.
  38420. * @returns the input's friendly name.
  38421. */
  38422. getSimpleName(): string;
  38423. private _pointerInput;
  38424. private _onMouseMove;
  38425. /**
  38426. * Rotate camera by mouse offset.
  38427. */
  38428. private rotateCamera;
  38429. }
  38430. }
  38431. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  38432. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38433. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38434. /**
  38435. * Default Inputs manager for the FlyCamera.
  38436. * It groups all the default supported inputs for ease of use.
  38437. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38438. */
  38439. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  38440. /**
  38441. * Instantiates a new FlyCameraInputsManager.
  38442. * @param camera Defines the camera the inputs belong to.
  38443. */
  38444. constructor(camera: FlyCamera);
  38445. /**
  38446. * Add keyboard input support to the input manager.
  38447. * @returns the new FlyCameraKeyboardMoveInput().
  38448. */
  38449. addKeyboard(): FlyCameraInputsManager;
  38450. /**
  38451. * Add mouse input support to the input manager.
  38452. * @param touchEnabled Enable touch screen support.
  38453. * @returns the new FlyCameraMouseInput().
  38454. */
  38455. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  38456. }
  38457. }
  38458. declare module "babylonjs/Cameras/flyCamera" {
  38459. import { Scene } from "babylonjs/scene";
  38460. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  38461. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38462. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38463. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  38464. /**
  38465. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38466. * such as in a 3D Space Shooter or a Flight Simulator.
  38467. */
  38468. export class FlyCamera extends TargetCamera {
  38469. /**
  38470. * Define the collision ellipsoid of the camera.
  38471. * This is helpful for simulating a camera body, like a player's body.
  38472. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38473. */
  38474. ellipsoid: Vector3;
  38475. /**
  38476. * Define an offset for the position of the ellipsoid around the camera.
  38477. * This can be helpful if the camera is attached away from the player's body center,
  38478. * such as at its head.
  38479. */
  38480. ellipsoidOffset: Vector3;
  38481. /**
  38482. * Enable or disable collisions of the camera with the rest of the scene objects.
  38483. */
  38484. checkCollisions: boolean;
  38485. /**
  38486. * Enable or disable gravity on the camera.
  38487. */
  38488. applyGravity: boolean;
  38489. /**
  38490. * Define the current direction the camera is moving to.
  38491. */
  38492. cameraDirection: Vector3;
  38493. /**
  38494. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  38495. * This overrides and empties cameraRotation.
  38496. */
  38497. rotationQuaternion: Quaternion;
  38498. /**
  38499. * Track Roll to maintain the wanted Rolling when looking around.
  38500. */
  38501. _trackRoll: number;
  38502. /**
  38503. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  38504. */
  38505. rollCorrect: number;
  38506. /**
  38507. * Mimic a banked turn, Rolling the camera when Yawing.
  38508. * It's recommended to use rollCorrect = 10 for faster banking correction.
  38509. */
  38510. bankedTurn: boolean;
  38511. /**
  38512. * Limit in radians for how much Roll banking will add. (Default: 90°)
  38513. */
  38514. bankedTurnLimit: number;
  38515. /**
  38516. * Value of 0 disables the banked Roll.
  38517. * Value of 1 is equal to the Yaw angle in radians.
  38518. */
  38519. bankedTurnMultiplier: number;
  38520. /**
  38521. * The inputs manager loads all the input sources, such as keyboard and mouse.
  38522. */
  38523. inputs: FlyCameraInputsManager;
  38524. /**
  38525. * Gets the input sensibility for mouse input.
  38526. * Higher values reduce sensitivity.
  38527. */
  38528. /**
  38529. * Sets the input sensibility for a mouse input.
  38530. * Higher values reduce sensitivity.
  38531. */
  38532. angularSensibility: number;
  38533. /**
  38534. * Get the keys for camera movement forward.
  38535. */
  38536. /**
  38537. * Set the keys for camera movement forward.
  38538. */
  38539. keysForward: number[];
  38540. /**
  38541. * Get the keys for camera movement backward.
  38542. */
  38543. keysBackward: number[];
  38544. /**
  38545. * Get the keys for camera movement up.
  38546. */
  38547. /**
  38548. * Set the keys for camera movement up.
  38549. */
  38550. keysUp: number[];
  38551. /**
  38552. * Get the keys for camera movement down.
  38553. */
  38554. /**
  38555. * Set the keys for camera movement down.
  38556. */
  38557. keysDown: number[];
  38558. /**
  38559. * Get the keys for camera movement left.
  38560. */
  38561. /**
  38562. * Set the keys for camera movement left.
  38563. */
  38564. keysLeft: number[];
  38565. /**
  38566. * Set the keys for camera movement right.
  38567. */
  38568. /**
  38569. * Set the keys for camera movement right.
  38570. */
  38571. keysRight: number[];
  38572. /**
  38573. * Event raised when the camera collides with a mesh in the scene.
  38574. */
  38575. onCollide: (collidedMesh: AbstractMesh) => void;
  38576. private _collider;
  38577. private _needMoveForGravity;
  38578. private _oldPosition;
  38579. private _diffPosition;
  38580. private _newPosition;
  38581. /** @hidden */
  38582. _localDirection: Vector3;
  38583. /** @hidden */
  38584. _transformedDirection: Vector3;
  38585. /**
  38586. * Instantiates a FlyCamera.
  38587. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38588. * such as in a 3D Space Shooter or a Flight Simulator.
  38589. * @param name Define the name of the camera in the scene.
  38590. * @param position Define the starting position of the camera in the scene.
  38591. * @param scene Define the scene the camera belongs to.
  38592. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  38593. */
  38594. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  38595. /**
  38596. * Attach a control to the HTML DOM element.
  38597. * @param element Defines the element that listens to the input events.
  38598. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  38599. */
  38600. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38601. /**
  38602. * Detach a control from the HTML DOM element.
  38603. * The camera will stop reacting to that input.
  38604. * @param element Defines the element that listens to the input events.
  38605. */
  38606. detachControl(element: HTMLElement): void;
  38607. private _collisionMask;
  38608. /**
  38609. * Get the mask that the camera ignores in collision events.
  38610. */
  38611. /**
  38612. * Set the mask that the camera ignores in collision events.
  38613. */
  38614. collisionMask: number;
  38615. /** @hidden */
  38616. _collideWithWorld(displacement: Vector3): void;
  38617. /** @hidden */
  38618. private _onCollisionPositionChange;
  38619. /** @hidden */
  38620. _checkInputs(): void;
  38621. /** @hidden */
  38622. _decideIfNeedsToMove(): boolean;
  38623. /** @hidden */
  38624. _updatePosition(): void;
  38625. /**
  38626. * Restore the Roll to its target value at the rate specified.
  38627. * @param rate - Higher means slower restoring.
  38628. * @hidden
  38629. */
  38630. restoreRoll(rate: number): void;
  38631. /**
  38632. * Destroy the camera and release the current resources held by it.
  38633. */
  38634. dispose(): void;
  38635. /**
  38636. * Get the current object class name.
  38637. * @returns the class name.
  38638. */
  38639. getClassName(): string;
  38640. }
  38641. }
  38642. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  38643. import { Nullable } from "babylonjs/types";
  38644. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38645. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38646. /**
  38647. * Listen to keyboard events to control the camera.
  38648. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38649. */
  38650. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  38651. /**
  38652. * Defines the camera the input is attached to.
  38653. */
  38654. camera: FlyCamera;
  38655. /**
  38656. * The list of keyboard keys used to control the forward move of the camera.
  38657. */
  38658. keysForward: number[];
  38659. /**
  38660. * The list of keyboard keys used to control the backward move of the camera.
  38661. */
  38662. keysBackward: number[];
  38663. /**
  38664. * The list of keyboard keys used to control the forward move of the camera.
  38665. */
  38666. keysUp: number[];
  38667. /**
  38668. * The list of keyboard keys used to control the backward move of the camera.
  38669. */
  38670. keysDown: number[];
  38671. /**
  38672. * The list of keyboard keys used to control the right strafe move of the camera.
  38673. */
  38674. keysRight: number[];
  38675. /**
  38676. * The list of keyboard keys used to control the left strafe move of the camera.
  38677. */
  38678. keysLeft: number[];
  38679. private _keys;
  38680. private _onCanvasBlurObserver;
  38681. private _onKeyboardObserver;
  38682. private _engine;
  38683. private _scene;
  38684. /**
  38685. * Attach the input controls to a specific dom element to get the input from.
  38686. * @param element Defines the element the controls should be listened from
  38687. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38688. */
  38689. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38690. /**
  38691. * Detach the current controls from the specified dom element.
  38692. * @param element Defines the element to stop listening the inputs from
  38693. */
  38694. detachControl(element: Nullable<HTMLElement>): void;
  38695. /**
  38696. * Gets the class name of the current intput.
  38697. * @returns the class name
  38698. */
  38699. getClassName(): string;
  38700. /** @hidden */
  38701. _onLostFocus(e: FocusEvent): void;
  38702. /**
  38703. * Get the friendly name associated with the input class.
  38704. * @returns the input friendly name
  38705. */
  38706. getSimpleName(): string;
  38707. /**
  38708. * Update the current camera state depending on the inputs that have been used this frame.
  38709. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38710. */
  38711. checkInputs(): void;
  38712. }
  38713. }
  38714. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  38715. import { Nullable } from "babylonjs/types";
  38716. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38717. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38718. /**
  38719. * Manage the mouse wheel inputs to control a follow camera.
  38720. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38721. */
  38722. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  38723. /**
  38724. * Defines the camera the input is attached to.
  38725. */
  38726. camera: FollowCamera;
  38727. /**
  38728. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  38729. */
  38730. axisControlRadius: boolean;
  38731. /**
  38732. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  38733. */
  38734. axisControlHeight: boolean;
  38735. /**
  38736. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  38737. */
  38738. axisControlRotation: boolean;
  38739. /**
  38740. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  38741. * relation to mouseWheel events.
  38742. */
  38743. wheelPrecision: number;
  38744. /**
  38745. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  38746. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  38747. */
  38748. wheelDeltaPercentage: number;
  38749. private _wheel;
  38750. private _observer;
  38751. /**
  38752. * Attach the input controls to a specific dom element to get the input from.
  38753. * @param element Defines the element the controls should be listened from
  38754. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38755. */
  38756. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38757. /**
  38758. * Detach the current controls from the specified dom element.
  38759. * @param element Defines the element to stop listening the inputs from
  38760. */
  38761. detachControl(element: Nullable<HTMLElement>): void;
  38762. /**
  38763. * Gets the class name of the current intput.
  38764. * @returns the class name
  38765. */
  38766. getClassName(): string;
  38767. /**
  38768. * Get the friendly name associated with the input class.
  38769. * @returns the input friendly name
  38770. */
  38771. getSimpleName(): string;
  38772. }
  38773. }
  38774. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  38775. import { Nullable } from "babylonjs/types";
  38776. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38777. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  38778. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  38779. /**
  38780. * Manage the pointers inputs to control an follow camera.
  38781. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38782. */
  38783. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  38784. /**
  38785. * Defines the camera the input is attached to.
  38786. */
  38787. camera: FollowCamera;
  38788. /**
  38789. * Gets the class name of the current input.
  38790. * @returns the class name
  38791. */
  38792. getClassName(): string;
  38793. /**
  38794. * Defines the pointer angular sensibility along the X axis or how fast is
  38795. * the camera rotating.
  38796. * A negative number will reverse the axis direction.
  38797. */
  38798. angularSensibilityX: number;
  38799. /**
  38800. * Defines the pointer angular sensibility along the Y axis or how fast is
  38801. * the camera rotating.
  38802. * A negative number will reverse the axis direction.
  38803. */
  38804. angularSensibilityY: number;
  38805. /**
  38806. * Defines the pointer pinch precision or how fast is the camera zooming.
  38807. * A negative number will reverse the axis direction.
  38808. */
  38809. pinchPrecision: number;
  38810. /**
  38811. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  38812. * from 0.
  38813. * It defines the percentage of current camera.radius to use as delta when
  38814. * pinch zoom is used.
  38815. */
  38816. pinchDeltaPercentage: number;
  38817. /**
  38818. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  38819. */
  38820. axisXControlRadius: boolean;
  38821. /**
  38822. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  38823. */
  38824. axisXControlHeight: boolean;
  38825. /**
  38826. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  38827. */
  38828. axisXControlRotation: boolean;
  38829. /**
  38830. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  38831. */
  38832. axisYControlRadius: boolean;
  38833. /**
  38834. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  38835. */
  38836. axisYControlHeight: boolean;
  38837. /**
  38838. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  38839. */
  38840. axisYControlRotation: boolean;
  38841. /**
  38842. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  38843. */
  38844. axisPinchControlRadius: boolean;
  38845. /**
  38846. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  38847. */
  38848. axisPinchControlHeight: boolean;
  38849. /**
  38850. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  38851. */
  38852. axisPinchControlRotation: boolean;
  38853. /**
  38854. * Log error messages if basic misconfiguration has occurred.
  38855. */
  38856. warningEnable: boolean;
  38857. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  38858. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  38859. private _warningCounter;
  38860. private _warning;
  38861. }
  38862. }
  38863. declare module "babylonjs/Cameras/followCameraInputsManager" {
  38864. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38865. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38866. /**
  38867. * Default Inputs manager for the FollowCamera.
  38868. * It groups all the default supported inputs for ease of use.
  38869. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38870. */
  38871. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  38872. /**
  38873. * Instantiates a new FollowCameraInputsManager.
  38874. * @param camera Defines the camera the inputs belong to
  38875. */
  38876. constructor(camera: FollowCamera);
  38877. /**
  38878. * Add keyboard input support to the input manager.
  38879. * @returns the current input manager
  38880. */
  38881. addKeyboard(): FollowCameraInputsManager;
  38882. /**
  38883. * Add mouse wheel input support to the input manager.
  38884. * @returns the current input manager
  38885. */
  38886. addMouseWheel(): FollowCameraInputsManager;
  38887. /**
  38888. * Add pointers input support to the input manager.
  38889. * @returns the current input manager
  38890. */
  38891. addPointers(): FollowCameraInputsManager;
  38892. /**
  38893. * Add orientation input support to the input manager.
  38894. * @returns the current input manager
  38895. */
  38896. addVRDeviceOrientation(): FollowCameraInputsManager;
  38897. }
  38898. }
  38899. declare module "babylonjs/Cameras/followCamera" {
  38900. import { Nullable } from "babylonjs/types";
  38901. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38902. import { Scene } from "babylonjs/scene";
  38903. import { Vector3 } from "babylonjs/Maths/math.vector";
  38904. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38905. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  38906. /**
  38907. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  38908. * an arc rotate version arcFollowCamera are available.
  38909. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38910. */
  38911. export class FollowCamera extends TargetCamera {
  38912. /**
  38913. * Distance the follow camera should follow an object at
  38914. */
  38915. radius: number;
  38916. /**
  38917. * Minimum allowed distance of the camera to the axis of rotation
  38918. * (The camera can not get closer).
  38919. * This can help limiting how the Camera is able to move in the scene.
  38920. */
  38921. lowerRadiusLimit: Nullable<number>;
  38922. /**
  38923. * Maximum allowed distance of the camera to the axis of rotation
  38924. * (The camera can not get further).
  38925. * This can help limiting how the Camera is able to move in the scene.
  38926. */
  38927. upperRadiusLimit: Nullable<number>;
  38928. /**
  38929. * Define a rotation offset between the camera and the object it follows
  38930. */
  38931. rotationOffset: number;
  38932. /**
  38933. * Minimum allowed angle to camera position relative to target object.
  38934. * This can help limiting how the Camera is able to move in the scene.
  38935. */
  38936. lowerRotationOffsetLimit: Nullable<number>;
  38937. /**
  38938. * Maximum allowed angle to camera position relative to target object.
  38939. * This can help limiting how the Camera is able to move in the scene.
  38940. */
  38941. upperRotationOffsetLimit: Nullable<number>;
  38942. /**
  38943. * Define a height offset between the camera and the object it follows.
  38944. * It can help following an object from the top (like a car chaing a plane)
  38945. */
  38946. heightOffset: number;
  38947. /**
  38948. * Minimum allowed height of camera position relative to target object.
  38949. * This can help limiting how the Camera is able to move in the scene.
  38950. */
  38951. lowerHeightOffsetLimit: Nullable<number>;
  38952. /**
  38953. * Maximum allowed height of camera position relative to target object.
  38954. * This can help limiting how the Camera is able to move in the scene.
  38955. */
  38956. upperHeightOffsetLimit: Nullable<number>;
  38957. /**
  38958. * Define how fast the camera can accelerate to follow it s target.
  38959. */
  38960. cameraAcceleration: number;
  38961. /**
  38962. * Define the speed limit of the camera following an object.
  38963. */
  38964. maxCameraSpeed: number;
  38965. /**
  38966. * Define the target of the camera.
  38967. */
  38968. lockedTarget: Nullable<AbstractMesh>;
  38969. /**
  38970. * Defines the input associated with the camera.
  38971. */
  38972. inputs: FollowCameraInputsManager;
  38973. /**
  38974. * Instantiates the follow camera.
  38975. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38976. * @param name Define the name of the camera in the scene
  38977. * @param position Define the position of the camera
  38978. * @param scene Define the scene the camera belong to
  38979. * @param lockedTarget Define the target of the camera
  38980. */
  38981. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  38982. private _follow;
  38983. /**
  38984. * Attached controls to the current camera.
  38985. * @param element Defines the element the controls should be listened from
  38986. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38987. */
  38988. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38989. /**
  38990. * Detach the current controls from the camera.
  38991. * The camera will stop reacting to inputs.
  38992. * @param element Defines the element to stop listening the inputs from
  38993. */
  38994. detachControl(element: HTMLElement): void;
  38995. /** @hidden */
  38996. _checkInputs(): void;
  38997. private _checkLimits;
  38998. /**
  38999. * Gets the camera class name.
  39000. * @returns the class name
  39001. */
  39002. getClassName(): string;
  39003. }
  39004. /**
  39005. * Arc Rotate version of the follow camera.
  39006. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39007. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39008. */
  39009. export class ArcFollowCamera extends TargetCamera {
  39010. /** The longitudinal angle of the camera */
  39011. alpha: number;
  39012. /** The latitudinal angle of the camera */
  39013. beta: number;
  39014. /** The radius of the camera from its target */
  39015. radius: number;
  39016. /** Define the camera target (the messh it should follow) */
  39017. target: Nullable<AbstractMesh>;
  39018. private _cartesianCoordinates;
  39019. /**
  39020. * Instantiates a new ArcFollowCamera
  39021. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39022. * @param name Define the name of the camera
  39023. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39024. * @param beta Define the rotation angle of the camera around the elevation axis
  39025. * @param radius Define the radius of the camera from its target point
  39026. * @param target Define the target of the camera
  39027. * @param scene Define the scene the camera belongs to
  39028. */
  39029. constructor(name: string,
  39030. /** The longitudinal angle of the camera */
  39031. alpha: number,
  39032. /** The latitudinal angle of the camera */
  39033. beta: number,
  39034. /** The radius of the camera from its target */
  39035. radius: number,
  39036. /** Define the camera target (the messh it should follow) */
  39037. target: Nullable<AbstractMesh>, scene: Scene);
  39038. private _follow;
  39039. /** @hidden */
  39040. _checkInputs(): void;
  39041. /**
  39042. * Returns the class name of the object.
  39043. * It is mostly used internally for serialization purposes.
  39044. */
  39045. getClassName(): string;
  39046. }
  39047. }
  39048. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39049. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39050. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39051. import { Nullable } from "babylonjs/types";
  39052. /**
  39053. * Manage the keyboard inputs to control the movement of a follow camera.
  39054. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39055. */
  39056. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39057. /**
  39058. * Defines the camera the input is attached to.
  39059. */
  39060. camera: FollowCamera;
  39061. /**
  39062. * Defines the list of key codes associated with the up action (increase heightOffset)
  39063. */
  39064. keysHeightOffsetIncr: number[];
  39065. /**
  39066. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39067. */
  39068. keysHeightOffsetDecr: number[];
  39069. /**
  39070. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39071. */
  39072. keysHeightOffsetModifierAlt: boolean;
  39073. /**
  39074. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39075. */
  39076. keysHeightOffsetModifierCtrl: boolean;
  39077. /**
  39078. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39079. */
  39080. keysHeightOffsetModifierShift: boolean;
  39081. /**
  39082. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39083. */
  39084. keysRotationOffsetIncr: number[];
  39085. /**
  39086. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39087. */
  39088. keysRotationOffsetDecr: number[];
  39089. /**
  39090. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39091. */
  39092. keysRotationOffsetModifierAlt: boolean;
  39093. /**
  39094. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39095. */
  39096. keysRotationOffsetModifierCtrl: boolean;
  39097. /**
  39098. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39099. */
  39100. keysRotationOffsetModifierShift: boolean;
  39101. /**
  39102. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39103. */
  39104. keysRadiusIncr: number[];
  39105. /**
  39106. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39107. */
  39108. keysRadiusDecr: number[];
  39109. /**
  39110. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39111. */
  39112. keysRadiusModifierAlt: boolean;
  39113. /**
  39114. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39115. */
  39116. keysRadiusModifierCtrl: boolean;
  39117. /**
  39118. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39119. */
  39120. keysRadiusModifierShift: boolean;
  39121. /**
  39122. * Defines the rate of change of heightOffset.
  39123. */
  39124. heightSensibility: number;
  39125. /**
  39126. * Defines the rate of change of rotationOffset.
  39127. */
  39128. rotationSensibility: number;
  39129. /**
  39130. * Defines the rate of change of radius.
  39131. */
  39132. radiusSensibility: number;
  39133. private _keys;
  39134. private _ctrlPressed;
  39135. private _altPressed;
  39136. private _shiftPressed;
  39137. private _onCanvasBlurObserver;
  39138. private _onKeyboardObserver;
  39139. private _engine;
  39140. private _scene;
  39141. /**
  39142. * Attach the input controls to a specific dom element to get the input from.
  39143. * @param element Defines the element the controls should be listened from
  39144. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39145. */
  39146. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39147. /**
  39148. * Detach the current controls from the specified dom element.
  39149. * @param element Defines the element to stop listening the inputs from
  39150. */
  39151. detachControl(element: Nullable<HTMLElement>): void;
  39152. /**
  39153. * Update the current camera state depending on the inputs that have been used this frame.
  39154. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39155. */
  39156. checkInputs(): void;
  39157. /**
  39158. * Gets the class name of the current input.
  39159. * @returns the class name
  39160. */
  39161. getClassName(): string;
  39162. /**
  39163. * Get the friendly name associated with the input class.
  39164. * @returns the input friendly name
  39165. */
  39166. getSimpleName(): string;
  39167. /**
  39168. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39169. * allow modification of the heightOffset value.
  39170. */
  39171. private _modifierHeightOffset;
  39172. /**
  39173. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39174. * allow modification of the rotationOffset value.
  39175. */
  39176. private _modifierRotationOffset;
  39177. /**
  39178. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39179. * allow modification of the radius value.
  39180. */
  39181. private _modifierRadius;
  39182. }
  39183. }
  39184. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39185. import { Nullable } from "babylonjs/types";
  39186. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39187. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39188. import { Observable } from "babylonjs/Misc/observable";
  39189. module "babylonjs/Cameras/freeCameraInputsManager" {
  39190. interface FreeCameraInputsManager {
  39191. /**
  39192. * @hidden
  39193. */
  39194. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39195. /**
  39196. * Add orientation input support to the input manager.
  39197. * @returns the current input manager
  39198. */
  39199. addDeviceOrientation(): FreeCameraInputsManager;
  39200. }
  39201. }
  39202. /**
  39203. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39204. * Screen rotation is taken into account.
  39205. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39206. */
  39207. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39208. private _camera;
  39209. private _screenOrientationAngle;
  39210. private _constantTranform;
  39211. private _screenQuaternion;
  39212. private _alpha;
  39213. private _beta;
  39214. private _gamma;
  39215. /**
  39216. * Can be used to detect if a device orientation sensor is availible on a device
  39217. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  39218. * @returns a promise that will resolve on orientation change
  39219. */
  39220. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  39221. /**
  39222. * @hidden
  39223. */
  39224. _onDeviceOrientationChangedObservable: Observable<void>;
  39225. /**
  39226. * Instantiates a new input
  39227. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39228. */
  39229. constructor();
  39230. /**
  39231. * Define the camera controlled by the input.
  39232. */
  39233. camera: FreeCamera;
  39234. /**
  39235. * Attach the input controls to a specific dom element to get the input from.
  39236. * @param element Defines the element the controls should be listened from
  39237. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39238. */
  39239. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39240. private _orientationChanged;
  39241. private _deviceOrientation;
  39242. /**
  39243. * Detach the current controls from the specified dom element.
  39244. * @param element Defines the element to stop listening the inputs from
  39245. */
  39246. detachControl(element: Nullable<HTMLElement>): void;
  39247. /**
  39248. * Update the current camera state depending on the inputs that have been used this frame.
  39249. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39250. */
  39251. checkInputs(): void;
  39252. /**
  39253. * Gets the class name of the current intput.
  39254. * @returns the class name
  39255. */
  39256. getClassName(): string;
  39257. /**
  39258. * Get the friendly name associated with the input class.
  39259. * @returns the input friendly name
  39260. */
  39261. getSimpleName(): string;
  39262. }
  39263. }
  39264. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  39265. import { Nullable } from "babylonjs/types";
  39266. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39267. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39268. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39269. /**
  39270. * Manage the gamepad inputs to control a free camera.
  39271. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39272. */
  39273. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  39274. /**
  39275. * Define the camera the input is attached to.
  39276. */
  39277. camera: FreeCamera;
  39278. /**
  39279. * Define the Gamepad controlling the input
  39280. */
  39281. gamepad: Nullable<Gamepad>;
  39282. /**
  39283. * Defines the gamepad rotation sensiblity.
  39284. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39285. */
  39286. gamepadAngularSensibility: number;
  39287. /**
  39288. * Defines the gamepad move sensiblity.
  39289. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39290. */
  39291. gamepadMoveSensibility: number;
  39292. private _onGamepadConnectedObserver;
  39293. private _onGamepadDisconnectedObserver;
  39294. private _cameraTransform;
  39295. private _deltaTransform;
  39296. private _vector3;
  39297. private _vector2;
  39298. /**
  39299. * Attach the input controls to a specific dom element to get the input from.
  39300. * @param element Defines the element the controls should be listened from
  39301. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39302. */
  39303. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39304. /**
  39305. * Detach the current controls from the specified dom element.
  39306. * @param element Defines the element to stop listening the inputs from
  39307. */
  39308. detachControl(element: Nullable<HTMLElement>): void;
  39309. /**
  39310. * Update the current camera state depending on the inputs that have been used this frame.
  39311. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39312. */
  39313. checkInputs(): void;
  39314. /**
  39315. * Gets the class name of the current intput.
  39316. * @returns the class name
  39317. */
  39318. getClassName(): string;
  39319. /**
  39320. * Get the friendly name associated with the input class.
  39321. * @returns the input friendly name
  39322. */
  39323. getSimpleName(): string;
  39324. }
  39325. }
  39326. declare module "babylonjs/Misc/virtualJoystick" {
  39327. import { Nullable } from "babylonjs/types";
  39328. import { Vector3 } from "babylonjs/Maths/math.vector";
  39329. /**
  39330. * Defines the potential axis of a Joystick
  39331. */
  39332. export enum JoystickAxis {
  39333. /** X axis */
  39334. X = 0,
  39335. /** Y axis */
  39336. Y = 1,
  39337. /** Z axis */
  39338. Z = 2
  39339. }
  39340. /**
  39341. * Class used to define virtual joystick (used in touch mode)
  39342. */
  39343. export class VirtualJoystick {
  39344. /**
  39345. * Gets or sets a boolean indicating that left and right values must be inverted
  39346. */
  39347. reverseLeftRight: boolean;
  39348. /**
  39349. * Gets or sets a boolean indicating that up and down values must be inverted
  39350. */
  39351. reverseUpDown: boolean;
  39352. /**
  39353. * Gets the offset value for the position (ie. the change of the position value)
  39354. */
  39355. deltaPosition: Vector3;
  39356. /**
  39357. * Gets a boolean indicating if the virtual joystick was pressed
  39358. */
  39359. pressed: boolean;
  39360. /**
  39361. * Canvas the virtual joystick will render onto, default z-index of this is 5
  39362. */
  39363. static Canvas: Nullable<HTMLCanvasElement>;
  39364. private static _globalJoystickIndex;
  39365. private static vjCanvasContext;
  39366. private static vjCanvasWidth;
  39367. private static vjCanvasHeight;
  39368. private static halfWidth;
  39369. private _action;
  39370. private _axisTargetedByLeftAndRight;
  39371. private _axisTargetedByUpAndDown;
  39372. private _joystickSensibility;
  39373. private _inversedSensibility;
  39374. private _joystickPointerID;
  39375. private _joystickColor;
  39376. private _joystickPointerPos;
  39377. private _joystickPreviousPointerPos;
  39378. private _joystickPointerStartPos;
  39379. private _deltaJoystickVector;
  39380. private _leftJoystick;
  39381. private _touches;
  39382. private _onPointerDownHandlerRef;
  39383. private _onPointerMoveHandlerRef;
  39384. private _onPointerUpHandlerRef;
  39385. private _onResize;
  39386. /**
  39387. * Creates a new virtual joystick
  39388. * @param leftJoystick defines that the joystick is for left hand (false by default)
  39389. */
  39390. constructor(leftJoystick?: boolean);
  39391. /**
  39392. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  39393. * @param newJoystickSensibility defines the new sensibility
  39394. */
  39395. setJoystickSensibility(newJoystickSensibility: number): void;
  39396. private _onPointerDown;
  39397. private _onPointerMove;
  39398. private _onPointerUp;
  39399. /**
  39400. * Change the color of the virtual joystick
  39401. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  39402. */
  39403. setJoystickColor(newColor: string): void;
  39404. /**
  39405. * Defines a callback to call when the joystick is touched
  39406. * @param action defines the callback
  39407. */
  39408. setActionOnTouch(action: () => any): void;
  39409. /**
  39410. * Defines which axis you'd like to control for left & right
  39411. * @param axis defines the axis to use
  39412. */
  39413. setAxisForLeftRight(axis: JoystickAxis): void;
  39414. /**
  39415. * Defines which axis you'd like to control for up & down
  39416. * @param axis defines the axis to use
  39417. */
  39418. setAxisForUpDown(axis: JoystickAxis): void;
  39419. private _drawVirtualJoystick;
  39420. /**
  39421. * Release internal HTML canvas
  39422. */
  39423. releaseCanvas(): void;
  39424. }
  39425. }
  39426. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  39427. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  39428. import { Nullable } from "babylonjs/types";
  39429. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39430. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39431. module "babylonjs/Cameras/freeCameraInputsManager" {
  39432. interface FreeCameraInputsManager {
  39433. /**
  39434. * Add virtual joystick input support to the input manager.
  39435. * @returns the current input manager
  39436. */
  39437. addVirtualJoystick(): FreeCameraInputsManager;
  39438. }
  39439. }
  39440. /**
  39441. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  39442. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39443. */
  39444. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  39445. /**
  39446. * Defines the camera the input is attached to.
  39447. */
  39448. camera: FreeCamera;
  39449. private _leftjoystick;
  39450. private _rightjoystick;
  39451. /**
  39452. * Gets the left stick of the virtual joystick.
  39453. * @returns The virtual Joystick
  39454. */
  39455. getLeftJoystick(): VirtualJoystick;
  39456. /**
  39457. * Gets the right stick of the virtual joystick.
  39458. * @returns The virtual Joystick
  39459. */
  39460. getRightJoystick(): VirtualJoystick;
  39461. /**
  39462. * Update the current camera state depending on the inputs that have been used this frame.
  39463. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39464. */
  39465. checkInputs(): void;
  39466. /**
  39467. * Attach the input controls to a specific dom element to get the input from.
  39468. * @param element Defines the element the controls should be listened from
  39469. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39470. */
  39471. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39472. /**
  39473. * Detach the current controls from the specified dom element.
  39474. * @param element Defines the element to stop listening the inputs from
  39475. */
  39476. detachControl(element: Nullable<HTMLElement>): void;
  39477. /**
  39478. * Gets the class name of the current intput.
  39479. * @returns the class name
  39480. */
  39481. getClassName(): string;
  39482. /**
  39483. * Get the friendly name associated with the input class.
  39484. * @returns the input friendly name
  39485. */
  39486. getSimpleName(): string;
  39487. }
  39488. }
  39489. declare module "babylonjs/Cameras/Inputs/index" {
  39490. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  39491. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  39492. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  39493. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  39494. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  39495. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  39496. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  39497. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  39498. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  39499. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  39500. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39501. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  39502. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  39503. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  39504. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  39505. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  39506. }
  39507. declare module "babylonjs/Cameras/touchCamera" {
  39508. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39509. import { Scene } from "babylonjs/scene";
  39510. import { Vector3 } from "babylonjs/Maths/math.vector";
  39511. /**
  39512. * This represents a FPS type of camera controlled by touch.
  39513. * This is like a universal camera minus the Gamepad controls.
  39514. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39515. */
  39516. export class TouchCamera extends FreeCamera {
  39517. /**
  39518. * Defines the touch sensibility for rotation.
  39519. * The higher the faster.
  39520. */
  39521. touchAngularSensibility: number;
  39522. /**
  39523. * Defines the touch sensibility for move.
  39524. * The higher the faster.
  39525. */
  39526. touchMoveSensibility: number;
  39527. /**
  39528. * Instantiates a new touch camera.
  39529. * This represents a FPS type of camera controlled by touch.
  39530. * This is like a universal camera minus the Gamepad controls.
  39531. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39532. * @param name Define the name of the camera in the scene
  39533. * @param position Define the start position of the camera in the scene
  39534. * @param scene Define the scene the camera belongs to
  39535. */
  39536. constructor(name: string, position: Vector3, scene: Scene);
  39537. /**
  39538. * Gets the current object class name.
  39539. * @return the class name
  39540. */
  39541. getClassName(): string;
  39542. /** @hidden */
  39543. _setupInputs(): void;
  39544. }
  39545. }
  39546. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  39547. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39548. import { Scene } from "babylonjs/scene";
  39549. import { Vector3 } from "babylonjs/Maths/math.vector";
  39550. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39551. import { Axis } from "babylonjs/Maths/math.axis";
  39552. /**
  39553. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  39554. * being tilted forward or back and left or right.
  39555. */
  39556. export class DeviceOrientationCamera extends FreeCamera {
  39557. private _initialQuaternion;
  39558. private _quaternionCache;
  39559. private _tmpDragQuaternion;
  39560. private _disablePointerInputWhenUsingDeviceOrientation;
  39561. /**
  39562. * Creates a new device orientation camera
  39563. * @param name The name of the camera
  39564. * @param position The start position camera
  39565. * @param scene The scene the camera belongs to
  39566. */
  39567. constructor(name: string, position: Vector3, scene: Scene);
  39568. /**
  39569. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  39570. */
  39571. disablePointerInputWhenUsingDeviceOrientation: boolean;
  39572. private _dragFactor;
  39573. /**
  39574. * Enabled turning on the y axis when the orientation sensor is active
  39575. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  39576. */
  39577. enableHorizontalDragging(dragFactor?: number): void;
  39578. /**
  39579. * Gets the current instance class name ("DeviceOrientationCamera").
  39580. * This helps avoiding instanceof at run time.
  39581. * @returns the class name
  39582. */
  39583. getClassName(): string;
  39584. /**
  39585. * @hidden
  39586. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  39587. */
  39588. _checkInputs(): void;
  39589. /**
  39590. * Reset the camera to its default orientation on the specified axis only.
  39591. * @param axis The axis to reset
  39592. */
  39593. resetToCurrentRotation(axis?: Axis): void;
  39594. }
  39595. }
  39596. declare module "babylonjs/Gamepads/xboxGamepad" {
  39597. import { Observable } from "babylonjs/Misc/observable";
  39598. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39599. /**
  39600. * Defines supported buttons for XBox360 compatible gamepads
  39601. */
  39602. export enum Xbox360Button {
  39603. /** A */
  39604. A = 0,
  39605. /** B */
  39606. B = 1,
  39607. /** X */
  39608. X = 2,
  39609. /** Y */
  39610. Y = 3,
  39611. /** Start */
  39612. Start = 4,
  39613. /** Back */
  39614. Back = 5,
  39615. /** Left button */
  39616. LB = 6,
  39617. /** Right button */
  39618. RB = 7,
  39619. /** Left stick */
  39620. LeftStick = 8,
  39621. /** Right stick */
  39622. RightStick = 9
  39623. }
  39624. /** Defines values for XBox360 DPad */
  39625. export enum Xbox360Dpad {
  39626. /** Up */
  39627. Up = 0,
  39628. /** Down */
  39629. Down = 1,
  39630. /** Left */
  39631. Left = 2,
  39632. /** Right */
  39633. Right = 3
  39634. }
  39635. /**
  39636. * Defines a XBox360 gamepad
  39637. */
  39638. export class Xbox360Pad extends Gamepad {
  39639. private _leftTrigger;
  39640. private _rightTrigger;
  39641. private _onlefttriggerchanged;
  39642. private _onrighttriggerchanged;
  39643. private _onbuttondown;
  39644. private _onbuttonup;
  39645. private _ondpaddown;
  39646. private _ondpadup;
  39647. /** Observable raised when a button is pressed */
  39648. onButtonDownObservable: Observable<Xbox360Button>;
  39649. /** Observable raised when a button is released */
  39650. onButtonUpObservable: Observable<Xbox360Button>;
  39651. /** Observable raised when a pad is pressed */
  39652. onPadDownObservable: Observable<Xbox360Dpad>;
  39653. /** Observable raised when a pad is released */
  39654. onPadUpObservable: Observable<Xbox360Dpad>;
  39655. private _buttonA;
  39656. private _buttonB;
  39657. private _buttonX;
  39658. private _buttonY;
  39659. private _buttonBack;
  39660. private _buttonStart;
  39661. private _buttonLB;
  39662. private _buttonRB;
  39663. private _buttonLeftStick;
  39664. private _buttonRightStick;
  39665. private _dPadUp;
  39666. private _dPadDown;
  39667. private _dPadLeft;
  39668. private _dPadRight;
  39669. private _isXboxOnePad;
  39670. /**
  39671. * Creates a new XBox360 gamepad object
  39672. * @param id defines the id of this gamepad
  39673. * @param index defines its index
  39674. * @param gamepad defines the internal HTML gamepad object
  39675. * @param xboxOne defines if it is a XBox One gamepad
  39676. */
  39677. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  39678. /**
  39679. * Defines the callback to call when left trigger is pressed
  39680. * @param callback defines the callback to use
  39681. */
  39682. onlefttriggerchanged(callback: (value: number) => void): void;
  39683. /**
  39684. * Defines the callback to call when right trigger is pressed
  39685. * @param callback defines the callback to use
  39686. */
  39687. onrighttriggerchanged(callback: (value: number) => void): void;
  39688. /**
  39689. * Gets the left trigger value
  39690. */
  39691. /**
  39692. * Sets the left trigger value
  39693. */
  39694. leftTrigger: number;
  39695. /**
  39696. * Gets the right trigger value
  39697. */
  39698. /**
  39699. * Sets the right trigger value
  39700. */
  39701. rightTrigger: number;
  39702. /**
  39703. * Defines the callback to call when a button is pressed
  39704. * @param callback defines the callback to use
  39705. */
  39706. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  39707. /**
  39708. * Defines the callback to call when a button is released
  39709. * @param callback defines the callback to use
  39710. */
  39711. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  39712. /**
  39713. * Defines the callback to call when a pad is pressed
  39714. * @param callback defines the callback to use
  39715. */
  39716. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  39717. /**
  39718. * Defines the callback to call when a pad is released
  39719. * @param callback defines the callback to use
  39720. */
  39721. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  39722. private _setButtonValue;
  39723. private _setDPadValue;
  39724. /**
  39725. * Gets the value of the `A` button
  39726. */
  39727. /**
  39728. * Sets the value of the `A` button
  39729. */
  39730. buttonA: number;
  39731. /**
  39732. * Gets the value of the `B` button
  39733. */
  39734. /**
  39735. * Sets the value of the `B` button
  39736. */
  39737. buttonB: number;
  39738. /**
  39739. * Gets the value of the `X` button
  39740. */
  39741. /**
  39742. * Sets the value of the `X` button
  39743. */
  39744. buttonX: number;
  39745. /**
  39746. * Gets the value of the `Y` button
  39747. */
  39748. /**
  39749. * Sets the value of the `Y` button
  39750. */
  39751. buttonY: number;
  39752. /**
  39753. * Gets the value of the `Start` button
  39754. */
  39755. /**
  39756. * Sets the value of the `Start` button
  39757. */
  39758. buttonStart: number;
  39759. /**
  39760. * Gets the value of the `Back` button
  39761. */
  39762. /**
  39763. * Sets the value of the `Back` button
  39764. */
  39765. buttonBack: number;
  39766. /**
  39767. * Gets the value of the `Left` button
  39768. */
  39769. /**
  39770. * Sets the value of the `Left` button
  39771. */
  39772. buttonLB: number;
  39773. /**
  39774. * Gets the value of the `Right` button
  39775. */
  39776. /**
  39777. * Sets the value of the `Right` button
  39778. */
  39779. buttonRB: number;
  39780. /**
  39781. * Gets the value of the Left joystick
  39782. */
  39783. /**
  39784. * Sets the value of the Left joystick
  39785. */
  39786. buttonLeftStick: number;
  39787. /**
  39788. * Gets the value of the Right joystick
  39789. */
  39790. /**
  39791. * Sets the value of the Right joystick
  39792. */
  39793. buttonRightStick: number;
  39794. /**
  39795. * Gets the value of D-pad up
  39796. */
  39797. /**
  39798. * Sets the value of D-pad up
  39799. */
  39800. dPadUp: number;
  39801. /**
  39802. * Gets the value of D-pad down
  39803. */
  39804. /**
  39805. * Sets the value of D-pad down
  39806. */
  39807. dPadDown: number;
  39808. /**
  39809. * Gets the value of D-pad left
  39810. */
  39811. /**
  39812. * Sets the value of D-pad left
  39813. */
  39814. dPadLeft: number;
  39815. /**
  39816. * Gets the value of D-pad right
  39817. */
  39818. /**
  39819. * Sets the value of D-pad right
  39820. */
  39821. dPadRight: number;
  39822. /**
  39823. * Force the gamepad to synchronize with device values
  39824. */
  39825. update(): void;
  39826. /**
  39827. * Disposes the gamepad
  39828. */
  39829. dispose(): void;
  39830. }
  39831. }
  39832. declare module "babylonjs/Gamepads/dualShockGamepad" {
  39833. import { Observable } from "babylonjs/Misc/observable";
  39834. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39835. /**
  39836. * Defines supported buttons for DualShock compatible gamepads
  39837. */
  39838. export enum DualShockButton {
  39839. /** Cross */
  39840. Cross = 0,
  39841. /** Circle */
  39842. Circle = 1,
  39843. /** Square */
  39844. Square = 2,
  39845. /** Triangle */
  39846. Triangle = 3,
  39847. /** Options */
  39848. Options = 4,
  39849. /** Share */
  39850. Share = 5,
  39851. /** L1 */
  39852. L1 = 6,
  39853. /** R1 */
  39854. R1 = 7,
  39855. /** Left stick */
  39856. LeftStick = 8,
  39857. /** Right stick */
  39858. RightStick = 9
  39859. }
  39860. /** Defines values for DualShock DPad */
  39861. export enum DualShockDpad {
  39862. /** Up */
  39863. Up = 0,
  39864. /** Down */
  39865. Down = 1,
  39866. /** Left */
  39867. Left = 2,
  39868. /** Right */
  39869. Right = 3
  39870. }
  39871. /**
  39872. * Defines a DualShock gamepad
  39873. */
  39874. export class DualShockPad extends Gamepad {
  39875. private _leftTrigger;
  39876. private _rightTrigger;
  39877. private _onlefttriggerchanged;
  39878. private _onrighttriggerchanged;
  39879. private _onbuttondown;
  39880. private _onbuttonup;
  39881. private _ondpaddown;
  39882. private _ondpadup;
  39883. /** Observable raised when a button is pressed */
  39884. onButtonDownObservable: Observable<DualShockButton>;
  39885. /** Observable raised when a button is released */
  39886. onButtonUpObservable: Observable<DualShockButton>;
  39887. /** Observable raised when a pad is pressed */
  39888. onPadDownObservable: Observable<DualShockDpad>;
  39889. /** Observable raised when a pad is released */
  39890. onPadUpObservable: Observable<DualShockDpad>;
  39891. private _buttonCross;
  39892. private _buttonCircle;
  39893. private _buttonSquare;
  39894. private _buttonTriangle;
  39895. private _buttonShare;
  39896. private _buttonOptions;
  39897. private _buttonL1;
  39898. private _buttonR1;
  39899. private _buttonLeftStick;
  39900. private _buttonRightStick;
  39901. private _dPadUp;
  39902. private _dPadDown;
  39903. private _dPadLeft;
  39904. private _dPadRight;
  39905. /**
  39906. * Creates a new DualShock gamepad object
  39907. * @param id defines the id of this gamepad
  39908. * @param index defines its index
  39909. * @param gamepad defines the internal HTML gamepad object
  39910. */
  39911. constructor(id: string, index: number, gamepad: any);
  39912. /**
  39913. * Defines the callback to call when left trigger is pressed
  39914. * @param callback defines the callback to use
  39915. */
  39916. onlefttriggerchanged(callback: (value: number) => void): void;
  39917. /**
  39918. * Defines the callback to call when right trigger is pressed
  39919. * @param callback defines the callback to use
  39920. */
  39921. onrighttriggerchanged(callback: (value: number) => void): void;
  39922. /**
  39923. * Gets the left trigger value
  39924. */
  39925. /**
  39926. * Sets the left trigger value
  39927. */
  39928. leftTrigger: number;
  39929. /**
  39930. * Gets the right trigger value
  39931. */
  39932. /**
  39933. * Sets the right trigger value
  39934. */
  39935. rightTrigger: number;
  39936. /**
  39937. * Defines the callback to call when a button is pressed
  39938. * @param callback defines the callback to use
  39939. */
  39940. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  39941. /**
  39942. * Defines the callback to call when a button is released
  39943. * @param callback defines the callback to use
  39944. */
  39945. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  39946. /**
  39947. * Defines the callback to call when a pad is pressed
  39948. * @param callback defines the callback to use
  39949. */
  39950. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  39951. /**
  39952. * Defines the callback to call when a pad is released
  39953. * @param callback defines the callback to use
  39954. */
  39955. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  39956. private _setButtonValue;
  39957. private _setDPadValue;
  39958. /**
  39959. * Gets the value of the `Cross` button
  39960. */
  39961. /**
  39962. * Sets the value of the `Cross` button
  39963. */
  39964. buttonCross: number;
  39965. /**
  39966. * Gets the value of the `Circle` button
  39967. */
  39968. /**
  39969. * Sets the value of the `Circle` button
  39970. */
  39971. buttonCircle: number;
  39972. /**
  39973. * Gets the value of the `Square` button
  39974. */
  39975. /**
  39976. * Sets the value of the `Square` button
  39977. */
  39978. buttonSquare: number;
  39979. /**
  39980. * Gets the value of the `Triangle` button
  39981. */
  39982. /**
  39983. * Sets the value of the `Triangle` button
  39984. */
  39985. buttonTriangle: number;
  39986. /**
  39987. * Gets the value of the `Options` button
  39988. */
  39989. /**
  39990. * Sets the value of the `Options` button
  39991. */
  39992. buttonOptions: number;
  39993. /**
  39994. * Gets the value of the `Share` button
  39995. */
  39996. /**
  39997. * Sets the value of the `Share` button
  39998. */
  39999. buttonShare: number;
  40000. /**
  40001. * Gets the value of the `L1` button
  40002. */
  40003. /**
  40004. * Sets the value of the `L1` button
  40005. */
  40006. buttonL1: number;
  40007. /**
  40008. * Gets the value of the `R1` button
  40009. */
  40010. /**
  40011. * Sets the value of the `R1` button
  40012. */
  40013. buttonR1: number;
  40014. /**
  40015. * Gets the value of the Left joystick
  40016. */
  40017. /**
  40018. * Sets the value of the Left joystick
  40019. */
  40020. buttonLeftStick: number;
  40021. /**
  40022. * Gets the value of the Right joystick
  40023. */
  40024. /**
  40025. * Sets the value of the Right joystick
  40026. */
  40027. buttonRightStick: number;
  40028. /**
  40029. * Gets the value of D-pad up
  40030. */
  40031. /**
  40032. * Sets the value of D-pad up
  40033. */
  40034. dPadUp: number;
  40035. /**
  40036. * Gets the value of D-pad down
  40037. */
  40038. /**
  40039. * Sets the value of D-pad down
  40040. */
  40041. dPadDown: number;
  40042. /**
  40043. * Gets the value of D-pad left
  40044. */
  40045. /**
  40046. * Sets the value of D-pad left
  40047. */
  40048. dPadLeft: number;
  40049. /**
  40050. * Gets the value of D-pad right
  40051. */
  40052. /**
  40053. * Sets the value of D-pad right
  40054. */
  40055. dPadRight: number;
  40056. /**
  40057. * Force the gamepad to synchronize with device values
  40058. */
  40059. update(): void;
  40060. /**
  40061. * Disposes the gamepad
  40062. */
  40063. dispose(): void;
  40064. }
  40065. }
  40066. declare module "babylonjs/Gamepads/gamepadManager" {
  40067. import { Observable } from "babylonjs/Misc/observable";
  40068. import { Nullable } from "babylonjs/types";
  40069. import { Scene } from "babylonjs/scene";
  40070. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40071. /**
  40072. * Manager for handling gamepads
  40073. */
  40074. export class GamepadManager {
  40075. private _scene?;
  40076. private _babylonGamepads;
  40077. private _oneGamepadConnected;
  40078. /** @hidden */
  40079. _isMonitoring: boolean;
  40080. private _gamepadEventSupported;
  40081. private _gamepadSupport;
  40082. /**
  40083. * observable to be triggered when the gamepad controller has been connected
  40084. */
  40085. onGamepadConnectedObservable: Observable<Gamepad>;
  40086. /**
  40087. * observable to be triggered when the gamepad controller has been disconnected
  40088. */
  40089. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40090. private _onGamepadConnectedEvent;
  40091. private _onGamepadDisconnectedEvent;
  40092. /**
  40093. * Initializes the gamepad manager
  40094. * @param _scene BabylonJS scene
  40095. */
  40096. constructor(_scene?: Scene | undefined);
  40097. /**
  40098. * The gamepads in the game pad manager
  40099. */
  40100. readonly gamepads: Gamepad[];
  40101. /**
  40102. * Get the gamepad controllers based on type
  40103. * @param type The type of gamepad controller
  40104. * @returns Nullable gamepad
  40105. */
  40106. getGamepadByType(type?: number): Nullable<Gamepad>;
  40107. /**
  40108. * Disposes the gamepad manager
  40109. */
  40110. dispose(): void;
  40111. private _addNewGamepad;
  40112. private _startMonitoringGamepads;
  40113. private _stopMonitoringGamepads;
  40114. /** @hidden */
  40115. _checkGamepadsStatus(): void;
  40116. private _updateGamepadObjects;
  40117. }
  40118. }
  40119. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40120. import { Nullable } from "babylonjs/types";
  40121. import { Scene } from "babylonjs/scene";
  40122. import { ISceneComponent } from "babylonjs/sceneComponent";
  40123. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40124. module "babylonjs/scene" {
  40125. interface Scene {
  40126. /** @hidden */
  40127. _gamepadManager: Nullable<GamepadManager>;
  40128. /**
  40129. * Gets the gamepad manager associated with the scene
  40130. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40131. */
  40132. gamepadManager: GamepadManager;
  40133. }
  40134. }
  40135. module "babylonjs/Cameras/freeCameraInputsManager" {
  40136. /**
  40137. * Interface representing a free camera inputs manager
  40138. */
  40139. interface FreeCameraInputsManager {
  40140. /**
  40141. * Adds gamepad input support to the FreeCameraInputsManager.
  40142. * @returns the FreeCameraInputsManager
  40143. */
  40144. addGamepad(): FreeCameraInputsManager;
  40145. }
  40146. }
  40147. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40148. /**
  40149. * Interface representing an arc rotate camera inputs manager
  40150. */
  40151. interface ArcRotateCameraInputsManager {
  40152. /**
  40153. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40154. * @returns the camera inputs manager
  40155. */
  40156. addGamepad(): ArcRotateCameraInputsManager;
  40157. }
  40158. }
  40159. /**
  40160. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40161. */
  40162. export class GamepadSystemSceneComponent implements ISceneComponent {
  40163. /**
  40164. * The component name helpfull to identify the component in the list of scene components.
  40165. */
  40166. readonly name: string;
  40167. /**
  40168. * The scene the component belongs to.
  40169. */
  40170. scene: Scene;
  40171. /**
  40172. * Creates a new instance of the component for the given scene
  40173. * @param scene Defines the scene to register the component in
  40174. */
  40175. constructor(scene: Scene);
  40176. /**
  40177. * Registers the component in a given scene
  40178. */
  40179. register(): void;
  40180. /**
  40181. * Rebuilds the elements related to this component in case of
  40182. * context lost for instance.
  40183. */
  40184. rebuild(): void;
  40185. /**
  40186. * Disposes the component and the associated ressources
  40187. */
  40188. dispose(): void;
  40189. private _beforeCameraUpdate;
  40190. }
  40191. }
  40192. declare module "babylonjs/Cameras/universalCamera" {
  40193. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40194. import { Scene } from "babylonjs/scene";
  40195. import { Vector3 } from "babylonjs/Maths/math.vector";
  40196. import "babylonjs/Gamepads/gamepadSceneComponent";
  40197. /**
  40198. * 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,
  40199. * which still works and will still be found in many Playgrounds.
  40200. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40201. */
  40202. export class UniversalCamera extends TouchCamera {
  40203. /**
  40204. * Defines the gamepad rotation sensiblity.
  40205. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40206. */
  40207. gamepadAngularSensibility: number;
  40208. /**
  40209. * Defines the gamepad move sensiblity.
  40210. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40211. */
  40212. gamepadMoveSensibility: number;
  40213. /**
  40214. * 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,
  40215. * which still works and will still be found in many Playgrounds.
  40216. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40217. * @param name Define the name of the camera in the scene
  40218. * @param position Define the start position of the camera in the scene
  40219. * @param scene Define the scene the camera belongs to
  40220. */
  40221. constructor(name: string, position: Vector3, scene: Scene);
  40222. /**
  40223. * Gets the current object class name.
  40224. * @return the class name
  40225. */
  40226. getClassName(): string;
  40227. }
  40228. }
  40229. declare module "babylonjs/Cameras/gamepadCamera" {
  40230. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40231. import { Scene } from "babylonjs/scene";
  40232. import { Vector3 } from "babylonjs/Maths/math.vector";
  40233. /**
  40234. * This represents a FPS type of camera. This is only here for back compat purpose.
  40235. * Please use the UniversalCamera instead as both are identical.
  40236. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40237. */
  40238. export class GamepadCamera extends UniversalCamera {
  40239. /**
  40240. * Instantiates a new Gamepad Camera
  40241. * This represents a FPS type of camera. This is only here for back compat purpose.
  40242. * Please use the UniversalCamera instead as both are identical.
  40243. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40244. * @param name Define the name of the camera in the scene
  40245. * @param position Define the start position of the camera in the scene
  40246. * @param scene Define the scene the camera belongs to
  40247. */
  40248. constructor(name: string, position: Vector3, scene: Scene);
  40249. /**
  40250. * Gets the current object class name.
  40251. * @return the class name
  40252. */
  40253. getClassName(): string;
  40254. }
  40255. }
  40256. declare module "babylonjs/Shaders/pass.fragment" {
  40257. /** @hidden */
  40258. export var passPixelShader: {
  40259. name: string;
  40260. shader: string;
  40261. };
  40262. }
  40263. declare module "babylonjs/Shaders/passCube.fragment" {
  40264. /** @hidden */
  40265. export var passCubePixelShader: {
  40266. name: string;
  40267. shader: string;
  40268. };
  40269. }
  40270. declare module "babylonjs/PostProcesses/passPostProcess" {
  40271. import { Nullable } from "babylonjs/types";
  40272. import { Camera } from "babylonjs/Cameras/camera";
  40273. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40274. import { Engine } from "babylonjs/Engines/engine";
  40275. import "babylonjs/Shaders/pass.fragment";
  40276. import "babylonjs/Shaders/passCube.fragment";
  40277. /**
  40278. * PassPostProcess which produces an output the same as it's input
  40279. */
  40280. export class PassPostProcess extends PostProcess {
  40281. /**
  40282. * Creates the PassPostProcess
  40283. * @param name The name of the effect.
  40284. * @param options The required width/height ratio to downsize to before computing the render pass.
  40285. * @param camera The camera to apply the render pass to.
  40286. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40287. * @param engine The engine which the post process will be applied. (default: current engine)
  40288. * @param reusable If the post process can be reused on the same frame. (default: false)
  40289. * @param textureType The type of texture to be used when performing the post processing.
  40290. * @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)
  40291. */
  40292. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40293. }
  40294. /**
  40295. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  40296. */
  40297. export class PassCubePostProcess extends PostProcess {
  40298. private _face;
  40299. /**
  40300. * Gets or sets the cube face to display.
  40301. * * 0 is +X
  40302. * * 1 is -X
  40303. * * 2 is +Y
  40304. * * 3 is -Y
  40305. * * 4 is +Z
  40306. * * 5 is -Z
  40307. */
  40308. face: number;
  40309. /**
  40310. * Creates the PassCubePostProcess
  40311. * @param name The name of the effect.
  40312. * @param options The required width/height ratio to downsize to before computing the render pass.
  40313. * @param camera The camera to apply the render pass to.
  40314. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40315. * @param engine The engine which the post process will be applied. (default: current engine)
  40316. * @param reusable If the post process can be reused on the same frame. (default: false)
  40317. * @param textureType The type of texture to be used when performing the post processing.
  40318. * @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)
  40319. */
  40320. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40321. }
  40322. }
  40323. declare module "babylonjs/Shaders/anaglyph.fragment" {
  40324. /** @hidden */
  40325. export var anaglyphPixelShader: {
  40326. name: string;
  40327. shader: string;
  40328. };
  40329. }
  40330. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  40331. import { Engine } from "babylonjs/Engines/engine";
  40332. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40333. import { Camera } from "babylonjs/Cameras/camera";
  40334. import "babylonjs/Shaders/anaglyph.fragment";
  40335. /**
  40336. * Postprocess used to generate anaglyphic rendering
  40337. */
  40338. export class AnaglyphPostProcess extends PostProcess {
  40339. private _passedProcess;
  40340. /**
  40341. * Creates a new AnaglyphPostProcess
  40342. * @param name defines postprocess name
  40343. * @param options defines creation options or target ratio scale
  40344. * @param rigCameras defines cameras using this postprocess
  40345. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  40346. * @param engine defines hosting engine
  40347. * @param reusable defines if the postprocess will be reused multiple times per frame
  40348. */
  40349. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  40350. }
  40351. }
  40352. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  40353. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  40354. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40355. import { Scene } from "babylonjs/scene";
  40356. import { Vector3 } from "babylonjs/Maths/math.vector";
  40357. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40358. /**
  40359. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  40360. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40361. */
  40362. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  40363. /**
  40364. * Creates a new AnaglyphArcRotateCamera
  40365. * @param name defines camera name
  40366. * @param alpha defines alpha angle (in radians)
  40367. * @param beta defines beta angle (in radians)
  40368. * @param radius defines radius
  40369. * @param target defines camera target
  40370. * @param interaxialDistance defines distance between each color axis
  40371. * @param scene defines the hosting scene
  40372. */
  40373. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  40374. /**
  40375. * Gets camera class name
  40376. * @returns AnaglyphArcRotateCamera
  40377. */
  40378. getClassName(): string;
  40379. }
  40380. }
  40381. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  40382. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40383. import { Scene } from "babylonjs/scene";
  40384. import { Vector3 } from "babylonjs/Maths/math.vector";
  40385. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40386. /**
  40387. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  40388. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40389. */
  40390. export class AnaglyphFreeCamera extends FreeCamera {
  40391. /**
  40392. * Creates a new AnaglyphFreeCamera
  40393. * @param name defines camera name
  40394. * @param position defines initial position
  40395. * @param interaxialDistance defines distance between each color axis
  40396. * @param scene defines the hosting scene
  40397. */
  40398. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40399. /**
  40400. * Gets camera class name
  40401. * @returns AnaglyphFreeCamera
  40402. */
  40403. getClassName(): string;
  40404. }
  40405. }
  40406. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  40407. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40408. import { Scene } from "babylonjs/scene";
  40409. import { Vector3 } from "babylonjs/Maths/math.vector";
  40410. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40411. /**
  40412. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  40413. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40414. */
  40415. export class AnaglyphGamepadCamera extends GamepadCamera {
  40416. /**
  40417. * Creates a new AnaglyphGamepadCamera
  40418. * @param name defines camera name
  40419. * @param position defines initial position
  40420. * @param interaxialDistance defines distance between each color axis
  40421. * @param scene defines the hosting scene
  40422. */
  40423. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40424. /**
  40425. * Gets camera class name
  40426. * @returns AnaglyphGamepadCamera
  40427. */
  40428. getClassName(): string;
  40429. }
  40430. }
  40431. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  40432. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40433. import { Scene } from "babylonjs/scene";
  40434. import { Vector3 } from "babylonjs/Maths/math.vector";
  40435. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40436. /**
  40437. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  40438. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40439. */
  40440. export class AnaglyphUniversalCamera extends UniversalCamera {
  40441. /**
  40442. * Creates a new AnaglyphUniversalCamera
  40443. * @param name defines camera name
  40444. * @param position defines initial position
  40445. * @param interaxialDistance defines distance between each color axis
  40446. * @param scene defines the hosting scene
  40447. */
  40448. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40449. /**
  40450. * Gets camera class name
  40451. * @returns AnaglyphUniversalCamera
  40452. */
  40453. getClassName(): string;
  40454. }
  40455. }
  40456. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  40457. /** @hidden */
  40458. export var stereoscopicInterlacePixelShader: {
  40459. name: string;
  40460. shader: string;
  40461. };
  40462. }
  40463. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  40464. import { Camera } from "babylonjs/Cameras/camera";
  40465. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40466. import { Engine } from "babylonjs/Engines/engine";
  40467. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  40468. /**
  40469. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  40470. */
  40471. export class StereoscopicInterlacePostProcess extends PostProcess {
  40472. private _stepSize;
  40473. private _passedProcess;
  40474. /**
  40475. * Initializes a StereoscopicInterlacePostProcess
  40476. * @param name The name of the effect.
  40477. * @param rigCameras The rig cameras to be appled to the post process
  40478. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  40479. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40480. * @param engine The engine which the post process will be applied. (default: current engine)
  40481. * @param reusable If the post process can be reused on the same frame. (default: false)
  40482. */
  40483. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  40484. }
  40485. }
  40486. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  40487. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  40488. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40489. import { Scene } from "babylonjs/scene";
  40490. import { Vector3 } from "babylonjs/Maths/math.vector";
  40491. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40492. /**
  40493. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  40494. * @see http://doc.babylonjs.com/features/cameras
  40495. */
  40496. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  40497. /**
  40498. * Creates a new StereoscopicArcRotateCamera
  40499. * @param name defines camera name
  40500. * @param alpha defines alpha angle (in radians)
  40501. * @param beta defines beta angle (in radians)
  40502. * @param radius defines radius
  40503. * @param target defines camera target
  40504. * @param interaxialDistance defines distance between each color axis
  40505. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40506. * @param scene defines the hosting scene
  40507. */
  40508. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40509. /**
  40510. * Gets camera class name
  40511. * @returns StereoscopicArcRotateCamera
  40512. */
  40513. getClassName(): string;
  40514. }
  40515. }
  40516. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  40517. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40518. import { Scene } from "babylonjs/scene";
  40519. import { Vector3 } from "babylonjs/Maths/math.vector";
  40520. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40521. /**
  40522. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  40523. * @see http://doc.babylonjs.com/features/cameras
  40524. */
  40525. export class StereoscopicFreeCamera extends FreeCamera {
  40526. /**
  40527. * Creates a new StereoscopicFreeCamera
  40528. * @param name defines camera name
  40529. * @param position defines initial position
  40530. * @param interaxialDistance defines distance between each color axis
  40531. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40532. * @param scene defines the hosting scene
  40533. */
  40534. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40535. /**
  40536. * Gets camera class name
  40537. * @returns StereoscopicFreeCamera
  40538. */
  40539. getClassName(): string;
  40540. }
  40541. }
  40542. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  40543. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40544. import { Scene } from "babylonjs/scene";
  40545. import { Vector3 } from "babylonjs/Maths/math.vector";
  40546. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40547. /**
  40548. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  40549. * @see http://doc.babylonjs.com/features/cameras
  40550. */
  40551. export class StereoscopicGamepadCamera extends GamepadCamera {
  40552. /**
  40553. * Creates a new StereoscopicGamepadCamera
  40554. * @param name defines camera name
  40555. * @param position defines initial position
  40556. * @param interaxialDistance defines distance between each color axis
  40557. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40558. * @param scene defines the hosting scene
  40559. */
  40560. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40561. /**
  40562. * Gets camera class name
  40563. * @returns StereoscopicGamepadCamera
  40564. */
  40565. getClassName(): string;
  40566. }
  40567. }
  40568. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  40569. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40570. import { Scene } from "babylonjs/scene";
  40571. import { Vector3 } from "babylonjs/Maths/math.vector";
  40572. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40573. /**
  40574. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  40575. * @see http://doc.babylonjs.com/features/cameras
  40576. */
  40577. export class StereoscopicUniversalCamera extends UniversalCamera {
  40578. /**
  40579. * Creates a new StereoscopicUniversalCamera
  40580. * @param name defines camera name
  40581. * @param position defines initial position
  40582. * @param interaxialDistance defines distance between each color axis
  40583. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40584. * @param scene defines the hosting scene
  40585. */
  40586. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40587. /**
  40588. * Gets camera class name
  40589. * @returns StereoscopicUniversalCamera
  40590. */
  40591. getClassName(): string;
  40592. }
  40593. }
  40594. declare module "babylonjs/Cameras/Stereoscopic/index" {
  40595. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  40596. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  40597. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  40598. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  40599. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  40600. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  40601. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  40602. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  40603. }
  40604. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  40605. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40606. import { Scene } from "babylonjs/scene";
  40607. import { Vector3 } from "babylonjs/Maths/math.vector";
  40608. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  40609. /**
  40610. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  40611. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  40612. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  40613. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  40614. */
  40615. export class VirtualJoysticksCamera extends FreeCamera {
  40616. /**
  40617. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  40618. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  40619. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  40620. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  40621. * @param name Define the name of the camera in the scene
  40622. * @param position Define the start position of the camera in the scene
  40623. * @param scene Define the scene the camera belongs to
  40624. */
  40625. constructor(name: string, position: Vector3, scene: Scene);
  40626. /**
  40627. * Gets the current object class name.
  40628. * @return the class name
  40629. */
  40630. getClassName(): string;
  40631. }
  40632. }
  40633. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  40634. import { Matrix } from "babylonjs/Maths/math.vector";
  40635. /**
  40636. * This represents all the required metrics to create a VR camera.
  40637. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  40638. */
  40639. export class VRCameraMetrics {
  40640. /**
  40641. * Define the horizontal resolution off the screen.
  40642. */
  40643. hResolution: number;
  40644. /**
  40645. * Define the vertical resolution off the screen.
  40646. */
  40647. vResolution: number;
  40648. /**
  40649. * Define the horizontal screen size.
  40650. */
  40651. hScreenSize: number;
  40652. /**
  40653. * Define the vertical screen size.
  40654. */
  40655. vScreenSize: number;
  40656. /**
  40657. * Define the vertical screen center position.
  40658. */
  40659. vScreenCenter: number;
  40660. /**
  40661. * Define the distance of the eyes to the screen.
  40662. */
  40663. eyeToScreenDistance: number;
  40664. /**
  40665. * Define the distance between both lenses
  40666. */
  40667. lensSeparationDistance: number;
  40668. /**
  40669. * Define the distance between both viewer's eyes.
  40670. */
  40671. interpupillaryDistance: number;
  40672. /**
  40673. * Define the distortion factor of the VR postprocess.
  40674. * Please, touch with care.
  40675. */
  40676. distortionK: number[];
  40677. /**
  40678. * Define the chromatic aberration correction factors for the VR post process.
  40679. */
  40680. chromaAbCorrection: number[];
  40681. /**
  40682. * Define the scale factor of the post process.
  40683. * The smaller the better but the slower.
  40684. */
  40685. postProcessScaleFactor: number;
  40686. /**
  40687. * Define an offset for the lens center.
  40688. */
  40689. lensCenterOffset: number;
  40690. /**
  40691. * Define if the current vr camera should compensate the distortion of the lense or not.
  40692. */
  40693. compensateDistortion: boolean;
  40694. /**
  40695. * Defines if multiview should be enabled when rendering (Default: false)
  40696. */
  40697. multiviewEnabled: boolean;
  40698. /**
  40699. * Gets the rendering aspect ratio based on the provided resolutions.
  40700. */
  40701. readonly aspectRatio: number;
  40702. /**
  40703. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  40704. */
  40705. readonly aspectRatioFov: number;
  40706. /**
  40707. * @hidden
  40708. */
  40709. readonly leftHMatrix: Matrix;
  40710. /**
  40711. * @hidden
  40712. */
  40713. readonly rightHMatrix: Matrix;
  40714. /**
  40715. * @hidden
  40716. */
  40717. readonly leftPreViewMatrix: Matrix;
  40718. /**
  40719. * @hidden
  40720. */
  40721. readonly rightPreViewMatrix: Matrix;
  40722. /**
  40723. * Get the default VRMetrics based on the most generic setup.
  40724. * @returns the default vr metrics
  40725. */
  40726. static GetDefault(): VRCameraMetrics;
  40727. }
  40728. }
  40729. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  40730. /** @hidden */
  40731. export var vrDistortionCorrectionPixelShader: {
  40732. name: string;
  40733. shader: string;
  40734. };
  40735. }
  40736. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  40737. import { Camera } from "babylonjs/Cameras/camera";
  40738. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40739. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40740. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  40741. /**
  40742. * VRDistortionCorrectionPostProcess used for mobile VR
  40743. */
  40744. export class VRDistortionCorrectionPostProcess extends PostProcess {
  40745. private _isRightEye;
  40746. private _distortionFactors;
  40747. private _postProcessScaleFactor;
  40748. private _lensCenterOffset;
  40749. private _scaleIn;
  40750. private _scaleFactor;
  40751. private _lensCenter;
  40752. /**
  40753. * Initializes the VRDistortionCorrectionPostProcess
  40754. * @param name The name of the effect.
  40755. * @param camera The camera to apply the render pass to.
  40756. * @param isRightEye If this is for the right eye distortion
  40757. * @param vrMetrics All the required metrics for the VR camera
  40758. */
  40759. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  40760. }
  40761. }
  40762. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  40763. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  40764. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40765. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40766. import { Scene } from "babylonjs/scene";
  40767. import { Vector3 } from "babylonjs/Maths/math.vector";
  40768. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  40769. import "babylonjs/Cameras/RigModes/vrRigMode";
  40770. /**
  40771. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  40772. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40773. */
  40774. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  40775. /**
  40776. * Creates a new VRDeviceOrientationArcRotateCamera
  40777. * @param name defines camera name
  40778. * @param alpha defines the camera rotation along the logitudinal axis
  40779. * @param beta defines the camera rotation along the latitudinal axis
  40780. * @param radius defines the camera distance from its target
  40781. * @param target defines the camera target
  40782. * @param scene defines the scene the camera belongs to
  40783. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40784. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40785. */
  40786. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40787. /**
  40788. * Gets camera class name
  40789. * @returns VRDeviceOrientationArcRotateCamera
  40790. */
  40791. getClassName(): string;
  40792. }
  40793. }
  40794. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  40795. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  40796. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40797. import { Scene } from "babylonjs/scene";
  40798. import { Vector3 } from "babylonjs/Maths/math.vector";
  40799. import "babylonjs/Cameras/RigModes/vrRigMode";
  40800. /**
  40801. * Camera used to simulate VR rendering (based on FreeCamera)
  40802. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40803. */
  40804. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  40805. /**
  40806. * Creates a new VRDeviceOrientationFreeCamera
  40807. * @param name defines camera name
  40808. * @param position defines the start position of the camera
  40809. * @param scene defines the scene the camera belongs to
  40810. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40811. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40812. */
  40813. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40814. /**
  40815. * Gets camera class name
  40816. * @returns VRDeviceOrientationFreeCamera
  40817. */
  40818. getClassName(): string;
  40819. }
  40820. }
  40821. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  40822. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  40823. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40824. import { Scene } from "babylonjs/scene";
  40825. import { Vector3 } from "babylonjs/Maths/math.vector";
  40826. import "babylonjs/Gamepads/gamepadSceneComponent";
  40827. /**
  40828. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  40829. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40830. */
  40831. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  40832. /**
  40833. * Creates a new VRDeviceOrientationGamepadCamera
  40834. * @param name defines camera name
  40835. * @param position defines the start position of the camera
  40836. * @param scene defines the scene the camera belongs to
  40837. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40838. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40839. */
  40840. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40841. /**
  40842. * Gets camera class name
  40843. * @returns VRDeviceOrientationGamepadCamera
  40844. */
  40845. getClassName(): string;
  40846. }
  40847. }
  40848. declare module "babylonjs/Materials/pushMaterial" {
  40849. import { Nullable } from "babylonjs/types";
  40850. import { Scene } from "babylonjs/scene";
  40851. import { Matrix } from "babylonjs/Maths/math.vector";
  40852. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40853. import { Mesh } from "babylonjs/Meshes/mesh";
  40854. import { Material } from "babylonjs/Materials/material";
  40855. import { Effect } from "babylonjs/Materials/effect";
  40856. /**
  40857. * Base class of materials working in push mode in babylon JS
  40858. * @hidden
  40859. */
  40860. export class PushMaterial extends Material {
  40861. protected _activeEffect: Effect;
  40862. protected _normalMatrix: Matrix;
  40863. /**
  40864. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  40865. * This means that the material can keep using a previous shader while a new one is being compiled.
  40866. * This is mostly used when shader parallel compilation is supported (true by default)
  40867. */
  40868. allowShaderHotSwapping: boolean;
  40869. constructor(name: string, scene: Scene);
  40870. getEffect(): Effect;
  40871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  40872. /**
  40873. * Binds the given world matrix to the active effect
  40874. *
  40875. * @param world the matrix to bind
  40876. */
  40877. bindOnlyWorldMatrix(world: Matrix): void;
  40878. /**
  40879. * Binds the given normal matrix to the active effect
  40880. *
  40881. * @param normalMatrix the matrix to bind
  40882. */
  40883. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  40884. bind(world: Matrix, mesh?: Mesh): void;
  40885. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  40886. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  40887. }
  40888. }
  40889. declare module "babylonjs/Materials/materialFlags" {
  40890. /**
  40891. * This groups all the flags used to control the materials channel.
  40892. */
  40893. export class MaterialFlags {
  40894. private static _DiffuseTextureEnabled;
  40895. /**
  40896. * Are diffuse textures enabled in the application.
  40897. */
  40898. static DiffuseTextureEnabled: boolean;
  40899. private static _AmbientTextureEnabled;
  40900. /**
  40901. * Are ambient textures enabled in the application.
  40902. */
  40903. static AmbientTextureEnabled: boolean;
  40904. private static _OpacityTextureEnabled;
  40905. /**
  40906. * Are opacity textures enabled in the application.
  40907. */
  40908. static OpacityTextureEnabled: boolean;
  40909. private static _ReflectionTextureEnabled;
  40910. /**
  40911. * Are reflection textures enabled in the application.
  40912. */
  40913. static ReflectionTextureEnabled: boolean;
  40914. private static _EmissiveTextureEnabled;
  40915. /**
  40916. * Are emissive textures enabled in the application.
  40917. */
  40918. static EmissiveTextureEnabled: boolean;
  40919. private static _SpecularTextureEnabled;
  40920. /**
  40921. * Are specular textures enabled in the application.
  40922. */
  40923. static SpecularTextureEnabled: boolean;
  40924. private static _BumpTextureEnabled;
  40925. /**
  40926. * Are bump textures enabled in the application.
  40927. */
  40928. static BumpTextureEnabled: boolean;
  40929. private static _LightmapTextureEnabled;
  40930. /**
  40931. * Are lightmap textures enabled in the application.
  40932. */
  40933. static LightmapTextureEnabled: boolean;
  40934. private static _RefractionTextureEnabled;
  40935. /**
  40936. * Are refraction textures enabled in the application.
  40937. */
  40938. static RefractionTextureEnabled: boolean;
  40939. private static _ColorGradingTextureEnabled;
  40940. /**
  40941. * Are color grading textures enabled in the application.
  40942. */
  40943. static ColorGradingTextureEnabled: boolean;
  40944. private static _FresnelEnabled;
  40945. /**
  40946. * Are fresnels enabled in the application.
  40947. */
  40948. static FresnelEnabled: boolean;
  40949. private static _ClearCoatTextureEnabled;
  40950. /**
  40951. * Are clear coat textures enabled in the application.
  40952. */
  40953. static ClearCoatTextureEnabled: boolean;
  40954. private static _ClearCoatBumpTextureEnabled;
  40955. /**
  40956. * Are clear coat bump textures enabled in the application.
  40957. */
  40958. static ClearCoatBumpTextureEnabled: boolean;
  40959. private static _ClearCoatTintTextureEnabled;
  40960. /**
  40961. * Are clear coat tint textures enabled in the application.
  40962. */
  40963. static ClearCoatTintTextureEnabled: boolean;
  40964. private static _SheenTextureEnabled;
  40965. /**
  40966. * Are sheen textures enabled in the application.
  40967. */
  40968. static SheenTextureEnabled: boolean;
  40969. private static _AnisotropicTextureEnabled;
  40970. /**
  40971. * Are anisotropic textures enabled in the application.
  40972. */
  40973. static AnisotropicTextureEnabled: boolean;
  40974. private static _ThicknessTextureEnabled;
  40975. /**
  40976. * Are thickness textures enabled in the application.
  40977. */
  40978. static ThicknessTextureEnabled: boolean;
  40979. }
  40980. }
  40981. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  40982. /** @hidden */
  40983. export var defaultFragmentDeclaration: {
  40984. name: string;
  40985. shader: string;
  40986. };
  40987. }
  40988. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  40989. /** @hidden */
  40990. export var defaultUboDeclaration: {
  40991. name: string;
  40992. shader: string;
  40993. };
  40994. }
  40995. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  40996. /** @hidden */
  40997. export var lightFragmentDeclaration: {
  40998. name: string;
  40999. shader: string;
  41000. };
  41001. }
  41002. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41003. /** @hidden */
  41004. export var lightUboDeclaration: {
  41005. name: string;
  41006. shader: string;
  41007. };
  41008. }
  41009. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41010. /** @hidden */
  41011. export var lightsFragmentFunctions: {
  41012. name: string;
  41013. shader: string;
  41014. };
  41015. }
  41016. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41017. /** @hidden */
  41018. export var shadowsFragmentFunctions: {
  41019. name: string;
  41020. shader: string;
  41021. };
  41022. }
  41023. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41024. /** @hidden */
  41025. export var fresnelFunction: {
  41026. name: string;
  41027. shader: string;
  41028. };
  41029. }
  41030. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41031. /** @hidden */
  41032. export var reflectionFunction: {
  41033. name: string;
  41034. shader: string;
  41035. };
  41036. }
  41037. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41038. /** @hidden */
  41039. export var bumpFragmentFunctions: {
  41040. name: string;
  41041. shader: string;
  41042. };
  41043. }
  41044. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41045. /** @hidden */
  41046. export var logDepthDeclaration: {
  41047. name: string;
  41048. shader: string;
  41049. };
  41050. }
  41051. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41052. /** @hidden */
  41053. export var bumpFragment: {
  41054. name: string;
  41055. shader: string;
  41056. };
  41057. }
  41058. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41059. /** @hidden */
  41060. export var depthPrePass: {
  41061. name: string;
  41062. shader: string;
  41063. };
  41064. }
  41065. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41066. /** @hidden */
  41067. export var lightFragment: {
  41068. name: string;
  41069. shader: string;
  41070. };
  41071. }
  41072. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41073. /** @hidden */
  41074. export var logDepthFragment: {
  41075. name: string;
  41076. shader: string;
  41077. };
  41078. }
  41079. declare module "babylonjs/Shaders/default.fragment" {
  41080. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41081. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41082. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41083. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41084. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41085. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41086. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41087. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41088. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41089. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41090. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41091. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41092. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41093. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41094. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41095. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41096. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41097. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41098. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41099. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41100. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41101. /** @hidden */
  41102. export var defaultPixelShader: {
  41103. name: string;
  41104. shader: string;
  41105. };
  41106. }
  41107. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41108. /** @hidden */
  41109. export var defaultVertexDeclaration: {
  41110. name: string;
  41111. shader: string;
  41112. };
  41113. }
  41114. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41115. /** @hidden */
  41116. export var bumpVertexDeclaration: {
  41117. name: string;
  41118. shader: string;
  41119. };
  41120. }
  41121. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41122. /** @hidden */
  41123. export var bumpVertex: {
  41124. name: string;
  41125. shader: string;
  41126. };
  41127. }
  41128. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41129. /** @hidden */
  41130. export var fogVertex: {
  41131. name: string;
  41132. shader: string;
  41133. };
  41134. }
  41135. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41136. /** @hidden */
  41137. export var shadowsVertex: {
  41138. name: string;
  41139. shader: string;
  41140. };
  41141. }
  41142. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41143. /** @hidden */
  41144. export var pointCloudVertex: {
  41145. name: string;
  41146. shader: string;
  41147. };
  41148. }
  41149. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41150. /** @hidden */
  41151. export var logDepthVertex: {
  41152. name: string;
  41153. shader: string;
  41154. };
  41155. }
  41156. declare module "babylonjs/Shaders/default.vertex" {
  41157. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41158. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41159. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41160. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41161. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41162. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41163. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41164. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41165. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41166. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41167. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41168. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41169. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41170. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41171. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41172. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41173. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41174. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41175. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41176. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41177. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41178. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41179. /** @hidden */
  41180. export var defaultVertexShader: {
  41181. name: string;
  41182. shader: string;
  41183. };
  41184. }
  41185. declare module "babylonjs/Materials/standardMaterial" {
  41186. import { SmartArray } from "babylonjs/Misc/smartArray";
  41187. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41188. import { Nullable } from "babylonjs/types";
  41189. import { Scene } from "babylonjs/scene";
  41190. import { Matrix } from "babylonjs/Maths/math.vector";
  41191. import { Color3 } from "babylonjs/Maths/math.color";
  41192. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41194. import { Mesh } from "babylonjs/Meshes/mesh";
  41195. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41196. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41197. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41198. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41199. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41200. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41201. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41202. import "babylonjs/Shaders/default.fragment";
  41203. import "babylonjs/Shaders/default.vertex";
  41204. /** @hidden */
  41205. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41206. MAINUV1: boolean;
  41207. MAINUV2: boolean;
  41208. DIFFUSE: boolean;
  41209. DIFFUSEDIRECTUV: number;
  41210. AMBIENT: boolean;
  41211. AMBIENTDIRECTUV: number;
  41212. OPACITY: boolean;
  41213. OPACITYDIRECTUV: number;
  41214. OPACITYRGB: boolean;
  41215. REFLECTION: boolean;
  41216. EMISSIVE: boolean;
  41217. EMISSIVEDIRECTUV: number;
  41218. SPECULAR: boolean;
  41219. SPECULARDIRECTUV: number;
  41220. BUMP: boolean;
  41221. BUMPDIRECTUV: number;
  41222. PARALLAX: boolean;
  41223. PARALLAXOCCLUSION: boolean;
  41224. SPECULAROVERALPHA: boolean;
  41225. CLIPPLANE: boolean;
  41226. CLIPPLANE2: boolean;
  41227. CLIPPLANE3: boolean;
  41228. CLIPPLANE4: boolean;
  41229. ALPHATEST: boolean;
  41230. DEPTHPREPASS: boolean;
  41231. ALPHAFROMDIFFUSE: boolean;
  41232. POINTSIZE: boolean;
  41233. FOG: boolean;
  41234. SPECULARTERM: boolean;
  41235. DIFFUSEFRESNEL: boolean;
  41236. OPACITYFRESNEL: boolean;
  41237. REFLECTIONFRESNEL: boolean;
  41238. REFRACTIONFRESNEL: boolean;
  41239. EMISSIVEFRESNEL: boolean;
  41240. FRESNEL: boolean;
  41241. NORMAL: boolean;
  41242. UV1: boolean;
  41243. UV2: boolean;
  41244. VERTEXCOLOR: boolean;
  41245. VERTEXALPHA: boolean;
  41246. NUM_BONE_INFLUENCERS: number;
  41247. BonesPerMesh: number;
  41248. BONETEXTURE: boolean;
  41249. INSTANCES: boolean;
  41250. GLOSSINESS: boolean;
  41251. ROUGHNESS: boolean;
  41252. EMISSIVEASILLUMINATION: boolean;
  41253. LINKEMISSIVEWITHDIFFUSE: boolean;
  41254. REFLECTIONFRESNELFROMSPECULAR: boolean;
  41255. LIGHTMAP: boolean;
  41256. LIGHTMAPDIRECTUV: number;
  41257. OBJECTSPACE_NORMALMAP: boolean;
  41258. USELIGHTMAPASSHADOWMAP: boolean;
  41259. REFLECTIONMAP_3D: boolean;
  41260. REFLECTIONMAP_SPHERICAL: boolean;
  41261. REFLECTIONMAP_PLANAR: boolean;
  41262. REFLECTIONMAP_CUBIC: boolean;
  41263. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  41264. REFLECTIONMAP_PROJECTION: boolean;
  41265. REFLECTIONMAP_SKYBOX: boolean;
  41266. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  41267. REFLECTIONMAP_EXPLICIT: boolean;
  41268. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  41269. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  41270. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  41271. INVERTCUBICMAP: boolean;
  41272. LOGARITHMICDEPTH: boolean;
  41273. REFRACTION: boolean;
  41274. REFRACTIONMAP_3D: boolean;
  41275. REFLECTIONOVERALPHA: boolean;
  41276. TWOSIDEDLIGHTING: boolean;
  41277. SHADOWFLOAT: boolean;
  41278. MORPHTARGETS: boolean;
  41279. MORPHTARGETS_NORMAL: boolean;
  41280. MORPHTARGETS_TANGENT: boolean;
  41281. MORPHTARGETS_UV: boolean;
  41282. NUM_MORPH_INFLUENCERS: number;
  41283. NONUNIFORMSCALING: boolean;
  41284. PREMULTIPLYALPHA: boolean;
  41285. IMAGEPROCESSING: boolean;
  41286. VIGNETTE: boolean;
  41287. VIGNETTEBLENDMODEMULTIPLY: boolean;
  41288. VIGNETTEBLENDMODEOPAQUE: boolean;
  41289. TONEMAPPING: boolean;
  41290. TONEMAPPING_ACES: boolean;
  41291. CONTRAST: boolean;
  41292. COLORCURVES: boolean;
  41293. COLORGRADING: boolean;
  41294. COLORGRADING3D: boolean;
  41295. SAMPLER3DGREENDEPTH: boolean;
  41296. SAMPLER3DBGRMAP: boolean;
  41297. IMAGEPROCESSINGPOSTPROCESS: boolean;
  41298. MULTIVIEW: boolean;
  41299. /**
  41300. * If the reflection texture on this material is in linear color space
  41301. * @hidden
  41302. */
  41303. IS_REFLECTION_LINEAR: boolean;
  41304. /**
  41305. * If the refraction texture on this material is in linear color space
  41306. * @hidden
  41307. */
  41308. IS_REFRACTION_LINEAR: boolean;
  41309. EXPOSURE: boolean;
  41310. constructor();
  41311. setReflectionMode(modeToEnable: string): void;
  41312. }
  41313. /**
  41314. * This is the default material used in Babylon. It is the best trade off between quality
  41315. * and performances.
  41316. * @see http://doc.babylonjs.com/babylon101/materials
  41317. */
  41318. export class StandardMaterial extends PushMaterial {
  41319. private _diffuseTexture;
  41320. /**
  41321. * The basic texture of the material as viewed under a light.
  41322. */
  41323. diffuseTexture: Nullable<BaseTexture>;
  41324. private _ambientTexture;
  41325. /**
  41326. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  41327. */
  41328. ambientTexture: Nullable<BaseTexture>;
  41329. private _opacityTexture;
  41330. /**
  41331. * Define the transparency of the material from a texture.
  41332. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  41333. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  41334. */
  41335. opacityTexture: Nullable<BaseTexture>;
  41336. private _reflectionTexture;
  41337. /**
  41338. * Define the texture used to display the reflection.
  41339. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41340. */
  41341. reflectionTexture: Nullable<BaseTexture>;
  41342. private _emissiveTexture;
  41343. /**
  41344. * Define texture of the material as if self lit.
  41345. * This will be mixed in the final result even in the absence of light.
  41346. */
  41347. emissiveTexture: Nullable<BaseTexture>;
  41348. private _specularTexture;
  41349. /**
  41350. * Define how the color and intensity of the highlight given by the light in the material.
  41351. */
  41352. specularTexture: Nullable<BaseTexture>;
  41353. private _bumpTexture;
  41354. /**
  41355. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  41356. * 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.
  41357. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  41358. */
  41359. bumpTexture: Nullable<BaseTexture>;
  41360. private _lightmapTexture;
  41361. /**
  41362. * Complex lighting can be computationally expensive to compute at runtime.
  41363. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  41364. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  41365. */
  41366. lightmapTexture: Nullable<BaseTexture>;
  41367. private _refractionTexture;
  41368. /**
  41369. * Define the texture used to display the refraction.
  41370. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41371. */
  41372. refractionTexture: Nullable<BaseTexture>;
  41373. /**
  41374. * The color of the material lit by the environmental background lighting.
  41375. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  41376. */
  41377. ambientColor: Color3;
  41378. /**
  41379. * The basic color of the material as viewed under a light.
  41380. */
  41381. diffuseColor: Color3;
  41382. /**
  41383. * Define how the color and intensity of the highlight given by the light in the material.
  41384. */
  41385. specularColor: Color3;
  41386. /**
  41387. * Define the color of the material as if self lit.
  41388. * This will be mixed in the final result even in the absence of light.
  41389. */
  41390. emissiveColor: Color3;
  41391. /**
  41392. * Defines how sharp are the highlights in the material.
  41393. * The bigger the value the sharper giving a more glossy feeling to the result.
  41394. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  41395. */
  41396. specularPower: number;
  41397. private _useAlphaFromDiffuseTexture;
  41398. /**
  41399. * Does the transparency come from the diffuse texture alpha channel.
  41400. */
  41401. useAlphaFromDiffuseTexture: boolean;
  41402. private _useEmissiveAsIllumination;
  41403. /**
  41404. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  41405. */
  41406. useEmissiveAsIllumination: boolean;
  41407. private _linkEmissiveWithDiffuse;
  41408. /**
  41409. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  41410. * the emissive level when the final color is close to one.
  41411. */
  41412. linkEmissiveWithDiffuse: boolean;
  41413. private _useSpecularOverAlpha;
  41414. /**
  41415. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  41416. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  41417. */
  41418. useSpecularOverAlpha: boolean;
  41419. private _useReflectionOverAlpha;
  41420. /**
  41421. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  41422. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  41423. */
  41424. useReflectionOverAlpha: boolean;
  41425. private _disableLighting;
  41426. /**
  41427. * Does lights from the scene impacts this material.
  41428. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  41429. */
  41430. disableLighting: boolean;
  41431. private _useObjectSpaceNormalMap;
  41432. /**
  41433. * Allows using an object space normal map (instead of tangent space).
  41434. */
  41435. useObjectSpaceNormalMap: boolean;
  41436. private _useParallax;
  41437. /**
  41438. * Is parallax enabled or not.
  41439. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41440. */
  41441. useParallax: boolean;
  41442. private _useParallaxOcclusion;
  41443. /**
  41444. * Is parallax occlusion enabled or not.
  41445. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  41446. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41447. */
  41448. useParallaxOcclusion: boolean;
  41449. /**
  41450. * 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.
  41451. */
  41452. parallaxScaleBias: number;
  41453. private _roughness;
  41454. /**
  41455. * Helps to define how blurry the reflections should appears in the material.
  41456. */
  41457. roughness: number;
  41458. /**
  41459. * In case of refraction, define the value of the index of refraction.
  41460. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41461. */
  41462. indexOfRefraction: number;
  41463. /**
  41464. * Invert the refraction texture alongside the y axis.
  41465. * It can be useful with procedural textures or probe for instance.
  41466. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41467. */
  41468. invertRefractionY: boolean;
  41469. /**
  41470. * Defines the alpha limits in alpha test mode.
  41471. */
  41472. alphaCutOff: number;
  41473. private _useLightmapAsShadowmap;
  41474. /**
  41475. * In case of light mapping, define whether the map contains light or shadow informations.
  41476. */
  41477. useLightmapAsShadowmap: boolean;
  41478. private _diffuseFresnelParameters;
  41479. /**
  41480. * Define the diffuse fresnel parameters of the material.
  41481. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41482. */
  41483. diffuseFresnelParameters: FresnelParameters;
  41484. private _opacityFresnelParameters;
  41485. /**
  41486. * Define the opacity fresnel parameters of the material.
  41487. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41488. */
  41489. opacityFresnelParameters: FresnelParameters;
  41490. private _reflectionFresnelParameters;
  41491. /**
  41492. * Define the reflection fresnel parameters of the material.
  41493. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41494. */
  41495. reflectionFresnelParameters: FresnelParameters;
  41496. private _refractionFresnelParameters;
  41497. /**
  41498. * Define the refraction fresnel parameters of the material.
  41499. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41500. */
  41501. refractionFresnelParameters: FresnelParameters;
  41502. private _emissiveFresnelParameters;
  41503. /**
  41504. * Define the emissive fresnel parameters of the material.
  41505. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41506. */
  41507. emissiveFresnelParameters: FresnelParameters;
  41508. private _useReflectionFresnelFromSpecular;
  41509. /**
  41510. * If true automatically deducts the fresnels values from the material specularity.
  41511. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41512. */
  41513. useReflectionFresnelFromSpecular: boolean;
  41514. private _useGlossinessFromSpecularMapAlpha;
  41515. /**
  41516. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  41517. */
  41518. useGlossinessFromSpecularMapAlpha: boolean;
  41519. private _maxSimultaneousLights;
  41520. /**
  41521. * Defines the maximum number of lights that can be used in the material
  41522. */
  41523. maxSimultaneousLights: number;
  41524. private _invertNormalMapX;
  41525. /**
  41526. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  41527. */
  41528. invertNormalMapX: boolean;
  41529. private _invertNormalMapY;
  41530. /**
  41531. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  41532. */
  41533. invertNormalMapY: boolean;
  41534. private _twoSidedLighting;
  41535. /**
  41536. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  41537. */
  41538. twoSidedLighting: boolean;
  41539. /**
  41540. * Default configuration related to image processing available in the standard Material.
  41541. */
  41542. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  41543. /**
  41544. * Gets the image processing configuration used either in this material.
  41545. */
  41546. /**
  41547. * Sets the Default image processing configuration used either in the this material.
  41548. *
  41549. * If sets to null, the scene one is in use.
  41550. */
  41551. imageProcessingConfiguration: ImageProcessingConfiguration;
  41552. /**
  41553. * Keep track of the image processing observer to allow dispose and replace.
  41554. */
  41555. private _imageProcessingObserver;
  41556. /**
  41557. * Attaches a new image processing configuration to the Standard Material.
  41558. * @param configuration
  41559. */
  41560. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  41561. /**
  41562. * Gets wether the color curves effect is enabled.
  41563. */
  41564. /**
  41565. * Sets wether the color curves effect is enabled.
  41566. */
  41567. cameraColorCurvesEnabled: boolean;
  41568. /**
  41569. * Gets wether the color grading effect is enabled.
  41570. */
  41571. /**
  41572. * Gets wether the color grading effect is enabled.
  41573. */
  41574. cameraColorGradingEnabled: boolean;
  41575. /**
  41576. * Gets wether tonemapping is enabled or not.
  41577. */
  41578. /**
  41579. * Sets wether tonemapping is enabled or not
  41580. */
  41581. cameraToneMappingEnabled: boolean;
  41582. /**
  41583. * The camera exposure used on this material.
  41584. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  41585. * This corresponds to a photographic exposure.
  41586. */
  41587. /**
  41588. * The camera exposure used on this material.
  41589. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  41590. * This corresponds to a photographic exposure.
  41591. */
  41592. cameraExposure: number;
  41593. /**
  41594. * Gets The camera contrast used on this material.
  41595. */
  41596. /**
  41597. * Sets The camera contrast used on this material.
  41598. */
  41599. cameraContrast: number;
  41600. /**
  41601. * Gets the Color Grading 2D Lookup Texture.
  41602. */
  41603. /**
  41604. * Sets the Color Grading 2D Lookup Texture.
  41605. */
  41606. cameraColorGradingTexture: Nullable<BaseTexture>;
  41607. /**
  41608. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  41609. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  41610. * 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;
  41611. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  41612. */
  41613. /**
  41614. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  41615. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  41616. * 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;
  41617. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  41618. */
  41619. cameraColorCurves: Nullable<ColorCurves>;
  41620. /**
  41621. * Custom callback helping to override the default shader used in the material.
  41622. */
  41623. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  41624. protected _renderTargets: SmartArray<RenderTargetTexture>;
  41625. protected _worldViewProjectionMatrix: Matrix;
  41626. protected _globalAmbientColor: Color3;
  41627. protected _useLogarithmicDepth: boolean;
  41628. protected _rebuildInParallel: boolean;
  41629. /**
  41630. * Instantiates a new standard material.
  41631. * This is the default material used in Babylon. It is the best trade off between quality
  41632. * and performances.
  41633. * @see http://doc.babylonjs.com/babylon101/materials
  41634. * @param name Define the name of the material in the scene
  41635. * @param scene Define the scene the material belong to
  41636. */
  41637. constructor(name: string, scene: Scene);
  41638. /**
  41639. * Gets a boolean indicating that current material needs to register RTT
  41640. */
  41641. readonly hasRenderTargetTextures: boolean;
  41642. /**
  41643. * Gets the current class name of the material e.g. "StandardMaterial"
  41644. * Mainly use in serialization.
  41645. * @returns the class name
  41646. */
  41647. getClassName(): string;
  41648. /**
  41649. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  41650. * You can try switching to logarithmic depth.
  41651. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  41652. */
  41653. useLogarithmicDepth: boolean;
  41654. /**
  41655. * Specifies if the material will require alpha blending
  41656. * @returns a boolean specifying if alpha blending is needed
  41657. */
  41658. needAlphaBlending(): boolean;
  41659. /**
  41660. * Specifies if this material should be rendered in alpha test mode
  41661. * @returns a boolean specifying if an alpha test is needed.
  41662. */
  41663. needAlphaTesting(): boolean;
  41664. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  41665. /**
  41666. * Get the texture used for alpha test purpose.
  41667. * @returns the diffuse texture in case of the standard material.
  41668. */
  41669. getAlphaTestTexture(): Nullable<BaseTexture>;
  41670. /**
  41671. * Get if the submesh is ready to be used and all its information available.
  41672. * Child classes can use it to update shaders
  41673. * @param mesh defines the mesh to check
  41674. * @param subMesh defines which submesh to check
  41675. * @param useInstances specifies that instances should be used
  41676. * @returns a boolean indicating that the submesh is ready or not
  41677. */
  41678. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  41679. /**
  41680. * Builds the material UBO layouts.
  41681. * Used internally during the effect preparation.
  41682. */
  41683. buildUniformLayout(): void;
  41684. /**
  41685. * Unbinds the material from the mesh
  41686. */
  41687. unbind(): void;
  41688. /**
  41689. * Binds the submesh to this material by preparing the effect and shader to draw
  41690. * @param world defines the world transformation matrix
  41691. * @param mesh defines the mesh containing the submesh
  41692. * @param subMesh defines the submesh to bind the material to
  41693. */
  41694. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  41695. /**
  41696. * Get the list of animatables in the material.
  41697. * @returns the list of animatables object used in the material
  41698. */
  41699. getAnimatables(): IAnimatable[];
  41700. /**
  41701. * Gets the active textures from the material
  41702. * @returns an array of textures
  41703. */
  41704. getActiveTextures(): BaseTexture[];
  41705. /**
  41706. * Specifies if the material uses a texture
  41707. * @param texture defines the texture to check against the material
  41708. * @returns a boolean specifying if the material uses the texture
  41709. */
  41710. hasTexture(texture: BaseTexture): boolean;
  41711. /**
  41712. * Disposes the material
  41713. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  41714. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  41715. */
  41716. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  41717. /**
  41718. * Makes a duplicate of the material, and gives it a new name
  41719. * @param name defines the new name for the duplicated material
  41720. * @returns the cloned material
  41721. */
  41722. clone(name: string): StandardMaterial;
  41723. /**
  41724. * Serializes this material in a JSON representation
  41725. * @returns the serialized material object
  41726. */
  41727. serialize(): any;
  41728. /**
  41729. * Creates a standard material from parsed material data
  41730. * @param source defines the JSON representation of the material
  41731. * @param scene defines the hosting scene
  41732. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  41733. * @returns a new standard material
  41734. */
  41735. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  41736. /**
  41737. * Are diffuse textures enabled in the application.
  41738. */
  41739. static DiffuseTextureEnabled: boolean;
  41740. /**
  41741. * Are ambient textures enabled in the application.
  41742. */
  41743. static AmbientTextureEnabled: boolean;
  41744. /**
  41745. * Are opacity textures enabled in the application.
  41746. */
  41747. static OpacityTextureEnabled: boolean;
  41748. /**
  41749. * Are reflection textures enabled in the application.
  41750. */
  41751. static ReflectionTextureEnabled: boolean;
  41752. /**
  41753. * Are emissive textures enabled in the application.
  41754. */
  41755. static EmissiveTextureEnabled: boolean;
  41756. /**
  41757. * Are specular textures enabled in the application.
  41758. */
  41759. static SpecularTextureEnabled: boolean;
  41760. /**
  41761. * Are bump textures enabled in the application.
  41762. */
  41763. static BumpTextureEnabled: boolean;
  41764. /**
  41765. * Are lightmap textures enabled in the application.
  41766. */
  41767. static LightmapTextureEnabled: boolean;
  41768. /**
  41769. * Are refraction textures enabled in the application.
  41770. */
  41771. static RefractionTextureEnabled: boolean;
  41772. /**
  41773. * Are color grading textures enabled in the application.
  41774. */
  41775. static ColorGradingTextureEnabled: boolean;
  41776. /**
  41777. * Are fresnels enabled in the application.
  41778. */
  41779. static FresnelEnabled: boolean;
  41780. }
  41781. }
  41782. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  41783. import { Scene } from "babylonjs/scene";
  41784. import { Texture } from "babylonjs/Materials/Textures/texture";
  41785. /**
  41786. * A class extending Texture allowing drawing on a texture
  41787. * @see http://doc.babylonjs.com/how_to/dynamictexture
  41788. */
  41789. export class DynamicTexture extends Texture {
  41790. private _generateMipMaps;
  41791. private _canvas;
  41792. private _context;
  41793. private _engine;
  41794. /**
  41795. * Creates a DynamicTexture
  41796. * @param name defines the name of the texture
  41797. * @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
  41798. * @param scene defines the scene where you want the texture
  41799. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  41800. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  41801. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  41802. */
  41803. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  41804. /**
  41805. * Get the current class name of the texture useful for serialization or dynamic coding.
  41806. * @returns "DynamicTexture"
  41807. */
  41808. getClassName(): string;
  41809. /**
  41810. * Gets the current state of canRescale
  41811. */
  41812. readonly canRescale: boolean;
  41813. private _recreate;
  41814. /**
  41815. * Scales the texture
  41816. * @param ratio the scale factor to apply to both width and height
  41817. */
  41818. scale(ratio: number): void;
  41819. /**
  41820. * Resizes the texture
  41821. * @param width the new width
  41822. * @param height the new height
  41823. */
  41824. scaleTo(width: number, height: number): void;
  41825. /**
  41826. * Gets the context of the canvas used by the texture
  41827. * @returns the canvas context of the dynamic texture
  41828. */
  41829. getContext(): CanvasRenderingContext2D;
  41830. /**
  41831. * Clears the texture
  41832. */
  41833. clear(): void;
  41834. /**
  41835. * Updates the texture
  41836. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  41837. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  41838. */
  41839. update(invertY?: boolean, premulAlpha?: boolean): void;
  41840. /**
  41841. * Draws text onto the texture
  41842. * @param text defines the text to be drawn
  41843. * @param x defines the placement of the text from the left
  41844. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  41845. * @param font defines the font to be used with font-style, font-size, font-name
  41846. * @param color defines the color used for the text
  41847. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  41848. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  41849. * @param update defines whether texture is immediately update (default is true)
  41850. */
  41851. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  41852. /**
  41853. * Clones the texture
  41854. * @returns the clone of the texture.
  41855. */
  41856. clone(): DynamicTexture;
  41857. /**
  41858. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  41859. * @returns a serialized dynamic texture object
  41860. */
  41861. serialize(): any;
  41862. /** @hidden */
  41863. _rebuild(): void;
  41864. }
  41865. }
  41866. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  41867. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41868. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41869. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41870. /** @hidden */
  41871. export var imageProcessingPixelShader: {
  41872. name: string;
  41873. shader: string;
  41874. };
  41875. }
  41876. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  41877. import { Nullable } from "babylonjs/types";
  41878. import { Color4 } from "babylonjs/Maths/math.color";
  41879. import { Camera } from "babylonjs/Cameras/camera";
  41880. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41881. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41882. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  41883. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41884. import { Engine } from "babylonjs/Engines/engine";
  41885. import "babylonjs/Shaders/imageProcessing.fragment";
  41886. import "babylonjs/Shaders/postprocess.vertex";
  41887. /**
  41888. * ImageProcessingPostProcess
  41889. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  41890. */
  41891. export class ImageProcessingPostProcess extends PostProcess {
  41892. /**
  41893. * Default configuration related to image processing available in the PBR Material.
  41894. */
  41895. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  41896. /**
  41897. * Gets the image processing configuration used either in this material.
  41898. */
  41899. /**
  41900. * Sets the Default image processing configuration used either in the this material.
  41901. *
  41902. * If sets to null, the scene one is in use.
  41903. */
  41904. imageProcessingConfiguration: ImageProcessingConfiguration;
  41905. /**
  41906. * Keep track of the image processing observer to allow dispose and replace.
  41907. */
  41908. private _imageProcessingObserver;
  41909. /**
  41910. * Attaches a new image processing configuration to the PBR Material.
  41911. * @param configuration
  41912. */
  41913. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  41914. /**
  41915. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  41916. */
  41917. /**
  41918. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  41919. */
  41920. colorCurves: Nullable<ColorCurves>;
  41921. /**
  41922. * Gets wether the color curves effect is enabled.
  41923. */
  41924. /**
  41925. * Sets wether the color curves effect is enabled.
  41926. */
  41927. colorCurvesEnabled: boolean;
  41928. /**
  41929. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  41930. */
  41931. /**
  41932. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  41933. */
  41934. colorGradingTexture: Nullable<BaseTexture>;
  41935. /**
  41936. * Gets wether the color grading effect is enabled.
  41937. */
  41938. /**
  41939. * Gets wether the color grading effect is enabled.
  41940. */
  41941. colorGradingEnabled: boolean;
  41942. /**
  41943. * Gets exposure used in the effect.
  41944. */
  41945. /**
  41946. * Sets exposure used in the effect.
  41947. */
  41948. exposure: number;
  41949. /**
  41950. * Gets wether tonemapping is enabled or not.
  41951. */
  41952. /**
  41953. * Sets wether tonemapping is enabled or not
  41954. */
  41955. toneMappingEnabled: boolean;
  41956. /**
  41957. * Gets the type of tone mapping effect.
  41958. */
  41959. /**
  41960. * Sets the type of tone mapping effect.
  41961. */
  41962. toneMappingType: number;
  41963. /**
  41964. * Gets contrast used in the effect.
  41965. */
  41966. /**
  41967. * Sets contrast used in the effect.
  41968. */
  41969. contrast: number;
  41970. /**
  41971. * Gets Vignette stretch size.
  41972. */
  41973. /**
  41974. * Sets Vignette stretch size.
  41975. */
  41976. vignetteStretch: number;
  41977. /**
  41978. * Gets Vignette centre X Offset.
  41979. */
  41980. /**
  41981. * Sets Vignette centre X Offset.
  41982. */
  41983. vignetteCentreX: number;
  41984. /**
  41985. * Gets Vignette centre Y Offset.
  41986. */
  41987. /**
  41988. * Sets Vignette centre Y Offset.
  41989. */
  41990. vignetteCentreY: number;
  41991. /**
  41992. * Gets Vignette weight or intensity of the vignette effect.
  41993. */
  41994. /**
  41995. * Sets Vignette weight or intensity of the vignette effect.
  41996. */
  41997. vignetteWeight: number;
  41998. /**
  41999. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42000. * if vignetteEnabled is set to true.
  42001. */
  42002. /**
  42003. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42004. * if vignetteEnabled is set to true.
  42005. */
  42006. vignetteColor: Color4;
  42007. /**
  42008. * Gets Camera field of view used by the Vignette effect.
  42009. */
  42010. /**
  42011. * Sets Camera field of view used by the Vignette effect.
  42012. */
  42013. vignetteCameraFov: number;
  42014. /**
  42015. * Gets the vignette blend mode allowing different kind of effect.
  42016. */
  42017. /**
  42018. * Sets the vignette blend mode allowing different kind of effect.
  42019. */
  42020. vignetteBlendMode: number;
  42021. /**
  42022. * Gets wether the vignette effect is enabled.
  42023. */
  42024. /**
  42025. * Sets wether the vignette effect is enabled.
  42026. */
  42027. vignetteEnabled: boolean;
  42028. private _fromLinearSpace;
  42029. /**
  42030. * Gets wether the input of the processing is in Gamma or Linear Space.
  42031. */
  42032. /**
  42033. * Sets wether the input of the processing is in Gamma or Linear Space.
  42034. */
  42035. fromLinearSpace: boolean;
  42036. /**
  42037. * Defines cache preventing GC.
  42038. */
  42039. private _defines;
  42040. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42041. /**
  42042. * "ImageProcessingPostProcess"
  42043. * @returns "ImageProcessingPostProcess"
  42044. */
  42045. getClassName(): string;
  42046. protected _updateParameters(): void;
  42047. dispose(camera?: Camera): void;
  42048. }
  42049. }
  42050. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42051. import { Scene } from "babylonjs/scene";
  42052. import { Color3 } from "babylonjs/Maths/math.color";
  42053. import { Mesh } from "babylonjs/Meshes/mesh";
  42054. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42055. import { Nullable } from "babylonjs/types";
  42056. /**
  42057. * Class containing static functions to help procedurally build meshes
  42058. */
  42059. export class GroundBuilder {
  42060. /**
  42061. * Creates a ground mesh
  42062. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42063. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42064. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42065. * @param name defines the name of the mesh
  42066. * @param options defines the options used to create the mesh
  42067. * @param scene defines the hosting scene
  42068. * @returns the ground mesh
  42069. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42070. */
  42071. static CreateGround(name: string, options: {
  42072. width?: number;
  42073. height?: number;
  42074. subdivisions?: number;
  42075. subdivisionsX?: number;
  42076. subdivisionsY?: number;
  42077. updatable?: boolean;
  42078. }, scene: any): Mesh;
  42079. /**
  42080. * Creates a tiled ground mesh
  42081. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42082. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42083. * * 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
  42084. * * 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
  42085. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42086. * @param name defines the name of the mesh
  42087. * @param options defines the options used to create the mesh
  42088. * @param scene defines the hosting scene
  42089. * @returns the tiled ground mesh
  42090. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42091. */
  42092. static CreateTiledGround(name: string, options: {
  42093. xmin: number;
  42094. zmin: number;
  42095. xmax: number;
  42096. zmax: number;
  42097. subdivisions?: {
  42098. w: number;
  42099. h: number;
  42100. };
  42101. precision?: {
  42102. w: number;
  42103. h: number;
  42104. };
  42105. updatable?: boolean;
  42106. }, scene?: Nullable<Scene>): Mesh;
  42107. /**
  42108. * Creates a ground mesh from a height map
  42109. * * The parameter `url` sets the URL of the height map image resource.
  42110. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42111. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42112. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42113. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42114. * * 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.
  42115. * * 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).
  42116. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42117. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42118. * @param name defines the name of the mesh
  42119. * @param url defines the url to the height map
  42120. * @param options defines the options used to create the mesh
  42121. * @param scene defines the hosting scene
  42122. * @returns the ground mesh
  42123. * @see https://doc.babylonjs.com/babylon101/height_map
  42124. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42125. */
  42126. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42127. width?: number;
  42128. height?: number;
  42129. subdivisions?: number;
  42130. minHeight?: number;
  42131. maxHeight?: number;
  42132. colorFilter?: Color3;
  42133. alphaFilter?: number;
  42134. updatable?: boolean;
  42135. onReady?: (mesh: GroundMesh) => void;
  42136. }, scene?: Nullable<Scene>): GroundMesh;
  42137. }
  42138. }
  42139. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42140. import { Vector4 } from "babylonjs/Maths/math.vector";
  42141. import { Mesh } from "babylonjs/Meshes/mesh";
  42142. /**
  42143. * Class containing static functions to help procedurally build meshes
  42144. */
  42145. export class TorusBuilder {
  42146. /**
  42147. * Creates a torus mesh
  42148. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42149. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42150. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42151. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42152. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42153. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42154. * @param name defines the name of the mesh
  42155. * @param options defines the options used to create the mesh
  42156. * @param scene defines the hosting scene
  42157. * @returns the torus mesh
  42158. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42159. */
  42160. static CreateTorus(name: string, options: {
  42161. diameter?: number;
  42162. thickness?: number;
  42163. tessellation?: number;
  42164. updatable?: boolean;
  42165. sideOrientation?: number;
  42166. frontUVs?: Vector4;
  42167. backUVs?: Vector4;
  42168. }, scene: any): Mesh;
  42169. }
  42170. }
  42171. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42172. import { Vector4 } from "babylonjs/Maths/math.vector";
  42173. import { Color4 } from "babylonjs/Maths/math.color";
  42174. import { Mesh } from "babylonjs/Meshes/mesh";
  42175. /**
  42176. * Class containing static functions to help procedurally build meshes
  42177. */
  42178. export class CylinderBuilder {
  42179. /**
  42180. * Creates a cylinder or a cone mesh
  42181. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42182. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42183. * * 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.
  42184. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42185. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42186. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42187. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42188. * * 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).
  42189. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42190. * * 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).
  42191. * * 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
  42192. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42193. * * 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
  42194. * * 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.
  42195. * * If `enclose` is false, a ring surface is one element.
  42196. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42197. * * 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
  42198. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42199. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42200. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42201. * @param name defines the name of the mesh
  42202. * @param options defines the options used to create the mesh
  42203. * @param scene defines the hosting scene
  42204. * @returns the cylinder mesh
  42205. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42206. */
  42207. static CreateCylinder(name: string, options: {
  42208. height?: number;
  42209. diameterTop?: number;
  42210. diameterBottom?: number;
  42211. diameter?: number;
  42212. tessellation?: number;
  42213. subdivisions?: number;
  42214. arc?: number;
  42215. faceColors?: Color4[];
  42216. faceUV?: Vector4[];
  42217. updatable?: boolean;
  42218. hasRings?: boolean;
  42219. enclose?: boolean;
  42220. cap?: number;
  42221. sideOrientation?: number;
  42222. frontUVs?: Vector4;
  42223. backUVs?: Vector4;
  42224. }, scene: any): Mesh;
  42225. }
  42226. }
  42227. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42228. import { Observable } from "babylonjs/Misc/observable";
  42229. import { Nullable } from "babylonjs/types";
  42230. import { Camera } from "babylonjs/Cameras/camera";
  42231. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42232. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42233. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42234. import { Scene } from "babylonjs/scene";
  42235. import { Vector3 } from "babylonjs/Maths/math.vector";
  42236. import { Color3 } from "babylonjs/Maths/math.color";
  42237. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42238. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42239. import { Mesh } from "babylonjs/Meshes/mesh";
  42240. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42241. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42242. import "babylonjs/Meshes/Builders/groundBuilder";
  42243. import "babylonjs/Meshes/Builders/torusBuilder";
  42244. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42245. import "babylonjs/Gamepads/gamepadSceneComponent";
  42246. import "babylonjs/Animations/animatable";
  42247. /**
  42248. * Options to modify the vr teleportation behavior.
  42249. */
  42250. export interface VRTeleportationOptions {
  42251. /**
  42252. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42253. */
  42254. floorMeshName?: string;
  42255. /**
  42256. * A list of meshes to be used as the teleportation floor. (default: empty)
  42257. */
  42258. floorMeshes?: Mesh[];
  42259. }
  42260. /**
  42261. * Options to modify the vr experience helper's behavior.
  42262. */
  42263. export interface VRExperienceHelperOptions extends WebVROptions {
  42264. /**
  42265. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42266. */
  42267. createDeviceOrientationCamera?: boolean;
  42268. /**
  42269. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42270. */
  42271. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42272. /**
  42273. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42274. */
  42275. laserToggle?: boolean;
  42276. /**
  42277. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42278. */
  42279. floorMeshes?: Mesh[];
  42280. /**
  42281. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42282. */
  42283. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42284. }
  42285. /**
  42286. * Event containing information after VR has been entered
  42287. */
  42288. export class OnAfterEnteringVRObservableEvent {
  42289. /**
  42290. * If entering vr was successful
  42291. */
  42292. success: boolean;
  42293. }
  42294. /**
  42295. * Helps to quickly add VR support to an existing scene.
  42296. * See http://doc.babylonjs.com/how_to/webvr_helper
  42297. */
  42298. export class VRExperienceHelper {
  42299. /** Options to modify the vr experience helper's behavior. */
  42300. webVROptions: VRExperienceHelperOptions;
  42301. private _scene;
  42302. private _position;
  42303. private _btnVR;
  42304. private _btnVRDisplayed;
  42305. private _webVRsupported;
  42306. private _webVRready;
  42307. private _webVRrequesting;
  42308. private _webVRpresenting;
  42309. private _hasEnteredVR;
  42310. private _fullscreenVRpresenting;
  42311. private _canvas;
  42312. private _webVRCamera;
  42313. private _vrDeviceOrientationCamera;
  42314. private _deviceOrientationCamera;
  42315. private _existingCamera;
  42316. private _onKeyDown;
  42317. private _onVrDisplayPresentChange;
  42318. private _onVRDisplayChanged;
  42319. private _onVRRequestPresentStart;
  42320. private _onVRRequestPresentComplete;
  42321. /**
  42322. * 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)
  42323. */
  42324. enableGazeEvenWhenNoPointerLock: boolean;
  42325. /**
  42326. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  42327. */
  42328. exitVROnDoubleTap: boolean;
  42329. /**
  42330. * Observable raised right before entering VR.
  42331. */
  42332. onEnteringVRObservable: Observable<VRExperienceHelper>;
  42333. /**
  42334. * Observable raised when entering VR has completed.
  42335. */
  42336. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  42337. /**
  42338. * Observable raised when exiting VR.
  42339. */
  42340. onExitingVRObservable: Observable<VRExperienceHelper>;
  42341. /**
  42342. * Observable raised when controller mesh is loaded.
  42343. */
  42344. onControllerMeshLoadedObservable: Observable<WebVRController>;
  42345. /** Return this.onEnteringVRObservable
  42346. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  42347. */
  42348. readonly onEnteringVR: Observable<VRExperienceHelper>;
  42349. /** Return this.onExitingVRObservable
  42350. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  42351. */
  42352. readonly onExitingVR: Observable<VRExperienceHelper>;
  42353. /** Return this.onControllerMeshLoadedObservable
  42354. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  42355. */
  42356. readonly onControllerMeshLoaded: Observable<WebVRController>;
  42357. private _rayLength;
  42358. private _useCustomVRButton;
  42359. private _teleportationRequested;
  42360. private _teleportActive;
  42361. private _floorMeshName;
  42362. private _floorMeshesCollection;
  42363. private _rotationAllowed;
  42364. private _teleportBackwardsVector;
  42365. private _teleportationTarget;
  42366. private _isDefaultTeleportationTarget;
  42367. private _postProcessMove;
  42368. private _teleportationFillColor;
  42369. private _teleportationBorderColor;
  42370. private _rotationAngle;
  42371. private _haloCenter;
  42372. private _cameraGazer;
  42373. private _padSensibilityUp;
  42374. private _padSensibilityDown;
  42375. private _leftController;
  42376. private _rightController;
  42377. /**
  42378. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  42379. */
  42380. onNewMeshSelected: Observable<AbstractMesh>;
  42381. /**
  42382. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  42383. * This observable will provide the mesh and the controller used to select the mesh
  42384. */
  42385. onMeshSelectedWithController: Observable<{
  42386. mesh: AbstractMesh;
  42387. controller: WebVRController;
  42388. }>;
  42389. /**
  42390. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  42391. */
  42392. onNewMeshPicked: Observable<PickingInfo>;
  42393. private _circleEase;
  42394. /**
  42395. * Observable raised before camera teleportation
  42396. */
  42397. onBeforeCameraTeleport: Observable<Vector3>;
  42398. /**
  42399. * Observable raised after camera teleportation
  42400. */
  42401. onAfterCameraTeleport: Observable<Vector3>;
  42402. /**
  42403. * Observable raised when current selected mesh gets unselected
  42404. */
  42405. onSelectedMeshUnselected: Observable<AbstractMesh>;
  42406. private _raySelectionPredicate;
  42407. /**
  42408. * To be optionaly changed by user to define custom ray selection
  42409. */
  42410. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  42411. /**
  42412. * To be optionaly changed by user to define custom selection logic (after ray selection)
  42413. */
  42414. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  42415. /**
  42416. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  42417. */
  42418. teleportationEnabled: boolean;
  42419. private _defaultHeight;
  42420. private _teleportationInitialized;
  42421. private _interactionsEnabled;
  42422. private _interactionsRequested;
  42423. private _displayGaze;
  42424. private _displayLaserPointer;
  42425. /**
  42426. * The mesh used to display where the user is going to teleport.
  42427. */
  42428. /**
  42429. * Sets the mesh to be used to display where the user is going to teleport.
  42430. */
  42431. teleportationTarget: Mesh;
  42432. /**
  42433. * 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
  42434. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  42435. * See http://doc.babylonjs.com/resources/baking_transformations
  42436. */
  42437. gazeTrackerMesh: Mesh;
  42438. /**
  42439. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  42440. */
  42441. updateGazeTrackerScale: boolean;
  42442. /**
  42443. * If the gaze trackers color should be updated when selecting meshes
  42444. */
  42445. updateGazeTrackerColor: boolean;
  42446. /**
  42447. * If the controller laser color should be updated when selecting meshes
  42448. */
  42449. updateControllerLaserColor: boolean;
  42450. /**
  42451. * The gaze tracking mesh corresponding to the left controller
  42452. */
  42453. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  42454. /**
  42455. * The gaze tracking mesh corresponding to the right controller
  42456. */
  42457. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  42458. /**
  42459. * If the ray of the gaze should be displayed.
  42460. */
  42461. /**
  42462. * Sets if the ray of the gaze should be displayed.
  42463. */
  42464. displayGaze: boolean;
  42465. /**
  42466. * If the ray of the LaserPointer should be displayed.
  42467. */
  42468. /**
  42469. * Sets if the ray of the LaserPointer should be displayed.
  42470. */
  42471. displayLaserPointer: boolean;
  42472. /**
  42473. * The deviceOrientationCamera used as the camera when not in VR.
  42474. */
  42475. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  42476. /**
  42477. * Based on the current WebVR support, returns the current VR camera used.
  42478. */
  42479. readonly currentVRCamera: Nullable<Camera>;
  42480. /**
  42481. * The webVRCamera which is used when in VR.
  42482. */
  42483. readonly webVRCamera: WebVRFreeCamera;
  42484. /**
  42485. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  42486. */
  42487. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  42488. /**
  42489. * The html button that is used to trigger entering into VR.
  42490. */
  42491. readonly vrButton: Nullable<HTMLButtonElement>;
  42492. private readonly _teleportationRequestInitiated;
  42493. /**
  42494. * Defines wether or not Pointer lock should be requested when switching to
  42495. * full screen.
  42496. */
  42497. requestPointerLockOnFullScreen: boolean;
  42498. /**
  42499. * Instantiates a VRExperienceHelper.
  42500. * Helps to quickly add VR support to an existing scene.
  42501. * @param scene The scene the VRExperienceHelper belongs to.
  42502. * @param webVROptions Options to modify the vr experience helper's behavior.
  42503. */
  42504. constructor(scene: Scene,
  42505. /** Options to modify the vr experience helper's behavior. */
  42506. webVROptions?: VRExperienceHelperOptions);
  42507. private _onDefaultMeshLoaded;
  42508. private _onResize;
  42509. private _onFullscreenChange;
  42510. /**
  42511. * Gets a value indicating if we are currently in VR mode.
  42512. */
  42513. readonly isInVRMode: boolean;
  42514. private onVrDisplayPresentChange;
  42515. private onVRDisplayChanged;
  42516. private moveButtonToBottomRight;
  42517. private displayVRButton;
  42518. private updateButtonVisibility;
  42519. private _cachedAngularSensibility;
  42520. /**
  42521. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  42522. * Otherwise, will use the fullscreen API.
  42523. */
  42524. enterVR(): void;
  42525. /**
  42526. * Attempt to exit VR, or fullscreen.
  42527. */
  42528. exitVR(): void;
  42529. /**
  42530. * The position of the vr experience helper.
  42531. */
  42532. /**
  42533. * Sets the position of the vr experience helper.
  42534. */
  42535. position: Vector3;
  42536. /**
  42537. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  42538. */
  42539. enableInteractions(): void;
  42540. private readonly _noControllerIsActive;
  42541. private beforeRender;
  42542. private _isTeleportationFloor;
  42543. /**
  42544. * Adds a floor mesh to be used for teleportation.
  42545. * @param floorMesh the mesh to be used for teleportation.
  42546. */
  42547. addFloorMesh(floorMesh: Mesh): void;
  42548. /**
  42549. * Removes a floor mesh from being used for teleportation.
  42550. * @param floorMesh the mesh to be removed.
  42551. */
  42552. removeFloorMesh(floorMesh: Mesh): void;
  42553. /**
  42554. * Enables interactions and teleportation using the VR controllers and gaze.
  42555. * @param vrTeleportationOptions options to modify teleportation behavior.
  42556. */
  42557. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  42558. private _onNewGamepadConnected;
  42559. private _tryEnableInteractionOnController;
  42560. private _onNewGamepadDisconnected;
  42561. private _enableInteractionOnController;
  42562. private _checkTeleportWithRay;
  42563. private _checkRotate;
  42564. private _checkTeleportBackwards;
  42565. private _enableTeleportationOnController;
  42566. private _createTeleportationCircles;
  42567. private _displayTeleportationTarget;
  42568. private _hideTeleportationTarget;
  42569. private _rotateCamera;
  42570. private _moveTeleportationSelectorTo;
  42571. private _workingVector;
  42572. private _workingQuaternion;
  42573. private _workingMatrix;
  42574. /**
  42575. * Teleports the users feet to the desired location
  42576. * @param location The location where the user's feet should be placed
  42577. */
  42578. teleportCamera(location: Vector3): void;
  42579. private _convertNormalToDirectionOfRay;
  42580. private _castRayAndSelectObject;
  42581. private _notifySelectedMeshUnselected;
  42582. /**
  42583. * Sets the color of the laser ray from the vr controllers.
  42584. * @param color new color for the ray.
  42585. */
  42586. changeLaserColor(color: Color3): void;
  42587. /**
  42588. * Sets the color of the ray from the vr headsets gaze.
  42589. * @param color new color for the ray.
  42590. */
  42591. changeGazeColor(color: Color3): void;
  42592. /**
  42593. * Exits VR and disposes of the vr experience helper
  42594. */
  42595. dispose(): void;
  42596. /**
  42597. * Gets the name of the VRExperienceHelper class
  42598. * @returns "VRExperienceHelper"
  42599. */
  42600. getClassName(): string;
  42601. }
  42602. }
  42603. declare module "babylonjs/Cameras/VR/index" {
  42604. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  42605. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  42606. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42607. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  42608. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  42609. export * from "babylonjs/Cameras/VR/webVRCamera";
  42610. }
  42611. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  42612. import { Observable } from "babylonjs/Misc/observable";
  42613. import { Nullable } from "babylonjs/types";
  42614. import { IDisposable, Scene } from "babylonjs/scene";
  42615. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  42616. /**
  42617. * Manages an XRSession to work with Babylon's engine
  42618. * @see https://doc.babylonjs.com/how_to/webxr
  42619. */
  42620. export class WebXRSessionManager implements IDisposable {
  42621. private scene;
  42622. /**
  42623. * Fires every time a new xrFrame arrives which can be used to update the camera
  42624. */
  42625. onXRFrameObservable: Observable<any>;
  42626. /**
  42627. * Fires when the xr session is ended either by the device or manually done
  42628. */
  42629. onXRSessionEnded: Observable<any>;
  42630. /**
  42631. * Underlying xr session
  42632. */
  42633. session: XRSession;
  42634. /**
  42635. * Type of reference space used when creating the session
  42636. */
  42637. referenceSpace: XRReferenceSpace;
  42638. /** @hidden */
  42639. _sessionRenderTargetTexture: Nullable<RenderTargetTexture>;
  42640. /**
  42641. * Current XR frame
  42642. */
  42643. currentFrame: Nullable<XRFrame>;
  42644. private _xrNavigator;
  42645. private baseLayer;
  42646. /**
  42647. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  42648. * @param scene The scene which the session should be created for
  42649. */
  42650. constructor(scene: Scene);
  42651. /**
  42652. * Initializes the manager
  42653. * After initialization enterXR can be called to start an XR session
  42654. * @returns Promise which resolves after it is initialized
  42655. */
  42656. initializeAsync(): Promise<void>;
  42657. /**
  42658. * Initializes an xr session
  42659. * @param xrSessionMode mode to initialize
  42660. * @returns a promise which will resolve once the session has been initialized
  42661. */
  42662. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  42663. /**
  42664. * Sets the reference space on the xr session
  42665. * @param referenceSpace space to set
  42666. * @returns a promise that will resolve once the reference space has been set
  42667. */
  42668. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  42669. /**
  42670. * Updates the render state of the session
  42671. * @param state state to set
  42672. * @returns a promise that resolves once the render state has been updated
  42673. */
  42674. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  42675. /**
  42676. * Starts rendering to the xr layer
  42677. * @returns a promise that will resolve once rendering has started
  42678. */
  42679. startRenderingToXRAsync(): Promise<void>;
  42680. /**
  42681. * Stops the xrSession and restores the renderloop
  42682. * @returns Promise which resolves after it exits XR
  42683. */
  42684. exitXRAsync(): Promise<unknown>;
  42685. /**
  42686. * Checks if a session would be supported for the creation options specified
  42687. * @param sessionMode session mode to check if supported eg. immersive-vr
  42688. * @returns true if supported
  42689. */
  42690. supportsSessionAsync(sessionMode: XRSessionMode): any;
  42691. /**
  42692. * @hidden
  42693. * Converts the render layer of xrSession to a render target
  42694. * @param session session to create render target for
  42695. * @param scene scene the new render target should be created for
  42696. */
  42697. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  42698. /**
  42699. * Disposes of the session manager
  42700. */
  42701. dispose(): void;
  42702. }
  42703. }
  42704. declare module "babylonjs/Cameras/XR/webXRCamera" {
  42705. import { Scene } from "babylonjs/scene";
  42706. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  42707. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  42708. /**
  42709. * WebXR Camera which holds the views for the xrSession
  42710. * @see https://doc.babylonjs.com/how_to/webxr
  42711. */
  42712. export class WebXRCamera extends FreeCamera {
  42713. private static _TmpMatrix;
  42714. /**
  42715. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  42716. * @param name the name of the camera
  42717. * @param scene the scene to add the camera to
  42718. */
  42719. constructor(name: string, scene: Scene);
  42720. private _updateNumberOfRigCameras;
  42721. /** @hidden */
  42722. _updateForDualEyeDebugging(pupilDistance?: number): void;
  42723. /**
  42724. * Updates the cameras position from the current pose information of the XR session
  42725. * @param xrSessionManager the session containing pose information
  42726. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  42727. */
  42728. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  42729. }
  42730. }
  42731. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  42732. import { Nullable } from "babylonjs/types";
  42733. import { IDisposable } from "babylonjs/scene";
  42734. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  42735. /**
  42736. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  42737. */
  42738. export class WebXRManagedOutputCanvas implements IDisposable {
  42739. private helper;
  42740. private _canvas;
  42741. /**
  42742. * xrpresent context of the canvas which can be used to display/mirror xr content
  42743. */
  42744. canvasContext: WebGLRenderingContext;
  42745. /**
  42746. * xr layer for the canvas
  42747. */
  42748. xrLayer: Nullable<XRWebGLLayer>;
  42749. /**
  42750. * Initializes the xr layer for the session
  42751. * @param xrSession xr session
  42752. * @returns a promise that will resolve once the XR Layer has been created
  42753. */
  42754. initializeXRLayerAsync(xrSession: any): any;
  42755. /**
  42756. * Initializes the canvas to be added/removed upon entering/exiting xr
  42757. * @param helper the xr experience helper used to trigger adding/removing of the canvas
  42758. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  42759. */
  42760. constructor(helper: WebXRExperienceHelper, canvas?: HTMLCanvasElement);
  42761. /**
  42762. * Disposes of the object
  42763. */
  42764. dispose(): void;
  42765. private _setManagedOutputCanvas;
  42766. private _addCanvas;
  42767. private _removeCanvas;
  42768. }
  42769. }
  42770. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  42771. import { Observable } from "babylonjs/Misc/observable";
  42772. import { IDisposable, Scene } from "babylonjs/scene";
  42773. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  42774. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42775. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  42776. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  42777. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  42778. /**
  42779. * States of the webXR experience
  42780. */
  42781. export enum WebXRState {
  42782. /**
  42783. * Transitioning to being in XR mode
  42784. */
  42785. ENTERING_XR = 0,
  42786. /**
  42787. * Transitioning to non XR mode
  42788. */
  42789. EXITING_XR = 1,
  42790. /**
  42791. * In XR mode and presenting
  42792. */
  42793. IN_XR = 2,
  42794. /**
  42795. * Not entered XR mode
  42796. */
  42797. NOT_IN_XR = 3
  42798. }
  42799. /**
  42800. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  42801. * @see https://doc.babylonjs.com/how_to/webxr
  42802. */
  42803. export class WebXRExperienceHelper implements IDisposable {
  42804. private scene;
  42805. /**
  42806. * 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
  42807. */
  42808. container: AbstractMesh;
  42809. /**
  42810. * Camera used to render xr content
  42811. */
  42812. camera: WebXRCamera;
  42813. /**
  42814. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  42815. */
  42816. state: WebXRState;
  42817. private _setState;
  42818. private static _TmpVector;
  42819. /**
  42820. * Fires when the state of the experience helper has changed
  42821. */
  42822. onStateChangedObservable: Observable<WebXRState>;
  42823. /** Session manager used to keep track of xr session */
  42824. sessionManager: WebXRSessionManager;
  42825. private _nonVRCamera;
  42826. private _originalSceneAutoClear;
  42827. private _supported;
  42828. /**
  42829. * Creates the experience helper
  42830. * @param scene the scene to attach the experience helper to
  42831. * @returns a promise for the experience helper
  42832. */
  42833. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  42834. /**
  42835. * Creates a WebXRExperienceHelper
  42836. * @param scene The scene the helper should be created in
  42837. */
  42838. private constructor();
  42839. /**
  42840. * Exits XR mode and returns the scene to its original state
  42841. * @returns promise that resolves after xr mode has exited
  42842. */
  42843. exitXRAsync(): Promise<unknown>;
  42844. /**
  42845. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  42846. * @param sessionCreationOptions options for the XR session
  42847. * @param referenceSpaceType frame of reference of the XR session
  42848. * @param outputCanvas the output canvas that will be used to enter XR mode
  42849. * @returns promise that resolves after xr mode has entered
  42850. */
  42851. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, outputCanvas: WebXRManagedOutputCanvas): any;
  42852. /**
  42853. * Updates the global position of the camera by moving the camera's container
  42854. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  42855. * @param position The desired global position of the camera
  42856. */
  42857. setPositionOfCameraUsingContainer(position: Vector3): void;
  42858. /**
  42859. * Rotates the xr camera by rotating the camera's container around the camera's position
  42860. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  42861. * @param rotation the desired quaternion rotation to apply to the camera
  42862. */
  42863. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  42864. /**
  42865. * Disposes of the experience helper
  42866. */
  42867. dispose(): void;
  42868. }
  42869. }
  42870. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  42871. import { Nullable } from "babylonjs/types";
  42872. import { Observable } from "babylonjs/Misc/observable";
  42873. import { IDisposable, Scene } from "babylonjs/scene";
  42874. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  42875. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  42876. /**
  42877. * Button which can be used to enter a different mode of XR
  42878. */
  42879. export class WebXREnterExitUIButton {
  42880. /** button element */
  42881. element: HTMLElement;
  42882. /** XR initialization options for the button */
  42883. sessionMode: XRSessionMode;
  42884. /** Reference space type */
  42885. referenceSpaceType: XRReferenceSpaceType;
  42886. /**
  42887. * Creates a WebXREnterExitUIButton
  42888. * @param element button element
  42889. * @param sessionMode XR initialization session mode
  42890. * @param referenceSpaceType the type of reference space to be used
  42891. */
  42892. constructor(
  42893. /** button element */
  42894. element: HTMLElement,
  42895. /** XR initialization options for the button */
  42896. sessionMode: XRSessionMode,
  42897. /** Reference space type */
  42898. referenceSpaceType: XRReferenceSpaceType);
  42899. /**
  42900. * Overwritable function which can be used to update the button's visuals when the state changes
  42901. * @param activeButton the current active button in the UI
  42902. */
  42903. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  42904. }
  42905. /**
  42906. * Options to create the webXR UI
  42907. */
  42908. export class WebXREnterExitUIOptions {
  42909. /**
  42910. * Context to enter xr with
  42911. */
  42912. webXRManagedOutputCanvas?: Nullable<WebXRManagedOutputCanvas>;
  42913. /**
  42914. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  42915. */
  42916. customButtons?: Array<WebXREnterExitUIButton>;
  42917. }
  42918. /**
  42919. * UI to allow the user to enter/exit XR mode
  42920. */
  42921. export class WebXREnterExitUI implements IDisposable {
  42922. private scene;
  42923. private _overlay;
  42924. private _buttons;
  42925. private _activeButton;
  42926. /**
  42927. * Fired every time the active button is changed.
  42928. *
  42929. * When xr is entered via a button that launches xr that button will be the callback parameter
  42930. *
  42931. * When exiting xr the callback parameter will be null)
  42932. */
  42933. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  42934. /**
  42935. * Creates UI to allow the user to enter/exit XR mode
  42936. * @param scene the scene to add the ui to
  42937. * @param helper the xr experience helper to enter/exit xr with
  42938. * @param options options to configure the UI
  42939. * @returns the created ui
  42940. */
  42941. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  42942. private constructor();
  42943. private _updateButtons;
  42944. /**
  42945. * Disposes of the object
  42946. */
  42947. dispose(): void;
  42948. }
  42949. }
  42950. declare module "babylonjs/Cameras/XR/webXRController" {
  42951. import { Nullable } from "babylonjs/types";
  42952. import { Observable } from "babylonjs/Misc/observable";
  42953. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42954. import { Ray } from "babylonjs/Culling/ray";
  42955. import { Scene } from "babylonjs/scene";
  42956. /**
  42957. * Represents an XR input
  42958. */
  42959. export class WebXRController {
  42960. private scene;
  42961. /** The underlying input source for the controller */
  42962. inputSource: XRInputSource;
  42963. private parentContainer;
  42964. /**
  42965. * 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
  42966. */
  42967. grip?: AbstractMesh;
  42968. /**
  42969. * Pointer which can be used to select objects or attach a visible laser to
  42970. */
  42971. pointer: AbstractMesh;
  42972. /**
  42973. * Event that fires when the controller is removed/disposed
  42974. */
  42975. onDisposeObservable: Observable<{}>;
  42976. private _tmpMatrix;
  42977. private _tmpQuaternion;
  42978. private _tmpVector;
  42979. /**
  42980. * Creates the controller
  42981. * @see https://doc.babylonjs.com/how_to/webxr
  42982. * @param scene the scene which the controller should be associated to
  42983. * @param inputSource the underlying input source for the controller
  42984. * @param parentContainer parent that the controller meshes should be children of
  42985. */
  42986. constructor(scene: Scene,
  42987. /** The underlying input source for the controller */
  42988. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  42989. /**
  42990. * Updates the controller pose based on the given XRFrame
  42991. * @param xrFrame xr frame to update the pose with
  42992. * @param referenceSpace reference space to use
  42993. */
  42994. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  42995. /**
  42996. * Gets a world space ray coming from the controller
  42997. * @param result the resulting ray
  42998. */
  42999. getWorldPointerRayToRef(result: Ray): void;
  43000. /**
  43001. * Disposes of the object
  43002. */
  43003. dispose(): void;
  43004. }
  43005. }
  43006. declare module "babylonjs/Cameras/XR/webXRInput" {
  43007. import { Observable } from "babylonjs/Misc/observable";
  43008. import { IDisposable } from "babylonjs/scene";
  43009. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43010. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43011. /**
  43012. * XR input used to track XR inputs such as controllers/rays
  43013. */
  43014. export class WebXRInput implements IDisposable {
  43015. /**
  43016. * Base experience the input listens to
  43017. */
  43018. baseExperience: WebXRExperienceHelper;
  43019. /**
  43020. * XR controllers being tracked
  43021. */
  43022. controllers: Array<WebXRController>;
  43023. private _frameObserver;
  43024. private _stateObserver;
  43025. /**
  43026. * Event when a controller has been connected/added
  43027. */
  43028. onControllerAddedObservable: Observable<WebXRController>;
  43029. /**
  43030. * Event when a controller has been removed/disconnected
  43031. */
  43032. onControllerRemovedObservable: Observable<WebXRController>;
  43033. /**
  43034. * Initializes the WebXRInput
  43035. * @param baseExperience experience helper which the input should be created for
  43036. */
  43037. constructor(
  43038. /**
  43039. * Base experience the input listens to
  43040. */
  43041. baseExperience: WebXRExperienceHelper);
  43042. private _onInputSourcesChange;
  43043. private _addAndRemoveControllers;
  43044. /**
  43045. * Disposes of the object
  43046. */
  43047. dispose(): void;
  43048. }
  43049. }
  43050. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43051. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43052. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43053. /**
  43054. * Enables teleportation
  43055. */
  43056. export class WebXRControllerTeleportation {
  43057. private _teleportationFillColor;
  43058. private _teleportationBorderColor;
  43059. private _tmpRay;
  43060. private _tmpVector;
  43061. /**
  43062. * Creates a WebXRControllerTeleportation
  43063. * @param input input manager to add teleportation to
  43064. * @param floorMeshes floormeshes which can be teleported to
  43065. */
  43066. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43067. }
  43068. }
  43069. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43070. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43071. /**
  43072. * Handles pointer input automatically for the pointer of XR controllers
  43073. */
  43074. export class WebXRControllerPointerSelection {
  43075. private static _idCounter;
  43076. private _tmpRay;
  43077. /**
  43078. * Creates a WebXRControllerPointerSelection
  43079. * @param input input manager to setup pointer selection
  43080. */
  43081. constructor(input: WebXRInput);
  43082. private _convertNormalToDirectionOfRay;
  43083. private _updatePointerDistance;
  43084. }
  43085. }
  43086. declare module "babylonjs/Loading/sceneLoader" {
  43087. import { Observable } from "babylonjs/Misc/observable";
  43088. import { Nullable } from "babylonjs/types";
  43089. import { Scene } from "babylonjs/scene";
  43090. import { Engine } from "babylonjs/Engines/engine";
  43091. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43092. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43093. import { AssetContainer } from "babylonjs/assetContainer";
  43094. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43095. import { Skeleton } from "babylonjs/Bones/skeleton";
  43096. /**
  43097. * Class used to represent data loading progression
  43098. */
  43099. export class SceneLoaderProgressEvent {
  43100. /** defines if data length to load can be evaluated */
  43101. readonly lengthComputable: boolean;
  43102. /** defines the loaded data length */
  43103. readonly loaded: number;
  43104. /** defines the data length to load */
  43105. readonly total: number;
  43106. /**
  43107. * Create a new progress event
  43108. * @param lengthComputable defines if data length to load can be evaluated
  43109. * @param loaded defines the loaded data length
  43110. * @param total defines the data length to load
  43111. */
  43112. constructor(
  43113. /** defines if data length to load can be evaluated */
  43114. lengthComputable: boolean,
  43115. /** defines the loaded data length */
  43116. loaded: number,
  43117. /** defines the data length to load */
  43118. total: number);
  43119. /**
  43120. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43121. * @param event defines the source event
  43122. * @returns a new SceneLoaderProgressEvent
  43123. */
  43124. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43125. }
  43126. /**
  43127. * Interface used by SceneLoader plugins to define supported file extensions
  43128. */
  43129. export interface ISceneLoaderPluginExtensions {
  43130. /**
  43131. * Defines the list of supported extensions
  43132. */
  43133. [extension: string]: {
  43134. isBinary: boolean;
  43135. };
  43136. }
  43137. /**
  43138. * Interface used by SceneLoader plugin factory
  43139. */
  43140. export interface ISceneLoaderPluginFactory {
  43141. /**
  43142. * Defines the name of the factory
  43143. */
  43144. name: string;
  43145. /**
  43146. * Function called to create a new plugin
  43147. * @return the new plugin
  43148. */
  43149. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43150. /**
  43151. * Boolean indicating if the plugin can direct load specific data
  43152. */
  43153. canDirectLoad?: (data: string) => boolean;
  43154. }
  43155. /**
  43156. * Interface used to define a SceneLoader plugin
  43157. */
  43158. export interface ISceneLoaderPlugin {
  43159. /**
  43160. * The friendly name of this plugin.
  43161. */
  43162. name: string;
  43163. /**
  43164. * The file extensions supported by this plugin.
  43165. */
  43166. extensions: string | ISceneLoaderPluginExtensions;
  43167. /**
  43168. * Import meshes into a scene.
  43169. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43170. * @param scene The scene to import into
  43171. * @param data The data to import
  43172. * @param rootUrl The root url for scene and resources
  43173. * @param meshes The meshes array to import into
  43174. * @param particleSystems The particle systems array to import into
  43175. * @param skeletons The skeletons array to import into
  43176. * @param onError The callback when import fails
  43177. * @returns True if successful or false otherwise
  43178. */
  43179. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  43180. /**
  43181. * Load into a scene.
  43182. * @param scene The scene to load into
  43183. * @param data The data to import
  43184. * @param rootUrl The root url for scene and resources
  43185. * @param onError The callback when import fails
  43186. * @returns true if successful or false otherwise
  43187. */
  43188. load(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  43189. /**
  43190. * The callback that returns true if the data can be directly loaded.
  43191. */
  43192. canDirectLoad?: (data: string) => boolean;
  43193. /**
  43194. * The callback that allows custom handling of the root url based on the response url.
  43195. */
  43196. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  43197. /**
  43198. * Load into an asset container.
  43199. * @param scene The scene to load into
  43200. * @param data The data to import
  43201. * @param rootUrl The root url for scene and resources
  43202. * @param onError The callback when import fails
  43203. * @returns The loaded asset container
  43204. */
  43205. loadAssetContainer(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  43206. }
  43207. /**
  43208. * Interface used to define an async SceneLoader plugin
  43209. */
  43210. export interface ISceneLoaderPluginAsync {
  43211. /**
  43212. * The friendly name of this plugin.
  43213. */
  43214. name: string;
  43215. /**
  43216. * The file extensions supported by this plugin.
  43217. */
  43218. extensions: string | ISceneLoaderPluginExtensions;
  43219. /**
  43220. * Import meshes into a scene.
  43221. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43222. * @param scene The scene to import into
  43223. * @param data The data to import
  43224. * @param rootUrl The root url for scene and resources
  43225. * @param onProgress The callback when the load progresses
  43226. * @param fileName Defines the name of the file to load
  43227. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  43228. */
  43229. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  43230. meshes: AbstractMesh[];
  43231. particleSystems: IParticleSystem[];
  43232. skeletons: Skeleton[];
  43233. animationGroups: AnimationGroup[];
  43234. }>;
  43235. /**
  43236. * Load into a scene.
  43237. * @param scene The scene to load into
  43238. * @param data The data to import
  43239. * @param rootUrl The root url for scene and resources
  43240. * @param onProgress The callback when the load progresses
  43241. * @param fileName Defines the name of the file to load
  43242. * @returns Nothing
  43243. */
  43244. loadAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  43245. /**
  43246. * The callback that returns true if the data can be directly loaded.
  43247. */
  43248. canDirectLoad?: (data: string) => boolean;
  43249. /**
  43250. * The callback that allows custom handling of the root url based on the response url.
  43251. */
  43252. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  43253. /**
  43254. * Load into an asset container.
  43255. * @param scene The scene to load into
  43256. * @param data The data to import
  43257. * @param rootUrl The root url for scene and resources
  43258. * @param onProgress The callback when the load progresses
  43259. * @param fileName Defines the name of the file to load
  43260. * @returns The loaded asset container
  43261. */
  43262. loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  43263. }
  43264. /**
  43265. * Class used to load scene from various file formats using registered plugins
  43266. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  43267. */
  43268. export class SceneLoader {
  43269. /**
  43270. * No logging while loading
  43271. */
  43272. static readonly NO_LOGGING: number;
  43273. /**
  43274. * Minimal logging while loading
  43275. */
  43276. static readonly MINIMAL_LOGGING: number;
  43277. /**
  43278. * Summary logging while loading
  43279. */
  43280. static readonly SUMMARY_LOGGING: number;
  43281. /**
  43282. * Detailled logging while loading
  43283. */
  43284. static readonly DETAILED_LOGGING: number;
  43285. /**
  43286. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  43287. */
  43288. static ForceFullSceneLoadingForIncremental: boolean;
  43289. /**
  43290. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  43291. */
  43292. static ShowLoadingScreen: boolean;
  43293. /**
  43294. * Defines the current logging level (while loading the scene)
  43295. * @ignorenaming
  43296. */
  43297. static loggingLevel: number;
  43298. /**
  43299. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  43300. */
  43301. static CleanBoneMatrixWeights: boolean;
  43302. /**
  43303. * Event raised when a plugin is used to load a scene
  43304. */
  43305. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43306. private static _registeredPlugins;
  43307. private static _getDefaultPlugin;
  43308. private static _getPluginForExtension;
  43309. private static _getPluginForDirectLoad;
  43310. private static _getPluginForFilename;
  43311. private static _getDirectLoad;
  43312. private static _loadData;
  43313. private static _getFileInfo;
  43314. /**
  43315. * Gets a plugin that can load the given extension
  43316. * @param extension defines the extension to load
  43317. * @returns a plugin or null if none works
  43318. */
  43319. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  43320. /**
  43321. * Gets a boolean indicating that the given extension can be loaded
  43322. * @param extension defines the extension to load
  43323. * @returns true if the extension is supported
  43324. */
  43325. static IsPluginForExtensionAvailable(extension: string): boolean;
  43326. /**
  43327. * Adds a new plugin to the list of registered plugins
  43328. * @param plugin defines the plugin to add
  43329. */
  43330. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  43331. /**
  43332. * Import meshes into a scene
  43333. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43334. * @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)
  43335. * @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)
  43336. * @param scene the instance of BABYLON.Scene to append to
  43337. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  43338. * @param onProgress a callback with a progress event for each file being loaded
  43339. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43340. * @param pluginExtension the extension used to determine the plugin
  43341. * @returns The loaded plugin
  43342. */
  43343. 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>;
  43344. /**
  43345. * Import meshes into a scene
  43346. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43347. * @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)
  43348. * @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)
  43349. * @param scene the instance of BABYLON.Scene to append to
  43350. * @param onProgress a callback with a progress event for each file being loaded
  43351. * @param pluginExtension the extension used to determine the plugin
  43352. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  43353. */
  43354. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  43355. meshes: AbstractMesh[];
  43356. particleSystems: IParticleSystem[];
  43357. skeletons: Skeleton[];
  43358. animationGroups: AnimationGroup[];
  43359. }>;
  43360. /**
  43361. * Load a scene
  43362. * @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)
  43363. * @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)
  43364. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43365. * @param onSuccess a callback with the scene when import succeeds
  43366. * @param onProgress a callback with a progress event for each file being loaded
  43367. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43368. * @param pluginExtension the extension used to determine the plugin
  43369. * @returns The loaded plugin
  43370. */
  43371. 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>;
  43372. /**
  43373. * Load a scene
  43374. * @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)
  43375. * @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)
  43376. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43377. * @param onProgress a callback with a progress event for each file being loaded
  43378. * @param pluginExtension the extension used to determine the plugin
  43379. * @returns The loaded scene
  43380. */
  43381. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43382. /**
  43383. * Append a scene
  43384. * @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)
  43385. * @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)
  43386. * @param scene is the instance of BABYLON.Scene to append to
  43387. * @param onSuccess a callback with the scene when import succeeds
  43388. * @param onProgress a callback with a progress event for each file being loaded
  43389. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43390. * @param pluginExtension the extension used to determine the plugin
  43391. * @returns The loaded plugin
  43392. */
  43393. 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>;
  43394. /**
  43395. * Append a scene
  43396. * @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)
  43397. * @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)
  43398. * @param scene is the instance of BABYLON.Scene to append to
  43399. * @param onProgress a callback with a progress event for each file being loaded
  43400. * @param pluginExtension the extension used to determine the plugin
  43401. * @returns The given scene
  43402. */
  43403. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43404. /**
  43405. * Load a scene into an asset container
  43406. * @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)
  43407. * @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)
  43408. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  43409. * @param onSuccess a callback with the scene when import succeeds
  43410. * @param onProgress a callback with a progress event for each file being loaded
  43411. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43412. * @param pluginExtension the extension used to determine the plugin
  43413. * @returns The loaded plugin
  43414. */
  43415. 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>;
  43416. /**
  43417. * Load a scene into an asset container
  43418. * @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)
  43419. * @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)
  43420. * @param scene is the instance of Scene to append to
  43421. * @param onProgress a callback with a progress event for each file being loaded
  43422. * @param pluginExtension the extension used to determine the plugin
  43423. * @returns The loaded asset container
  43424. */
  43425. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  43426. }
  43427. }
  43428. declare module "babylonjs/Gamepads/Controllers/genericController" {
  43429. import { Scene } from "babylonjs/scene";
  43430. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43431. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43432. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43433. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43434. /**
  43435. * Generic Controller
  43436. */
  43437. export class GenericController extends WebVRController {
  43438. /**
  43439. * Base Url for the controller model.
  43440. */
  43441. static readonly MODEL_BASE_URL: string;
  43442. /**
  43443. * File name for the controller model.
  43444. */
  43445. static readonly MODEL_FILENAME: string;
  43446. /**
  43447. * Creates a new GenericController from a gamepad
  43448. * @param vrGamepad the gamepad that the controller should be created from
  43449. */
  43450. constructor(vrGamepad: any);
  43451. /**
  43452. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43453. * @param scene scene in which to add meshes
  43454. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43455. */
  43456. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43457. /**
  43458. * Called once for each button that changed state since the last frame
  43459. * @param buttonIdx Which button index changed
  43460. * @param state New state of the button
  43461. * @param changes Which properties on the state changed since last frame
  43462. */
  43463. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43464. }
  43465. }
  43466. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  43467. import { Observable } from "babylonjs/Misc/observable";
  43468. import { Scene } from "babylonjs/scene";
  43469. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43470. import { Ray } from "babylonjs/Culling/ray";
  43471. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43472. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43473. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43474. /**
  43475. * Defines the WindowsMotionController object that the state of the windows motion controller
  43476. */
  43477. export class WindowsMotionController extends WebVRController {
  43478. /**
  43479. * The base url used to load the left and right controller models
  43480. */
  43481. static MODEL_BASE_URL: string;
  43482. /**
  43483. * The name of the left controller model file
  43484. */
  43485. static MODEL_LEFT_FILENAME: string;
  43486. /**
  43487. * The name of the right controller model file
  43488. */
  43489. static MODEL_RIGHT_FILENAME: string;
  43490. /**
  43491. * The controller name prefix for this controller type
  43492. */
  43493. static readonly GAMEPAD_ID_PREFIX: string;
  43494. /**
  43495. * The controller id pattern for this controller type
  43496. */
  43497. private static readonly GAMEPAD_ID_PATTERN;
  43498. private _loadedMeshInfo;
  43499. private readonly _mapping;
  43500. /**
  43501. * Fired when the trackpad on this controller is clicked
  43502. */
  43503. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  43504. /**
  43505. * Fired when the trackpad on this controller is modified
  43506. */
  43507. onTrackpadValuesChangedObservable: Observable<StickValues>;
  43508. /**
  43509. * The current x and y values of this controller's trackpad
  43510. */
  43511. trackpad: StickValues;
  43512. /**
  43513. * Creates a new WindowsMotionController from a gamepad
  43514. * @param vrGamepad the gamepad that the controller should be created from
  43515. */
  43516. constructor(vrGamepad: any);
  43517. /**
  43518. * Fired when the trigger on this controller is modified
  43519. */
  43520. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43521. /**
  43522. * Fired when the menu button on this controller is modified
  43523. */
  43524. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43525. /**
  43526. * Fired when the grip button on this controller is modified
  43527. */
  43528. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43529. /**
  43530. * Fired when the thumbstick button on this controller is modified
  43531. */
  43532. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43533. /**
  43534. * Fired when the touchpad button on this controller is modified
  43535. */
  43536. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43537. /**
  43538. * Fired when the touchpad values on this controller are modified
  43539. */
  43540. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  43541. private _updateTrackpad;
  43542. /**
  43543. * Called once per frame by the engine.
  43544. */
  43545. update(): void;
  43546. /**
  43547. * Called once for each button that changed state since the last frame
  43548. * @param buttonIdx Which button index changed
  43549. * @param state New state of the button
  43550. * @param changes Which properties on the state changed since last frame
  43551. */
  43552. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43553. /**
  43554. * Moves the buttons on the controller mesh based on their current state
  43555. * @param buttonName the name of the button to move
  43556. * @param buttonValue the value of the button which determines the buttons new position
  43557. */
  43558. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  43559. /**
  43560. * Moves the axis on the controller mesh based on its current state
  43561. * @param axis the index of the axis
  43562. * @param axisValue the value of the axis which determines the meshes new position
  43563. * @hidden
  43564. */
  43565. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  43566. /**
  43567. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43568. * @param scene scene in which to add meshes
  43569. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43570. */
  43571. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  43572. /**
  43573. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  43574. * can be transformed by button presses and axes values, based on this._mapping.
  43575. *
  43576. * @param scene scene in which the meshes exist
  43577. * @param meshes list of meshes that make up the controller model to process
  43578. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  43579. */
  43580. private processModel;
  43581. private createMeshInfo;
  43582. /**
  43583. * Gets the ray of the controller in the direction the controller is pointing
  43584. * @param length the length the resulting ray should be
  43585. * @returns a ray in the direction the controller is pointing
  43586. */
  43587. getForwardRay(length?: number): Ray;
  43588. /**
  43589. * Disposes of the controller
  43590. */
  43591. dispose(): void;
  43592. }
  43593. }
  43594. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  43595. import { Observable } from "babylonjs/Misc/observable";
  43596. import { Scene } from "babylonjs/scene";
  43597. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43598. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43599. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43600. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43601. /**
  43602. * Oculus Touch Controller
  43603. */
  43604. export class OculusTouchController extends WebVRController {
  43605. /**
  43606. * Base Url for the controller model.
  43607. */
  43608. static MODEL_BASE_URL: string;
  43609. /**
  43610. * File name for the left controller model.
  43611. */
  43612. static MODEL_LEFT_FILENAME: string;
  43613. /**
  43614. * File name for the right controller model.
  43615. */
  43616. static MODEL_RIGHT_FILENAME: string;
  43617. /**
  43618. * Base Url for the Quest controller model.
  43619. */
  43620. static QUEST_MODEL_BASE_URL: string;
  43621. /**
  43622. * @hidden
  43623. * If the controllers are running on a device that needs the updated Quest controller models
  43624. */
  43625. static _IsQuest: boolean;
  43626. /**
  43627. * Fired when the secondary trigger on this controller is modified
  43628. */
  43629. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  43630. /**
  43631. * Fired when the thumb rest on this controller is modified
  43632. */
  43633. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  43634. /**
  43635. * Creates a new OculusTouchController from a gamepad
  43636. * @param vrGamepad the gamepad that the controller should be created from
  43637. */
  43638. constructor(vrGamepad: any);
  43639. /**
  43640. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43641. * @param scene scene in which to add meshes
  43642. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43643. */
  43644. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43645. /**
  43646. * Fired when the A button on this controller is modified
  43647. */
  43648. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43649. /**
  43650. * Fired when the B button on this controller is modified
  43651. */
  43652. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43653. /**
  43654. * Fired when the X button on this controller is modified
  43655. */
  43656. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43657. /**
  43658. * Fired when the Y button on this controller is modified
  43659. */
  43660. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43661. /**
  43662. * Called once for each button that changed state since the last frame
  43663. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  43664. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  43665. * 2) secondary trigger (same)
  43666. * 3) A (right) X (left), touch, pressed = value
  43667. * 4) B / Y
  43668. * 5) thumb rest
  43669. * @param buttonIdx Which button index changed
  43670. * @param state New state of the button
  43671. * @param changes Which properties on the state changed since last frame
  43672. */
  43673. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43674. }
  43675. }
  43676. declare module "babylonjs/Gamepads/Controllers/viveController" {
  43677. import { Scene } from "babylonjs/scene";
  43678. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43679. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43680. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43681. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43682. import { Observable } from "babylonjs/Misc/observable";
  43683. /**
  43684. * Vive Controller
  43685. */
  43686. export class ViveController extends WebVRController {
  43687. /**
  43688. * Base Url for the controller model.
  43689. */
  43690. static MODEL_BASE_URL: string;
  43691. /**
  43692. * File name for the controller model.
  43693. */
  43694. static MODEL_FILENAME: string;
  43695. /**
  43696. * Creates a new ViveController from a gamepad
  43697. * @param vrGamepad the gamepad that the controller should be created from
  43698. */
  43699. constructor(vrGamepad: any);
  43700. /**
  43701. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43702. * @param scene scene in which to add meshes
  43703. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43704. */
  43705. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43706. /**
  43707. * Fired when the left button on this controller is modified
  43708. */
  43709. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43710. /**
  43711. * Fired when the right button on this controller is modified
  43712. */
  43713. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43714. /**
  43715. * Fired when the menu button on this controller is modified
  43716. */
  43717. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43718. /**
  43719. * Called once for each button that changed state since the last frame
  43720. * Vive mapping:
  43721. * 0: touchpad
  43722. * 1: trigger
  43723. * 2: left AND right buttons
  43724. * 3: menu button
  43725. * @param buttonIdx Which button index changed
  43726. * @param state New state of the button
  43727. * @param changes Which properties on the state changed since last frame
  43728. */
  43729. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43730. }
  43731. }
  43732. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  43733. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43734. /**
  43735. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  43736. */
  43737. export class WebXRControllerModelLoader {
  43738. /**
  43739. * Creates the WebXRControllerModelLoader
  43740. * @param input xr input that creates the controllers
  43741. */
  43742. constructor(input: WebXRInput);
  43743. }
  43744. }
  43745. declare module "babylonjs/Cameras/XR/index" {
  43746. export * from "babylonjs/Cameras/XR/webXRCamera";
  43747. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  43748. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43749. export * from "babylonjs/Cameras/XR/webXRInput";
  43750. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  43751. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  43752. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  43753. export * from "babylonjs/Cameras/XR/webXRController";
  43754. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  43755. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  43756. }
  43757. declare module "babylonjs/Cameras/RigModes/index" {
  43758. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  43759. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  43760. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  43761. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  43762. }
  43763. declare module "babylonjs/Cameras/index" {
  43764. export * from "babylonjs/Cameras/Inputs/index";
  43765. export * from "babylonjs/Cameras/cameraInputsManager";
  43766. export * from "babylonjs/Cameras/camera";
  43767. export * from "babylonjs/Cameras/targetCamera";
  43768. export * from "babylonjs/Cameras/freeCamera";
  43769. export * from "babylonjs/Cameras/freeCameraInputsManager";
  43770. export * from "babylonjs/Cameras/touchCamera";
  43771. export * from "babylonjs/Cameras/arcRotateCamera";
  43772. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  43773. export * from "babylonjs/Cameras/deviceOrientationCamera";
  43774. export * from "babylonjs/Cameras/flyCamera";
  43775. export * from "babylonjs/Cameras/flyCameraInputsManager";
  43776. export * from "babylonjs/Cameras/followCamera";
  43777. export * from "babylonjs/Cameras/followCameraInputsManager";
  43778. export * from "babylonjs/Cameras/gamepadCamera";
  43779. export * from "babylonjs/Cameras/Stereoscopic/index";
  43780. export * from "babylonjs/Cameras/universalCamera";
  43781. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  43782. export * from "babylonjs/Cameras/VR/index";
  43783. export * from "babylonjs/Cameras/XR/index";
  43784. export * from "babylonjs/Cameras/RigModes/index";
  43785. }
  43786. declare module "babylonjs/Collisions/index" {
  43787. export * from "babylonjs/Collisions/collider";
  43788. export * from "babylonjs/Collisions/collisionCoordinator";
  43789. export * from "babylonjs/Collisions/pickingInfo";
  43790. export * from "babylonjs/Collisions/intersectionInfo";
  43791. export * from "babylonjs/Collisions/meshCollisionData";
  43792. }
  43793. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  43794. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  43795. import { Vector3 } from "babylonjs/Maths/math.vector";
  43796. import { Ray } from "babylonjs/Culling/ray";
  43797. import { Plane } from "babylonjs/Maths/math.plane";
  43798. /**
  43799. * Contains an array of blocks representing the octree
  43800. */
  43801. export interface IOctreeContainer<T> {
  43802. /**
  43803. * Blocks within the octree
  43804. */
  43805. blocks: Array<OctreeBlock<T>>;
  43806. }
  43807. /**
  43808. * Class used to store a cell in an octree
  43809. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43810. */
  43811. export class OctreeBlock<T> {
  43812. /**
  43813. * Gets the content of the current block
  43814. */
  43815. entries: T[];
  43816. /**
  43817. * Gets the list of block children
  43818. */
  43819. blocks: Array<OctreeBlock<T>>;
  43820. private _depth;
  43821. private _maxDepth;
  43822. private _capacity;
  43823. private _minPoint;
  43824. private _maxPoint;
  43825. private _boundingVectors;
  43826. private _creationFunc;
  43827. /**
  43828. * Creates a new block
  43829. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  43830. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  43831. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  43832. * @param depth defines the current depth of this block in the octree
  43833. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  43834. * @param creationFunc defines a callback to call when an element is added to the block
  43835. */
  43836. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  43837. /**
  43838. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  43839. */
  43840. readonly capacity: number;
  43841. /**
  43842. * Gets the minimum vector (in world space) of the block's bounding box
  43843. */
  43844. readonly minPoint: Vector3;
  43845. /**
  43846. * Gets the maximum vector (in world space) of the block's bounding box
  43847. */
  43848. readonly maxPoint: Vector3;
  43849. /**
  43850. * Add a new element to this block
  43851. * @param entry defines the element to add
  43852. */
  43853. addEntry(entry: T): void;
  43854. /**
  43855. * Remove an element from this block
  43856. * @param entry defines the element to remove
  43857. */
  43858. removeEntry(entry: T): void;
  43859. /**
  43860. * Add an array of elements to this block
  43861. * @param entries defines the array of elements to add
  43862. */
  43863. addEntries(entries: T[]): void;
  43864. /**
  43865. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  43866. * @param frustumPlanes defines the frustum planes to test
  43867. * @param selection defines the array to store current content if selection is positive
  43868. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43869. */
  43870. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  43871. /**
  43872. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  43873. * @param sphereCenter defines the bounding sphere center
  43874. * @param sphereRadius defines the bounding sphere radius
  43875. * @param selection defines the array to store current content if selection is positive
  43876. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43877. */
  43878. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  43879. /**
  43880. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  43881. * @param ray defines the ray to test with
  43882. * @param selection defines the array to store current content if selection is positive
  43883. */
  43884. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  43885. /**
  43886. * Subdivide the content into child blocks (this block will then be empty)
  43887. */
  43888. createInnerBlocks(): void;
  43889. /**
  43890. * @hidden
  43891. */
  43892. 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;
  43893. }
  43894. }
  43895. declare module "babylonjs/Culling/Octrees/octree" {
  43896. import { SmartArray } from "babylonjs/Misc/smartArray";
  43897. import { Vector3 } from "babylonjs/Maths/math.vector";
  43898. import { SubMesh } from "babylonjs/Meshes/subMesh";
  43899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43900. import { Ray } from "babylonjs/Culling/ray";
  43901. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  43902. import { Plane } from "babylonjs/Maths/math.plane";
  43903. /**
  43904. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  43905. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43906. */
  43907. export class Octree<T> {
  43908. /** 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.) */
  43909. maxDepth: number;
  43910. /**
  43911. * Blocks within the octree containing objects
  43912. */
  43913. blocks: Array<OctreeBlock<T>>;
  43914. /**
  43915. * Content stored in the octree
  43916. */
  43917. dynamicContent: T[];
  43918. private _maxBlockCapacity;
  43919. private _selectionContent;
  43920. private _creationFunc;
  43921. /**
  43922. * Creates a octree
  43923. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43924. * @param creationFunc function to be used to instatiate the octree
  43925. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  43926. * @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.)
  43927. */
  43928. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  43929. /** 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.) */
  43930. maxDepth?: number);
  43931. /**
  43932. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  43933. * @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);
  43934. * @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);
  43935. * @param entries meshes to be added to the octree blocks
  43936. */
  43937. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  43938. /**
  43939. * Adds a mesh to the octree
  43940. * @param entry Mesh to add to the octree
  43941. */
  43942. addMesh(entry: T): void;
  43943. /**
  43944. * Remove an element from the octree
  43945. * @param entry defines the element to remove
  43946. */
  43947. removeMesh(entry: T): void;
  43948. /**
  43949. * Selects an array of meshes within the frustum
  43950. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  43951. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  43952. * @returns array of meshes within the frustum
  43953. */
  43954. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  43955. /**
  43956. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  43957. * @param sphereCenter defines the bounding sphere center
  43958. * @param sphereRadius defines the bounding sphere radius
  43959. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43960. * @returns an array of objects that intersect the sphere
  43961. */
  43962. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  43963. /**
  43964. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  43965. * @param ray defines the ray to test with
  43966. * @returns array of intersected objects
  43967. */
  43968. intersectsRay(ray: Ray): SmartArray<T>;
  43969. /**
  43970. * Adds a mesh into the octree block if it intersects the block
  43971. */
  43972. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  43973. /**
  43974. * Adds a submesh into the octree block if it intersects the block
  43975. */
  43976. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  43977. }
  43978. }
  43979. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  43980. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  43981. import { Scene } from "babylonjs/scene";
  43982. import { SubMesh } from "babylonjs/Meshes/subMesh";
  43983. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43984. import { Ray } from "babylonjs/Culling/ray";
  43985. import { Octree } from "babylonjs/Culling/Octrees/octree";
  43986. import { Collider } from "babylonjs/Collisions/collider";
  43987. module "babylonjs/scene" {
  43988. interface Scene {
  43989. /**
  43990. * @hidden
  43991. * Backing Filed
  43992. */
  43993. _selectionOctree: Octree<AbstractMesh>;
  43994. /**
  43995. * Gets the octree used to boost mesh selection (picking)
  43996. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43997. */
  43998. selectionOctree: Octree<AbstractMesh>;
  43999. /**
  44000. * Creates or updates the octree used to boost selection (picking)
  44001. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44002. * @param maxCapacity defines the maximum capacity per leaf
  44003. * @param maxDepth defines the maximum depth of the octree
  44004. * @returns an octree of AbstractMesh
  44005. */
  44006. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44007. }
  44008. }
  44009. module "babylonjs/Meshes/abstractMesh" {
  44010. interface AbstractMesh {
  44011. /**
  44012. * @hidden
  44013. * Backing Field
  44014. */
  44015. _submeshesOctree: Octree<SubMesh>;
  44016. /**
  44017. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44018. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44019. * @param maxCapacity defines the maximum size of each block (64 by default)
  44020. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44021. * @returns the new octree
  44022. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44023. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44024. */
  44025. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44026. }
  44027. }
  44028. /**
  44029. * Defines the octree scene component responsible to manage any octrees
  44030. * in a given scene.
  44031. */
  44032. export class OctreeSceneComponent {
  44033. /**
  44034. * The component name help to identify the component in the list of scene components.
  44035. */
  44036. readonly name: string;
  44037. /**
  44038. * The scene the component belongs to.
  44039. */
  44040. scene: Scene;
  44041. /**
  44042. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44043. */
  44044. readonly checksIsEnabled: boolean;
  44045. /**
  44046. * Creates a new instance of the component for the given scene
  44047. * @param scene Defines the scene to register the component in
  44048. */
  44049. constructor(scene: Scene);
  44050. /**
  44051. * Registers the component in a given scene
  44052. */
  44053. register(): void;
  44054. /**
  44055. * Return the list of active meshes
  44056. * @returns the list of active meshes
  44057. */
  44058. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44059. /**
  44060. * Return the list of active sub meshes
  44061. * @param mesh The mesh to get the candidates sub meshes from
  44062. * @returns the list of active sub meshes
  44063. */
  44064. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44065. private _tempRay;
  44066. /**
  44067. * Return the list of sub meshes intersecting with a given local ray
  44068. * @param mesh defines the mesh to find the submesh for
  44069. * @param localRay defines the ray in local space
  44070. * @returns the list of intersecting sub meshes
  44071. */
  44072. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44073. /**
  44074. * Return the list of sub meshes colliding with a collider
  44075. * @param mesh defines the mesh to find the submesh for
  44076. * @param collider defines the collider to evaluate the collision against
  44077. * @returns the list of colliding sub meshes
  44078. */
  44079. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  44080. /**
  44081. * Rebuilds the elements related to this component in case of
  44082. * context lost for instance.
  44083. */
  44084. rebuild(): void;
  44085. /**
  44086. * Disposes the component and the associated ressources.
  44087. */
  44088. dispose(): void;
  44089. }
  44090. }
  44091. declare module "babylonjs/Culling/Octrees/index" {
  44092. export * from "babylonjs/Culling/Octrees/octree";
  44093. export * from "babylonjs/Culling/Octrees/octreeBlock";
  44094. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  44095. }
  44096. declare module "babylonjs/Culling/index" {
  44097. export * from "babylonjs/Culling/boundingBox";
  44098. export * from "babylonjs/Culling/boundingInfo";
  44099. export * from "babylonjs/Culling/boundingSphere";
  44100. export * from "babylonjs/Culling/Octrees/index";
  44101. export * from "babylonjs/Culling/ray";
  44102. }
  44103. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  44104. import { IDisposable, Scene } from "babylonjs/scene";
  44105. import { Nullable } from "babylonjs/types";
  44106. import { Observable } from "babylonjs/Misc/observable";
  44107. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44108. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  44109. import { Camera } from "babylonjs/Cameras/camera";
  44110. /**
  44111. * Renders a layer on top of an existing scene
  44112. */
  44113. export class UtilityLayerRenderer implements IDisposable {
  44114. /** the original scene that will be rendered on top of */
  44115. originalScene: Scene;
  44116. private _pointerCaptures;
  44117. private _lastPointerEvents;
  44118. private static _DefaultUtilityLayer;
  44119. private static _DefaultKeepDepthUtilityLayer;
  44120. private _sharedGizmoLight;
  44121. private _renderCamera;
  44122. /**
  44123. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  44124. * @returns the camera that is used when rendering the utility layer
  44125. */
  44126. getRenderCamera(): Nullable<Camera>;
  44127. /**
  44128. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  44129. * @param cam the camera that should be used when rendering the utility layer
  44130. */
  44131. setRenderCamera(cam: Nullable<Camera>): void;
  44132. /**
  44133. * @hidden
  44134. * Light which used by gizmos to get light shading
  44135. */
  44136. _getSharedGizmoLight(): HemisphericLight;
  44137. /**
  44138. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  44139. */
  44140. pickUtilitySceneFirst: boolean;
  44141. /**
  44142. * 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)
  44143. */
  44144. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  44145. /**
  44146. * 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)
  44147. */
  44148. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  44149. /**
  44150. * The scene that is rendered on top of the original scene
  44151. */
  44152. utilityLayerScene: Scene;
  44153. /**
  44154. * If the utility layer should automatically be rendered on top of existing scene
  44155. */
  44156. shouldRender: boolean;
  44157. /**
  44158. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  44159. */
  44160. onlyCheckPointerDownEvents: boolean;
  44161. /**
  44162. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  44163. */
  44164. processAllEvents: boolean;
  44165. /**
  44166. * Observable raised when the pointer move from the utility layer scene to the main scene
  44167. */
  44168. onPointerOutObservable: Observable<number>;
  44169. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  44170. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  44171. private _afterRenderObserver;
  44172. private _sceneDisposeObserver;
  44173. private _originalPointerObserver;
  44174. /**
  44175. * Instantiates a UtilityLayerRenderer
  44176. * @param originalScene the original scene that will be rendered on top of
  44177. * @param handleEvents boolean indicating if the utility layer should handle events
  44178. */
  44179. constructor(
  44180. /** the original scene that will be rendered on top of */
  44181. originalScene: Scene, handleEvents?: boolean);
  44182. private _notifyObservers;
  44183. /**
  44184. * Renders the utility layers scene on top of the original scene
  44185. */
  44186. render(): void;
  44187. /**
  44188. * Disposes of the renderer
  44189. */
  44190. dispose(): void;
  44191. private _updateCamera;
  44192. }
  44193. }
  44194. declare module "babylonjs/Gizmos/gizmo" {
  44195. import { Nullable } from "babylonjs/types";
  44196. import { IDisposable } from "babylonjs/scene";
  44197. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44198. import { Mesh } from "babylonjs/Meshes/mesh";
  44199. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44200. /**
  44201. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  44202. */
  44203. export class Gizmo implements IDisposable {
  44204. /** The utility layer the gizmo will be added to */
  44205. gizmoLayer: UtilityLayerRenderer;
  44206. /**
  44207. * The root mesh of the gizmo
  44208. */
  44209. _rootMesh: Mesh;
  44210. private _attachedMesh;
  44211. /**
  44212. * Ratio for the scale of the gizmo (Default: 1)
  44213. */
  44214. scaleRatio: number;
  44215. /**
  44216. * If a custom mesh has been set (Default: false)
  44217. */
  44218. protected _customMeshSet: boolean;
  44219. /**
  44220. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  44221. * * When set, interactions will be enabled
  44222. */
  44223. attachedMesh: Nullable<AbstractMesh>;
  44224. /**
  44225. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  44226. * @param mesh The mesh to replace the default mesh of the gizmo
  44227. */
  44228. setCustomMesh(mesh: Mesh): void;
  44229. /**
  44230. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  44231. */
  44232. updateGizmoRotationToMatchAttachedMesh: boolean;
  44233. /**
  44234. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  44235. */
  44236. updateGizmoPositionToMatchAttachedMesh: boolean;
  44237. /**
  44238. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  44239. */
  44240. updateScale: boolean;
  44241. protected _interactionsEnabled: boolean;
  44242. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44243. private _beforeRenderObserver;
  44244. private _tempVector;
  44245. /**
  44246. * Creates a gizmo
  44247. * @param gizmoLayer The utility layer the gizmo will be added to
  44248. */
  44249. constructor(
  44250. /** The utility layer the gizmo will be added to */
  44251. gizmoLayer?: UtilityLayerRenderer);
  44252. /**
  44253. * Updates the gizmo to match the attached mesh's position/rotation
  44254. */
  44255. protected _update(): void;
  44256. /**
  44257. * Disposes of the gizmo
  44258. */
  44259. dispose(): void;
  44260. }
  44261. }
  44262. declare module "babylonjs/Gizmos/planeDragGizmo" {
  44263. import { Observable } from "babylonjs/Misc/observable";
  44264. import { Nullable } from "babylonjs/types";
  44265. import { Vector3 } from "babylonjs/Maths/math.vector";
  44266. import { Color3 } from "babylonjs/Maths/math.color";
  44267. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44269. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44270. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44271. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44272. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44273. import { Scene } from "babylonjs/scene";
  44274. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44275. /**
  44276. * Single plane drag gizmo
  44277. */
  44278. export class PlaneDragGizmo extends Gizmo {
  44279. /**
  44280. * Drag behavior responsible for the gizmos dragging interactions
  44281. */
  44282. dragBehavior: PointerDragBehavior;
  44283. private _pointerObserver;
  44284. /**
  44285. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44286. */
  44287. snapDistance: number;
  44288. /**
  44289. * Event that fires each time the gizmo snaps to a new location.
  44290. * * snapDistance is the the change in distance
  44291. */
  44292. onSnapObservable: Observable<{
  44293. snapDistance: number;
  44294. }>;
  44295. private _plane;
  44296. private _coloredMaterial;
  44297. private _hoverMaterial;
  44298. private _isEnabled;
  44299. private _parent;
  44300. /** @hidden */
  44301. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  44302. /** @hidden */
  44303. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44304. /**
  44305. * Creates a PlaneDragGizmo
  44306. * @param gizmoLayer The utility layer the gizmo will be added to
  44307. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  44308. * @param color The color of the gizmo
  44309. */
  44310. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44311. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44312. /**
  44313. * If the gizmo is enabled
  44314. */
  44315. isEnabled: boolean;
  44316. /**
  44317. * Disposes of the gizmo
  44318. */
  44319. dispose(): void;
  44320. }
  44321. }
  44322. declare module "babylonjs/Gizmos/positionGizmo" {
  44323. import { Observable } from "babylonjs/Misc/observable";
  44324. import { Nullable } from "babylonjs/types";
  44325. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44326. import { Mesh } from "babylonjs/Meshes/mesh";
  44327. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44328. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  44329. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  44330. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44331. /**
  44332. * Gizmo that enables dragging a mesh along 3 axis
  44333. */
  44334. export class PositionGizmo extends Gizmo {
  44335. /**
  44336. * Internal gizmo used for interactions on the x axis
  44337. */
  44338. xGizmo: AxisDragGizmo;
  44339. /**
  44340. * Internal gizmo used for interactions on the y axis
  44341. */
  44342. yGizmo: AxisDragGizmo;
  44343. /**
  44344. * Internal gizmo used for interactions on the z axis
  44345. */
  44346. zGizmo: AxisDragGizmo;
  44347. /**
  44348. * Internal gizmo used for interactions on the yz plane
  44349. */
  44350. xPlaneGizmo: PlaneDragGizmo;
  44351. /**
  44352. * Internal gizmo used for interactions on the xz plane
  44353. */
  44354. yPlaneGizmo: PlaneDragGizmo;
  44355. /**
  44356. * Internal gizmo used for interactions on the xy plane
  44357. */
  44358. zPlaneGizmo: PlaneDragGizmo;
  44359. /**
  44360. * private variables
  44361. */
  44362. private _meshAttached;
  44363. private _updateGizmoRotationToMatchAttachedMesh;
  44364. private _snapDistance;
  44365. private _scaleRatio;
  44366. /** Fires an event when any of it's sub gizmos are dragged */
  44367. onDragStartObservable: Observable<unknown>;
  44368. /** Fires an event when any of it's sub gizmos are released from dragging */
  44369. onDragEndObservable: Observable<unknown>;
  44370. /**
  44371. * If set to true, planar drag is enabled
  44372. */
  44373. private _planarGizmoEnabled;
  44374. attachedMesh: Nullable<AbstractMesh>;
  44375. /**
  44376. * Creates a PositionGizmo
  44377. * @param gizmoLayer The utility layer the gizmo will be added to
  44378. */
  44379. constructor(gizmoLayer?: UtilityLayerRenderer);
  44380. /**
  44381. * If the planar drag gizmo is enabled
  44382. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  44383. */
  44384. planarGizmoEnabled: boolean;
  44385. updateGizmoRotationToMatchAttachedMesh: boolean;
  44386. /**
  44387. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44388. */
  44389. snapDistance: number;
  44390. /**
  44391. * Ratio for the scale of the gizmo (Default: 1)
  44392. */
  44393. scaleRatio: number;
  44394. /**
  44395. * Disposes of the gizmo
  44396. */
  44397. dispose(): void;
  44398. /**
  44399. * CustomMeshes are not supported by this gizmo
  44400. * @param mesh The mesh to replace the default mesh of the gizmo
  44401. */
  44402. setCustomMesh(mesh: Mesh): void;
  44403. }
  44404. }
  44405. declare module "babylonjs/Gizmos/axisDragGizmo" {
  44406. import { Observable } from "babylonjs/Misc/observable";
  44407. import { Nullable } from "babylonjs/types";
  44408. import { Vector3 } from "babylonjs/Maths/math.vector";
  44409. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44411. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44412. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44413. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44414. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44415. import { Scene } from "babylonjs/scene";
  44416. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44417. import { Color3 } from "babylonjs/Maths/math.color";
  44418. /**
  44419. * Single axis drag gizmo
  44420. */
  44421. export class AxisDragGizmo extends Gizmo {
  44422. /**
  44423. * Drag behavior responsible for the gizmos dragging interactions
  44424. */
  44425. dragBehavior: PointerDragBehavior;
  44426. private _pointerObserver;
  44427. /**
  44428. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44429. */
  44430. snapDistance: number;
  44431. /**
  44432. * Event that fires each time the gizmo snaps to a new location.
  44433. * * snapDistance is the the change in distance
  44434. */
  44435. onSnapObservable: Observable<{
  44436. snapDistance: number;
  44437. }>;
  44438. private _isEnabled;
  44439. private _parent;
  44440. private _arrow;
  44441. private _coloredMaterial;
  44442. private _hoverMaterial;
  44443. /** @hidden */
  44444. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  44445. /** @hidden */
  44446. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44447. /**
  44448. * Creates an AxisDragGizmo
  44449. * @param gizmoLayer The utility layer the gizmo will be added to
  44450. * @param dragAxis The axis which the gizmo will be able to drag on
  44451. * @param color The color of the gizmo
  44452. */
  44453. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44454. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44455. /**
  44456. * If the gizmo is enabled
  44457. */
  44458. isEnabled: boolean;
  44459. /**
  44460. * Disposes of the gizmo
  44461. */
  44462. dispose(): void;
  44463. }
  44464. }
  44465. declare module "babylonjs/Debug/axesViewer" {
  44466. import { Vector3 } from "babylonjs/Maths/math.vector";
  44467. import { Nullable } from "babylonjs/types";
  44468. import { Scene } from "babylonjs/scene";
  44469. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44470. /**
  44471. * The Axes viewer will show 3 axes in a specific point in space
  44472. */
  44473. export class AxesViewer {
  44474. private _xAxis;
  44475. private _yAxis;
  44476. private _zAxis;
  44477. private _scaleLinesFactor;
  44478. private _instanced;
  44479. /**
  44480. * Gets the hosting scene
  44481. */
  44482. scene: Scene;
  44483. /**
  44484. * Gets or sets a number used to scale line length
  44485. */
  44486. scaleLines: number;
  44487. /** Gets the node hierarchy used to render x-axis */
  44488. readonly xAxis: TransformNode;
  44489. /** Gets the node hierarchy used to render y-axis */
  44490. readonly yAxis: TransformNode;
  44491. /** Gets the node hierarchy used to render z-axis */
  44492. readonly zAxis: TransformNode;
  44493. /**
  44494. * Creates a new AxesViewer
  44495. * @param scene defines the hosting scene
  44496. * @param scaleLines defines a number used to scale line length (1 by default)
  44497. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  44498. * @param xAxis defines the node hierarchy used to render the x-axis
  44499. * @param yAxis defines the node hierarchy used to render the y-axis
  44500. * @param zAxis defines the node hierarchy used to render the z-axis
  44501. */
  44502. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  44503. /**
  44504. * Force the viewer to update
  44505. * @param position defines the position of the viewer
  44506. * @param xaxis defines the x axis of the viewer
  44507. * @param yaxis defines the y axis of the viewer
  44508. * @param zaxis defines the z axis of the viewer
  44509. */
  44510. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  44511. /**
  44512. * Creates an instance of this axes viewer.
  44513. * @returns a new axes viewer with instanced meshes
  44514. */
  44515. createInstance(): AxesViewer;
  44516. /** Releases resources */
  44517. dispose(): void;
  44518. private static _SetRenderingGroupId;
  44519. }
  44520. }
  44521. declare module "babylonjs/Debug/boneAxesViewer" {
  44522. import { Nullable } from "babylonjs/types";
  44523. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  44524. import { Vector3 } from "babylonjs/Maths/math.vector";
  44525. import { Mesh } from "babylonjs/Meshes/mesh";
  44526. import { Bone } from "babylonjs/Bones/bone";
  44527. import { Scene } from "babylonjs/scene";
  44528. /**
  44529. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  44530. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  44531. */
  44532. export class BoneAxesViewer extends AxesViewer {
  44533. /**
  44534. * Gets or sets the target mesh where to display the axes viewer
  44535. */
  44536. mesh: Nullable<Mesh>;
  44537. /**
  44538. * Gets or sets the target bone where to display the axes viewer
  44539. */
  44540. bone: Nullable<Bone>;
  44541. /** Gets current position */
  44542. pos: Vector3;
  44543. /** Gets direction of X axis */
  44544. xaxis: Vector3;
  44545. /** Gets direction of Y axis */
  44546. yaxis: Vector3;
  44547. /** Gets direction of Z axis */
  44548. zaxis: Vector3;
  44549. /**
  44550. * Creates a new BoneAxesViewer
  44551. * @param scene defines the hosting scene
  44552. * @param bone defines the target bone
  44553. * @param mesh defines the target mesh
  44554. * @param scaleLines defines a scaling factor for line length (1 by default)
  44555. */
  44556. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  44557. /**
  44558. * Force the viewer to update
  44559. */
  44560. update(): void;
  44561. /** Releases resources */
  44562. dispose(): void;
  44563. }
  44564. }
  44565. declare module "babylonjs/Debug/debugLayer" {
  44566. import { Scene } from "babylonjs/scene";
  44567. /**
  44568. * Interface used to define scene explorer extensibility option
  44569. */
  44570. export interface IExplorerExtensibilityOption {
  44571. /**
  44572. * Define the option label
  44573. */
  44574. label: string;
  44575. /**
  44576. * Defines the action to execute on click
  44577. */
  44578. action: (entity: any) => void;
  44579. }
  44580. /**
  44581. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  44582. */
  44583. export interface IExplorerExtensibilityGroup {
  44584. /**
  44585. * Defines a predicate to test if a given type mut be extended
  44586. */
  44587. predicate: (entity: any) => boolean;
  44588. /**
  44589. * Gets the list of options added to a type
  44590. */
  44591. entries: IExplorerExtensibilityOption[];
  44592. }
  44593. /**
  44594. * Interface used to define the options to use to create the Inspector
  44595. */
  44596. export interface IInspectorOptions {
  44597. /**
  44598. * Display in overlay mode (default: false)
  44599. */
  44600. overlay?: boolean;
  44601. /**
  44602. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  44603. */
  44604. globalRoot?: HTMLElement;
  44605. /**
  44606. * Display the Scene explorer
  44607. */
  44608. showExplorer?: boolean;
  44609. /**
  44610. * Display the property inspector
  44611. */
  44612. showInspector?: boolean;
  44613. /**
  44614. * Display in embed mode (both panes on the right)
  44615. */
  44616. embedMode?: boolean;
  44617. /**
  44618. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  44619. */
  44620. handleResize?: boolean;
  44621. /**
  44622. * Allow the panes to popup (default: true)
  44623. */
  44624. enablePopup?: boolean;
  44625. /**
  44626. * Allow the panes to be closed by users (default: true)
  44627. */
  44628. enableClose?: boolean;
  44629. /**
  44630. * Optional list of extensibility entries
  44631. */
  44632. explorerExtensibility?: IExplorerExtensibilityGroup[];
  44633. /**
  44634. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  44635. */
  44636. inspectorURL?: string;
  44637. }
  44638. module "babylonjs/scene" {
  44639. interface Scene {
  44640. /**
  44641. * @hidden
  44642. * Backing field
  44643. */
  44644. _debugLayer: DebugLayer;
  44645. /**
  44646. * Gets the debug layer (aka Inspector) associated with the scene
  44647. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44648. */
  44649. debugLayer: DebugLayer;
  44650. }
  44651. }
  44652. /**
  44653. * The debug layer (aka Inspector) is the go to tool in order to better understand
  44654. * what is happening in your scene
  44655. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44656. */
  44657. export class DebugLayer {
  44658. /**
  44659. * Define the url to get the inspector script from.
  44660. * By default it uses the babylonjs CDN.
  44661. * @ignoreNaming
  44662. */
  44663. static InspectorURL: string;
  44664. private _scene;
  44665. private BJSINSPECTOR;
  44666. private _onPropertyChangedObservable?;
  44667. /**
  44668. * Observable triggered when a property is changed through the inspector.
  44669. */
  44670. readonly onPropertyChangedObservable: any;
  44671. /**
  44672. * Instantiates a new debug layer.
  44673. * The debug layer (aka Inspector) is the go to tool in order to better understand
  44674. * what is happening in your scene
  44675. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44676. * @param scene Defines the scene to inspect
  44677. */
  44678. constructor(scene: Scene);
  44679. /** Creates the inspector window. */
  44680. private _createInspector;
  44681. /**
  44682. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  44683. * @param entity defines the entity to select
  44684. * @param lineContainerTitle defines the specific block to highlight
  44685. */
  44686. select(entity: any, lineContainerTitle?: string): void;
  44687. /** Get the inspector from bundle or global */
  44688. private _getGlobalInspector;
  44689. /**
  44690. * Get if the inspector is visible or not.
  44691. * @returns true if visible otherwise, false
  44692. */
  44693. isVisible(): boolean;
  44694. /**
  44695. * Hide the inspector and close its window.
  44696. */
  44697. hide(): void;
  44698. /**
  44699. * Launch the debugLayer.
  44700. * @param config Define the configuration of the inspector
  44701. * @return a promise fulfilled when the debug layer is visible
  44702. */
  44703. show(config?: IInspectorOptions): Promise<DebugLayer>;
  44704. }
  44705. }
  44706. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  44707. import { Nullable } from "babylonjs/types";
  44708. import { Scene } from "babylonjs/scene";
  44709. import { Vector4 } from "babylonjs/Maths/math.vector";
  44710. import { Color4 } from "babylonjs/Maths/math.color";
  44711. import { Mesh } from "babylonjs/Meshes/mesh";
  44712. /**
  44713. * Class containing static functions to help procedurally build meshes
  44714. */
  44715. export class BoxBuilder {
  44716. /**
  44717. * Creates a box mesh
  44718. * * The parameter `size` sets the size (float) of each box side (default 1)
  44719. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  44720. * * 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)
  44721. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  44722. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44723. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44724. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44725. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  44726. * @param name defines the name of the mesh
  44727. * @param options defines the options used to create the mesh
  44728. * @param scene defines the hosting scene
  44729. * @returns the box mesh
  44730. */
  44731. static CreateBox(name: string, options: {
  44732. size?: number;
  44733. width?: number;
  44734. height?: number;
  44735. depth?: number;
  44736. faceUV?: Vector4[];
  44737. faceColors?: Color4[];
  44738. sideOrientation?: number;
  44739. frontUVs?: Vector4;
  44740. backUVs?: Vector4;
  44741. wrap?: boolean;
  44742. topBaseAt?: number;
  44743. bottomBaseAt?: number;
  44744. updatable?: boolean;
  44745. }, scene?: Nullable<Scene>): Mesh;
  44746. }
  44747. }
  44748. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  44749. import { Vector4 } from "babylonjs/Maths/math.vector";
  44750. import { Mesh } from "babylonjs/Meshes/mesh";
  44751. import { Scene } from "babylonjs/scene";
  44752. import { Nullable } from "babylonjs/types";
  44753. /**
  44754. * Class containing static functions to help procedurally build meshes
  44755. */
  44756. export class SphereBuilder {
  44757. /**
  44758. * Creates a sphere mesh
  44759. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  44760. * * 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`)
  44761. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  44762. * * 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
  44763. * * 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)
  44764. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44765. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44766. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44767. * @param name defines the name of the mesh
  44768. * @param options defines the options used to create the mesh
  44769. * @param scene defines the hosting scene
  44770. * @returns the sphere mesh
  44771. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  44772. */
  44773. static CreateSphere(name: string, options: {
  44774. segments?: number;
  44775. diameter?: number;
  44776. diameterX?: number;
  44777. diameterY?: number;
  44778. diameterZ?: number;
  44779. arc?: number;
  44780. slice?: number;
  44781. sideOrientation?: number;
  44782. frontUVs?: Vector4;
  44783. backUVs?: Vector4;
  44784. updatable?: boolean;
  44785. }, scene?: Nullable<Scene>): Mesh;
  44786. }
  44787. }
  44788. declare module "babylonjs/Debug/physicsViewer" {
  44789. import { Nullable } from "babylonjs/types";
  44790. import { Scene } from "babylonjs/scene";
  44791. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44792. import { Mesh } from "babylonjs/Meshes/mesh";
  44793. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  44794. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  44795. /**
  44796. * Used to show the physics impostor around the specific mesh
  44797. */
  44798. export class PhysicsViewer {
  44799. /** @hidden */
  44800. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  44801. /** @hidden */
  44802. protected _meshes: Array<Nullable<AbstractMesh>>;
  44803. /** @hidden */
  44804. protected _scene: Nullable<Scene>;
  44805. /** @hidden */
  44806. protected _numMeshes: number;
  44807. /** @hidden */
  44808. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  44809. private _renderFunction;
  44810. private _utilityLayer;
  44811. private _debugBoxMesh;
  44812. private _debugSphereMesh;
  44813. private _debugCylinderMesh;
  44814. private _debugMaterial;
  44815. private _debugMeshMeshes;
  44816. /**
  44817. * Creates a new PhysicsViewer
  44818. * @param scene defines the hosting scene
  44819. */
  44820. constructor(scene: Scene);
  44821. /** @hidden */
  44822. protected _updateDebugMeshes(): void;
  44823. /**
  44824. * Renders a specified physic impostor
  44825. * @param impostor defines the impostor to render
  44826. * @param targetMesh defines the mesh represented by the impostor
  44827. * @returns the new debug mesh used to render the impostor
  44828. */
  44829. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  44830. /**
  44831. * Hides a specified physic impostor
  44832. * @param impostor defines the impostor to hide
  44833. */
  44834. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  44835. private _getDebugMaterial;
  44836. private _getDebugBoxMesh;
  44837. private _getDebugSphereMesh;
  44838. private _getDebugCylinderMesh;
  44839. private _getDebugMeshMesh;
  44840. private _getDebugMesh;
  44841. /** Releases all resources */
  44842. dispose(): void;
  44843. }
  44844. }
  44845. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  44846. import { Vector3 } from "babylonjs/Maths/math.vector";
  44847. import { Color4 } from "babylonjs/Maths/math.color";
  44848. import { Nullable } from "babylonjs/types";
  44849. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  44850. import { Scene } from "babylonjs/scene";
  44851. /**
  44852. * Class containing static functions to help procedurally build meshes
  44853. */
  44854. export class LinesBuilder {
  44855. /**
  44856. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  44857. * * 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
  44858. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  44859. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  44860. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  44861. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  44862. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  44863. * * 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
  44864. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  44865. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44866. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  44867. * @param name defines the name of the new line system
  44868. * @param options defines the options used to create the line system
  44869. * @param scene defines the hosting scene
  44870. * @returns a new line system mesh
  44871. */
  44872. static CreateLineSystem(name: string, options: {
  44873. lines: Vector3[][];
  44874. updatable?: boolean;
  44875. instance?: Nullable<LinesMesh>;
  44876. colors?: Nullable<Color4[][]>;
  44877. useVertexAlpha?: boolean;
  44878. }, scene: Nullable<Scene>): LinesMesh;
  44879. /**
  44880. * Creates a line mesh
  44881. * 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
  44882. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  44883. * * The parameter `points` is an array successive Vector3
  44884. * * 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
  44885. * * The optional parameter `colors` is an array of successive Color4, one per line point
  44886. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  44887. * * When updating an instance, remember that only point positions can change, not the number of points
  44888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44889. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  44890. * @param name defines the name of the new line system
  44891. * @param options defines the options used to create the line system
  44892. * @param scene defines the hosting scene
  44893. * @returns a new line mesh
  44894. */
  44895. static CreateLines(name: string, options: {
  44896. points: Vector3[];
  44897. updatable?: boolean;
  44898. instance?: Nullable<LinesMesh>;
  44899. colors?: Color4[];
  44900. useVertexAlpha?: boolean;
  44901. }, scene?: Nullable<Scene>): LinesMesh;
  44902. /**
  44903. * Creates a dashed line mesh
  44904. * * 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
  44905. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  44906. * * The parameter `points` is an array successive Vector3
  44907. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  44908. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  44909. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  44910. * * 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
  44911. * * When updating an instance, remember that only point positions can change, not the number of points
  44912. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44913. * @param name defines the name of the mesh
  44914. * @param options defines the options used to create the mesh
  44915. * @param scene defines the hosting scene
  44916. * @returns the dashed line mesh
  44917. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  44918. */
  44919. static CreateDashedLines(name: string, options: {
  44920. points: Vector3[];
  44921. dashSize?: number;
  44922. gapSize?: number;
  44923. dashNb?: number;
  44924. updatable?: boolean;
  44925. instance?: LinesMesh;
  44926. }, scene?: Nullable<Scene>): LinesMesh;
  44927. }
  44928. }
  44929. declare module "babylonjs/Debug/rayHelper" {
  44930. import { Nullable } from "babylonjs/types";
  44931. import { Ray } from "babylonjs/Culling/ray";
  44932. import { Vector3 } from "babylonjs/Maths/math.vector";
  44933. import { Color3 } from "babylonjs/Maths/math.color";
  44934. import { Scene } from "babylonjs/scene";
  44935. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44936. import "babylonjs/Meshes/Builders/linesBuilder";
  44937. /**
  44938. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  44939. * in order to better appreciate the issue one might have.
  44940. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  44941. */
  44942. export class RayHelper {
  44943. /**
  44944. * Defines the ray we are currently tryin to visualize.
  44945. */
  44946. ray: Nullable<Ray>;
  44947. private _renderPoints;
  44948. private _renderLine;
  44949. private _renderFunction;
  44950. private _scene;
  44951. private _updateToMeshFunction;
  44952. private _attachedToMesh;
  44953. private _meshSpaceDirection;
  44954. private _meshSpaceOrigin;
  44955. /**
  44956. * Helper function to create a colored helper in a scene in one line.
  44957. * @param ray Defines the ray we are currently tryin to visualize
  44958. * @param scene Defines the scene the ray is used in
  44959. * @param color Defines the color we want to see the ray in
  44960. * @returns The newly created ray helper.
  44961. */
  44962. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  44963. /**
  44964. * Instantiate a new ray helper.
  44965. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  44966. * in order to better appreciate the issue one might have.
  44967. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  44968. * @param ray Defines the ray we are currently tryin to visualize
  44969. */
  44970. constructor(ray: Ray);
  44971. /**
  44972. * Shows the ray we are willing to debug.
  44973. * @param scene Defines the scene the ray needs to be rendered in
  44974. * @param color Defines the color the ray needs to be rendered in
  44975. */
  44976. show(scene: Scene, color?: Color3): void;
  44977. /**
  44978. * Hides the ray we are debugging.
  44979. */
  44980. hide(): void;
  44981. private _render;
  44982. /**
  44983. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  44984. * @param mesh Defines the mesh we want the helper attached to
  44985. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  44986. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  44987. * @param length Defines the length of the ray
  44988. */
  44989. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  44990. /**
  44991. * Detach the ray helper from the mesh it has previously been attached to.
  44992. */
  44993. detachFromMesh(): void;
  44994. private _updateToMesh;
  44995. /**
  44996. * Dispose the helper and release its associated resources.
  44997. */
  44998. dispose(): void;
  44999. }
  45000. }
  45001. declare module "babylonjs/Debug/skeletonViewer" {
  45002. import { Color3 } from "babylonjs/Maths/math.color";
  45003. import { Scene } from "babylonjs/scene";
  45004. import { Nullable } from "babylonjs/types";
  45005. import { Skeleton } from "babylonjs/Bones/skeleton";
  45006. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45007. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45008. /**
  45009. * Class used to render a debug view of a given skeleton
  45010. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45011. */
  45012. export class SkeletonViewer {
  45013. /** defines the skeleton to render */
  45014. skeleton: Skeleton;
  45015. /** defines the mesh attached to the skeleton */
  45016. mesh: AbstractMesh;
  45017. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45018. autoUpdateBonesMatrices: boolean;
  45019. /** defines the rendering group id to use with the viewer */
  45020. renderingGroupId: number;
  45021. /** Gets or sets the color used to render the skeleton */
  45022. color: Color3;
  45023. private _scene;
  45024. private _debugLines;
  45025. private _debugMesh;
  45026. private _isEnabled;
  45027. private _renderFunction;
  45028. private _utilityLayer;
  45029. /**
  45030. * Returns the mesh used to render the bones
  45031. */
  45032. readonly debugMesh: Nullable<LinesMesh>;
  45033. /**
  45034. * Creates a new SkeletonViewer
  45035. * @param skeleton defines the skeleton to render
  45036. * @param mesh defines the mesh attached to the skeleton
  45037. * @param scene defines the hosting scene
  45038. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45039. * @param renderingGroupId defines the rendering group id to use with the viewer
  45040. */
  45041. constructor(
  45042. /** defines the skeleton to render */
  45043. skeleton: Skeleton,
  45044. /** defines the mesh attached to the skeleton */
  45045. mesh: AbstractMesh, scene: Scene,
  45046. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45047. autoUpdateBonesMatrices?: boolean,
  45048. /** defines the rendering group id to use with the viewer */
  45049. renderingGroupId?: number);
  45050. /** Gets or sets a boolean indicating if the viewer is enabled */
  45051. isEnabled: boolean;
  45052. private _getBonePosition;
  45053. private _getLinesForBonesWithLength;
  45054. private _getLinesForBonesNoLength;
  45055. /** Update the viewer to sync with current skeleton state */
  45056. update(): void;
  45057. /** Release associated resources */
  45058. dispose(): void;
  45059. }
  45060. }
  45061. declare module "babylonjs/Debug/index" {
  45062. export * from "babylonjs/Debug/axesViewer";
  45063. export * from "babylonjs/Debug/boneAxesViewer";
  45064. export * from "babylonjs/Debug/debugLayer";
  45065. export * from "babylonjs/Debug/physicsViewer";
  45066. export * from "babylonjs/Debug/rayHelper";
  45067. export * from "babylonjs/Debug/skeletonViewer";
  45068. }
  45069. declare module "babylonjs/Engines/nullEngine" {
  45070. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45071. import { Scene } from "babylonjs/scene";
  45072. import { Engine } from "babylonjs/Engines/engine";
  45073. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45074. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45075. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45076. import { Effect } from "babylonjs/Materials/effect";
  45077. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45078. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45079. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  45080. /**
  45081. * Options to create the null engine
  45082. */
  45083. export class NullEngineOptions {
  45084. /**
  45085. * Render width (Default: 512)
  45086. */
  45087. renderWidth: number;
  45088. /**
  45089. * Render height (Default: 256)
  45090. */
  45091. renderHeight: number;
  45092. /**
  45093. * Texture size (Default: 512)
  45094. */
  45095. textureSize: number;
  45096. /**
  45097. * If delta time between frames should be constant
  45098. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45099. */
  45100. deterministicLockstep: boolean;
  45101. /**
  45102. * Maximum about of steps between frames (Default: 4)
  45103. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45104. */
  45105. lockstepMaxSteps: number;
  45106. }
  45107. /**
  45108. * The null engine class provides support for headless version of babylon.js.
  45109. * This can be used in server side scenario or for testing purposes
  45110. */
  45111. export class NullEngine extends Engine {
  45112. private _options;
  45113. /**
  45114. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45115. */
  45116. isDeterministicLockStep(): boolean;
  45117. /** @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep */
  45118. getLockstepMaxSteps(): number;
  45119. /**
  45120. * Sets hardware scaling, used to save performance if needed
  45121. * @see https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  45122. */
  45123. getHardwareScalingLevel(): number;
  45124. constructor(options?: NullEngineOptions);
  45125. createVertexBuffer(vertices: FloatArray): DataBuffer;
  45126. createIndexBuffer(indices: IndicesArray): DataBuffer;
  45127. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  45128. getRenderWidth(useScreen?: boolean): number;
  45129. getRenderHeight(useScreen?: boolean): number;
  45130. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  45131. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  45132. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  45133. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45134. bindSamplers(effect: Effect): void;
  45135. enableEffect(effect: Effect): void;
  45136. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45137. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45138. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45139. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45140. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45141. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45142. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45143. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45144. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45145. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45146. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45147. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45148. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45149. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45150. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45151. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45152. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45153. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45154. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45155. setBool(uniform: WebGLUniformLocation, bool: number): void;
  45156. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  45157. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  45158. bindBuffers(vertexBuffers: {
  45159. [key: string]: VertexBuffer;
  45160. }, indexBuffer: DataBuffer, effect: Effect): void;
  45161. wipeCaches(bruteForce?: boolean): void;
  45162. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  45163. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  45164. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  45165. /** @hidden */
  45166. _createTexture(): WebGLTexture;
  45167. /** @hidden */
  45168. _releaseTexture(texture: InternalTexture): void;
  45169. 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;
  45170. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  45171. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  45172. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  45173. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  45174. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  45175. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  45176. areAllEffectsReady(): boolean;
  45177. /**
  45178. * @hidden
  45179. * Get the current error code of the webGL context
  45180. * @returns the error code
  45181. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  45182. */
  45183. getError(): number;
  45184. /** @hidden */
  45185. _getUnpackAlignement(): number;
  45186. /** @hidden */
  45187. _unpackFlipY(value: boolean): void;
  45188. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  45189. /**
  45190. * Updates a dynamic vertex buffer.
  45191. * @param vertexBuffer the vertex buffer to update
  45192. * @param data the data used to update the vertex buffer
  45193. * @param byteOffset the byte offset of the data (optional)
  45194. * @param byteLength the byte length of the data (optional)
  45195. */
  45196. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  45197. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  45198. /** @hidden */
  45199. _bindTexture(channel: number, texture: InternalTexture): void;
  45200. protected _deleteBuffer(buffer: WebGLBuffer): void;
  45201. releaseEffects(): void;
  45202. displayLoadingUI(): void;
  45203. hideLoadingUI(): void;
  45204. /** @hidden */
  45205. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45206. /** @hidden */
  45207. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45208. /** @hidden */
  45209. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45210. /** @hidden */
  45211. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  45212. }
  45213. }
  45214. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  45215. import { Nullable, int } from "babylonjs/types";
  45216. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  45217. /** @hidden */
  45218. export class _OcclusionDataStorage {
  45219. /** @hidden */
  45220. occlusionInternalRetryCounter: number;
  45221. /** @hidden */
  45222. isOcclusionQueryInProgress: boolean;
  45223. /** @hidden */
  45224. isOccluded: boolean;
  45225. /** @hidden */
  45226. occlusionRetryCount: number;
  45227. /** @hidden */
  45228. occlusionType: number;
  45229. /** @hidden */
  45230. occlusionQueryAlgorithmType: number;
  45231. }
  45232. module "babylonjs/Engines/engine" {
  45233. interface Engine {
  45234. /**
  45235. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  45236. * @return the new query
  45237. */
  45238. createQuery(): WebGLQuery;
  45239. /**
  45240. * Delete and release a webGL query
  45241. * @param query defines the query to delete
  45242. * @return the current engine
  45243. */
  45244. deleteQuery(query: WebGLQuery): Engine;
  45245. /**
  45246. * Check if a given query has resolved and got its value
  45247. * @param query defines the query to check
  45248. * @returns true if the query got its value
  45249. */
  45250. isQueryResultAvailable(query: WebGLQuery): boolean;
  45251. /**
  45252. * Gets the value of a given query
  45253. * @param query defines the query to check
  45254. * @returns the value of the query
  45255. */
  45256. getQueryResult(query: WebGLQuery): number;
  45257. /**
  45258. * Initiates an occlusion query
  45259. * @param algorithmType defines the algorithm to use
  45260. * @param query defines the query to use
  45261. * @returns the current engine
  45262. * @see http://doc.babylonjs.com/features/occlusionquery
  45263. */
  45264. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  45265. /**
  45266. * Ends an occlusion query
  45267. * @see http://doc.babylonjs.com/features/occlusionquery
  45268. * @param algorithmType defines the algorithm to use
  45269. * @returns the current engine
  45270. */
  45271. endOcclusionQuery(algorithmType: number): Engine;
  45272. /**
  45273. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  45274. * Please note that only one query can be issued at a time
  45275. * @returns a time token used to track the time span
  45276. */
  45277. startTimeQuery(): Nullable<_TimeToken>;
  45278. /**
  45279. * Ends a time query
  45280. * @param token defines the token used to measure the time span
  45281. * @returns the time spent (in ns)
  45282. */
  45283. endTimeQuery(token: _TimeToken): int;
  45284. /** @hidden */
  45285. _currentNonTimestampToken: Nullable<_TimeToken>;
  45286. /** @hidden */
  45287. _createTimeQuery(): WebGLQuery;
  45288. /** @hidden */
  45289. _deleteTimeQuery(query: WebGLQuery): void;
  45290. /** @hidden */
  45291. _getGlAlgorithmType(algorithmType: number): number;
  45292. /** @hidden */
  45293. _getTimeQueryResult(query: WebGLQuery): any;
  45294. /** @hidden */
  45295. _getTimeQueryAvailability(query: WebGLQuery): any;
  45296. }
  45297. }
  45298. module "babylonjs/Meshes/abstractMesh" {
  45299. interface AbstractMesh {
  45300. /**
  45301. * Backing filed
  45302. * @hidden
  45303. */
  45304. __occlusionDataStorage: _OcclusionDataStorage;
  45305. /**
  45306. * Access property
  45307. * @hidden
  45308. */
  45309. _occlusionDataStorage: _OcclusionDataStorage;
  45310. /**
  45311. * 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.
  45312. * The default value is -1 which means don't break the query and wait till the result
  45313. * @see http://doc.babylonjs.com/features/occlusionquery
  45314. */
  45315. occlusionRetryCount: number;
  45316. /**
  45317. * 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:
  45318. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  45319. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  45320. * * 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.
  45321. * @see http://doc.babylonjs.com/features/occlusionquery
  45322. */
  45323. occlusionType: number;
  45324. /**
  45325. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  45326. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  45327. * * 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.
  45328. * @see http://doc.babylonjs.com/features/occlusionquery
  45329. */
  45330. occlusionQueryAlgorithmType: number;
  45331. /**
  45332. * 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
  45333. * @see http://doc.babylonjs.com/features/occlusionquery
  45334. */
  45335. isOccluded: boolean;
  45336. /**
  45337. * Flag to check the progress status of the query
  45338. * @see http://doc.babylonjs.com/features/occlusionquery
  45339. */
  45340. isOcclusionQueryInProgress: boolean;
  45341. }
  45342. }
  45343. }
  45344. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  45345. import { Nullable } from "babylonjs/types";
  45346. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45347. /** @hidden */
  45348. export var _forceTransformFeedbackToBundle: boolean;
  45349. module "babylonjs/Engines/engine" {
  45350. interface Engine {
  45351. /**
  45352. * Creates a webGL transform feedback object
  45353. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  45354. * @returns the webGL transform feedback object
  45355. */
  45356. createTransformFeedback(): WebGLTransformFeedback;
  45357. /**
  45358. * Delete a webGL transform feedback object
  45359. * @param value defines the webGL transform feedback object to delete
  45360. */
  45361. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  45362. /**
  45363. * Bind a webGL transform feedback object to the webgl context
  45364. * @param value defines the webGL transform feedback object to bind
  45365. */
  45366. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  45367. /**
  45368. * Begins a transform feedback operation
  45369. * @param usePoints defines if points or triangles must be used
  45370. */
  45371. beginTransformFeedback(usePoints: boolean): void;
  45372. /**
  45373. * Ends a transform feedback operation
  45374. */
  45375. endTransformFeedback(): void;
  45376. /**
  45377. * Specify the varyings to use with transform feedback
  45378. * @param program defines the associated webGL program
  45379. * @param value defines the list of strings representing the varying names
  45380. */
  45381. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  45382. /**
  45383. * Bind a webGL buffer for a transform feedback operation
  45384. * @param value defines the webGL buffer to bind
  45385. */
  45386. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  45387. }
  45388. }
  45389. }
  45390. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  45391. import { Scene } from "babylonjs/scene";
  45392. import { Engine } from "babylonjs/Engines/engine";
  45393. import { Texture } from "babylonjs/Materials/Textures/texture";
  45394. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  45395. import "babylonjs/Engines/Extensions/engine.multiRender";
  45396. /**
  45397. * Creation options of the multi render target texture.
  45398. */
  45399. export interface IMultiRenderTargetOptions {
  45400. /**
  45401. * Define if the texture needs to create mip maps after render.
  45402. */
  45403. generateMipMaps?: boolean;
  45404. /**
  45405. * Define the types of all the draw buffers we want to create
  45406. */
  45407. types?: number[];
  45408. /**
  45409. * Define the sampling modes of all the draw buffers we want to create
  45410. */
  45411. samplingModes?: number[];
  45412. /**
  45413. * Define if a depth buffer is required
  45414. */
  45415. generateDepthBuffer?: boolean;
  45416. /**
  45417. * Define if a stencil buffer is required
  45418. */
  45419. generateStencilBuffer?: boolean;
  45420. /**
  45421. * Define if a depth texture is required instead of a depth buffer
  45422. */
  45423. generateDepthTexture?: boolean;
  45424. /**
  45425. * Define the number of desired draw buffers
  45426. */
  45427. textureCount?: number;
  45428. /**
  45429. * Define if aspect ratio should be adapted to the texture or stay the scene one
  45430. */
  45431. doNotChangeAspectRatio?: boolean;
  45432. /**
  45433. * Define the default type of the buffers we are creating
  45434. */
  45435. defaultType?: number;
  45436. }
  45437. /**
  45438. * A multi render target, like a render target provides the ability to render to a texture.
  45439. * Unlike the render target, it can render to several draw buffers in one draw.
  45440. * This is specially interesting in deferred rendering or for any effects requiring more than
  45441. * just one color from a single pass.
  45442. */
  45443. export class MultiRenderTarget extends RenderTargetTexture {
  45444. private _internalTextures;
  45445. private _textures;
  45446. private _multiRenderTargetOptions;
  45447. /**
  45448. * Get if draw buffers are currently supported by the used hardware and browser.
  45449. */
  45450. readonly isSupported: boolean;
  45451. /**
  45452. * Get the list of textures generated by the multi render target.
  45453. */
  45454. readonly textures: Texture[];
  45455. /**
  45456. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  45457. */
  45458. readonly depthTexture: Texture;
  45459. /**
  45460. * Set the wrapping mode on U of all the textures we are rendering to.
  45461. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  45462. */
  45463. wrapU: number;
  45464. /**
  45465. * Set the wrapping mode on V of all the textures we are rendering to.
  45466. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  45467. */
  45468. wrapV: number;
  45469. /**
  45470. * Instantiate a new multi render target texture.
  45471. * A multi render target, like a render target provides the ability to render to a texture.
  45472. * Unlike the render target, it can render to several draw buffers in one draw.
  45473. * This is specially interesting in deferred rendering or for any effects requiring more than
  45474. * just one color from a single pass.
  45475. * @param name Define the name of the texture
  45476. * @param size Define the size of the buffers to render to
  45477. * @param count Define the number of target we are rendering into
  45478. * @param scene Define the scene the texture belongs to
  45479. * @param options Define the options used to create the multi render target
  45480. */
  45481. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  45482. /** @hidden */
  45483. _rebuild(): void;
  45484. private _createInternalTextures;
  45485. private _createTextures;
  45486. /**
  45487. * Define the number of samples used if MSAA is enabled.
  45488. */
  45489. samples: number;
  45490. /**
  45491. * Resize all the textures in the multi render target.
  45492. * Be carrefull as it will recreate all the data in the new texture.
  45493. * @param size Define the new size
  45494. */
  45495. resize(size: any): void;
  45496. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  45497. /**
  45498. * Dispose the render targets and their associated resources
  45499. */
  45500. dispose(): void;
  45501. /**
  45502. * Release all the underlying texture used as draw buffers.
  45503. */
  45504. releaseInternalTextures(): void;
  45505. }
  45506. }
  45507. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  45508. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45509. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  45510. import { Nullable } from "babylonjs/types";
  45511. module "babylonjs/Engines/engine" {
  45512. interface Engine {
  45513. /**
  45514. * Unbind a list of render target textures from the webGL context
  45515. * This is used only when drawBuffer extension or webGL2 are active
  45516. * @param textures defines the render target textures to unbind
  45517. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  45518. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  45519. */
  45520. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  45521. /**
  45522. * Create a multi render target texture
  45523. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  45524. * @param size defines the size of the texture
  45525. * @param options defines the creation options
  45526. * @returns the cube texture as an InternalTexture
  45527. */
  45528. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  45529. /**
  45530. * Update the sample count for a given multiple render target texture
  45531. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  45532. * @param textures defines the textures to update
  45533. * @param samples defines the sample count to set
  45534. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  45535. */
  45536. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  45537. }
  45538. }
  45539. }
  45540. declare module "babylonjs/Engines/Extensions/index" {
  45541. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  45542. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  45543. export * from "babylonjs/Engines/Extensions/engine.multiview";
  45544. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  45545. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  45546. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  45547. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  45548. export * from "babylonjs/Engines/Extensions/engine.webVR";
  45549. }
  45550. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  45551. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  45552. /** @hidden */
  45553. export var rgbdEncodePixelShader: {
  45554. name: string;
  45555. shader: string;
  45556. };
  45557. }
  45558. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  45559. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  45560. /** @hidden */
  45561. export var rgbdDecodePixelShader: {
  45562. name: string;
  45563. shader: string;
  45564. };
  45565. }
  45566. declare module "babylonjs/Misc/environmentTextureTools" {
  45567. import { Nullable } from "babylonjs/types";
  45568. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  45569. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45570. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  45571. import "babylonjs/Engines/Extensions/engine.renderTarget";
  45572. import "babylonjs/Shaders/rgbdEncode.fragment";
  45573. import "babylonjs/Shaders/rgbdDecode.fragment";
  45574. /**
  45575. * Raw texture data and descriptor sufficient for WebGL texture upload
  45576. */
  45577. export interface EnvironmentTextureInfo {
  45578. /**
  45579. * Version of the environment map
  45580. */
  45581. version: number;
  45582. /**
  45583. * Width of image
  45584. */
  45585. width: number;
  45586. /**
  45587. * Irradiance information stored in the file.
  45588. */
  45589. irradiance: any;
  45590. /**
  45591. * Specular information stored in the file.
  45592. */
  45593. specular: any;
  45594. }
  45595. /**
  45596. * Defines One Image in the file. It requires only the position in the file
  45597. * as well as the length.
  45598. */
  45599. interface BufferImageData {
  45600. /**
  45601. * Length of the image data.
  45602. */
  45603. length: number;
  45604. /**
  45605. * Position of the data from the null terminator delimiting the end of the JSON.
  45606. */
  45607. position: number;
  45608. }
  45609. /**
  45610. * Defines the specular data enclosed in the file.
  45611. * This corresponds to the version 1 of the data.
  45612. */
  45613. export interface EnvironmentTextureSpecularInfoV1 {
  45614. /**
  45615. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  45616. */
  45617. specularDataPosition?: number;
  45618. /**
  45619. * This contains all the images data needed to reconstruct the cubemap.
  45620. */
  45621. mipmaps: Array<BufferImageData>;
  45622. /**
  45623. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  45624. */
  45625. lodGenerationScale: number;
  45626. }
  45627. /**
  45628. * Sets of helpers addressing the serialization and deserialization of environment texture
  45629. * stored in a BabylonJS env file.
  45630. * Those files are usually stored as .env files.
  45631. */
  45632. export class EnvironmentTextureTools {
  45633. /**
  45634. * Magic number identifying the env file.
  45635. */
  45636. private static _MagicBytes;
  45637. /**
  45638. * Gets the environment info from an env file.
  45639. * @param data The array buffer containing the .env bytes.
  45640. * @returns the environment file info (the json header) if successfully parsed.
  45641. */
  45642. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  45643. /**
  45644. * Creates an environment texture from a loaded cube texture.
  45645. * @param texture defines the cube texture to convert in env file
  45646. * @return a promise containing the environment data if succesfull.
  45647. */
  45648. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  45649. /**
  45650. * Creates a JSON representation of the spherical data.
  45651. * @param texture defines the texture containing the polynomials
  45652. * @return the JSON representation of the spherical info
  45653. */
  45654. private static _CreateEnvTextureIrradiance;
  45655. /**
  45656. * Creates the ArrayBufferViews used for initializing environment texture image data.
  45657. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  45658. * @param info parameters that determine what views will be created for accessing the underlying buffer
  45659. * @return the views described by info providing access to the underlying buffer
  45660. */
  45661. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  45662. /**
  45663. * Uploads the texture info contained in the env file to the GPU.
  45664. * @param texture defines the internal texture to upload to
  45665. * @param arrayBuffer defines the buffer cotaining the data to load
  45666. * @param info defines the texture info retrieved through the GetEnvInfo method
  45667. * @returns a promise
  45668. */
  45669. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  45670. /**
  45671. * Uploads the levels of image data to the GPU.
  45672. * @param texture defines the internal texture to upload to
  45673. * @param imageData defines the array buffer views of image data [mipmap][face]
  45674. * @returns a promise
  45675. */
  45676. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  45677. /**
  45678. * Uploads spherical polynomials information to the texture.
  45679. * @param texture defines the texture we are trying to upload the information to
  45680. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  45681. */
  45682. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  45683. /** @hidden */
  45684. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  45685. }
  45686. }
  45687. declare module "babylonjs/Maths/math.vertexFormat" {
  45688. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  45689. /**
  45690. * Contains position and normal vectors for a vertex
  45691. */
  45692. export class PositionNormalVertex {
  45693. /** the position of the vertex (defaut: 0,0,0) */
  45694. position: Vector3;
  45695. /** the normal of the vertex (defaut: 0,1,0) */
  45696. normal: Vector3;
  45697. /**
  45698. * Creates a PositionNormalVertex
  45699. * @param position the position of the vertex (defaut: 0,0,0)
  45700. * @param normal the normal of the vertex (defaut: 0,1,0)
  45701. */
  45702. constructor(
  45703. /** the position of the vertex (defaut: 0,0,0) */
  45704. position?: Vector3,
  45705. /** the normal of the vertex (defaut: 0,1,0) */
  45706. normal?: Vector3);
  45707. /**
  45708. * Clones the PositionNormalVertex
  45709. * @returns the cloned PositionNormalVertex
  45710. */
  45711. clone(): PositionNormalVertex;
  45712. }
  45713. /**
  45714. * Contains position, normal and uv vectors for a vertex
  45715. */
  45716. export class PositionNormalTextureVertex {
  45717. /** the position of the vertex (defaut: 0,0,0) */
  45718. position: Vector3;
  45719. /** the normal of the vertex (defaut: 0,1,0) */
  45720. normal: Vector3;
  45721. /** the uv of the vertex (default: 0,0) */
  45722. uv: Vector2;
  45723. /**
  45724. * Creates a PositionNormalTextureVertex
  45725. * @param position the position of the vertex (defaut: 0,0,0)
  45726. * @param normal the normal of the vertex (defaut: 0,1,0)
  45727. * @param uv the uv of the vertex (default: 0,0)
  45728. */
  45729. constructor(
  45730. /** the position of the vertex (defaut: 0,0,0) */
  45731. position?: Vector3,
  45732. /** the normal of the vertex (defaut: 0,1,0) */
  45733. normal?: Vector3,
  45734. /** the uv of the vertex (default: 0,0) */
  45735. uv?: Vector2);
  45736. /**
  45737. * Clones the PositionNormalTextureVertex
  45738. * @returns the cloned PositionNormalTextureVertex
  45739. */
  45740. clone(): PositionNormalTextureVertex;
  45741. }
  45742. }
  45743. declare module "babylonjs/Maths/math" {
  45744. export * from "babylonjs/Maths/math.axis";
  45745. export * from "babylonjs/Maths/math.color";
  45746. export * from "babylonjs/Maths/math.constants";
  45747. export * from "babylonjs/Maths/math.frustum";
  45748. export * from "babylonjs/Maths/math.path";
  45749. export * from "babylonjs/Maths/math.plane";
  45750. export * from "babylonjs/Maths/math.size";
  45751. export * from "babylonjs/Maths/math.vector";
  45752. export * from "babylonjs/Maths/math.vertexFormat";
  45753. export * from "babylonjs/Maths/math.viewport";
  45754. }
  45755. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  45756. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  45757. /** @hidden */
  45758. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  45759. private _genericAttributeLocation;
  45760. private _varyingLocationCount;
  45761. private _varyingLocationMap;
  45762. private _replacements;
  45763. private _textureCount;
  45764. private _uniforms;
  45765. lineProcessor(line: string): string;
  45766. attributeProcessor(attribute: string): string;
  45767. varyingProcessor(varying: string, isFragment: boolean): string;
  45768. uniformProcessor(uniform: string): string;
  45769. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  45770. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  45771. }
  45772. }
  45773. declare module "babylonjs/Engines/nativeEngine" {
  45774. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  45775. import { Engine } from "babylonjs/Engines/engine";
  45776. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45777. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45778. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  45779. import { Effect } from "babylonjs/Materials/effect";
  45780. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45781. import { Color4, Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  45782. import { Scene } from "babylonjs/scene";
  45783. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45784. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45785. /**
  45786. * Container for accessors for natively-stored mesh data buffers.
  45787. */
  45788. class NativeDataBuffer extends DataBuffer {
  45789. /**
  45790. * Accessor value used to identify/retrieve a natively-stored index buffer.
  45791. */
  45792. nativeIndexBuffer?: any;
  45793. /**
  45794. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  45795. */
  45796. nativeVertexBuffer?: any;
  45797. }
  45798. /** @hidden */
  45799. export class NativeEngine extends Engine {
  45800. private readonly _native;
  45801. getHardwareScalingLevel(): number;
  45802. constructor();
  45803. /**
  45804. * Can be used to override the current requestAnimationFrame requester.
  45805. * @hidden
  45806. */
  45807. protected _queueNewFrame(bindedRenderFunction: any, requester: any): number;
  45808. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  45809. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  45810. createVertexBuffer(data: DataArray): NativeDataBuffer;
  45811. recordVertexArrayObject(vertexBuffers: {
  45812. [key: string]: VertexBuffer;
  45813. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  45814. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  45815. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  45816. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45817. /**
  45818. * Draw a list of indexed primitives
  45819. * @param fillMode defines the primitive to use
  45820. * @param indexStart defines the starting index
  45821. * @param indexCount defines the number of index to draw
  45822. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45823. */
  45824. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  45825. /**
  45826. * Draw a list of unindexed primitives
  45827. * @param fillMode defines the primitive to use
  45828. * @param verticesStart defines the index of first vertex to draw
  45829. * @param verticesCount defines the count of vertices to draw
  45830. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45831. */
  45832. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  45833. createPipelineContext(): IPipelineContext;
  45834. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  45835. /** @hidden */
  45836. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  45837. /** @hidden */
  45838. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  45839. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  45840. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  45841. protected _setProgram(program: WebGLProgram): void;
  45842. _releaseEffect(effect: Effect): void;
  45843. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  45844. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  45845. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  45846. bindSamplers(effect: Effect): void;
  45847. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  45848. getRenderWidth(useScreen?: boolean): number;
  45849. getRenderHeight(useScreen?: boolean): number;
  45850. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  45851. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45852. /**
  45853. * Set the z offset to apply to current rendering
  45854. * @param value defines the offset to apply
  45855. */
  45856. setZOffset(value: number): void;
  45857. /**
  45858. * Gets the current value of the zOffset
  45859. * @returns the current zOffset state
  45860. */
  45861. getZOffset(): number;
  45862. /**
  45863. * Enable or disable depth buffering
  45864. * @param enable defines the state to set
  45865. */
  45866. setDepthBuffer(enable: boolean): void;
  45867. /**
  45868. * Gets a boolean indicating if depth writing is enabled
  45869. * @returns the current depth writing state
  45870. */
  45871. getDepthWrite(): boolean;
  45872. /**
  45873. * Enable or disable depth writing
  45874. * @param enable defines the state to set
  45875. */
  45876. setDepthWrite(enable: boolean): void;
  45877. /**
  45878. * Enable or disable color writing
  45879. * @param enable defines the state to set
  45880. */
  45881. setColorWrite(enable: boolean): void;
  45882. /**
  45883. * Gets a boolean indicating if color writing is enabled
  45884. * @returns the current color writing state
  45885. */
  45886. getColorWrite(): boolean;
  45887. /**
  45888. * Sets alpha constants used by some alpha blending modes
  45889. * @param r defines the red component
  45890. * @param g defines the green component
  45891. * @param b defines the blue component
  45892. * @param a defines the alpha component
  45893. */
  45894. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  45895. /**
  45896. * Sets the current alpha mode
  45897. * @param mode defines the mode to use (one of the BABYLON.Engine.ALPHA_XXX)
  45898. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  45899. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  45900. */
  45901. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  45902. /**
  45903. * Gets the current alpha mode
  45904. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  45905. * @returns the current alpha mode
  45906. */
  45907. getAlphaMode(): number;
  45908. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45909. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45910. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45911. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45912. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45913. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45914. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45915. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45916. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45917. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45918. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45919. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45920. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45921. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45922. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45923. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45924. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45925. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45926. setBool(uniform: WebGLUniformLocation, bool: number): void;
  45927. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  45928. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  45929. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  45930. wipeCaches(bruteForce?: boolean): void;
  45931. _createTexture(): WebGLTexture;
  45932. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  45933. /**
  45934. * Usually called from BABYLON.Texture.ts.
  45935. * Passed information to create a WebGLTexture
  45936. * @param urlArg defines a value which contains one of the following:
  45937. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  45938. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  45939. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  45940. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  45941. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  45942. * @param scene needed for loading to the correct scene
  45943. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  45944. * @param onLoad optional callback to be called upon successful completion
  45945. * @param onError optional callback to be called upon failure
  45946. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  45947. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  45948. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  45949. * @param forcedExtension defines the extension to use to pick the right loader
  45950. * @returns a InternalTexture for assignment back into BABYLON.Texture
  45951. */
  45952. 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;
  45953. /**
  45954. * Creates a cube texture
  45955. * @param rootUrl defines the url where the files to load is located
  45956. * @param scene defines the current scene
  45957. * @param files defines the list of files to load (1 per face)
  45958. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  45959. * @param onLoad defines an optional callback raised when the texture is loaded
  45960. * @param onError defines an optional callback raised if there is an issue to load the texture
  45961. * @param format defines the format of the data
  45962. * @param forcedExtension defines the extension to use to pick the right loader
  45963. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  45964. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  45965. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  45966. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  45967. * @returns the cube texture as an InternalTexture
  45968. */
  45969. 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;
  45970. private _getSamplingFilter;
  45971. private static _GetNativeTextureFormat;
  45972. createRenderTargetTexture(size: number | {
  45973. width: number;
  45974. height: number;
  45975. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  45976. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  45977. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  45978. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  45979. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  45980. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  45981. /**
  45982. * Updates a dynamic vertex buffer.
  45983. * @param vertexBuffer the vertex buffer to update
  45984. * @param data the data used to update the vertex buffer
  45985. * @param byteOffset the byte offset of the data (optional)
  45986. * @param byteLength the byte length of the data (optional)
  45987. */
  45988. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  45989. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  45990. private _updateAnisotropicLevel;
  45991. private _getAddressMode;
  45992. /** @hidden */
  45993. _bindTexture(channel: number, texture: InternalTexture): void;
  45994. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  45995. releaseEffects(): void;
  45996. /** @hidden */
  45997. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45998. /** @hidden */
  45999. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46000. /** @hidden */
  46001. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46002. /** @hidden */
  46003. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46004. }
  46005. }
  46006. declare module "babylonjs/Engines/index" {
  46007. export * from "babylonjs/Engines/constants";
  46008. export * from "babylonjs/Engines/engine";
  46009. export * from "babylonjs/Engines/engineStore";
  46010. export * from "babylonjs/Engines/nullEngine";
  46011. export * from "babylonjs/Engines/Extensions/index";
  46012. export * from "babylonjs/Engines/IPipelineContext";
  46013. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  46014. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46015. export * from "babylonjs/Engines/nativeEngine";
  46016. }
  46017. declare module "babylonjs/Events/clipboardEvents" {
  46018. /**
  46019. * Gather the list of clipboard event types as constants.
  46020. */
  46021. export class ClipboardEventTypes {
  46022. /**
  46023. * The clipboard event is fired when a copy command is active (pressed).
  46024. */
  46025. static readonly COPY: number;
  46026. /**
  46027. * The clipboard event is fired when a cut command is active (pressed).
  46028. */
  46029. static readonly CUT: number;
  46030. /**
  46031. * The clipboard event is fired when a paste command is active (pressed).
  46032. */
  46033. static readonly PASTE: number;
  46034. }
  46035. /**
  46036. * This class is used to store clipboard related info for the onClipboardObservable event.
  46037. */
  46038. export class ClipboardInfo {
  46039. /**
  46040. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46041. */
  46042. type: number;
  46043. /**
  46044. * Defines the related dom event
  46045. */
  46046. event: ClipboardEvent;
  46047. /**
  46048. *Creates an instance of ClipboardInfo.
  46049. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  46050. * @param event Defines the related dom event
  46051. */
  46052. constructor(
  46053. /**
  46054. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46055. */
  46056. type: number,
  46057. /**
  46058. * Defines the related dom event
  46059. */
  46060. event: ClipboardEvent);
  46061. /**
  46062. * Get the clipboard event's type from the keycode.
  46063. * @param keyCode Defines the keyCode for the current keyboard event.
  46064. * @return {number}
  46065. */
  46066. static GetTypeFromCharacter(keyCode: number): number;
  46067. }
  46068. }
  46069. declare module "babylonjs/Events/index" {
  46070. export * from "babylonjs/Events/keyboardEvents";
  46071. export * from "babylonjs/Events/pointerEvents";
  46072. export * from "babylonjs/Events/clipboardEvents";
  46073. }
  46074. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  46075. import { Scene } from "babylonjs/scene";
  46076. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46077. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  46078. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  46079. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  46080. /**
  46081. * Google Daydream controller
  46082. */
  46083. export class DaydreamController extends WebVRController {
  46084. /**
  46085. * Base Url for the controller model.
  46086. */
  46087. static MODEL_BASE_URL: string;
  46088. /**
  46089. * File name for the controller model.
  46090. */
  46091. static MODEL_FILENAME: string;
  46092. /**
  46093. * Gamepad Id prefix used to identify Daydream Controller.
  46094. */
  46095. static readonly GAMEPAD_ID_PREFIX: string;
  46096. /**
  46097. * Creates a new DaydreamController from a gamepad
  46098. * @param vrGamepad the gamepad that the controller should be created from
  46099. */
  46100. constructor(vrGamepad: any);
  46101. /**
  46102. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  46103. * @param scene scene in which to add meshes
  46104. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  46105. */
  46106. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  46107. /**
  46108. * Called once for each button that changed state since the last frame
  46109. * @param buttonIdx Which button index changed
  46110. * @param state New state of the button
  46111. * @param changes Which properties on the state changed since last frame
  46112. */
  46113. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  46114. }
  46115. }
  46116. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  46117. import { Scene } from "babylonjs/scene";
  46118. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46119. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  46120. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  46121. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  46122. /**
  46123. * Gear VR Controller
  46124. */
  46125. export class GearVRController extends WebVRController {
  46126. /**
  46127. * Base Url for the controller model.
  46128. */
  46129. static MODEL_BASE_URL: string;
  46130. /**
  46131. * File name for the controller model.
  46132. */
  46133. static MODEL_FILENAME: string;
  46134. /**
  46135. * Gamepad Id prefix used to identify this controller.
  46136. */
  46137. static readonly GAMEPAD_ID_PREFIX: string;
  46138. private readonly _buttonIndexToObservableNameMap;
  46139. /**
  46140. * Creates a new GearVRController from a gamepad
  46141. * @param vrGamepad the gamepad that the controller should be created from
  46142. */
  46143. constructor(vrGamepad: any);
  46144. /**
  46145. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  46146. * @param scene scene in which to add meshes
  46147. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  46148. */
  46149. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  46150. /**
  46151. * Called once for each button that changed state since the last frame
  46152. * @param buttonIdx Which button index changed
  46153. * @param state New state of the button
  46154. * @param changes Which properties on the state changed since last frame
  46155. */
  46156. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  46157. }
  46158. }
  46159. declare module "babylonjs/Gamepads/Controllers/index" {
  46160. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  46161. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  46162. export * from "babylonjs/Gamepads/Controllers/genericController";
  46163. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  46164. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  46165. export * from "babylonjs/Gamepads/Controllers/viveController";
  46166. export * from "babylonjs/Gamepads/Controllers/webVRController";
  46167. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  46168. }
  46169. declare module "babylonjs/Gamepads/index" {
  46170. export * from "babylonjs/Gamepads/Controllers/index";
  46171. export * from "babylonjs/Gamepads/gamepad";
  46172. export * from "babylonjs/Gamepads/gamepadManager";
  46173. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  46174. export * from "babylonjs/Gamepads/xboxGamepad";
  46175. export * from "babylonjs/Gamepads/dualShockGamepad";
  46176. }
  46177. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  46178. import { Scene } from "babylonjs/scene";
  46179. import { Vector4 } from "babylonjs/Maths/math.vector";
  46180. import { Color4 } from "babylonjs/Maths/math.color";
  46181. import { Mesh } from "babylonjs/Meshes/mesh";
  46182. import { Nullable } from "babylonjs/types";
  46183. /**
  46184. * Class containing static functions to help procedurally build meshes
  46185. */
  46186. export class PolyhedronBuilder {
  46187. /**
  46188. * Creates a polyhedron mesh
  46189. * * 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
  46190. * * The parameter `size` (positive float, default 1) sets the polygon size
  46191. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  46192. * * 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`
  46193. * * 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
  46194. * * 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)`)
  46195. * * 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
  46196. * * 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
  46197. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  46198. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  46199. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  46200. * @param name defines the name of the mesh
  46201. * @param options defines the options used to create the mesh
  46202. * @param scene defines the hosting scene
  46203. * @returns the polyhedron mesh
  46204. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  46205. */
  46206. static CreatePolyhedron(name: string, options: {
  46207. type?: number;
  46208. size?: number;
  46209. sizeX?: number;
  46210. sizeY?: number;
  46211. sizeZ?: number;
  46212. custom?: any;
  46213. faceUV?: Vector4[];
  46214. faceColors?: Color4[];
  46215. flat?: boolean;
  46216. updatable?: boolean;
  46217. sideOrientation?: number;
  46218. frontUVs?: Vector4;
  46219. backUVs?: Vector4;
  46220. }, scene?: Nullable<Scene>): Mesh;
  46221. }
  46222. }
  46223. declare module "babylonjs/Gizmos/scaleGizmo" {
  46224. import { Observable } from "babylonjs/Misc/observable";
  46225. import { Nullable } from "babylonjs/types";
  46226. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46227. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46228. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  46229. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46230. /**
  46231. * Gizmo that enables scaling a mesh along 3 axis
  46232. */
  46233. export class ScaleGizmo extends Gizmo {
  46234. /**
  46235. * Internal gizmo used for interactions on the x axis
  46236. */
  46237. xGizmo: AxisScaleGizmo;
  46238. /**
  46239. * Internal gizmo used for interactions on the y axis
  46240. */
  46241. yGizmo: AxisScaleGizmo;
  46242. /**
  46243. * Internal gizmo used for interactions on the z axis
  46244. */
  46245. zGizmo: AxisScaleGizmo;
  46246. /**
  46247. * Internal gizmo used to scale all axis equally
  46248. */
  46249. uniformScaleGizmo: AxisScaleGizmo;
  46250. private _meshAttached;
  46251. private _updateGizmoRotationToMatchAttachedMesh;
  46252. private _snapDistance;
  46253. private _scaleRatio;
  46254. private _uniformScalingMesh;
  46255. private _octahedron;
  46256. /** Fires an event when any of it's sub gizmos are dragged */
  46257. onDragStartObservable: Observable<unknown>;
  46258. /** Fires an event when any of it's sub gizmos are released from dragging */
  46259. onDragEndObservable: Observable<unknown>;
  46260. attachedMesh: Nullable<AbstractMesh>;
  46261. /**
  46262. * Creates a ScaleGizmo
  46263. * @param gizmoLayer The utility layer the gizmo will be added to
  46264. */
  46265. constructor(gizmoLayer?: UtilityLayerRenderer);
  46266. updateGizmoRotationToMatchAttachedMesh: boolean;
  46267. /**
  46268. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  46269. */
  46270. snapDistance: number;
  46271. /**
  46272. * Ratio for the scale of the gizmo (Default: 1)
  46273. */
  46274. scaleRatio: number;
  46275. /**
  46276. * Disposes of the gizmo
  46277. */
  46278. dispose(): void;
  46279. }
  46280. }
  46281. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  46282. import { Observable } from "babylonjs/Misc/observable";
  46283. import { Nullable } from "babylonjs/types";
  46284. import { Vector3 } from "babylonjs/Maths/math.vector";
  46285. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46286. import { Mesh } from "babylonjs/Meshes/mesh";
  46287. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  46288. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46289. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46290. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  46291. import { Color3 } from "babylonjs/Maths/math.color";
  46292. /**
  46293. * Single axis scale gizmo
  46294. */
  46295. export class AxisScaleGizmo extends Gizmo {
  46296. /**
  46297. * Drag behavior responsible for the gizmos dragging interactions
  46298. */
  46299. dragBehavior: PointerDragBehavior;
  46300. private _pointerObserver;
  46301. /**
  46302. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  46303. */
  46304. snapDistance: number;
  46305. /**
  46306. * Event that fires each time the gizmo snaps to a new location.
  46307. * * snapDistance is the the change in distance
  46308. */
  46309. onSnapObservable: Observable<{
  46310. snapDistance: number;
  46311. }>;
  46312. /**
  46313. * If the scaling operation should be done on all axis (default: false)
  46314. */
  46315. uniformScaling: boolean;
  46316. private _isEnabled;
  46317. private _parent;
  46318. private _arrow;
  46319. private _coloredMaterial;
  46320. private _hoverMaterial;
  46321. /**
  46322. * Creates an AxisScaleGizmo
  46323. * @param gizmoLayer The utility layer the gizmo will be added to
  46324. * @param dragAxis The axis which the gizmo will be able to scale on
  46325. * @param color The color of the gizmo
  46326. */
  46327. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  46328. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  46329. /**
  46330. * If the gizmo is enabled
  46331. */
  46332. isEnabled: boolean;
  46333. /**
  46334. * Disposes of the gizmo
  46335. */
  46336. dispose(): void;
  46337. /**
  46338. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  46339. * @param mesh The mesh to replace the default mesh of the gizmo
  46340. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  46341. */
  46342. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  46343. }
  46344. }
  46345. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  46346. import { Observable } from "babylonjs/Misc/observable";
  46347. import { Nullable } from "babylonjs/types";
  46348. import { Vector3 } from "babylonjs/Maths/math.vector";
  46349. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46350. import { Mesh } from "babylonjs/Meshes/mesh";
  46351. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46352. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46353. import { Color3 } from "babylonjs/Maths/math.color";
  46354. import "babylonjs/Meshes/Builders/boxBuilder";
  46355. /**
  46356. * Bounding box gizmo
  46357. */
  46358. export class BoundingBoxGizmo extends Gizmo {
  46359. private _lineBoundingBox;
  46360. private _rotateSpheresParent;
  46361. private _scaleBoxesParent;
  46362. private _boundingDimensions;
  46363. private _renderObserver;
  46364. private _pointerObserver;
  46365. private _scaleDragSpeed;
  46366. private _tmpQuaternion;
  46367. private _tmpVector;
  46368. private _tmpRotationMatrix;
  46369. /**
  46370. * 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)
  46371. */
  46372. ignoreChildren: boolean;
  46373. /**
  46374. * 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)
  46375. */
  46376. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  46377. /**
  46378. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  46379. */
  46380. rotationSphereSize: number;
  46381. /**
  46382. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  46383. */
  46384. scaleBoxSize: number;
  46385. /**
  46386. * 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)
  46387. */
  46388. fixedDragMeshScreenSize: boolean;
  46389. /**
  46390. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  46391. */
  46392. fixedDragMeshScreenSizeDistanceFactor: number;
  46393. /**
  46394. * Fired when a rotation sphere or scale box is dragged
  46395. */
  46396. onDragStartObservable: Observable<{}>;
  46397. /**
  46398. * Fired when a scale box is dragged
  46399. */
  46400. onScaleBoxDragObservable: Observable<{}>;
  46401. /**
  46402. * Fired when a scale box drag is ended
  46403. */
  46404. onScaleBoxDragEndObservable: Observable<{}>;
  46405. /**
  46406. * Fired when a rotation sphere is dragged
  46407. */
  46408. onRotationSphereDragObservable: Observable<{}>;
  46409. /**
  46410. * Fired when a rotation sphere drag is ended
  46411. */
  46412. onRotationSphereDragEndObservable: Observable<{}>;
  46413. /**
  46414. * 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)
  46415. */
  46416. scalePivot: Nullable<Vector3>;
  46417. /**
  46418. * Mesh used as a pivot to rotate the attached mesh
  46419. */
  46420. private _anchorMesh;
  46421. private _existingMeshScale;
  46422. private _dragMesh;
  46423. private pointerDragBehavior;
  46424. private coloredMaterial;
  46425. private hoverColoredMaterial;
  46426. /**
  46427. * Sets the color of the bounding box gizmo
  46428. * @param color the color to set
  46429. */
  46430. setColor(color: Color3): void;
  46431. /**
  46432. * Creates an BoundingBoxGizmo
  46433. * @param gizmoLayer The utility layer the gizmo will be added to
  46434. * @param color The color of the gizmo
  46435. */
  46436. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  46437. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  46438. private _selectNode;
  46439. /**
  46440. * Updates the bounding box information for the Gizmo
  46441. */
  46442. updateBoundingBox(): void;
  46443. private _updateRotationSpheres;
  46444. private _updateScaleBoxes;
  46445. /**
  46446. * Enables rotation on the specified axis and disables rotation on the others
  46447. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  46448. */
  46449. setEnabledRotationAxis(axis: string): void;
  46450. /**
  46451. * Enables/disables scaling
  46452. * @param enable if scaling should be enabled
  46453. */
  46454. setEnabledScaling(enable: boolean): void;
  46455. private _updateDummy;
  46456. /**
  46457. * Enables a pointer drag behavior on the bounding box of the gizmo
  46458. */
  46459. enableDragBehavior(): void;
  46460. /**
  46461. * Disposes of the gizmo
  46462. */
  46463. dispose(): void;
  46464. /**
  46465. * 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)
  46466. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  46467. * @returns the bounding box mesh with the passed in mesh as a child
  46468. */
  46469. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  46470. /**
  46471. * CustomMeshes are not supported by this gizmo
  46472. * @param mesh The mesh to replace the default mesh of the gizmo
  46473. */
  46474. setCustomMesh(mesh: Mesh): void;
  46475. }
  46476. }
  46477. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  46478. import { Observable } from "babylonjs/Misc/observable";
  46479. import { Nullable } from "babylonjs/types";
  46480. import { Vector3 } from "babylonjs/Maths/math.vector";
  46481. import { Color3 } from "babylonjs/Maths/math.color";
  46482. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46483. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  46484. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46485. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46486. import "babylonjs/Meshes/Builders/linesBuilder";
  46487. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  46488. /**
  46489. * Single plane rotation gizmo
  46490. */
  46491. export class PlaneRotationGizmo extends Gizmo {
  46492. /**
  46493. * Drag behavior responsible for the gizmos dragging interactions
  46494. */
  46495. dragBehavior: PointerDragBehavior;
  46496. private _pointerObserver;
  46497. /**
  46498. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  46499. */
  46500. snapDistance: number;
  46501. /**
  46502. * Event that fires each time the gizmo snaps to a new location.
  46503. * * snapDistance is the the change in distance
  46504. */
  46505. onSnapObservable: Observable<{
  46506. snapDistance: number;
  46507. }>;
  46508. private _isEnabled;
  46509. private _parent;
  46510. /**
  46511. * Creates a PlaneRotationGizmo
  46512. * @param gizmoLayer The utility layer the gizmo will be added to
  46513. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  46514. * @param color The color of the gizmo
  46515. * @param tessellation Amount of tessellation to be used when creating rotation circles
  46516. * @param useEulerRotation Use and update Euler angle instead of quaternion
  46517. */
  46518. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  46519. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  46520. /**
  46521. * If the gizmo is enabled
  46522. */
  46523. isEnabled: boolean;
  46524. /**
  46525. * Disposes of the gizmo
  46526. */
  46527. dispose(): void;
  46528. }
  46529. }
  46530. declare module "babylonjs/Gizmos/rotationGizmo" {
  46531. import { Observable } from "babylonjs/Misc/observable";
  46532. import { Nullable } from "babylonjs/types";
  46533. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46534. import { Mesh } from "babylonjs/Meshes/mesh";
  46535. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46536. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  46537. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46538. /**
  46539. * Gizmo that enables rotating a mesh along 3 axis
  46540. */
  46541. export class RotationGizmo extends Gizmo {
  46542. /**
  46543. * Internal gizmo used for interactions on the x axis
  46544. */
  46545. xGizmo: PlaneRotationGizmo;
  46546. /**
  46547. * Internal gizmo used for interactions on the y axis
  46548. */
  46549. yGizmo: PlaneRotationGizmo;
  46550. /**
  46551. * Internal gizmo used for interactions on the z axis
  46552. */
  46553. zGizmo: PlaneRotationGizmo;
  46554. /** Fires an event when any of it's sub gizmos are dragged */
  46555. onDragStartObservable: Observable<unknown>;
  46556. /** Fires an event when any of it's sub gizmos are released from dragging */
  46557. onDragEndObservable: Observable<unknown>;
  46558. private _meshAttached;
  46559. attachedMesh: Nullable<AbstractMesh>;
  46560. /**
  46561. * Creates a RotationGizmo
  46562. * @param gizmoLayer The utility layer the gizmo will be added to
  46563. * @param tessellation Amount of tessellation to be used when creating rotation circles
  46564. * @param useEulerRotation Use and update Euler angle instead of quaternion
  46565. */
  46566. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  46567. updateGizmoRotationToMatchAttachedMesh: boolean;
  46568. /**
  46569. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  46570. */
  46571. snapDistance: number;
  46572. /**
  46573. * Ratio for the scale of the gizmo (Default: 1)
  46574. */
  46575. scaleRatio: number;
  46576. /**
  46577. * Disposes of the gizmo
  46578. */
  46579. dispose(): void;
  46580. /**
  46581. * CustomMeshes are not supported by this gizmo
  46582. * @param mesh The mesh to replace the default mesh of the gizmo
  46583. */
  46584. setCustomMesh(mesh: Mesh): void;
  46585. }
  46586. }
  46587. declare module "babylonjs/Gizmos/gizmoManager" {
  46588. import { Observable } from "babylonjs/Misc/observable";
  46589. import { Nullable } from "babylonjs/types";
  46590. import { Scene, IDisposable } from "babylonjs/scene";
  46591. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46592. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46593. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  46594. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  46595. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  46596. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  46597. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  46598. /**
  46599. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  46600. */
  46601. export class GizmoManager implements IDisposable {
  46602. private scene;
  46603. /**
  46604. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  46605. */
  46606. gizmos: {
  46607. positionGizmo: Nullable<PositionGizmo>;
  46608. rotationGizmo: Nullable<RotationGizmo>;
  46609. scaleGizmo: Nullable<ScaleGizmo>;
  46610. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  46611. };
  46612. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  46613. clearGizmoOnEmptyPointerEvent: boolean;
  46614. /** Fires an event when the manager is attached to a mesh */
  46615. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  46616. private _gizmosEnabled;
  46617. private _pointerObserver;
  46618. private _attachedMesh;
  46619. private _boundingBoxColor;
  46620. private _defaultUtilityLayer;
  46621. private _defaultKeepDepthUtilityLayer;
  46622. /**
  46623. * When bounding box gizmo is enabled, this can be used to track drag/end events
  46624. */
  46625. boundingBoxDragBehavior: SixDofDragBehavior;
  46626. /**
  46627. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  46628. */
  46629. attachableMeshes: Nullable<Array<AbstractMesh>>;
  46630. /**
  46631. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  46632. */
  46633. usePointerToAttachGizmos: boolean;
  46634. /**
  46635. * Utility layer that the bounding box gizmo belongs to
  46636. */
  46637. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  46638. /**
  46639. * Utility layer that all gizmos besides bounding box belong to
  46640. */
  46641. readonly utilityLayer: UtilityLayerRenderer;
  46642. /**
  46643. * Instatiates a gizmo manager
  46644. * @param scene the scene to overlay the gizmos on top of
  46645. */
  46646. constructor(scene: Scene);
  46647. /**
  46648. * Attaches a set of gizmos to the specified mesh
  46649. * @param mesh The mesh the gizmo's should be attached to
  46650. */
  46651. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  46652. /**
  46653. * If the position gizmo is enabled
  46654. */
  46655. positionGizmoEnabled: boolean;
  46656. /**
  46657. * If the rotation gizmo is enabled
  46658. */
  46659. rotationGizmoEnabled: boolean;
  46660. /**
  46661. * If the scale gizmo is enabled
  46662. */
  46663. scaleGizmoEnabled: boolean;
  46664. /**
  46665. * If the boundingBox gizmo is enabled
  46666. */
  46667. boundingBoxGizmoEnabled: boolean;
  46668. /**
  46669. * Disposes of the gizmo manager
  46670. */
  46671. dispose(): void;
  46672. }
  46673. }
  46674. declare module "babylonjs/Lights/directionalLight" {
  46675. import { Camera } from "babylonjs/Cameras/camera";
  46676. import { Scene } from "babylonjs/scene";
  46677. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  46678. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46679. import { Light } from "babylonjs/Lights/light";
  46680. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  46681. import { Effect } from "babylonjs/Materials/effect";
  46682. /**
  46683. * A directional light is defined by a direction (what a surprise!).
  46684. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  46685. * 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.
  46686. * Documentation: https://doc.babylonjs.com/babylon101/lights
  46687. */
  46688. export class DirectionalLight extends ShadowLight {
  46689. private _shadowFrustumSize;
  46690. /**
  46691. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  46692. */
  46693. /**
  46694. * Specifies a fix frustum size for the shadow generation.
  46695. */
  46696. shadowFrustumSize: number;
  46697. private _shadowOrthoScale;
  46698. /**
  46699. * Gets the shadow projection scale against the optimal computed one.
  46700. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  46701. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  46702. */
  46703. /**
  46704. * Sets the shadow projection scale against the optimal computed one.
  46705. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  46706. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  46707. */
  46708. shadowOrthoScale: number;
  46709. /**
  46710. * Automatically compute the projection matrix to best fit (including all the casters)
  46711. * on each frame.
  46712. */
  46713. autoUpdateExtends: boolean;
  46714. private _orthoLeft;
  46715. private _orthoRight;
  46716. private _orthoTop;
  46717. private _orthoBottom;
  46718. /**
  46719. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  46720. * The directional light is emitted from everywhere in the given direction.
  46721. * It can cast shadows.
  46722. * Documentation : https://doc.babylonjs.com/babylon101/lights
  46723. * @param name The friendly name of the light
  46724. * @param direction The direction of the light
  46725. * @param scene The scene the light belongs to
  46726. */
  46727. constructor(name: string, direction: Vector3, scene: Scene);
  46728. /**
  46729. * Returns the string "DirectionalLight".
  46730. * @return The class name
  46731. */
  46732. getClassName(): string;
  46733. /**
  46734. * Returns the integer 1.
  46735. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  46736. */
  46737. getTypeID(): number;
  46738. /**
  46739. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  46740. * Returns the DirectionalLight Shadow projection matrix.
  46741. */
  46742. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46743. /**
  46744. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  46745. * Returns the DirectionalLight Shadow projection matrix.
  46746. */
  46747. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  46748. /**
  46749. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  46750. * Returns the DirectionalLight Shadow projection matrix.
  46751. */
  46752. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46753. protected _buildUniformLayout(): void;
  46754. /**
  46755. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  46756. * @param effect The effect to update
  46757. * @param lightIndex The index of the light in the effect to update
  46758. * @returns The directional light
  46759. */
  46760. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  46761. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  46762. /**
  46763. * Gets the minZ used for shadow according to both the scene and the light.
  46764. *
  46765. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  46766. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  46767. * @param activeCamera The camera we are returning the min for
  46768. * @returns the depth min z
  46769. */
  46770. getDepthMinZ(activeCamera: Camera): number;
  46771. /**
  46772. * Gets the maxZ used for shadow according to both the scene and the light.
  46773. *
  46774. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  46775. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  46776. * @param activeCamera The camera we are returning the max for
  46777. * @returns the depth max z
  46778. */
  46779. getDepthMaxZ(activeCamera: Camera): number;
  46780. /**
  46781. * Prepares the list of defines specific to the light type.
  46782. * @param defines the list of defines
  46783. * @param lightIndex defines the index of the light for the effect
  46784. */
  46785. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  46786. }
  46787. }
  46788. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  46789. import { Mesh } from "babylonjs/Meshes/mesh";
  46790. /**
  46791. * Class containing static functions to help procedurally build meshes
  46792. */
  46793. export class HemisphereBuilder {
  46794. /**
  46795. * Creates a hemisphere mesh
  46796. * @param name defines the name of the mesh
  46797. * @param options defines the options used to create the mesh
  46798. * @param scene defines the hosting scene
  46799. * @returns the hemisphere mesh
  46800. */
  46801. static CreateHemisphere(name: string, options: {
  46802. segments?: number;
  46803. diameter?: number;
  46804. sideOrientation?: number;
  46805. }, scene: any): Mesh;
  46806. }
  46807. }
  46808. declare module "babylonjs/Lights/spotLight" {
  46809. import { Nullable } from "babylonjs/types";
  46810. import { Scene } from "babylonjs/scene";
  46811. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  46812. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46813. import { Effect } from "babylonjs/Materials/effect";
  46814. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46815. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  46816. /**
  46817. * A spot light is defined by a position, a direction, an angle, and an exponent.
  46818. * These values define a cone of light starting from the position, emitting toward the direction.
  46819. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  46820. * and the exponent defines the speed of the decay of the light with distance (reach).
  46821. * Documentation: https://doc.babylonjs.com/babylon101/lights
  46822. */
  46823. export class SpotLight extends ShadowLight {
  46824. private _angle;
  46825. private _innerAngle;
  46826. private _cosHalfAngle;
  46827. private _lightAngleScale;
  46828. private _lightAngleOffset;
  46829. /**
  46830. * Gets the cone angle of the spot light in Radians.
  46831. */
  46832. /**
  46833. * Sets the cone angle of the spot light in Radians.
  46834. */
  46835. angle: number;
  46836. /**
  46837. * Only used in gltf falloff mode, this defines the angle where
  46838. * the directional falloff will start before cutting at angle which could be seen
  46839. * as outer angle.
  46840. */
  46841. /**
  46842. * Only used in gltf falloff mode, this defines the angle where
  46843. * the directional falloff will start before cutting at angle which could be seen
  46844. * as outer angle.
  46845. */
  46846. innerAngle: number;
  46847. private _shadowAngleScale;
  46848. /**
  46849. * Allows scaling the angle of the light for shadow generation only.
  46850. */
  46851. /**
  46852. * Allows scaling the angle of the light for shadow generation only.
  46853. */
  46854. shadowAngleScale: number;
  46855. /**
  46856. * The light decay speed with the distance from the emission spot.
  46857. */
  46858. exponent: number;
  46859. private _projectionTextureMatrix;
  46860. /**
  46861. * Allows reading the projecton texture
  46862. */
  46863. readonly projectionTextureMatrix: Matrix;
  46864. protected _projectionTextureLightNear: number;
  46865. /**
  46866. * Gets the near clip of the Spotlight for texture projection.
  46867. */
  46868. /**
  46869. * Sets the near clip of the Spotlight for texture projection.
  46870. */
  46871. projectionTextureLightNear: number;
  46872. protected _projectionTextureLightFar: number;
  46873. /**
  46874. * Gets the far clip of the Spotlight for texture projection.
  46875. */
  46876. /**
  46877. * Sets the far clip of the Spotlight for texture projection.
  46878. */
  46879. projectionTextureLightFar: number;
  46880. protected _projectionTextureUpDirection: Vector3;
  46881. /**
  46882. * Gets the Up vector of the Spotlight for texture projection.
  46883. */
  46884. /**
  46885. * Sets the Up vector of the Spotlight for texture projection.
  46886. */
  46887. projectionTextureUpDirection: Vector3;
  46888. private _projectionTexture;
  46889. /**
  46890. * Gets the projection texture of the light.
  46891. */
  46892. /**
  46893. * Sets the projection texture of the light.
  46894. */
  46895. projectionTexture: Nullable<BaseTexture>;
  46896. private _projectionTextureViewLightDirty;
  46897. private _projectionTextureProjectionLightDirty;
  46898. private _projectionTextureDirty;
  46899. private _projectionTextureViewTargetVector;
  46900. private _projectionTextureViewLightMatrix;
  46901. private _projectionTextureProjectionLightMatrix;
  46902. private _projectionTextureScalingMatrix;
  46903. /**
  46904. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  46905. * It can cast shadows.
  46906. * Documentation : https://doc.babylonjs.com/babylon101/lights
  46907. * @param name The light friendly name
  46908. * @param position The position of the spot light in the scene
  46909. * @param direction The direction of the light in the scene
  46910. * @param angle The cone angle of the light in Radians
  46911. * @param exponent The light decay speed with the distance from the emission spot
  46912. * @param scene The scene the lights belongs to
  46913. */
  46914. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  46915. /**
  46916. * Returns the string "SpotLight".
  46917. * @returns the class name
  46918. */
  46919. getClassName(): string;
  46920. /**
  46921. * Returns the integer 2.
  46922. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  46923. */
  46924. getTypeID(): number;
  46925. /**
  46926. * Overrides the direction setter to recompute the projection texture view light Matrix.
  46927. */
  46928. protected _setDirection(value: Vector3): void;
  46929. /**
  46930. * Overrides the position setter to recompute the projection texture view light Matrix.
  46931. */
  46932. protected _setPosition(value: Vector3): void;
  46933. /**
  46934. * 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.
  46935. * Returns the SpotLight.
  46936. */
  46937. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46938. protected _computeProjectionTextureViewLightMatrix(): void;
  46939. protected _computeProjectionTextureProjectionLightMatrix(): void;
  46940. /**
  46941. * Main function for light texture projection matrix computing.
  46942. */
  46943. protected _computeProjectionTextureMatrix(): void;
  46944. protected _buildUniformLayout(): void;
  46945. private _computeAngleValues;
  46946. /**
  46947. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  46948. * @param effect The effect to update
  46949. * @param lightIndex The index of the light in the effect to update
  46950. * @returns The spot light
  46951. */
  46952. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  46953. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  46954. /**
  46955. * Disposes the light and the associated resources.
  46956. */
  46957. dispose(): void;
  46958. /**
  46959. * Prepares the list of defines specific to the light type.
  46960. * @param defines the list of defines
  46961. * @param lightIndex defines the index of the light for the effect
  46962. */
  46963. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  46964. }
  46965. }
  46966. declare module "babylonjs/Gizmos/lightGizmo" {
  46967. import { Nullable } from "babylonjs/types";
  46968. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46969. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46970. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  46971. import { Light } from "babylonjs/Lights/light";
  46972. /**
  46973. * Gizmo that enables viewing a light
  46974. */
  46975. export class LightGizmo extends Gizmo {
  46976. private _lightMesh;
  46977. private _material;
  46978. private cachedPosition;
  46979. private cachedForward;
  46980. /**
  46981. * Creates a LightGizmo
  46982. * @param gizmoLayer The utility layer the gizmo will be added to
  46983. */
  46984. constructor(gizmoLayer?: UtilityLayerRenderer);
  46985. private _light;
  46986. /**
  46987. * The light that the gizmo is attached to
  46988. */
  46989. light: Nullable<Light>;
  46990. /**
  46991. * Gets the material used to render the light gizmo
  46992. */
  46993. readonly material: StandardMaterial;
  46994. /**
  46995. * @hidden
  46996. * Updates the gizmo to match the attached mesh's position/rotation
  46997. */
  46998. protected _update(): void;
  46999. private static _Scale;
  47000. /**
  47001. * Creates the lines for a light mesh
  47002. */
  47003. private static _createLightLines;
  47004. /**
  47005. * Disposes of the light gizmo
  47006. */
  47007. dispose(): void;
  47008. private static _CreateHemisphericLightMesh;
  47009. private static _CreatePointLightMesh;
  47010. private static _CreateSpotLightMesh;
  47011. private static _CreateDirectionalLightMesh;
  47012. }
  47013. }
  47014. declare module "babylonjs/Gizmos/index" {
  47015. export * from "babylonjs/Gizmos/axisDragGizmo";
  47016. export * from "babylonjs/Gizmos/axisScaleGizmo";
  47017. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  47018. export * from "babylonjs/Gizmos/gizmo";
  47019. export * from "babylonjs/Gizmos/gizmoManager";
  47020. export * from "babylonjs/Gizmos/planeRotationGizmo";
  47021. export * from "babylonjs/Gizmos/positionGizmo";
  47022. export * from "babylonjs/Gizmos/rotationGizmo";
  47023. export * from "babylonjs/Gizmos/scaleGizmo";
  47024. export * from "babylonjs/Gizmos/lightGizmo";
  47025. export * from "babylonjs/Gizmos/planeDragGizmo";
  47026. }
  47027. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  47028. /** @hidden */
  47029. export var backgroundFragmentDeclaration: {
  47030. name: string;
  47031. shader: string;
  47032. };
  47033. }
  47034. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  47035. /** @hidden */
  47036. export var backgroundUboDeclaration: {
  47037. name: string;
  47038. shader: string;
  47039. };
  47040. }
  47041. declare module "babylonjs/Shaders/background.fragment" {
  47042. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  47043. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  47044. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  47045. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  47046. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  47047. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  47048. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47049. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  47050. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  47051. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  47052. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  47053. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  47054. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  47055. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  47056. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  47057. /** @hidden */
  47058. export var backgroundPixelShader: {
  47059. name: string;
  47060. shader: string;
  47061. };
  47062. }
  47063. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  47064. /** @hidden */
  47065. export var backgroundVertexDeclaration: {
  47066. name: string;
  47067. shader: string;
  47068. };
  47069. }
  47070. declare module "babylonjs/Shaders/background.vertex" {
  47071. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  47072. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  47073. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47074. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  47075. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  47076. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  47077. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  47078. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  47079. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  47080. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  47081. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  47082. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  47083. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  47084. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  47085. /** @hidden */
  47086. export var backgroundVertexShader: {
  47087. name: string;
  47088. shader: string;
  47089. };
  47090. }
  47091. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  47092. import { Nullable, int, float } from "babylonjs/types";
  47093. import { Scene } from "babylonjs/scene";
  47094. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47095. import { SubMesh } from "babylonjs/Meshes/subMesh";
  47096. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47097. import { Mesh } from "babylonjs/Meshes/mesh";
  47098. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  47099. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  47100. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  47101. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47102. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  47103. import { Color3 } from "babylonjs/Maths/math.color";
  47104. import "babylonjs/Shaders/background.fragment";
  47105. import "babylonjs/Shaders/background.vertex";
  47106. /**
  47107. * Background material used to create an efficient environement around your scene.
  47108. */
  47109. export class BackgroundMaterial extends PushMaterial {
  47110. /**
  47111. * Standard reflectance value at parallel view angle.
  47112. */
  47113. static StandardReflectance0: number;
  47114. /**
  47115. * Standard reflectance value at grazing angle.
  47116. */
  47117. static StandardReflectance90: number;
  47118. protected _primaryColor: Color3;
  47119. /**
  47120. * Key light Color (multiply against the environement texture)
  47121. */
  47122. primaryColor: Color3;
  47123. protected __perceptualColor: Nullable<Color3>;
  47124. /**
  47125. * Experimental Internal Use Only.
  47126. *
  47127. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  47128. * This acts as a helper to set the primary color to a more "human friendly" value.
  47129. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  47130. * output color as close as possible from the chosen value.
  47131. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  47132. * part of lighting setup.)
  47133. */
  47134. _perceptualColor: Nullable<Color3>;
  47135. protected _primaryColorShadowLevel: float;
  47136. /**
  47137. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  47138. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  47139. */
  47140. primaryColorShadowLevel: float;
  47141. protected _primaryColorHighlightLevel: float;
  47142. /**
  47143. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  47144. * The primary color is used at the level chosen to define what the white area would look.
  47145. */
  47146. primaryColorHighlightLevel: float;
  47147. protected _reflectionTexture: Nullable<BaseTexture>;
  47148. /**
  47149. * Reflection Texture used in the material.
  47150. * Should be author in a specific way for the best result (refer to the documentation).
  47151. */
  47152. reflectionTexture: Nullable<BaseTexture>;
  47153. protected _reflectionBlur: float;
  47154. /**
  47155. * Reflection Texture level of blur.
  47156. *
  47157. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  47158. * texture twice.
  47159. */
  47160. reflectionBlur: float;
  47161. protected _diffuseTexture: Nullable<BaseTexture>;
  47162. /**
  47163. * Diffuse Texture used in the material.
  47164. * Should be author in a specific way for the best result (refer to the documentation).
  47165. */
  47166. diffuseTexture: Nullable<BaseTexture>;
  47167. protected _shadowLights: Nullable<IShadowLight[]>;
  47168. /**
  47169. * Specify the list of lights casting shadow on the material.
  47170. * All scene shadow lights will be included if null.
  47171. */
  47172. shadowLights: Nullable<IShadowLight[]>;
  47173. protected _shadowLevel: float;
  47174. /**
  47175. * Helps adjusting the shadow to a softer level if required.
  47176. * 0 means black shadows and 1 means no shadows.
  47177. */
  47178. shadowLevel: float;
  47179. protected _sceneCenter: Vector3;
  47180. /**
  47181. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  47182. * It is usually zero but might be interesting to modify according to your setup.
  47183. */
  47184. sceneCenter: Vector3;
  47185. protected _opacityFresnel: boolean;
  47186. /**
  47187. * This helps specifying that the material is falling off to the sky box at grazing angle.
  47188. * This helps ensuring a nice transition when the camera goes under the ground.
  47189. */
  47190. opacityFresnel: boolean;
  47191. protected _reflectionFresnel: boolean;
  47192. /**
  47193. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  47194. * This helps adding a mirror texture on the ground.
  47195. */
  47196. reflectionFresnel: boolean;
  47197. protected _reflectionFalloffDistance: number;
  47198. /**
  47199. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  47200. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  47201. */
  47202. reflectionFalloffDistance: number;
  47203. protected _reflectionAmount: number;
  47204. /**
  47205. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  47206. */
  47207. reflectionAmount: number;
  47208. protected _reflectionReflectance0: number;
  47209. /**
  47210. * This specifies the weight of the reflection at grazing angle.
  47211. */
  47212. reflectionReflectance0: number;
  47213. protected _reflectionReflectance90: number;
  47214. /**
  47215. * This specifies the weight of the reflection at a perpendicular point of view.
  47216. */
  47217. reflectionReflectance90: number;
  47218. /**
  47219. * Sets the reflection reflectance fresnel values according to the default standard
  47220. * empirically know to work well :-)
  47221. */
  47222. reflectionStandardFresnelWeight: number;
  47223. protected _useRGBColor: boolean;
  47224. /**
  47225. * Helps to directly use the maps channels instead of their level.
  47226. */
  47227. useRGBColor: boolean;
  47228. protected _enableNoise: boolean;
  47229. /**
  47230. * This helps reducing the banding effect that could occur on the background.
  47231. */
  47232. enableNoise: boolean;
  47233. /**
  47234. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  47235. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  47236. * Recommended to be keep at 1.0 except for special cases.
  47237. */
  47238. fovMultiplier: number;
  47239. private _fovMultiplier;
  47240. /**
  47241. * Enable the FOV adjustment feature controlled by fovMultiplier.
  47242. */
  47243. useEquirectangularFOV: boolean;
  47244. private _maxSimultaneousLights;
  47245. /**
  47246. * Number of Simultaneous lights allowed on the material.
  47247. */
  47248. maxSimultaneousLights: int;
  47249. /**
  47250. * Default configuration related to image processing available in the Background Material.
  47251. */
  47252. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  47253. /**
  47254. * Keep track of the image processing observer to allow dispose and replace.
  47255. */
  47256. private _imageProcessingObserver;
  47257. /**
  47258. * Attaches a new image processing configuration to the PBR Material.
  47259. * @param configuration (if null the scene configuration will be use)
  47260. */
  47261. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  47262. /**
  47263. * Gets the image processing configuration used either in this material.
  47264. */
  47265. /**
  47266. * Sets the Default image processing configuration used either in the this material.
  47267. *
  47268. * If sets to null, the scene one is in use.
  47269. */
  47270. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  47271. /**
  47272. * Gets wether the color curves effect is enabled.
  47273. */
  47274. /**
  47275. * Sets wether the color curves effect is enabled.
  47276. */
  47277. cameraColorCurvesEnabled: boolean;
  47278. /**
  47279. * Gets wether the color grading effect is enabled.
  47280. */
  47281. /**
  47282. * Gets wether the color grading effect is enabled.
  47283. */
  47284. cameraColorGradingEnabled: boolean;
  47285. /**
  47286. * Gets wether tonemapping is enabled or not.
  47287. */
  47288. /**
  47289. * Sets wether tonemapping is enabled or not
  47290. */
  47291. cameraToneMappingEnabled: boolean;
  47292. /**
  47293. * The camera exposure used on this material.
  47294. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  47295. * This corresponds to a photographic exposure.
  47296. */
  47297. /**
  47298. * The camera exposure used on this material.
  47299. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  47300. * This corresponds to a photographic exposure.
  47301. */
  47302. cameraExposure: float;
  47303. /**
  47304. * Gets The camera contrast used on this material.
  47305. */
  47306. /**
  47307. * Sets The camera contrast used on this material.
  47308. */
  47309. cameraContrast: float;
  47310. /**
  47311. * Gets the Color Grading 2D Lookup Texture.
  47312. */
  47313. /**
  47314. * Sets the Color Grading 2D Lookup Texture.
  47315. */
  47316. cameraColorGradingTexture: Nullable<BaseTexture>;
  47317. /**
  47318. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  47319. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  47320. * 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;
  47321. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  47322. */
  47323. /**
  47324. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  47325. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  47326. * 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;
  47327. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  47328. */
  47329. cameraColorCurves: Nullable<ColorCurves>;
  47330. /**
  47331. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  47332. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  47333. */
  47334. switchToBGR: boolean;
  47335. private _renderTargets;
  47336. private _reflectionControls;
  47337. private _white;
  47338. private _primaryShadowColor;
  47339. private _primaryHighlightColor;
  47340. /**
  47341. * Instantiates a Background Material in the given scene
  47342. * @param name The friendly name of the material
  47343. * @param scene The scene to add the material to
  47344. */
  47345. constructor(name: string, scene: Scene);
  47346. /**
  47347. * Gets a boolean indicating that current material needs to register RTT
  47348. */
  47349. readonly hasRenderTargetTextures: boolean;
  47350. /**
  47351. * The entire material has been created in order to prevent overdraw.
  47352. * @returns false
  47353. */
  47354. needAlphaTesting(): boolean;
  47355. /**
  47356. * The entire material has been created in order to prevent overdraw.
  47357. * @returns true if blending is enable
  47358. */
  47359. needAlphaBlending(): boolean;
  47360. /**
  47361. * Checks wether the material is ready to be rendered for a given mesh.
  47362. * @param mesh The mesh to render
  47363. * @param subMesh The submesh to check against
  47364. * @param useInstances Specify wether or not the material is used with instances
  47365. * @returns true if all the dependencies are ready (Textures, Effects...)
  47366. */
  47367. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  47368. /**
  47369. * Compute the primary color according to the chosen perceptual color.
  47370. */
  47371. private _computePrimaryColorFromPerceptualColor;
  47372. /**
  47373. * Compute the highlights and shadow colors according to their chosen levels.
  47374. */
  47375. private _computePrimaryColors;
  47376. /**
  47377. * Build the uniform buffer used in the material.
  47378. */
  47379. buildUniformLayout(): void;
  47380. /**
  47381. * Unbind the material.
  47382. */
  47383. unbind(): void;
  47384. /**
  47385. * Bind only the world matrix to the material.
  47386. * @param world The world matrix to bind.
  47387. */
  47388. bindOnlyWorldMatrix(world: Matrix): void;
  47389. /**
  47390. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  47391. * @param world The world matrix to bind.
  47392. * @param subMesh The submesh to bind for.
  47393. */
  47394. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  47395. /**
  47396. * Checks to see if a texture is used in the material.
  47397. * @param texture - Base texture to use.
  47398. * @returns - Boolean specifying if a texture is used in the material.
  47399. */
  47400. hasTexture(texture: BaseTexture): boolean;
  47401. /**
  47402. * Dispose the material.
  47403. * @param forceDisposeEffect Force disposal of the associated effect.
  47404. * @param forceDisposeTextures Force disposal of the associated textures.
  47405. */
  47406. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  47407. /**
  47408. * Clones the material.
  47409. * @param name The cloned name.
  47410. * @returns The cloned material.
  47411. */
  47412. clone(name: string): BackgroundMaterial;
  47413. /**
  47414. * Serializes the current material to its JSON representation.
  47415. * @returns The JSON representation.
  47416. */
  47417. serialize(): any;
  47418. /**
  47419. * Gets the class name of the material
  47420. * @returns "BackgroundMaterial"
  47421. */
  47422. getClassName(): string;
  47423. /**
  47424. * Parse a JSON input to create back a background material.
  47425. * @param source The JSON data to parse
  47426. * @param scene The scene to create the parsed material in
  47427. * @param rootUrl The root url of the assets the material depends upon
  47428. * @returns the instantiated BackgroundMaterial.
  47429. */
  47430. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  47431. }
  47432. }
  47433. declare module "babylonjs/Helpers/environmentHelper" {
  47434. import { Observable } from "babylonjs/Misc/observable";
  47435. import { Nullable } from "babylonjs/types";
  47436. import { Scene } from "babylonjs/scene";
  47437. import { Vector3 } from "babylonjs/Maths/math.vector";
  47438. import { Color3 } from "babylonjs/Maths/math.color";
  47439. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47440. import { Mesh } from "babylonjs/Meshes/mesh";
  47441. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47442. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  47443. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  47444. import "babylonjs/Meshes/Builders/planeBuilder";
  47445. import "babylonjs/Meshes/Builders/boxBuilder";
  47446. /**
  47447. * Represents the different options available during the creation of
  47448. * a Environment helper.
  47449. *
  47450. * This can control the default ground, skybox and image processing setup of your scene.
  47451. */
  47452. export interface IEnvironmentHelperOptions {
  47453. /**
  47454. * Specifies wether or not to create a ground.
  47455. * True by default.
  47456. */
  47457. createGround: boolean;
  47458. /**
  47459. * Specifies the ground size.
  47460. * 15 by default.
  47461. */
  47462. groundSize: number;
  47463. /**
  47464. * The texture used on the ground for the main color.
  47465. * Comes from the BabylonJS CDN by default.
  47466. *
  47467. * Remarks: Can be either a texture or a url.
  47468. */
  47469. groundTexture: string | BaseTexture;
  47470. /**
  47471. * The color mixed in the ground texture by default.
  47472. * BabylonJS clearColor by default.
  47473. */
  47474. groundColor: Color3;
  47475. /**
  47476. * Specifies the ground opacity.
  47477. * 1 by default.
  47478. */
  47479. groundOpacity: number;
  47480. /**
  47481. * Enables the ground to receive shadows.
  47482. * True by default.
  47483. */
  47484. enableGroundShadow: boolean;
  47485. /**
  47486. * Helps preventing the shadow to be fully black on the ground.
  47487. * 0.5 by default.
  47488. */
  47489. groundShadowLevel: number;
  47490. /**
  47491. * Creates a mirror texture attach to the ground.
  47492. * false by default.
  47493. */
  47494. enableGroundMirror: boolean;
  47495. /**
  47496. * Specifies the ground mirror size ratio.
  47497. * 0.3 by default as the default kernel is 64.
  47498. */
  47499. groundMirrorSizeRatio: number;
  47500. /**
  47501. * Specifies the ground mirror blur kernel size.
  47502. * 64 by default.
  47503. */
  47504. groundMirrorBlurKernel: number;
  47505. /**
  47506. * Specifies the ground mirror visibility amount.
  47507. * 1 by default
  47508. */
  47509. groundMirrorAmount: number;
  47510. /**
  47511. * Specifies the ground mirror reflectance weight.
  47512. * This uses the standard weight of the background material to setup the fresnel effect
  47513. * of the mirror.
  47514. * 1 by default.
  47515. */
  47516. groundMirrorFresnelWeight: number;
  47517. /**
  47518. * Specifies the ground mirror Falloff distance.
  47519. * This can helps reducing the size of the reflection.
  47520. * 0 by Default.
  47521. */
  47522. groundMirrorFallOffDistance: number;
  47523. /**
  47524. * Specifies the ground mirror texture type.
  47525. * Unsigned Int by Default.
  47526. */
  47527. groundMirrorTextureType: number;
  47528. /**
  47529. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  47530. * the shown objects.
  47531. */
  47532. groundYBias: number;
  47533. /**
  47534. * Specifies wether or not to create a skybox.
  47535. * True by default.
  47536. */
  47537. createSkybox: boolean;
  47538. /**
  47539. * Specifies the skybox size.
  47540. * 20 by default.
  47541. */
  47542. skyboxSize: number;
  47543. /**
  47544. * The texture used on the skybox for the main color.
  47545. * Comes from the BabylonJS CDN by default.
  47546. *
  47547. * Remarks: Can be either a texture or a url.
  47548. */
  47549. skyboxTexture: string | BaseTexture;
  47550. /**
  47551. * The color mixed in the skybox texture by default.
  47552. * BabylonJS clearColor by default.
  47553. */
  47554. skyboxColor: Color3;
  47555. /**
  47556. * The background rotation around the Y axis of the scene.
  47557. * This helps aligning the key lights of your scene with the background.
  47558. * 0 by default.
  47559. */
  47560. backgroundYRotation: number;
  47561. /**
  47562. * Compute automatically the size of the elements to best fit with the scene.
  47563. */
  47564. sizeAuto: boolean;
  47565. /**
  47566. * Default position of the rootMesh if autoSize is not true.
  47567. */
  47568. rootPosition: Vector3;
  47569. /**
  47570. * Sets up the image processing in the scene.
  47571. * true by default.
  47572. */
  47573. setupImageProcessing: boolean;
  47574. /**
  47575. * The texture used as your environment texture in the scene.
  47576. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  47577. *
  47578. * Remarks: Can be either a texture or a url.
  47579. */
  47580. environmentTexture: string | BaseTexture;
  47581. /**
  47582. * The value of the exposure to apply to the scene.
  47583. * 0.6 by default if setupImageProcessing is true.
  47584. */
  47585. cameraExposure: number;
  47586. /**
  47587. * The value of the contrast to apply to the scene.
  47588. * 1.6 by default if setupImageProcessing is true.
  47589. */
  47590. cameraContrast: number;
  47591. /**
  47592. * Specifies wether or not tonemapping should be enabled in the scene.
  47593. * true by default if setupImageProcessing is true.
  47594. */
  47595. toneMappingEnabled: boolean;
  47596. }
  47597. /**
  47598. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  47599. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  47600. * It also helps with the default setup of your imageProcessing configuration.
  47601. */
  47602. export class EnvironmentHelper {
  47603. /**
  47604. * Default ground texture URL.
  47605. */
  47606. private static _groundTextureCDNUrl;
  47607. /**
  47608. * Default skybox texture URL.
  47609. */
  47610. private static _skyboxTextureCDNUrl;
  47611. /**
  47612. * Default environment texture URL.
  47613. */
  47614. private static _environmentTextureCDNUrl;
  47615. /**
  47616. * Creates the default options for the helper.
  47617. */
  47618. private static _getDefaultOptions;
  47619. private _rootMesh;
  47620. /**
  47621. * Gets the root mesh created by the helper.
  47622. */
  47623. readonly rootMesh: Mesh;
  47624. private _skybox;
  47625. /**
  47626. * Gets the skybox created by the helper.
  47627. */
  47628. readonly skybox: Nullable<Mesh>;
  47629. private _skyboxTexture;
  47630. /**
  47631. * Gets the skybox texture created by the helper.
  47632. */
  47633. readonly skyboxTexture: Nullable<BaseTexture>;
  47634. private _skyboxMaterial;
  47635. /**
  47636. * Gets the skybox material created by the helper.
  47637. */
  47638. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  47639. private _ground;
  47640. /**
  47641. * Gets the ground mesh created by the helper.
  47642. */
  47643. readonly ground: Nullable<Mesh>;
  47644. private _groundTexture;
  47645. /**
  47646. * Gets the ground texture created by the helper.
  47647. */
  47648. readonly groundTexture: Nullable<BaseTexture>;
  47649. private _groundMirror;
  47650. /**
  47651. * Gets the ground mirror created by the helper.
  47652. */
  47653. readonly groundMirror: Nullable<MirrorTexture>;
  47654. /**
  47655. * Gets the ground mirror render list to helps pushing the meshes
  47656. * you wish in the ground reflection.
  47657. */
  47658. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  47659. private _groundMaterial;
  47660. /**
  47661. * Gets the ground material created by the helper.
  47662. */
  47663. readonly groundMaterial: Nullable<BackgroundMaterial>;
  47664. /**
  47665. * Stores the creation options.
  47666. */
  47667. private readonly _scene;
  47668. private _options;
  47669. /**
  47670. * This observable will be notified with any error during the creation of the environment,
  47671. * mainly texture creation errors.
  47672. */
  47673. onErrorObservable: Observable<{
  47674. message?: string;
  47675. exception?: any;
  47676. }>;
  47677. /**
  47678. * constructor
  47679. * @param options Defines the options we want to customize the helper
  47680. * @param scene The scene to add the material to
  47681. */
  47682. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  47683. /**
  47684. * Updates the background according to the new options
  47685. * @param options
  47686. */
  47687. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  47688. /**
  47689. * Sets the primary color of all the available elements.
  47690. * @param color the main color to affect to the ground and the background
  47691. */
  47692. setMainColor(color: Color3): void;
  47693. /**
  47694. * Setup the image processing according to the specified options.
  47695. */
  47696. private _setupImageProcessing;
  47697. /**
  47698. * Setup the environment texture according to the specified options.
  47699. */
  47700. private _setupEnvironmentTexture;
  47701. /**
  47702. * Setup the background according to the specified options.
  47703. */
  47704. private _setupBackground;
  47705. /**
  47706. * Get the scene sizes according to the setup.
  47707. */
  47708. private _getSceneSize;
  47709. /**
  47710. * Setup the ground according to the specified options.
  47711. */
  47712. private _setupGround;
  47713. /**
  47714. * Setup the ground material according to the specified options.
  47715. */
  47716. private _setupGroundMaterial;
  47717. /**
  47718. * Setup the ground diffuse texture according to the specified options.
  47719. */
  47720. private _setupGroundDiffuseTexture;
  47721. /**
  47722. * Setup the ground mirror texture according to the specified options.
  47723. */
  47724. private _setupGroundMirrorTexture;
  47725. /**
  47726. * Setup the ground to receive the mirror texture.
  47727. */
  47728. private _setupMirrorInGroundMaterial;
  47729. /**
  47730. * Setup the skybox according to the specified options.
  47731. */
  47732. private _setupSkybox;
  47733. /**
  47734. * Setup the skybox material according to the specified options.
  47735. */
  47736. private _setupSkyboxMaterial;
  47737. /**
  47738. * Setup the skybox reflection texture according to the specified options.
  47739. */
  47740. private _setupSkyboxReflectionTexture;
  47741. private _errorHandler;
  47742. /**
  47743. * Dispose all the elements created by the Helper.
  47744. */
  47745. dispose(): void;
  47746. }
  47747. }
  47748. declare module "babylonjs/Helpers/photoDome" {
  47749. import { Observable } from "babylonjs/Misc/observable";
  47750. import { Nullable } from "babylonjs/types";
  47751. import { Scene } from "babylonjs/scene";
  47752. import { TransformNode } from "babylonjs/Meshes/transformNode";
  47753. import { Mesh } from "babylonjs/Meshes/mesh";
  47754. import { Texture } from "babylonjs/Materials/Textures/texture";
  47755. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  47756. import "babylonjs/Meshes/Builders/sphereBuilder";
  47757. /**
  47758. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  47759. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  47760. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  47761. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  47762. */
  47763. export class PhotoDome extends TransformNode {
  47764. /**
  47765. * Define the image as a Monoscopic panoramic 360 image.
  47766. */
  47767. static readonly MODE_MONOSCOPIC: number;
  47768. /**
  47769. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  47770. */
  47771. static readonly MODE_TOPBOTTOM: number;
  47772. /**
  47773. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  47774. */
  47775. static readonly MODE_SIDEBYSIDE: number;
  47776. private _useDirectMapping;
  47777. /**
  47778. * The texture being displayed on the sphere
  47779. */
  47780. protected _photoTexture: Texture;
  47781. /**
  47782. * Gets or sets the texture being displayed on the sphere
  47783. */
  47784. photoTexture: Texture;
  47785. /**
  47786. * Observable raised when an error occured while loading the 360 image
  47787. */
  47788. onLoadErrorObservable: Observable<string>;
  47789. /**
  47790. * The skybox material
  47791. */
  47792. protected _material: BackgroundMaterial;
  47793. /**
  47794. * The surface used for the skybox
  47795. */
  47796. protected _mesh: Mesh;
  47797. /**
  47798. * Gets the mesh used for the skybox.
  47799. */
  47800. readonly mesh: Mesh;
  47801. /**
  47802. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  47803. * Also see the options.resolution property.
  47804. */
  47805. fovMultiplier: number;
  47806. private _imageMode;
  47807. /**
  47808. * Gets or set the current video mode for the video. It can be:
  47809. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  47810. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  47811. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  47812. */
  47813. imageMode: number;
  47814. /**
  47815. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  47816. * @param name Element's name, child elements will append suffixes for their own names.
  47817. * @param urlsOfPhoto defines the url of the photo to display
  47818. * @param options defines an object containing optional or exposed sub element properties
  47819. * @param onError defines a callback called when an error occured while loading the texture
  47820. */
  47821. constructor(name: string, urlOfPhoto: string, options: {
  47822. resolution?: number;
  47823. size?: number;
  47824. useDirectMapping?: boolean;
  47825. faceForward?: boolean;
  47826. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  47827. private _onBeforeCameraRenderObserver;
  47828. private _changeImageMode;
  47829. /**
  47830. * Releases resources associated with this node.
  47831. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  47832. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  47833. */
  47834. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  47835. }
  47836. }
  47837. declare module "babylonjs/Misc/rgbdTextureTools" {
  47838. import "babylonjs/Shaders/rgbdDecode.fragment";
  47839. import { Texture } from "babylonjs/Materials/Textures/texture";
  47840. /**
  47841. * Class used to host RGBD texture specific utilities
  47842. */
  47843. export class RGBDTextureTools {
  47844. /**
  47845. * Expand the RGBD Texture from RGBD to Half Float if possible.
  47846. * @param texture the texture to expand.
  47847. */
  47848. static ExpandRGBDTexture(texture: Texture): void;
  47849. }
  47850. }
  47851. declare module "babylonjs/Misc/brdfTextureTools" {
  47852. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47853. import { Scene } from "babylonjs/scene";
  47854. /**
  47855. * Class used to host texture specific utilities
  47856. */
  47857. export class BRDFTextureTools {
  47858. /**
  47859. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  47860. * @param scene defines the hosting scene
  47861. * @returns the environment BRDF texture
  47862. */
  47863. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  47864. private static _environmentBRDFBase64Texture;
  47865. }
  47866. }
  47867. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  47868. import { Nullable } from "babylonjs/types";
  47869. import { Color3 } from "babylonjs/Maths/math.color";
  47870. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47871. import { EffectFallbacks } from "babylonjs/Materials/effect";
  47872. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  47873. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  47874. import { Engine } from "babylonjs/Engines/engine";
  47875. import { Scene } from "babylonjs/scene";
  47876. /**
  47877. * @hidden
  47878. */
  47879. export interface IMaterialClearCoatDefines {
  47880. CLEARCOAT: boolean;
  47881. CLEARCOAT_DEFAULTIOR: boolean;
  47882. CLEARCOAT_TEXTURE: boolean;
  47883. CLEARCOAT_TEXTUREDIRECTUV: number;
  47884. CLEARCOAT_BUMP: boolean;
  47885. CLEARCOAT_BUMPDIRECTUV: number;
  47886. CLEARCOAT_TINT: boolean;
  47887. CLEARCOAT_TINT_TEXTURE: boolean;
  47888. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  47889. /** @hidden */
  47890. _areTexturesDirty: boolean;
  47891. }
  47892. /**
  47893. * Define the code related to the clear coat parameters of the pbr material.
  47894. */
  47895. export class PBRClearCoatConfiguration {
  47896. /**
  47897. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  47898. * The default fits with a polyurethane material.
  47899. */
  47900. private static readonly _DefaultIndexOfRefraction;
  47901. private _isEnabled;
  47902. /**
  47903. * Defines if the clear coat is enabled in the material.
  47904. */
  47905. isEnabled: boolean;
  47906. /**
  47907. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  47908. */
  47909. intensity: number;
  47910. /**
  47911. * Defines the clear coat layer roughness.
  47912. */
  47913. roughness: number;
  47914. private _indexOfRefraction;
  47915. /**
  47916. * Defines the index of refraction of the clear coat.
  47917. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  47918. * The default fits with a polyurethane material.
  47919. * Changing the default value is more performance intensive.
  47920. */
  47921. indexOfRefraction: number;
  47922. private _texture;
  47923. /**
  47924. * Stores the clear coat values in a texture.
  47925. */
  47926. texture: Nullable<BaseTexture>;
  47927. private _bumpTexture;
  47928. /**
  47929. * Define the clear coat specific bump texture.
  47930. */
  47931. bumpTexture: Nullable<BaseTexture>;
  47932. private _isTintEnabled;
  47933. /**
  47934. * Defines if the clear coat tint is enabled in the material.
  47935. */
  47936. isTintEnabled: boolean;
  47937. /**
  47938. * Defines the clear coat tint of the material.
  47939. * This is only use if tint is enabled
  47940. */
  47941. tintColor: Color3;
  47942. /**
  47943. * Defines the distance at which the tint color should be found in the
  47944. * clear coat media.
  47945. * This is only use if tint is enabled
  47946. */
  47947. tintColorAtDistance: number;
  47948. /**
  47949. * Defines the clear coat layer thickness.
  47950. * This is only use if tint is enabled
  47951. */
  47952. tintThickness: number;
  47953. private _tintTexture;
  47954. /**
  47955. * Stores the clear tint values in a texture.
  47956. * rgb is tint
  47957. * a is a thickness factor
  47958. */
  47959. tintTexture: Nullable<BaseTexture>;
  47960. /** @hidden */
  47961. private _internalMarkAllSubMeshesAsTexturesDirty;
  47962. /** @hidden */
  47963. _markAllSubMeshesAsTexturesDirty(): void;
  47964. /**
  47965. * Instantiate a new istance of clear coat configuration.
  47966. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  47967. */
  47968. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  47969. /**
  47970. * Gets wehter the submesh is ready to be used or not.
  47971. * @param defines the list of "defines" to update.
  47972. * @param scene defines the scene the material belongs to.
  47973. * @param engine defines the engine the material belongs to.
  47974. * @param disableBumpMap defines wether the material disables bump or not.
  47975. * @returns - boolean indicating that the submesh is ready or not.
  47976. */
  47977. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  47978. /**
  47979. * Checks to see if a texture is used in the material.
  47980. * @param defines the list of "defines" to update.
  47981. * @param scene defines the scene to the material belongs to.
  47982. */
  47983. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  47984. /**
  47985. * Binds the material data.
  47986. * @param uniformBuffer defines the Uniform buffer to fill in.
  47987. * @param scene defines the scene the material belongs to.
  47988. * @param engine defines the engine the material belongs to.
  47989. * @param disableBumpMap defines wether the material disables bump or not.
  47990. * @param isFrozen defines wether the material is frozen or not.
  47991. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  47992. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  47993. */
  47994. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  47995. /**
  47996. * Checks to see if a texture is used in the material.
  47997. * @param texture - Base texture to use.
  47998. * @returns - Boolean specifying if a texture is used in the material.
  47999. */
  48000. hasTexture(texture: BaseTexture): boolean;
  48001. /**
  48002. * Returns an array of the actively used textures.
  48003. * @param activeTextures Array of BaseTextures
  48004. */
  48005. getActiveTextures(activeTextures: BaseTexture[]): void;
  48006. /**
  48007. * Returns the animatable textures.
  48008. * @param animatables Array of animatable textures.
  48009. */
  48010. getAnimatables(animatables: IAnimatable[]): void;
  48011. /**
  48012. * Disposes the resources of the material.
  48013. * @param forceDisposeTextures - Forces the disposal of all textures.
  48014. */
  48015. dispose(forceDisposeTextures?: boolean): void;
  48016. /**
  48017. * Get the current class name of the texture useful for serialization or dynamic coding.
  48018. * @returns "PBRClearCoatConfiguration"
  48019. */
  48020. getClassName(): string;
  48021. /**
  48022. * Add fallbacks to the effect fallbacks list.
  48023. * @param defines defines the Base texture to use.
  48024. * @param fallbacks defines the current fallback list.
  48025. * @param currentRank defines the current fallback rank.
  48026. * @returns the new fallback rank.
  48027. */
  48028. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48029. /**
  48030. * Add the required uniforms to the current list.
  48031. * @param uniforms defines the current uniform list.
  48032. */
  48033. static AddUniforms(uniforms: string[]): void;
  48034. /**
  48035. * Add the required samplers to the current list.
  48036. * @param samplers defines the current sampler list.
  48037. */
  48038. static AddSamplers(samplers: string[]): void;
  48039. /**
  48040. * Add the required uniforms to the current buffer.
  48041. * @param uniformBuffer defines the current uniform buffer.
  48042. */
  48043. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48044. /**
  48045. * Makes a duplicate of the current configuration into another one.
  48046. * @param clearCoatConfiguration define the config where to copy the info
  48047. */
  48048. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  48049. /**
  48050. * Serializes this clear coat configuration.
  48051. * @returns - An object with the serialized config.
  48052. */
  48053. serialize(): any;
  48054. /**
  48055. * Parses a anisotropy Configuration from a serialized object.
  48056. * @param source - Serialized object.
  48057. * @param scene Defines the scene we are parsing for
  48058. * @param rootUrl Defines the rootUrl to load from
  48059. */
  48060. parse(source: any, scene: Scene, rootUrl: string): void;
  48061. }
  48062. }
  48063. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  48064. import { EffectFallbacks } from "babylonjs/Materials/effect";
  48065. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48066. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48067. import { Vector2 } from "babylonjs/Maths/math.vector";
  48068. import { Scene } from "babylonjs/scene";
  48069. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48070. import { Nullable } from "babylonjs/types";
  48071. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48072. /**
  48073. * @hidden
  48074. */
  48075. export interface IMaterialAnisotropicDefines {
  48076. ANISOTROPIC: boolean;
  48077. ANISOTROPIC_TEXTURE: boolean;
  48078. ANISOTROPIC_TEXTUREDIRECTUV: number;
  48079. MAINUV1: boolean;
  48080. _areTexturesDirty: boolean;
  48081. _needUVs: boolean;
  48082. }
  48083. /**
  48084. * Define the code related to the anisotropic parameters of the pbr material.
  48085. */
  48086. export class PBRAnisotropicConfiguration {
  48087. private _isEnabled;
  48088. /**
  48089. * Defines if the anisotropy is enabled in the material.
  48090. */
  48091. isEnabled: boolean;
  48092. /**
  48093. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  48094. */
  48095. intensity: number;
  48096. /**
  48097. * Defines if the effect is along the tangents, bitangents or in between.
  48098. * By default, the effect is "strectching" the highlights along the tangents.
  48099. */
  48100. direction: Vector2;
  48101. private _texture;
  48102. /**
  48103. * Stores the anisotropy values in a texture.
  48104. * rg is direction (like normal from -1 to 1)
  48105. * b is a intensity
  48106. */
  48107. texture: Nullable<BaseTexture>;
  48108. /** @hidden */
  48109. private _internalMarkAllSubMeshesAsTexturesDirty;
  48110. /** @hidden */
  48111. _markAllSubMeshesAsTexturesDirty(): void;
  48112. /**
  48113. * Instantiate a new istance of anisotropy configuration.
  48114. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  48115. */
  48116. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  48117. /**
  48118. * Specifies that the submesh is ready to be used.
  48119. * @param defines the list of "defines" to update.
  48120. * @param scene defines the scene the material belongs to.
  48121. * @returns - boolean indicating that the submesh is ready or not.
  48122. */
  48123. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  48124. /**
  48125. * Checks to see if a texture is used in the material.
  48126. * @param defines the list of "defines" to update.
  48127. * @param mesh the mesh we are preparing the defines for.
  48128. * @param scene defines the scene the material belongs to.
  48129. */
  48130. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  48131. /**
  48132. * Binds the material data.
  48133. * @param uniformBuffer defines the Uniform buffer to fill in.
  48134. * @param scene defines the scene the material belongs to.
  48135. * @param isFrozen defines wether the material is frozen or not.
  48136. */
  48137. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  48138. /**
  48139. * Checks to see if a texture is used in the material.
  48140. * @param texture - Base texture to use.
  48141. * @returns - Boolean specifying if a texture is used in the material.
  48142. */
  48143. hasTexture(texture: BaseTexture): boolean;
  48144. /**
  48145. * Returns an array of the actively used textures.
  48146. * @param activeTextures Array of BaseTextures
  48147. */
  48148. getActiveTextures(activeTextures: BaseTexture[]): void;
  48149. /**
  48150. * Returns the animatable textures.
  48151. * @param animatables Array of animatable textures.
  48152. */
  48153. getAnimatables(animatables: IAnimatable[]): void;
  48154. /**
  48155. * Disposes the resources of the material.
  48156. * @param forceDisposeTextures - Forces the disposal of all textures.
  48157. */
  48158. dispose(forceDisposeTextures?: boolean): void;
  48159. /**
  48160. * Get the current class name of the texture useful for serialization or dynamic coding.
  48161. * @returns "PBRAnisotropicConfiguration"
  48162. */
  48163. getClassName(): string;
  48164. /**
  48165. * Add fallbacks to the effect fallbacks list.
  48166. * @param defines defines the Base texture to use.
  48167. * @param fallbacks defines the current fallback list.
  48168. * @param currentRank defines the current fallback rank.
  48169. * @returns the new fallback rank.
  48170. */
  48171. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48172. /**
  48173. * Add the required uniforms to the current list.
  48174. * @param uniforms defines the current uniform list.
  48175. */
  48176. static AddUniforms(uniforms: string[]): void;
  48177. /**
  48178. * Add the required uniforms to the current buffer.
  48179. * @param uniformBuffer defines the current uniform buffer.
  48180. */
  48181. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48182. /**
  48183. * Add the required samplers to the current list.
  48184. * @param samplers defines the current sampler list.
  48185. */
  48186. static AddSamplers(samplers: string[]): void;
  48187. /**
  48188. * Makes a duplicate of the current configuration into another one.
  48189. * @param anisotropicConfiguration define the config where to copy the info
  48190. */
  48191. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  48192. /**
  48193. * Serializes this anisotropy configuration.
  48194. * @returns - An object with the serialized config.
  48195. */
  48196. serialize(): any;
  48197. /**
  48198. * Parses a anisotropy Configuration from a serialized object.
  48199. * @param source - Serialized object.
  48200. * @param scene Defines the scene we are parsing for
  48201. * @param rootUrl Defines the rootUrl to load from
  48202. */
  48203. parse(source: any, scene: Scene, rootUrl: string): void;
  48204. }
  48205. }
  48206. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  48207. import { Scene } from "babylonjs/scene";
  48208. /**
  48209. * @hidden
  48210. */
  48211. export interface IMaterialBRDFDefines {
  48212. BRDF_V_HEIGHT_CORRELATED: boolean;
  48213. MS_BRDF_ENERGY_CONSERVATION: boolean;
  48214. SPHERICAL_HARMONICS: boolean;
  48215. /** @hidden */
  48216. _areMiscDirty: boolean;
  48217. }
  48218. /**
  48219. * Define the code related to the BRDF parameters of the pbr material.
  48220. */
  48221. export class PBRBRDFConfiguration {
  48222. /**
  48223. * Default value used for the energy conservation.
  48224. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  48225. */
  48226. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  48227. /**
  48228. * Default value used for the Smith Visibility Height Correlated mode.
  48229. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  48230. */
  48231. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  48232. /**
  48233. * Default value used for the IBL diffuse part.
  48234. * This can help switching back to the polynomials mode globally which is a tiny bit
  48235. * less GPU intensive at the drawback of a lower quality.
  48236. */
  48237. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  48238. private _useEnergyConservation;
  48239. /**
  48240. * Defines if the material uses energy conservation.
  48241. */
  48242. useEnergyConservation: boolean;
  48243. private _useSmithVisibilityHeightCorrelated;
  48244. /**
  48245. * LEGACY Mode set to false
  48246. * Defines if the material uses height smith correlated visibility term.
  48247. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  48248. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  48249. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  48250. * Not relying on height correlated will also disable energy conservation.
  48251. */
  48252. useSmithVisibilityHeightCorrelated: boolean;
  48253. private _useSphericalHarmonics;
  48254. /**
  48255. * LEGACY Mode set to false
  48256. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  48257. * diffuse part of the IBL.
  48258. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  48259. * to the ground truth.
  48260. */
  48261. useSphericalHarmonics: boolean;
  48262. /** @hidden */
  48263. private _internalMarkAllSubMeshesAsMiscDirty;
  48264. /** @hidden */
  48265. _markAllSubMeshesAsMiscDirty(): void;
  48266. /**
  48267. * Instantiate a new istance of clear coat configuration.
  48268. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  48269. */
  48270. constructor(markAllSubMeshesAsMiscDirty: () => void);
  48271. /**
  48272. * Checks to see if a texture is used in the material.
  48273. * @param defines the list of "defines" to update.
  48274. */
  48275. prepareDefines(defines: IMaterialBRDFDefines): void;
  48276. /**
  48277. * Get the current class name of the texture useful for serialization or dynamic coding.
  48278. * @returns "PBRClearCoatConfiguration"
  48279. */
  48280. getClassName(): string;
  48281. /**
  48282. * Makes a duplicate of the current configuration into another one.
  48283. * @param brdfConfiguration define the config where to copy the info
  48284. */
  48285. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  48286. /**
  48287. * Serializes this BRDF configuration.
  48288. * @returns - An object with the serialized config.
  48289. */
  48290. serialize(): any;
  48291. /**
  48292. * Parses a anisotropy Configuration from a serialized object.
  48293. * @param source - Serialized object.
  48294. * @param scene Defines the scene we are parsing for
  48295. * @param rootUrl Defines the rootUrl to load from
  48296. */
  48297. parse(source: any, scene: Scene, rootUrl: string): void;
  48298. }
  48299. }
  48300. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  48301. import { EffectFallbacks } from "babylonjs/Materials/effect";
  48302. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48303. import { Color3 } from "babylonjs/Maths/math.color";
  48304. import { Scene } from "babylonjs/scene";
  48305. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48306. import { Nullable } from "babylonjs/types";
  48307. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48308. /**
  48309. * @hidden
  48310. */
  48311. export interface IMaterialSheenDefines {
  48312. SHEEN: boolean;
  48313. SHEEN_TEXTURE: boolean;
  48314. SHEEN_TEXTUREDIRECTUV: number;
  48315. SHEEN_LINKWITHALBEDO: boolean;
  48316. /** @hidden */
  48317. _areTexturesDirty: boolean;
  48318. }
  48319. /**
  48320. * Define the code related to the Sheen parameters of the pbr material.
  48321. */
  48322. export class PBRSheenConfiguration {
  48323. private _isEnabled;
  48324. /**
  48325. * Defines if the material uses sheen.
  48326. */
  48327. isEnabled: boolean;
  48328. private _linkSheenWithAlbedo;
  48329. /**
  48330. * Defines if the sheen is linked to the sheen color.
  48331. */
  48332. linkSheenWithAlbedo: boolean;
  48333. /**
  48334. * Defines the sheen intensity.
  48335. */
  48336. intensity: number;
  48337. /**
  48338. * Defines the sheen color.
  48339. */
  48340. color: Color3;
  48341. private _texture;
  48342. /**
  48343. * Stores the sheen tint values in a texture.
  48344. * rgb is tint
  48345. * a is a intensity
  48346. */
  48347. texture: Nullable<BaseTexture>;
  48348. /** @hidden */
  48349. private _internalMarkAllSubMeshesAsTexturesDirty;
  48350. /** @hidden */
  48351. _markAllSubMeshesAsTexturesDirty(): void;
  48352. /**
  48353. * Instantiate a new istance of clear coat configuration.
  48354. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  48355. */
  48356. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  48357. /**
  48358. * Specifies that the submesh is ready to be used.
  48359. * @param defines the list of "defines" to update.
  48360. * @param scene defines the scene the material belongs to.
  48361. * @returns - boolean indicating that the submesh is ready or not.
  48362. */
  48363. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  48364. /**
  48365. * Checks to see if a texture is used in the material.
  48366. * @param defines the list of "defines" to update.
  48367. * @param scene defines the scene the material belongs to.
  48368. */
  48369. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  48370. /**
  48371. * Binds the material data.
  48372. * @param uniformBuffer defines the Uniform buffer to fill in.
  48373. * @param scene defines the scene the material belongs to.
  48374. * @param isFrozen defines wether the material is frozen or not.
  48375. */
  48376. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  48377. /**
  48378. * Checks to see if a texture is used in the material.
  48379. * @param texture - Base texture to use.
  48380. * @returns - Boolean specifying if a texture is used in the material.
  48381. */
  48382. hasTexture(texture: BaseTexture): boolean;
  48383. /**
  48384. * Returns an array of the actively used textures.
  48385. * @param activeTextures Array of BaseTextures
  48386. */
  48387. getActiveTextures(activeTextures: BaseTexture[]): void;
  48388. /**
  48389. * Returns the animatable textures.
  48390. * @param animatables Array of animatable textures.
  48391. */
  48392. getAnimatables(animatables: IAnimatable[]): void;
  48393. /**
  48394. * Disposes the resources of the material.
  48395. * @param forceDisposeTextures - Forces the disposal of all textures.
  48396. */
  48397. dispose(forceDisposeTextures?: boolean): void;
  48398. /**
  48399. * Get the current class name of the texture useful for serialization or dynamic coding.
  48400. * @returns "PBRSheenConfiguration"
  48401. */
  48402. getClassName(): string;
  48403. /**
  48404. * Add fallbacks to the effect fallbacks list.
  48405. * @param defines defines the Base texture to use.
  48406. * @param fallbacks defines the current fallback list.
  48407. * @param currentRank defines the current fallback rank.
  48408. * @returns the new fallback rank.
  48409. */
  48410. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48411. /**
  48412. * Add the required uniforms to the current list.
  48413. * @param uniforms defines the current uniform list.
  48414. */
  48415. static AddUniforms(uniforms: string[]): void;
  48416. /**
  48417. * Add the required uniforms to the current buffer.
  48418. * @param uniformBuffer defines the current uniform buffer.
  48419. */
  48420. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48421. /**
  48422. * Add the required samplers to the current list.
  48423. * @param samplers defines the current sampler list.
  48424. */
  48425. static AddSamplers(samplers: string[]): void;
  48426. /**
  48427. * Makes a duplicate of the current configuration into another one.
  48428. * @param sheenConfiguration define the config where to copy the info
  48429. */
  48430. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  48431. /**
  48432. * Serializes this BRDF configuration.
  48433. * @returns - An object with the serialized config.
  48434. */
  48435. serialize(): any;
  48436. /**
  48437. * Parses a anisotropy Configuration from a serialized object.
  48438. * @param source - Serialized object.
  48439. * @param scene Defines the scene we are parsing for
  48440. * @param rootUrl Defines the rootUrl to load from
  48441. */
  48442. parse(source: any, scene: Scene, rootUrl: string): void;
  48443. }
  48444. }
  48445. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  48446. import { Nullable } from "babylonjs/types";
  48447. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48448. import { Color3 } from "babylonjs/Maths/math.color";
  48449. import { SmartArray } from "babylonjs/Misc/smartArray";
  48450. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48451. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48452. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  48453. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48454. import { Engine } from "babylonjs/Engines/engine";
  48455. import { Scene } from "babylonjs/scene";
  48456. /**
  48457. * @hidden
  48458. */
  48459. export interface IMaterialSubSurfaceDefines {
  48460. SUBSURFACE: boolean;
  48461. SS_REFRACTION: boolean;
  48462. SS_TRANSLUCENCY: boolean;
  48463. SS_SCATERRING: boolean;
  48464. SS_THICKNESSANDMASK_TEXTURE: boolean;
  48465. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  48466. SS_REFRACTIONMAP_3D: boolean;
  48467. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  48468. SS_LODINREFRACTIONALPHA: boolean;
  48469. SS_GAMMAREFRACTION: boolean;
  48470. SS_RGBDREFRACTION: boolean;
  48471. SS_LINEARSPECULARREFRACTION: boolean;
  48472. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  48473. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  48474. /** @hidden */
  48475. _areTexturesDirty: boolean;
  48476. }
  48477. /**
  48478. * Define the code related to the sub surface parameters of the pbr material.
  48479. */
  48480. export class PBRSubSurfaceConfiguration {
  48481. private _isRefractionEnabled;
  48482. /**
  48483. * Defines if the refraction is enabled in the material.
  48484. */
  48485. isRefractionEnabled: boolean;
  48486. private _isTranslucencyEnabled;
  48487. /**
  48488. * Defines if the translucency is enabled in the material.
  48489. */
  48490. isTranslucencyEnabled: boolean;
  48491. private _isScatteringEnabled;
  48492. /**
  48493. * Defines the refraction intensity of the material.
  48494. * The refraction when enabled replaces the Diffuse part of the material.
  48495. * The intensity helps transitionning between diffuse and refraction.
  48496. */
  48497. refractionIntensity: number;
  48498. /**
  48499. * Defines the translucency intensity of the material.
  48500. * When translucency has been enabled, this defines how much of the "translucency"
  48501. * is addded to the diffuse part of the material.
  48502. */
  48503. translucencyIntensity: number;
  48504. /**
  48505. * Defines the scattering intensity of the material.
  48506. * When scattering has been enabled, this defines how much of the "scattered light"
  48507. * is addded to the diffuse part of the material.
  48508. */
  48509. scatteringIntensity: number;
  48510. private _thicknessTexture;
  48511. /**
  48512. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  48513. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  48514. * 0 would mean minimumThickness
  48515. * 1 would mean maximumThickness
  48516. * The other channels might be use as a mask to vary the different effects intensity.
  48517. */
  48518. thicknessTexture: Nullable<BaseTexture>;
  48519. private _refractionTexture;
  48520. /**
  48521. * Defines the texture to use for refraction.
  48522. */
  48523. refractionTexture: Nullable<BaseTexture>;
  48524. private _indexOfRefraction;
  48525. /**
  48526. * Defines the index of refraction used in the material.
  48527. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  48528. */
  48529. indexOfRefraction: number;
  48530. private _invertRefractionY;
  48531. /**
  48532. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  48533. */
  48534. invertRefractionY: boolean;
  48535. private _linkRefractionWithTransparency;
  48536. /**
  48537. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  48538. * Materials half opaque for instance using refraction could benefit from this control.
  48539. */
  48540. linkRefractionWithTransparency: boolean;
  48541. /**
  48542. * Defines the minimum thickness stored in the thickness map.
  48543. * If no thickness map is defined, this value will be used to simulate thickness.
  48544. */
  48545. minimumThickness: number;
  48546. /**
  48547. * Defines the maximum thickness stored in the thickness map.
  48548. */
  48549. maximumThickness: number;
  48550. /**
  48551. * Defines the volume tint of the material.
  48552. * This is used for both translucency and scattering.
  48553. */
  48554. tintColor: Color3;
  48555. /**
  48556. * Defines the distance at which the tint color should be found in the media.
  48557. * This is used for refraction only.
  48558. */
  48559. tintColorAtDistance: number;
  48560. /**
  48561. * Defines how far each channel transmit through the media.
  48562. * It is defined as a color to simplify it selection.
  48563. */
  48564. diffusionDistance: Color3;
  48565. private _useMaskFromThicknessTexture;
  48566. /**
  48567. * Stores the intensity of the different subsurface effects in the thickness texture.
  48568. * * the green channel is the translucency intensity.
  48569. * * the blue channel is the scattering intensity.
  48570. * * the alpha channel is the refraction intensity.
  48571. */
  48572. useMaskFromThicknessTexture: boolean;
  48573. /** @hidden */
  48574. private _internalMarkAllSubMeshesAsTexturesDirty;
  48575. /** @hidden */
  48576. _markAllSubMeshesAsTexturesDirty(): void;
  48577. /**
  48578. * Instantiate a new istance of sub surface configuration.
  48579. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  48580. */
  48581. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  48582. /**
  48583. * Gets wehter the submesh is ready to be used or not.
  48584. * @param defines the list of "defines" to update.
  48585. * @param scene defines the scene the material belongs to.
  48586. * @returns - boolean indicating that the submesh is ready or not.
  48587. */
  48588. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  48589. /**
  48590. * Checks to see if a texture is used in the material.
  48591. * @param defines the list of "defines" to update.
  48592. * @param scene defines the scene to the material belongs to.
  48593. */
  48594. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  48595. /**
  48596. * Binds the material data.
  48597. * @param uniformBuffer defines the Uniform buffer to fill in.
  48598. * @param scene defines the scene the material belongs to.
  48599. * @param engine defines the engine the material belongs to.
  48600. * @param isFrozen defines wether the material is frozen or not.
  48601. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  48602. */
  48603. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  48604. /**
  48605. * Unbinds the material from the mesh.
  48606. * @param activeEffect defines the effect that should be unbound from.
  48607. * @returns true if unbound, otherwise false
  48608. */
  48609. unbind(activeEffect: Effect): boolean;
  48610. /**
  48611. * Returns the texture used for refraction or null if none is used.
  48612. * @param scene defines the scene the material belongs to.
  48613. * @returns - Refraction texture if present. If no refraction texture and refraction
  48614. * is linked with transparency, returns environment texture. Otherwise, returns null.
  48615. */
  48616. private _getRefractionTexture;
  48617. /**
  48618. * Returns true if alpha blending should be disabled.
  48619. */
  48620. readonly disableAlphaBlending: boolean;
  48621. /**
  48622. * Fills the list of render target textures.
  48623. * @param renderTargets the list of render targets to update
  48624. */
  48625. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  48626. /**
  48627. * Checks to see if a texture is used in the material.
  48628. * @param texture - Base texture to use.
  48629. * @returns - Boolean specifying if a texture is used in the material.
  48630. */
  48631. hasTexture(texture: BaseTexture): boolean;
  48632. /**
  48633. * Gets a boolean indicating that current material needs to register RTT
  48634. * @returns true if this uses a render target otherwise false.
  48635. */
  48636. hasRenderTargetTextures(): boolean;
  48637. /**
  48638. * Returns an array of the actively used textures.
  48639. * @param activeTextures Array of BaseTextures
  48640. */
  48641. getActiveTextures(activeTextures: BaseTexture[]): void;
  48642. /**
  48643. * Returns the animatable textures.
  48644. * @param animatables Array of animatable textures.
  48645. */
  48646. getAnimatables(animatables: IAnimatable[]): void;
  48647. /**
  48648. * Disposes the resources of the material.
  48649. * @param forceDisposeTextures - Forces the disposal of all textures.
  48650. */
  48651. dispose(forceDisposeTextures?: boolean): void;
  48652. /**
  48653. * Get the current class name of the texture useful for serialization or dynamic coding.
  48654. * @returns "PBRSubSurfaceConfiguration"
  48655. */
  48656. getClassName(): string;
  48657. /**
  48658. * Add fallbacks to the effect fallbacks list.
  48659. * @param defines defines the Base texture to use.
  48660. * @param fallbacks defines the current fallback list.
  48661. * @param currentRank defines the current fallback rank.
  48662. * @returns the new fallback rank.
  48663. */
  48664. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48665. /**
  48666. * Add the required uniforms to the current list.
  48667. * @param uniforms defines the current uniform list.
  48668. */
  48669. static AddUniforms(uniforms: string[]): void;
  48670. /**
  48671. * Add the required samplers to the current list.
  48672. * @param samplers defines the current sampler list.
  48673. */
  48674. static AddSamplers(samplers: string[]): void;
  48675. /**
  48676. * Add the required uniforms to the current buffer.
  48677. * @param uniformBuffer defines the current uniform buffer.
  48678. */
  48679. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48680. /**
  48681. * Makes a duplicate of the current configuration into another one.
  48682. * @param configuration define the config where to copy the info
  48683. */
  48684. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  48685. /**
  48686. * Serializes this Sub Surface configuration.
  48687. * @returns - An object with the serialized config.
  48688. */
  48689. serialize(): any;
  48690. /**
  48691. * Parses a anisotropy Configuration from a serialized object.
  48692. * @param source - Serialized object.
  48693. * @param scene Defines the scene we are parsing for
  48694. * @param rootUrl Defines the rootUrl to load from
  48695. */
  48696. parse(source: any, scene: Scene, rootUrl: string): void;
  48697. }
  48698. }
  48699. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  48700. /** @hidden */
  48701. export var pbrFragmentDeclaration: {
  48702. name: string;
  48703. shader: string;
  48704. };
  48705. }
  48706. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  48707. /** @hidden */
  48708. export var pbrUboDeclaration: {
  48709. name: string;
  48710. shader: string;
  48711. };
  48712. }
  48713. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  48714. /** @hidden */
  48715. export var pbrFragmentExtraDeclaration: {
  48716. name: string;
  48717. shader: string;
  48718. };
  48719. }
  48720. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  48721. /** @hidden */
  48722. export var pbrFragmentSamplersDeclaration: {
  48723. name: string;
  48724. shader: string;
  48725. };
  48726. }
  48727. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  48728. /** @hidden */
  48729. export var pbrHelperFunctions: {
  48730. name: string;
  48731. shader: string;
  48732. };
  48733. }
  48734. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  48735. /** @hidden */
  48736. export var harmonicsFunctions: {
  48737. name: string;
  48738. shader: string;
  48739. };
  48740. }
  48741. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  48742. /** @hidden */
  48743. export var pbrDirectLightingSetupFunctions: {
  48744. name: string;
  48745. shader: string;
  48746. };
  48747. }
  48748. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  48749. /** @hidden */
  48750. export var pbrDirectLightingFalloffFunctions: {
  48751. name: string;
  48752. shader: string;
  48753. };
  48754. }
  48755. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  48756. /** @hidden */
  48757. export var pbrBRDFFunctions: {
  48758. name: string;
  48759. shader: string;
  48760. };
  48761. }
  48762. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  48763. /** @hidden */
  48764. export var pbrDirectLightingFunctions: {
  48765. name: string;
  48766. shader: string;
  48767. };
  48768. }
  48769. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  48770. /** @hidden */
  48771. export var pbrIBLFunctions: {
  48772. name: string;
  48773. shader: string;
  48774. };
  48775. }
  48776. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  48777. /** @hidden */
  48778. export var pbrDebug: {
  48779. name: string;
  48780. shader: string;
  48781. };
  48782. }
  48783. declare module "babylonjs/Shaders/pbr.fragment" {
  48784. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  48785. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  48786. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  48787. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48788. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48789. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  48790. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  48791. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  48792. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  48793. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  48794. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48795. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  48796. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  48797. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  48798. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  48799. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  48800. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  48801. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  48802. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  48803. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  48804. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  48805. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  48806. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  48807. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  48808. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  48809. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  48810. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  48811. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  48812. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  48813. /** @hidden */
  48814. export var pbrPixelShader: {
  48815. name: string;
  48816. shader: string;
  48817. };
  48818. }
  48819. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  48820. /** @hidden */
  48821. export var pbrVertexDeclaration: {
  48822. name: string;
  48823. shader: string;
  48824. };
  48825. }
  48826. declare module "babylonjs/Shaders/pbr.vertex" {
  48827. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  48828. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  48829. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48830. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48831. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48832. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  48833. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  48834. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48835. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48836. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48837. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48838. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  48839. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  48840. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  48841. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  48842. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48843. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48844. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  48845. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48846. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48847. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48848. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  48849. /** @hidden */
  48850. export var pbrVertexShader: {
  48851. name: string;
  48852. shader: string;
  48853. };
  48854. }
  48855. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  48856. import { Nullable } from "babylonjs/types";
  48857. import { Scene } from "babylonjs/scene";
  48858. import { Matrix } from "babylonjs/Maths/math.vector";
  48859. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48860. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48861. import { Mesh } from "babylonjs/Meshes/mesh";
  48862. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  48863. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  48864. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  48865. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  48866. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  48867. import { Color3 } from "babylonjs/Maths/math.color";
  48868. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  48869. import { Material } from "babylonjs/Materials/material";
  48870. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  48871. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48872. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48873. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48874. import "babylonjs/Shaders/pbr.fragment";
  48875. import "babylonjs/Shaders/pbr.vertex";
  48876. /**
  48877. * Manages the defines for the PBR Material.
  48878. * @hidden
  48879. */
  48880. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  48881. PBR: boolean;
  48882. MAINUV1: boolean;
  48883. MAINUV2: boolean;
  48884. UV1: boolean;
  48885. UV2: boolean;
  48886. ALBEDO: boolean;
  48887. ALBEDODIRECTUV: number;
  48888. VERTEXCOLOR: boolean;
  48889. AMBIENT: boolean;
  48890. AMBIENTDIRECTUV: number;
  48891. AMBIENTINGRAYSCALE: boolean;
  48892. OPACITY: boolean;
  48893. VERTEXALPHA: boolean;
  48894. OPACITYDIRECTUV: number;
  48895. OPACITYRGB: boolean;
  48896. ALPHATEST: boolean;
  48897. DEPTHPREPASS: boolean;
  48898. ALPHABLEND: boolean;
  48899. ALPHAFROMALBEDO: boolean;
  48900. ALPHATESTVALUE: string;
  48901. SPECULAROVERALPHA: boolean;
  48902. RADIANCEOVERALPHA: boolean;
  48903. ALPHAFRESNEL: boolean;
  48904. LINEARALPHAFRESNEL: boolean;
  48905. PREMULTIPLYALPHA: boolean;
  48906. EMISSIVE: boolean;
  48907. EMISSIVEDIRECTUV: number;
  48908. REFLECTIVITY: boolean;
  48909. REFLECTIVITYDIRECTUV: number;
  48910. SPECULARTERM: boolean;
  48911. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  48912. MICROSURFACEAUTOMATIC: boolean;
  48913. LODBASEDMICROSFURACE: boolean;
  48914. MICROSURFACEMAP: boolean;
  48915. MICROSURFACEMAPDIRECTUV: number;
  48916. METALLICWORKFLOW: boolean;
  48917. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  48918. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  48919. METALLNESSSTOREINMETALMAPBLUE: boolean;
  48920. AOSTOREINMETALMAPRED: boolean;
  48921. ENVIRONMENTBRDF: boolean;
  48922. ENVIRONMENTBRDF_RGBD: boolean;
  48923. NORMAL: boolean;
  48924. TANGENT: boolean;
  48925. BUMP: boolean;
  48926. BUMPDIRECTUV: number;
  48927. OBJECTSPACE_NORMALMAP: boolean;
  48928. PARALLAX: boolean;
  48929. PARALLAXOCCLUSION: boolean;
  48930. NORMALXYSCALE: boolean;
  48931. LIGHTMAP: boolean;
  48932. LIGHTMAPDIRECTUV: number;
  48933. USELIGHTMAPASSHADOWMAP: boolean;
  48934. GAMMALIGHTMAP: boolean;
  48935. RGBDLIGHTMAP: boolean;
  48936. REFLECTION: boolean;
  48937. REFLECTIONMAP_3D: boolean;
  48938. REFLECTIONMAP_SPHERICAL: boolean;
  48939. REFLECTIONMAP_PLANAR: boolean;
  48940. REFLECTIONMAP_CUBIC: boolean;
  48941. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  48942. REFLECTIONMAP_PROJECTION: boolean;
  48943. REFLECTIONMAP_SKYBOX: boolean;
  48944. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  48945. REFLECTIONMAP_EXPLICIT: boolean;
  48946. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  48947. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  48948. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  48949. INVERTCUBICMAP: boolean;
  48950. USESPHERICALFROMREFLECTIONMAP: boolean;
  48951. USEIRRADIANCEMAP: boolean;
  48952. SPHERICAL_HARMONICS: boolean;
  48953. USESPHERICALINVERTEX: boolean;
  48954. REFLECTIONMAP_OPPOSITEZ: boolean;
  48955. LODINREFLECTIONALPHA: boolean;
  48956. GAMMAREFLECTION: boolean;
  48957. RGBDREFLECTION: boolean;
  48958. LINEARSPECULARREFLECTION: boolean;
  48959. RADIANCEOCCLUSION: boolean;
  48960. HORIZONOCCLUSION: boolean;
  48961. INSTANCES: boolean;
  48962. NUM_BONE_INFLUENCERS: number;
  48963. BonesPerMesh: number;
  48964. BONETEXTURE: boolean;
  48965. NONUNIFORMSCALING: boolean;
  48966. MORPHTARGETS: boolean;
  48967. MORPHTARGETS_NORMAL: boolean;
  48968. MORPHTARGETS_TANGENT: boolean;
  48969. MORPHTARGETS_UV: boolean;
  48970. NUM_MORPH_INFLUENCERS: number;
  48971. IMAGEPROCESSING: boolean;
  48972. VIGNETTE: boolean;
  48973. VIGNETTEBLENDMODEMULTIPLY: boolean;
  48974. VIGNETTEBLENDMODEOPAQUE: boolean;
  48975. TONEMAPPING: boolean;
  48976. TONEMAPPING_ACES: boolean;
  48977. CONTRAST: boolean;
  48978. COLORCURVES: boolean;
  48979. COLORGRADING: boolean;
  48980. COLORGRADING3D: boolean;
  48981. SAMPLER3DGREENDEPTH: boolean;
  48982. SAMPLER3DBGRMAP: boolean;
  48983. IMAGEPROCESSINGPOSTPROCESS: boolean;
  48984. EXPOSURE: boolean;
  48985. MULTIVIEW: boolean;
  48986. USEPHYSICALLIGHTFALLOFF: boolean;
  48987. USEGLTFLIGHTFALLOFF: boolean;
  48988. TWOSIDEDLIGHTING: boolean;
  48989. SHADOWFLOAT: boolean;
  48990. CLIPPLANE: boolean;
  48991. CLIPPLANE2: boolean;
  48992. CLIPPLANE3: boolean;
  48993. CLIPPLANE4: boolean;
  48994. POINTSIZE: boolean;
  48995. FOG: boolean;
  48996. LOGARITHMICDEPTH: boolean;
  48997. FORCENORMALFORWARD: boolean;
  48998. SPECULARAA: boolean;
  48999. CLEARCOAT: boolean;
  49000. CLEARCOAT_DEFAULTIOR: boolean;
  49001. CLEARCOAT_TEXTURE: boolean;
  49002. CLEARCOAT_TEXTUREDIRECTUV: number;
  49003. CLEARCOAT_BUMP: boolean;
  49004. CLEARCOAT_BUMPDIRECTUV: number;
  49005. CLEARCOAT_TINT: boolean;
  49006. CLEARCOAT_TINT_TEXTURE: boolean;
  49007. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49008. ANISOTROPIC: boolean;
  49009. ANISOTROPIC_TEXTURE: boolean;
  49010. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49011. BRDF_V_HEIGHT_CORRELATED: boolean;
  49012. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49013. SHEEN: boolean;
  49014. SHEEN_TEXTURE: boolean;
  49015. SHEEN_TEXTUREDIRECTUV: number;
  49016. SHEEN_LINKWITHALBEDO: boolean;
  49017. SUBSURFACE: boolean;
  49018. SS_REFRACTION: boolean;
  49019. SS_TRANSLUCENCY: boolean;
  49020. SS_SCATERRING: boolean;
  49021. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49022. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49023. SS_REFRACTIONMAP_3D: boolean;
  49024. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49025. SS_LODINREFRACTIONALPHA: boolean;
  49026. SS_GAMMAREFRACTION: boolean;
  49027. SS_RGBDREFRACTION: boolean;
  49028. SS_LINEARSPECULARREFRACTION: boolean;
  49029. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49030. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49031. UNLIT: boolean;
  49032. DEBUGMODE: number;
  49033. /**
  49034. * Initializes the PBR Material defines.
  49035. */
  49036. constructor();
  49037. /**
  49038. * Resets the PBR Material defines.
  49039. */
  49040. reset(): void;
  49041. }
  49042. /**
  49043. * The Physically based material base class of BJS.
  49044. *
  49045. * This offers the main features of a standard PBR material.
  49046. * For more information, please refer to the documentation :
  49047. * https://doc.babylonjs.com/how_to/physically_based_rendering
  49048. */
  49049. export abstract class PBRBaseMaterial extends PushMaterial {
  49050. /**
  49051. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  49052. */
  49053. static readonly PBRMATERIAL_OPAQUE: number;
  49054. /**
  49055. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  49056. */
  49057. static readonly PBRMATERIAL_ALPHATEST: number;
  49058. /**
  49059. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49060. */
  49061. static readonly PBRMATERIAL_ALPHABLEND: number;
  49062. /**
  49063. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49064. * They are also discarded below the alpha cutoff threshold to improve performances.
  49065. */
  49066. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  49067. /**
  49068. * Defines the default value of how much AO map is occluding the analytical lights
  49069. * (point spot...).
  49070. */
  49071. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  49072. /**
  49073. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  49074. */
  49075. static readonly LIGHTFALLOFF_PHYSICAL: number;
  49076. /**
  49077. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  49078. * to enhance interoperability with other engines.
  49079. */
  49080. static readonly LIGHTFALLOFF_GLTF: number;
  49081. /**
  49082. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  49083. * to enhance interoperability with other materials.
  49084. */
  49085. static readonly LIGHTFALLOFF_STANDARD: number;
  49086. /**
  49087. * Intensity of the direct lights e.g. the four lights available in your scene.
  49088. * This impacts both the direct diffuse and specular highlights.
  49089. */
  49090. protected _directIntensity: number;
  49091. /**
  49092. * Intensity of the emissive part of the material.
  49093. * This helps controlling the emissive effect without modifying the emissive color.
  49094. */
  49095. protected _emissiveIntensity: number;
  49096. /**
  49097. * Intensity of the environment e.g. how much the environment will light the object
  49098. * either through harmonics for rough material or through the refelction for shiny ones.
  49099. */
  49100. protected _environmentIntensity: number;
  49101. /**
  49102. * This is a special control allowing the reduction of the specular highlights coming from the
  49103. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  49104. */
  49105. protected _specularIntensity: number;
  49106. /**
  49107. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  49108. */
  49109. private _lightingInfos;
  49110. /**
  49111. * Debug Control allowing disabling the bump map on this material.
  49112. */
  49113. protected _disableBumpMap: boolean;
  49114. /**
  49115. * AKA Diffuse Texture in standard nomenclature.
  49116. */
  49117. protected _albedoTexture: Nullable<BaseTexture>;
  49118. /**
  49119. * AKA Occlusion Texture in other nomenclature.
  49120. */
  49121. protected _ambientTexture: Nullable<BaseTexture>;
  49122. /**
  49123. * AKA Occlusion Texture Intensity in other nomenclature.
  49124. */
  49125. protected _ambientTextureStrength: number;
  49126. /**
  49127. * Defines how much the AO map is occluding the analytical lights (point spot...).
  49128. * 1 means it completely occludes it
  49129. * 0 mean it has no impact
  49130. */
  49131. protected _ambientTextureImpactOnAnalyticalLights: number;
  49132. /**
  49133. * Stores the alpha values in a texture.
  49134. */
  49135. protected _opacityTexture: Nullable<BaseTexture>;
  49136. /**
  49137. * Stores the reflection values in a texture.
  49138. */
  49139. protected _reflectionTexture: Nullable<BaseTexture>;
  49140. /**
  49141. * Stores the emissive values in a texture.
  49142. */
  49143. protected _emissiveTexture: Nullable<BaseTexture>;
  49144. /**
  49145. * AKA Specular texture in other nomenclature.
  49146. */
  49147. protected _reflectivityTexture: Nullable<BaseTexture>;
  49148. /**
  49149. * Used to switch from specular/glossiness to metallic/roughness workflow.
  49150. */
  49151. protected _metallicTexture: Nullable<BaseTexture>;
  49152. /**
  49153. * Specifies the metallic scalar of the metallic/roughness workflow.
  49154. * Can also be used to scale the metalness values of the metallic texture.
  49155. */
  49156. protected _metallic: Nullable<number>;
  49157. /**
  49158. * Specifies the roughness scalar of the metallic/roughness workflow.
  49159. * Can also be used to scale the roughness values of the metallic texture.
  49160. */
  49161. protected _roughness: Nullable<number>;
  49162. /**
  49163. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  49164. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  49165. */
  49166. protected _microSurfaceTexture: Nullable<BaseTexture>;
  49167. /**
  49168. * Stores surface normal data used to displace a mesh in a texture.
  49169. */
  49170. protected _bumpTexture: Nullable<BaseTexture>;
  49171. /**
  49172. * Stores the pre-calculated light information of a mesh in a texture.
  49173. */
  49174. protected _lightmapTexture: Nullable<BaseTexture>;
  49175. /**
  49176. * The color of a material in ambient lighting.
  49177. */
  49178. protected _ambientColor: Color3;
  49179. /**
  49180. * AKA Diffuse Color in other nomenclature.
  49181. */
  49182. protected _albedoColor: Color3;
  49183. /**
  49184. * AKA Specular Color in other nomenclature.
  49185. */
  49186. protected _reflectivityColor: Color3;
  49187. /**
  49188. * The color applied when light is reflected from a material.
  49189. */
  49190. protected _reflectionColor: Color3;
  49191. /**
  49192. * The color applied when light is emitted from a material.
  49193. */
  49194. protected _emissiveColor: Color3;
  49195. /**
  49196. * AKA Glossiness in other nomenclature.
  49197. */
  49198. protected _microSurface: number;
  49199. /**
  49200. * Specifies that the material will use the light map as a show map.
  49201. */
  49202. protected _useLightmapAsShadowmap: boolean;
  49203. /**
  49204. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  49205. * makes the reflect vector face the model (under horizon).
  49206. */
  49207. protected _useHorizonOcclusion: boolean;
  49208. /**
  49209. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  49210. * too much the area relying on ambient texture to define their ambient occlusion.
  49211. */
  49212. protected _useRadianceOcclusion: boolean;
  49213. /**
  49214. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  49215. */
  49216. protected _useAlphaFromAlbedoTexture: boolean;
  49217. /**
  49218. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  49219. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  49220. */
  49221. protected _useSpecularOverAlpha: boolean;
  49222. /**
  49223. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  49224. */
  49225. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  49226. /**
  49227. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  49228. */
  49229. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  49230. /**
  49231. * Specifies if the metallic texture contains the roughness information in its green channel.
  49232. */
  49233. protected _useRoughnessFromMetallicTextureGreen: boolean;
  49234. /**
  49235. * Specifies if the metallic texture contains the metallness information in its blue channel.
  49236. */
  49237. protected _useMetallnessFromMetallicTextureBlue: boolean;
  49238. /**
  49239. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  49240. */
  49241. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  49242. /**
  49243. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  49244. */
  49245. protected _useAmbientInGrayScale: boolean;
  49246. /**
  49247. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  49248. * The material will try to infer what glossiness each pixel should be.
  49249. */
  49250. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  49251. /**
  49252. * Defines the falloff type used in this material.
  49253. * It by default is Physical.
  49254. */
  49255. protected _lightFalloff: number;
  49256. /**
  49257. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  49258. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  49259. */
  49260. protected _useRadianceOverAlpha: boolean;
  49261. /**
  49262. * Allows using an object space normal map (instead of tangent space).
  49263. */
  49264. protected _useObjectSpaceNormalMap: boolean;
  49265. /**
  49266. * Allows using the bump map in parallax mode.
  49267. */
  49268. protected _useParallax: boolean;
  49269. /**
  49270. * Allows using the bump map in parallax occlusion mode.
  49271. */
  49272. protected _useParallaxOcclusion: boolean;
  49273. /**
  49274. * Controls the scale bias of the parallax mode.
  49275. */
  49276. protected _parallaxScaleBias: number;
  49277. /**
  49278. * If sets to true, disables all the lights affecting the material.
  49279. */
  49280. protected _disableLighting: boolean;
  49281. /**
  49282. * Number of Simultaneous lights allowed on the material.
  49283. */
  49284. protected _maxSimultaneousLights: number;
  49285. /**
  49286. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  49287. */
  49288. protected _invertNormalMapX: boolean;
  49289. /**
  49290. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  49291. */
  49292. protected _invertNormalMapY: boolean;
  49293. /**
  49294. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  49295. */
  49296. protected _twoSidedLighting: boolean;
  49297. /**
  49298. * Defines the alpha limits in alpha test mode.
  49299. */
  49300. protected _alphaCutOff: number;
  49301. /**
  49302. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  49303. */
  49304. protected _forceAlphaTest: boolean;
  49305. /**
  49306. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49307. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  49308. */
  49309. protected _useAlphaFresnel: boolean;
  49310. /**
  49311. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49312. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  49313. */
  49314. protected _useLinearAlphaFresnel: boolean;
  49315. /**
  49316. * The transparency mode of the material.
  49317. */
  49318. protected _transparencyMode: Nullable<number>;
  49319. /**
  49320. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  49321. * from cos thetav and roughness:
  49322. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  49323. */
  49324. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  49325. /**
  49326. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  49327. */
  49328. protected _forceIrradianceInFragment: boolean;
  49329. /**
  49330. * Force normal to face away from face.
  49331. */
  49332. protected _forceNormalForward: boolean;
  49333. /**
  49334. * Enables specular anti aliasing in the PBR shader.
  49335. * It will both interacts on the Geometry for analytical and IBL lighting.
  49336. * It also prefilter the roughness map based on the bump values.
  49337. */
  49338. protected _enableSpecularAntiAliasing: boolean;
  49339. /**
  49340. * Default configuration related to image processing available in the PBR Material.
  49341. */
  49342. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  49343. /**
  49344. * Keep track of the image processing observer to allow dispose and replace.
  49345. */
  49346. private _imageProcessingObserver;
  49347. /**
  49348. * Attaches a new image processing configuration to the PBR Material.
  49349. * @param configuration
  49350. */
  49351. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  49352. /**
  49353. * Stores the available render targets.
  49354. */
  49355. private _renderTargets;
  49356. /**
  49357. * Sets the global ambient color for the material used in lighting calculations.
  49358. */
  49359. private _globalAmbientColor;
  49360. /**
  49361. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  49362. */
  49363. private _useLogarithmicDepth;
  49364. /**
  49365. * If set to true, no lighting calculations will be applied.
  49366. */
  49367. private _unlit;
  49368. private _debugMode;
  49369. /**
  49370. * @hidden
  49371. * This is reserved for the inspector.
  49372. * Defines the material debug mode.
  49373. * It helps seeing only some components of the material while troubleshooting.
  49374. */
  49375. debugMode: number;
  49376. /**
  49377. * @hidden
  49378. * This is reserved for the inspector.
  49379. * Specify from where on screen the debug mode should start.
  49380. * The value goes from -1 (full screen) to 1 (not visible)
  49381. * It helps with side by side comparison against the final render
  49382. * This defaults to -1
  49383. */
  49384. private debugLimit;
  49385. /**
  49386. * @hidden
  49387. * This is reserved for the inspector.
  49388. * As the default viewing range might not be enough (if the ambient is really small for instance)
  49389. * You can use the factor to better multiply the final value.
  49390. */
  49391. private debugFactor;
  49392. /**
  49393. * Defines the clear coat layer parameters for the material.
  49394. */
  49395. readonly clearCoat: PBRClearCoatConfiguration;
  49396. /**
  49397. * Defines the anisotropic parameters for the material.
  49398. */
  49399. readonly anisotropy: PBRAnisotropicConfiguration;
  49400. /**
  49401. * Defines the BRDF parameters for the material.
  49402. */
  49403. readonly brdf: PBRBRDFConfiguration;
  49404. /**
  49405. * Defines the Sheen parameters for the material.
  49406. */
  49407. readonly sheen: PBRSheenConfiguration;
  49408. /**
  49409. * Defines the SubSurface parameters for the material.
  49410. */
  49411. readonly subSurface: PBRSubSurfaceConfiguration;
  49412. /**
  49413. * Custom callback helping to override the default shader used in the material.
  49414. */
  49415. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  49416. protected _rebuildInParallel: boolean;
  49417. /**
  49418. * Instantiates a new PBRMaterial instance.
  49419. *
  49420. * @param name The material name
  49421. * @param scene The scene the material will be use in.
  49422. */
  49423. constructor(name: string, scene: Scene);
  49424. /**
  49425. * Gets a boolean indicating that current material needs to register RTT
  49426. */
  49427. readonly hasRenderTargetTextures: boolean;
  49428. /**
  49429. * Gets the name of the material class.
  49430. */
  49431. getClassName(): string;
  49432. /**
  49433. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  49434. */
  49435. /**
  49436. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  49437. */
  49438. useLogarithmicDepth: boolean;
  49439. /**
  49440. * Gets the current transparency mode.
  49441. */
  49442. /**
  49443. * Sets the transparency mode of the material.
  49444. *
  49445. * | Value | Type | Description |
  49446. * | ----- | ----------------------------------- | ----------- |
  49447. * | 0 | OPAQUE | |
  49448. * | 1 | ALPHATEST | |
  49449. * | 2 | ALPHABLEND | |
  49450. * | 3 | ALPHATESTANDBLEND | |
  49451. *
  49452. */
  49453. transparencyMode: Nullable<number>;
  49454. /**
  49455. * Returns true if alpha blending should be disabled.
  49456. */
  49457. private readonly _disableAlphaBlending;
  49458. /**
  49459. * Specifies whether or not this material should be rendered in alpha blend mode.
  49460. */
  49461. needAlphaBlending(): boolean;
  49462. /**
  49463. * Specifies if the mesh will require alpha blending.
  49464. * @param mesh - BJS mesh.
  49465. */
  49466. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  49467. /**
  49468. * Specifies whether or not this material should be rendered in alpha test mode.
  49469. */
  49470. needAlphaTesting(): boolean;
  49471. /**
  49472. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  49473. */
  49474. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  49475. /**
  49476. * Gets the texture used for the alpha test.
  49477. */
  49478. getAlphaTestTexture(): Nullable<BaseTexture>;
  49479. /**
  49480. * Specifies that the submesh is ready to be used.
  49481. * @param mesh - BJS mesh.
  49482. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  49483. * @param useInstances - Specifies that instances should be used.
  49484. * @returns - boolean indicating that the submesh is ready or not.
  49485. */
  49486. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  49487. /**
  49488. * Specifies if the material uses metallic roughness workflow.
  49489. * @returns boolean specifiying if the material uses metallic roughness workflow.
  49490. */
  49491. isMetallicWorkflow(): boolean;
  49492. private _prepareEffect;
  49493. private _prepareDefines;
  49494. /**
  49495. * Force shader compilation
  49496. */
  49497. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  49498. clipPlane: boolean;
  49499. }>): void;
  49500. /**
  49501. * Initializes the uniform buffer layout for the shader.
  49502. */
  49503. buildUniformLayout(): void;
  49504. /**
  49505. * Unbinds the material from the mesh
  49506. */
  49507. unbind(): void;
  49508. /**
  49509. * Binds the submesh data.
  49510. * @param world - The world matrix.
  49511. * @param mesh - The BJS mesh.
  49512. * @param subMesh - A submesh of the BJS mesh.
  49513. */
  49514. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  49515. /**
  49516. * Returns the animatable textures.
  49517. * @returns - Array of animatable textures.
  49518. */
  49519. getAnimatables(): IAnimatable[];
  49520. /**
  49521. * Returns the texture used for reflections.
  49522. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  49523. */
  49524. private _getReflectionTexture;
  49525. /**
  49526. * Returns an array of the actively used textures.
  49527. * @returns - Array of BaseTextures
  49528. */
  49529. getActiveTextures(): BaseTexture[];
  49530. /**
  49531. * Checks to see if a texture is used in the material.
  49532. * @param texture - Base texture to use.
  49533. * @returns - Boolean specifying if a texture is used in the material.
  49534. */
  49535. hasTexture(texture: BaseTexture): boolean;
  49536. /**
  49537. * Disposes the resources of the material.
  49538. * @param forceDisposeEffect - Forces the disposal of effects.
  49539. * @param forceDisposeTextures - Forces the disposal of all textures.
  49540. */
  49541. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  49542. }
  49543. }
  49544. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  49545. import { Nullable } from "babylonjs/types";
  49546. import { Scene } from "babylonjs/scene";
  49547. import { Color3 } from "babylonjs/Maths/math.color";
  49548. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  49549. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  49550. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49551. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  49552. /**
  49553. * The Physically based material of BJS.
  49554. *
  49555. * This offers the main features of a standard PBR material.
  49556. * For more information, please refer to the documentation :
  49557. * https://doc.babylonjs.com/how_to/physically_based_rendering
  49558. */
  49559. export class PBRMaterial extends PBRBaseMaterial {
  49560. /**
  49561. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  49562. */
  49563. static readonly PBRMATERIAL_OPAQUE: number;
  49564. /**
  49565. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  49566. */
  49567. static readonly PBRMATERIAL_ALPHATEST: number;
  49568. /**
  49569. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49570. */
  49571. static readonly PBRMATERIAL_ALPHABLEND: number;
  49572. /**
  49573. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49574. * They are also discarded below the alpha cutoff threshold to improve performances.
  49575. */
  49576. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  49577. /**
  49578. * Defines the default value of how much AO map is occluding the analytical lights
  49579. * (point spot...).
  49580. */
  49581. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  49582. /**
  49583. * Intensity of the direct lights e.g. the four lights available in your scene.
  49584. * This impacts both the direct diffuse and specular highlights.
  49585. */
  49586. directIntensity: number;
  49587. /**
  49588. * Intensity of the emissive part of the material.
  49589. * This helps controlling the emissive effect without modifying the emissive color.
  49590. */
  49591. emissiveIntensity: number;
  49592. /**
  49593. * Intensity of the environment e.g. how much the environment will light the object
  49594. * either through harmonics for rough material or through the refelction for shiny ones.
  49595. */
  49596. environmentIntensity: number;
  49597. /**
  49598. * This is a special control allowing the reduction of the specular highlights coming from the
  49599. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  49600. */
  49601. specularIntensity: number;
  49602. /**
  49603. * Debug Control allowing disabling the bump map on this material.
  49604. */
  49605. disableBumpMap: boolean;
  49606. /**
  49607. * AKA Diffuse Texture in standard nomenclature.
  49608. */
  49609. albedoTexture: BaseTexture;
  49610. /**
  49611. * AKA Occlusion Texture in other nomenclature.
  49612. */
  49613. ambientTexture: BaseTexture;
  49614. /**
  49615. * AKA Occlusion Texture Intensity in other nomenclature.
  49616. */
  49617. ambientTextureStrength: number;
  49618. /**
  49619. * Defines how much the AO map is occluding the analytical lights (point spot...).
  49620. * 1 means it completely occludes it
  49621. * 0 mean it has no impact
  49622. */
  49623. ambientTextureImpactOnAnalyticalLights: number;
  49624. /**
  49625. * Stores the alpha values in a texture.
  49626. */
  49627. opacityTexture: BaseTexture;
  49628. /**
  49629. * Stores the reflection values in a texture.
  49630. */
  49631. reflectionTexture: Nullable<BaseTexture>;
  49632. /**
  49633. * Stores the emissive values in a texture.
  49634. */
  49635. emissiveTexture: BaseTexture;
  49636. /**
  49637. * AKA Specular texture in other nomenclature.
  49638. */
  49639. reflectivityTexture: BaseTexture;
  49640. /**
  49641. * Used to switch from specular/glossiness to metallic/roughness workflow.
  49642. */
  49643. metallicTexture: BaseTexture;
  49644. /**
  49645. * Specifies the metallic scalar of the metallic/roughness workflow.
  49646. * Can also be used to scale the metalness values of the metallic texture.
  49647. */
  49648. metallic: Nullable<number>;
  49649. /**
  49650. * Specifies the roughness scalar of the metallic/roughness workflow.
  49651. * Can also be used to scale the roughness values of the metallic texture.
  49652. */
  49653. roughness: Nullable<number>;
  49654. /**
  49655. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  49656. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  49657. */
  49658. microSurfaceTexture: BaseTexture;
  49659. /**
  49660. * Stores surface normal data used to displace a mesh in a texture.
  49661. */
  49662. bumpTexture: BaseTexture;
  49663. /**
  49664. * Stores the pre-calculated light information of a mesh in a texture.
  49665. */
  49666. lightmapTexture: BaseTexture;
  49667. /**
  49668. * Stores the refracted light information in a texture.
  49669. */
  49670. refractionTexture: Nullable<BaseTexture>;
  49671. /**
  49672. * The color of a material in ambient lighting.
  49673. */
  49674. ambientColor: Color3;
  49675. /**
  49676. * AKA Diffuse Color in other nomenclature.
  49677. */
  49678. albedoColor: Color3;
  49679. /**
  49680. * AKA Specular Color in other nomenclature.
  49681. */
  49682. reflectivityColor: Color3;
  49683. /**
  49684. * The color reflected from the material.
  49685. */
  49686. reflectionColor: Color3;
  49687. /**
  49688. * The color emitted from the material.
  49689. */
  49690. emissiveColor: Color3;
  49691. /**
  49692. * AKA Glossiness in other nomenclature.
  49693. */
  49694. microSurface: number;
  49695. /**
  49696. * source material index of refraction (IOR)' / 'destination material IOR.
  49697. */
  49698. indexOfRefraction: number;
  49699. /**
  49700. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49701. */
  49702. invertRefractionY: boolean;
  49703. /**
  49704. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49705. * Materials half opaque for instance using refraction could benefit from this control.
  49706. */
  49707. linkRefractionWithTransparency: boolean;
  49708. /**
  49709. * If true, the light map contains occlusion information instead of lighting info.
  49710. */
  49711. useLightmapAsShadowmap: boolean;
  49712. /**
  49713. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  49714. */
  49715. useAlphaFromAlbedoTexture: boolean;
  49716. /**
  49717. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  49718. */
  49719. forceAlphaTest: boolean;
  49720. /**
  49721. * Defines the alpha limits in alpha test mode.
  49722. */
  49723. alphaCutOff: number;
  49724. /**
  49725. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  49726. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  49727. */
  49728. useSpecularOverAlpha: boolean;
  49729. /**
  49730. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  49731. */
  49732. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  49733. /**
  49734. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  49735. */
  49736. useRoughnessFromMetallicTextureAlpha: boolean;
  49737. /**
  49738. * Specifies if the metallic texture contains the roughness information in its green channel.
  49739. */
  49740. useRoughnessFromMetallicTextureGreen: boolean;
  49741. /**
  49742. * Specifies if the metallic texture contains the metallness information in its blue channel.
  49743. */
  49744. useMetallnessFromMetallicTextureBlue: boolean;
  49745. /**
  49746. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  49747. */
  49748. useAmbientOcclusionFromMetallicTextureRed: boolean;
  49749. /**
  49750. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  49751. */
  49752. useAmbientInGrayScale: boolean;
  49753. /**
  49754. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  49755. * The material will try to infer what glossiness each pixel should be.
  49756. */
  49757. useAutoMicroSurfaceFromReflectivityMap: boolean;
  49758. /**
  49759. * BJS is using an harcoded light falloff based on a manually sets up range.
  49760. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  49761. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  49762. */
  49763. /**
  49764. * BJS is using an harcoded light falloff based on a manually sets up range.
  49765. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  49766. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  49767. */
  49768. usePhysicalLightFalloff: boolean;
  49769. /**
  49770. * In order to support the falloff compatibility with gltf, a special mode has been added
  49771. * to reproduce the gltf light falloff.
  49772. */
  49773. /**
  49774. * In order to support the falloff compatibility with gltf, a special mode has been added
  49775. * to reproduce the gltf light falloff.
  49776. */
  49777. useGLTFLightFalloff: boolean;
  49778. /**
  49779. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  49780. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  49781. */
  49782. useRadianceOverAlpha: boolean;
  49783. /**
  49784. * Allows using an object space normal map (instead of tangent space).
  49785. */
  49786. useObjectSpaceNormalMap: boolean;
  49787. /**
  49788. * Allows using the bump map in parallax mode.
  49789. */
  49790. useParallax: boolean;
  49791. /**
  49792. * Allows using the bump map in parallax occlusion mode.
  49793. */
  49794. useParallaxOcclusion: boolean;
  49795. /**
  49796. * Controls the scale bias of the parallax mode.
  49797. */
  49798. parallaxScaleBias: number;
  49799. /**
  49800. * If sets to true, disables all the lights affecting the material.
  49801. */
  49802. disableLighting: boolean;
  49803. /**
  49804. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  49805. */
  49806. forceIrradianceInFragment: boolean;
  49807. /**
  49808. * Number of Simultaneous lights allowed on the material.
  49809. */
  49810. maxSimultaneousLights: number;
  49811. /**
  49812. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  49813. */
  49814. invertNormalMapX: boolean;
  49815. /**
  49816. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  49817. */
  49818. invertNormalMapY: boolean;
  49819. /**
  49820. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  49821. */
  49822. twoSidedLighting: boolean;
  49823. /**
  49824. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49825. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  49826. */
  49827. useAlphaFresnel: boolean;
  49828. /**
  49829. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49830. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  49831. */
  49832. useLinearAlphaFresnel: boolean;
  49833. /**
  49834. * Let user defines the brdf lookup texture used for IBL.
  49835. * A default 8bit version is embedded but you could point at :
  49836. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  49837. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  49838. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  49839. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  49840. */
  49841. environmentBRDFTexture: Nullable<BaseTexture>;
  49842. /**
  49843. * Force normal to face away from face.
  49844. */
  49845. forceNormalForward: boolean;
  49846. /**
  49847. * Enables specular anti aliasing in the PBR shader.
  49848. * It will both interacts on the Geometry for analytical and IBL lighting.
  49849. * It also prefilter the roughness map based on the bump values.
  49850. */
  49851. enableSpecularAntiAliasing: boolean;
  49852. /**
  49853. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  49854. * makes the reflect vector face the model (under horizon).
  49855. */
  49856. useHorizonOcclusion: boolean;
  49857. /**
  49858. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  49859. * too much the area relying on ambient texture to define their ambient occlusion.
  49860. */
  49861. useRadianceOcclusion: boolean;
  49862. /**
  49863. * If set to true, no lighting calculations will be applied.
  49864. */
  49865. unlit: boolean;
  49866. /**
  49867. * Gets the image processing configuration used either in this material.
  49868. */
  49869. /**
  49870. * Sets the Default image processing configuration used either in the this material.
  49871. *
  49872. * If sets to null, the scene one is in use.
  49873. */
  49874. imageProcessingConfiguration: ImageProcessingConfiguration;
  49875. /**
  49876. * Gets wether the color curves effect is enabled.
  49877. */
  49878. /**
  49879. * Sets wether the color curves effect is enabled.
  49880. */
  49881. cameraColorCurvesEnabled: boolean;
  49882. /**
  49883. * Gets wether the color grading effect is enabled.
  49884. */
  49885. /**
  49886. * Gets wether the color grading effect is enabled.
  49887. */
  49888. cameraColorGradingEnabled: boolean;
  49889. /**
  49890. * Gets wether tonemapping is enabled or not.
  49891. */
  49892. /**
  49893. * Sets wether tonemapping is enabled or not
  49894. */
  49895. cameraToneMappingEnabled: boolean;
  49896. /**
  49897. * The camera exposure used on this material.
  49898. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  49899. * This corresponds to a photographic exposure.
  49900. */
  49901. /**
  49902. * The camera exposure used on this material.
  49903. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  49904. * This corresponds to a photographic exposure.
  49905. */
  49906. cameraExposure: number;
  49907. /**
  49908. * Gets The camera contrast used on this material.
  49909. */
  49910. /**
  49911. * Sets The camera contrast used on this material.
  49912. */
  49913. cameraContrast: number;
  49914. /**
  49915. * Gets the Color Grading 2D Lookup Texture.
  49916. */
  49917. /**
  49918. * Sets the Color Grading 2D Lookup Texture.
  49919. */
  49920. cameraColorGradingTexture: Nullable<BaseTexture>;
  49921. /**
  49922. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  49923. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  49924. * 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;
  49925. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  49926. */
  49927. /**
  49928. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  49929. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  49930. * 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;
  49931. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  49932. */
  49933. cameraColorCurves: Nullable<ColorCurves>;
  49934. /**
  49935. * Instantiates a new PBRMaterial instance.
  49936. *
  49937. * @param name The material name
  49938. * @param scene The scene the material will be use in.
  49939. */
  49940. constructor(name: string, scene: Scene);
  49941. /**
  49942. * Returns the name of this material class.
  49943. */
  49944. getClassName(): string;
  49945. /**
  49946. * Makes a duplicate of the current material.
  49947. * @param name - name to use for the new material.
  49948. */
  49949. clone(name: string): PBRMaterial;
  49950. /**
  49951. * Serializes this PBR Material.
  49952. * @returns - An object with the serialized material.
  49953. */
  49954. serialize(): any;
  49955. /**
  49956. * Parses a PBR Material from a serialized object.
  49957. * @param source - Serialized object.
  49958. * @param scene - BJS scene instance.
  49959. * @param rootUrl - url for the scene object
  49960. * @returns - PBRMaterial
  49961. */
  49962. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  49963. }
  49964. }
  49965. declare module "babylonjs/Misc/dds" {
  49966. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  49967. import { Engine } from "babylonjs/Engines/engine";
  49968. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49969. import { Nullable } from "babylonjs/types";
  49970. import { Scene } from "babylonjs/scene";
  49971. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  49972. /**
  49973. * Direct draw surface info
  49974. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  49975. */
  49976. export interface DDSInfo {
  49977. /**
  49978. * Width of the texture
  49979. */
  49980. width: number;
  49981. /**
  49982. * Width of the texture
  49983. */
  49984. height: number;
  49985. /**
  49986. * Number of Mipmaps for the texture
  49987. * @see https://en.wikipedia.org/wiki/Mipmap
  49988. */
  49989. mipmapCount: number;
  49990. /**
  49991. * If the textures format is a known fourCC format
  49992. * @see https://www.fourcc.org/
  49993. */
  49994. isFourCC: boolean;
  49995. /**
  49996. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  49997. */
  49998. isRGB: boolean;
  49999. /**
  50000. * If the texture is a lumincance format
  50001. */
  50002. isLuminance: boolean;
  50003. /**
  50004. * If this is a cube texture
  50005. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  50006. */
  50007. isCube: boolean;
  50008. /**
  50009. * If the texture is a compressed format eg. FOURCC_DXT1
  50010. */
  50011. isCompressed: boolean;
  50012. /**
  50013. * The dxgiFormat of the texture
  50014. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  50015. */
  50016. dxgiFormat: number;
  50017. /**
  50018. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  50019. */
  50020. textureType: number;
  50021. /**
  50022. * Sphericle polynomial created for the dds texture
  50023. */
  50024. sphericalPolynomial?: SphericalPolynomial;
  50025. }
  50026. /**
  50027. * Class used to provide DDS decompression tools
  50028. */
  50029. export class DDSTools {
  50030. /**
  50031. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  50032. */
  50033. static StoreLODInAlphaChannel: boolean;
  50034. /**
  50035. * Gets DDS information from an array buffer
  50036. * @param arrayBuffer defines the array buffer to read data from
  50037. * @returns the DDS information
  50038. */
  50039. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  50040. private static _FloatView;
  50041. private static _Int32View;
  50042. private static _ToHalfFloat;
  50043. private static _FromHalfFloat;
  50044. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  50045. private static _GetHalfFloatRGBAArrayBuffer;
  50046. private static _GetFloatRGBAArrayBuffer;
  50047. private static _GetFloatAsUIntRGBAArrayBuffer;
  50048. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  50049. private static _GetRGBAArrayBuffer;
  50050. private static _ExtractLongWordOrder;
  50051. private static _GetRGBArrayBuffer;
  50052. private static _GetLuminanceArrayBuffer;
  50053. /**
  50054. * Uploads DDS Levels to a Babylon Texture
  50055. * @hidden
  50056. */
  50057. static UploadDDSLevels(engine: Engine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  50058. }
  50059. module "babylonjs/Engines/engine" {
  50060. interface Engine {
  50061. /**
  50062. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  50063. * @param rootUrl defines the url where the file to load is located
  50064. * @param scene defines the current scene
  50065. * @param lodScale defines scale to apply to the mip map selection
  50066. * @param lodOffset defines offset to apply to the mip map selection
  50067. * @param onLoad defines an optional callback raised when the texture is loaded
  50068. * @param onError defines an optional callback raised if there is an issue to load the texture
  50069. * @param format defines the format of the data
  50070. * @param forcedExtension defines the extension to use to pick the right loader
  50071. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  50072. * @returns the cube texture as an InternalTexture
  50073. */
  50074. 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;
  50075. }
  50076. }
  50077. }
  50078. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  50079. import { Nullable } from "babylonjs/types";
  50080. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50081. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  50082. /**
  50083. * Implementation of the DDS Texture Loader.
  50084. * @hidden
  50085. */
  50086. export class _DDSTextureLoader implements IInternalTextureLoader {
  50087. /**
  50088. * Defines wether the loader supports cascade loading the different faces.
  50089. */
  50090. readonly supportCascades: boolean;
  50091. /**
  50092. * This returns if the loader support the current file information.
  50093. * @param extension defines the file extension of the file being loaded
  50094. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50095. * @param fallback defines the fallback internal texture if any
  50096. * @param isBase64 defines whether the texture is encoded as a base64
  50097. * @param isBuffer defines whether the texture data are stored as a buffer
  50098. * @returns true if the loader can load the specified file
  50099. */
  50100. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  50101. /**
  50102. * Transform the url before loading if required.
  50103. * @param rootUrl the url of the texture
  50104. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50105. * @returns the transformed texture
  50106. */
  50107. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  50108. /**
  50109. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  50110. * @param rootUrl the url of the texture
  50111. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50112. * @returns the fallback texture
  50113. */
  50114. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  50115. /**
  50116. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  50117. * @param data contains the texture data
  50118. * @param texture defines the BabylonJS internal texture
  50119. * @param createPolynomials will be true if polynomials have been requested
  50120. * @param onLoad defines the callback to trigger once the texture is ready
  50121. * @param onError defines the callback to trigger in case of error
  50122. */
  50123. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  50124. /**
  50125. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  50126. * @param data contains the texture data
  50127. * @param texture defines the BabylonJS internal texture
  50128. * @param callback defines the method to call once ready to upload
  50129. */
  50130. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  50131. }
  50132. }
  50133. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  50134. import { Nullable } from "babylonjs/types";
  50135. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50136. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  50137. /**
  50138. * Implementation of the ENV Texture Loader.
  50139. * @hidden
  50140. */
  50141. export class _ENVTextureLoader implements IInternalTextureLoader {
  50142. /**
  50143. * Defines wether the loader supports cascade loading the different faces.
  50144. */
  50145. readonly supportCascades: boolean;
  50146. /**
  50147. * This returns if the loader support the current file information.
  50148. * @param extension defines the file extension of the file being loaded
  50149. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50150. * @param fallback defines the fallback internal texture if any
  50151. * @param isBase64 defines whether the texture is encoded as a base64
  50152. * @param isBuffer defines whether the texture data are stored as a buffer
  50153. * @returns true if the loader can load the specified file
  50154. */
  50155. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  50156. /**
  50157. * Transform the url before loading if required.
  50158. * @param rootUrl the url of the texture
  50159. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50160. * @returns the transformed texture
  50161. */
  50162. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  50163. /**
  50164. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  50165. * @param rootUrl the url of the texture
  50166. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50167. * @returns the fallback texture
  50168. */
  50169. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  50170. /**
  50171. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  50172. * @param data contains the texture data
  50173. * @param texture defines the BabylonJS internal texture
  50174. * @param createPolynomials will be true if polynomials have been requested
  50175. * @param onLoad defines the callback to trigger once the texture is ready
  50176. * @param onError defines the callback to trigger in case of error
  50177. */
  50178. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  50179. /**
  50180. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  50181. * @param data contains the texture data
  50182. * @param texture defines the BabylonJS internal texture
  50183. * @param callback defines the method to call once ready to upload
  50184. */
  50185. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  50186. }
  50187. }
  50188. declare module "babylonjs/Misc/khronosTextureContainer" {
  50189. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50190. /**
  50191. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  50192. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  50193. */
  50194. export class KhronosTextureContainer {
  50195. /** contents of the KTX container file */
  50196. arrayBuffer: any;
  50197. private static HEADER_LEN;
  50198. private static COMPRESSED_2D;
  50199. private static COMPRESSED_3D;
  50200. private static TEX_2D;
  50201. private static TEX_3D;
  50202. /**
  50203. * Gets the openGL type
  50204. */
  50205. glType: number;
  50206. /**
  50207. * Gets the openGL type size
  50208. */
  50209. glTypeSize: number;
  50210. /**
  50211. * Gets the openGL format
  50212. */
  50213. glFormat: number;
  50214. /**
  50215. * Gets the openGL internal format
  50216. */
  50217. glInternalFormat: number;
  50218. /**
  50219. * Gets the base internal format
  50220. */
  50221. glBaseInternalFormat: number;
  50222. /**
  50223. * Gets image width in pixel
  50224. */
  50225. pixelWidth: number;
  50226. /**
  50227. * Gets image height in pixel
  50228. */
  50229. pixelHeight: number;
  50230. /**
  50231. * Gets image depth in pixels
  50232. */
  50233. pixelDepth: number;
  50234. /**
  50235. * Gets the number of array elements
  50236. */
  50237. numberOfArrayElements: number;
  50238. /**
  50239. * Gets the number of faces
  50240. */
  50241. numberOfFaces: number;
  50242. /**
  50243. * Gets the number of mipmap levels
  50244. */
  50245. numberOfMipmapLevels: number;
  50246. /**
  50247. * Gets the bytes of key value data
  50248. */
  50249. bytesOfKeyValueData: number;
  50250. /**
  50251. * Gets the load type
  50252. */
  50253. loadType: number;
  50254. /**
  50255. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  50256. */
  50257. isInvalid: boolean;
  50258. /**
  50259. * Creates a new KhronosTextureContainer
  50260. * @param arrayBuffer contents of the KTX container file
  50261. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  50262. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  50263. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  50264. */
  50265. constructor(
  50266. /** contents of the KTX container file */
  50267. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  50268. /**
  50269. * Uploads KTX content to a Babylon Texture.
  50270. * It is assumed that the texture has already been created & is currently bound
  50271. * @hidden
  50272. */
  50273. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  50274. private _upload2DCompressedLevels;
  50275. }
  50276. }
  50277. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  50278. import { Nullable } from "babylonjs/types";
  50279. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50280. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  50281. /**
  50282. * Implementation of the KTX Texture Loader.
  50283. * @hidden
  50284. */
  50285. export class _KTXTextureLoader implements IInternalTextureLoader {
  50286. /**
  50287. * Defines wether the loader supports cascade loading the different faces.
  50288. */
  50289. readonly supportCascades: boolean;
  50290. /**
  50291. * This returns if the loader support the current file information.
  50292. * @param extension defines the file extension of the file being loaded
  50293. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50294. * @param fallback defines the fallback internal texture if any
  50295. * @param isBase64 defines whether the texture is encoded as a base64
  50296. * @param isBuffer defines whether the texture data are stored as a buffer
  50297. * @returns true if the loader can load the specified file
  50298. */
  50299. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  50300. /**
  50301. * Transform the url before loading if required.
  50302. * @param rootUrl the url of the texture
  50303. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50304. * @returns the transformed texture
  50305. */
  50306. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  50307. /**
  50308. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  50309. * @param rootUrl the url of the texture
  50310. * @param textureFormatInUse defines the current compressed format in use iun the engine
  50311. * @returns the fallback texture
  50312. */
  50313. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  50314. /**
  50315. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  50316. * @param data contains the texture data
  50317. * @param texture defines the BabylonJS internal texture
  50318. * @param createPolynomials will be true if polynomials have been requested
  50319. * @param onLoad defines the callback to trigger once the texture is ready
  50320. * @param onError defines the callback to trigger in case of error
  50321. */
  50322. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  50323. /**
  50324. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  50325. * @param data contains the texture data
  50326. * @param texture defines the BabylonJS internal texture
  50327. * @param callback defines the method to call once ready to upload
  50328. */
  50329. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  50330. }
  50331. }
  50332. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  50333. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  50334. import { Scene } from "babylonjs/scene";
  50335. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  50336. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  50337. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  50338. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  50339. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  50340. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  50341. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50342. /**
  50343. * Options for the default xr helper
  50344. */
  50345. export class WebXRDefaultExperienceOptions {
  50346. /**
  50347. * Floor meshes that should be used for teleporting
  50348. */
  50349. floorMeshes: Array<AbstractMesh>;
  50350. }
  50351. /**
  50352. * Default experience which provides a similar setup to the previous webVRExperience
  50353. */
  50354. export class WebXRDefaultExperience {
  50355. /**
  50356. * Base experience
  50357. */
  50358. baseExperience: WebXRExperienceHelper;
  50359. /**
  50360. * Input experience extension
  50361. */
  50362. input: WebXRInput;
  50363. /**
  50364. * Loads the controller models
  50365. */
  50366. controllerModelLoader: WebXRControllerModelLoader;
  50367. /**
  50368. * Enables laser pointer and selection
  50369. */
  50370. pointerSelection: WebXRControllerPointerSelection;
  50371. /**
  50372. * Enables teleportation
  50373. */
  50374. teleportation: WebXRControllerTeleportation;
  50375. /**
  50376. * Enables ui for enetering/exiting xr
  50377. */
  50378. enterExitUI: WebXREnterExitUI;
  50379. /**
  50380. * Default output canvas xr should render to
  50381. */
  50382. outputCanvas: WebXRManagedOutputCanvas;
  50383. /**
  50384. * Creates the default xr experience
  50385. * @param scene scene
  50386. * @param options options for basic configuration
  50387. * @returns resulting WebXRDefaultExperience
  50388. */
  50389. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  50390. private constructor();
  50391. /**
  50392. * DIsposes of the experience helper
  50393. */
  50394. dispose(): void;
  50395. }
  50396. }
  50397. declare module "babylonjs/Helpers/sceneHelpers" {
  50398. import { Nullable } from "babylonjs/types";
  50399. import { Mesh } from "babylonjs/Meshes/mesh";
  50400. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50401. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  50402. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  50403. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  50404. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  50405. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  50406. import "babylonjs/Meshes/Builders/boxBuilder";
  50407. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  50408. /** @hidden */
  50409. export var _forceSceneHelpersToBundle: boolean;
  50410. module "babylonjs/scene" {
  50411. interface Scene {
  50412. /**
  50413. * Creates a default light for the scene.
  50414. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  50415. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  50416. */
  50417. createDefaultLight(replace?: boolean): void;
  50418. /**
  50419. * Creates a default camera for the scene.
  50420. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  50421. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  50422. * @param replace has default false, when true replaces the active camera in the scene
  50423. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  50424. */
  50425. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  50426. /**
  50427. * Creates a default camera and a default light.
  50428. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  50429. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  50430. * @param replace has the default false, when true replaces the active camera/light in the scene
  50431. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  50432. */
  50433. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  50434. /**
  50435. * Creates a new sky box
  50436. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  50437. * @param environmentTexture defines the texture to use as environment texture
  50438. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  50439. * @param scale defines the overall scale of the skybox
  50440. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  50441. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  50442. * @returns a new mesh holding the sky box
  50443. */
  50444. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  50445. /**
  50446. * Creates a new environment
  50447. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  50448. * @param options defines the options you can use to configure the environment
  50449. * @returns the new EnvironmentHelper
  50450. */
  50451. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  50452. /**
  50453. * Creates a new VREXperienceHelper
  50454. * @see http://doc.babylonjs.com/how_to/webvr_helper
  50455. * @param webVROptions defines the options used to create the new VREXperienceHelper
  50456. * @returns a new VREXperienceHelper
  50457. */
  50458. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  50459. /**
  50460. * Creates a new WebXRDefaultExperience
  50461. * @see http://doc.babylonjs.com/how_to/webxr
  50462. * @param options experience options
  50463. * @returns a promise for a new WebXRDefaultExperience
  50464. */
  50465. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  50466. }
  50467. }
  50468. }
  50469. declare module "babylonjs/Helpers/videoDome" {
  50470. import { Scene } from "babylonjs/scene";
  50471. import { TransformNode } from "babylonjs/Meshes/transformNode";
  50472. import { Mesh } from "babylonjs/Meshes/mesh";
  50473. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  50474. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  50475. import "babylonjs/Meshes/Builders/sphereBuilder";
  50476. /**
  50477. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  50478. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  50479. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  50480. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  50481. */
  50482. export class VideoDome extends TransformNode {
  50483. /**
  50484. * Define the video source as a Monoscopic panoramic 360 video.
  50485. */
  50486. static readonly MODE_MONOSCOPIC: number;
  50487. /**
  50488. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  50489. */
  50490. static readonly MODE_TOPBOTTOM: number;
  50491. /**
  50492. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  50493. */
  50494. static readonly MODE_SIDEBYSIDE: number;
  50495. private _halfDome;
  50496. private _useDirectMapping;
  50497. /**
  50498. * The video texture being displayed on the sphere
  50499. */
  50500. protected _videoTexture: VideoTexture;
  50501. /**
  50502. * Gets the video texture being displayed on the sphere
  50503. */
  50504. readonly videoTexture: VideoTexture;
  50505. /**
  50506. * The skybox material
  50507. */
  50508. protected _material: BackgroundMaterial;
  50509. /**
  50510. * The surface used for the skybox
  50511. */
  50512. protected _mesh: Mesh;
  50513. /**
  50514. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  50515. */
  50516. private _halfDomeMask;
  50517. /**
  50518. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  50519. * Also see the options.resolution property.
  50520. */
  50521. fovMultiplier: number;
  50522. private _videoMode;
  50523. /**
  50524. * Gets or set the current video mode for the video. It can be:
  50525. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  50526. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  50527. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  50528. */
  50529. videoMode: number;
  50530. /**
  50531. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  50532. *
  50533. */
  50534. /**
  50535. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  50536. */
  50537. halfDome: boolean;
  50538. /**
  50539. * Oberserver used in Stereoscopic VR Mode.
  50540. */
  50541. private _onBeforeCameraRenderObserver;
  50542. /**
  50543. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  50544. * @param name Element's name, child elements will append suffixes for their own names.
  50545. * @param urlsOrVideo defines the url(s) or the video element to use
  50546. * @param options An object containing optional or exposed sub element properties
  50547. */
  50548. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  50549. resolution?: number;
  50550. clickToPlay?: boolean;
  50551. autoPlay?: boolean;
  50552. loop?: boolean;
  50553. size?: number;
  50554. poster?: string;
  50555. faceForward?: boolean;
  50556. useDirectMapping?: boolean;
  50557. halfDomeMode?: boolean;
  50558. }, scene: Scene);
  50559. private _changeVideoMode;
  50560. /**
  50561. * Releases resources associated with this node.
  50562. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  50563. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  50564. */
  50565. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  50566. }
  50567. }
  50568. declare module "babylonjs/Helpers/index" {
  50569. export * from "babylonjs/Helpers/environmentHelper";
  50570. export * from "babylonjs/Helpers/photoDome";
  50571. export * from "babylonjs/Helpers/sceneHelpers";
  50572. export * from "babylonjs/Helpers/videoDome";
  50573. }
  50574. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  50575. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  50576. import { IDisposable } from "babylonjs/scene";
  50577. import { Engine } from "babylonjs/Engines/engine";
  50578. /**
  50579. * This class can be used to get instrumentation data from a Babylon engine
  50580. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  50581. */
  50582. export class EngineInstrumentation implements IDisposable {
  50583. /**
  50584. * Define the instrumented engine.
  50585. */
  50586. engine: Engine;
  50587. private _captureGPUFrameTime;
  50588. private _gpuFrameTimeToken;
  50589. private _gpuFrameTime;
  50590. private _captureShaderCompilationTime;
  50591. private _shaderCompilationTime;
  50592. private _onBeginFrameObserver;
  50593. private _onEndFrameObserver;
  50594. private _onBeforeShaderCompilationObserver;
  50595. private _onAfterShaderCompilationObserver;
  50596. /**
  50597. * Gets the perf counter used for GPU frame time
  50598. */
  50599. readonly gpuFrameTimeCounter: PerfCounter;
  50600. /**
  50601. * Gets the GPU frame time capture status
  50602. */
  50603. /**
  50604. * Enable or disable the GPU frame time capture
  50605. */
  50606. captureGPUFrameTime: boolean;
  50607. /**
  50608. * Gets the perf counter used for shader compilation time
  50609. */
  50610. readonly shaderCompilationTimeCounter: PerfCounter;
  50611. /**
  50612. * Gets the shader compilation time capture status
  50613. */
  50614. /**
  50615. * Enable or disable the shader compilation time capture
  50616. */
  50617. captureShaderCompilationTime: boolean;
  50618. /**
  50619. * Instantiates a new engine instrumentation.
  50620. * This class can be used to get instrumentation data from a Babylon engine
  50621. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  50622. * @param engine Defines the engine to instrument
  50623. */
  50624. constructor(
  50625. /**
  50626. * Define the instrumented engine.
  50627. */
  50628. engine: Engine);
  50629. /**
  50630. * Dispose and release associated resources.
  50631. */
  50632. dispose(): void;
  50633. }
  50634. }
  50635. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  50636. import { Scene, IDisposable } from "babylonjs/scene";
  50637. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  50638. /**
  50639. * This class can be used to get instrumentation data from a Babylon engine
  50640. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  50641. */
  50642. export class SceneInstrumentation implements IDisposable {
  50643. /**
  50644. * Defines the scene to instrument
  50645. */
  50646. scene: Scene;
  50647. private _captureActiveMeshesEvaluationTime;
  50648. private _activeMeshesEvaluationTime;
  50649. private _captureRenderTargetsRenderTime;
  50650. private _renderTargetsRenderTime;
  50651. private _captureFrameTime;
  50652. private _frameTime;
  50653. private _captureRenderTime;
  50654. private _renderTime;
  50655. private _captureInterFrameTime;
  50656. private _interFrameTime;
  50657. private _captureParticlesRenderTime;
  50658. private _particlesRenderTime;
  50659. private _captureSpritesRenderTime;
  50660. private _spritesRenderTime;
  50661. private _capturePhysicsTime;
  50662. private _physicsTime;
  50663. private _captureAnimationsTime;
  50664. private _animationsTime;
  50665. private _captureCameraRenderTime;
  50666. private _cameraRenderTime;
  50667. private _onBeforeActiveMeshesEvaluationObserver;
  50668. private _onAfterActiveMeshesEvaluationObserver;
  50669. private _onBeforeRenderTargetsRenderObserver;
  50670. private _onAfterRenderTargetsRenderObserver;
  50671. private _onAfterRenderObserver;
  50672. private _onBeforeDrawPhaseObserver;
  50673. private _onAfterDrawPhaseObserver;
  50674. private _onBeforeAnimationsObserver;
  50675. private _onBeforeParticlesRenderingObserver;
  50676. private _onAfterParticlesRenderingObserver;
  50677. private _onBeforeSpritesRenderingObserver;
  50678. private _onAfterSpritesRenderingObserver;
  50679. private _onBeforePhysicsObserver;
  50680. private _onAfterPhysicsObserver;
  50681. private _onAfterAnimationsObserver;
  50682. private _onBeforeCameraRenderObserver;
  50683. private _onAfterCameraRenderObserver;
  50684. /**
  50685. * Gets the perf counter used for active meshes evaluation time
  50686. */
  50687. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  50688. /**
  50689. * Gets the active meshes evaluation time capture status
  50690. */
  50691. /**
  50692. * Enable or disable the active meshes evaluation time capture
  50693. */
  50694. captureActiveMeshesEvaluationTime: boolean;
  50695. /**
  50696. * Gets the perf counter used for render targets render time
  50697. */
  50698. readonly renderTargetsRenderTimeCounter: PerfCounter;
  50699. /**
  50700. * Gets the render targets render time capture status
  50701. */
  50702. /**
  50703. * Enable or disable the render targets render time capture
  50704. */
  50705. captureRenderTargetsRenderTime: boolean;
  50706. /**
  50707. * Gets the perf counter used for particles render time
  50708. */
  50709. readonly particlesRenderTimeCounter: PerfCounter;
  50710. /**
  50711. * Gets the particles render time capture status
  50712. */
  50713. /**
  50714. * Enable or disable the particles render time capture
  50715. */
  50716. captureParticlesRenderTime: boolean;
  50717. /**
  50718. * Gets the perf counter used for sprites render time
  50719. */
  50720. readonly spritesRenderTimeCounter: PerfCounter;
  50721. /**
  50722. * Gets the sprites render time capture status
  50723. */
  50724. /**
  50725. * Enable or disable the sprites render time capture
  50726. */
  50727. captureSpritesRenderTime: boolean;
  50728. /**
  50729. * Gets the perf counter used for physics time
  50730. */
  50731. readonly physicsTimeCounter: PerfCounter;
  50732. /**
  50733. * Gets the physics time capture status
  50734. */
  50735. /**
  50736. * Enable or disable the physics time capture
  50737. */
  50738. capturePhysicsTime: boolean;
  50739. /**
  50740. * Gets the perf counter used for animations time
  50741. */
  50742. readonly animationsTimeCounter: PerfCounter;
  50743. /**
  50744. * Gets the animations time capture status
  50745. */
  50746. /**
  50747. * Enable or disable the animations time capture
  50748. */
  50749. captureAnimationsTime: boolean;
  50750. /**
  50751. * Gets the perf counter used for frame time capture
  50752. */
  50753. readonly frameTimeCounter: PerfCounter;
  50754. /**
  50755. * Gets the frame time capture status
  50756. */
  50757. /**
  50758. * Enable or disable the frame time capture
  50759. */
  50760. captureFrameTime: boolean;
  50761. /**
  50762. * Gets the perf counter used for inter-frames time capture
  50763. */
  50764. readonly interFrameTimeCounter: PerfCounter;
  50765. /**
  50766. * Gets the inter-frames time capture status
  50767. */
  50768. /**
  50769. * Enable or disable the inter-frames time capture
  50770. */
  50771. captureInterFrameTime: boolean;
  50772. /**
  50773. * Gets the perf counter used for render time capture
  50774. */
  50775. readonly renderTimeCounter: PerfCounter;
  50776. /**
  50777. * Gets the render time capture status
  50778. */
  50779. /**
  50780. * Enable or disable the render time capture
  50781. */
  50782. captureRenderTime: boolean;
  50783. /**
  50784. * Gets the perf counter used for camera render time capture
  50785. */
  50786. readonly cameraRenderTimeCounter: PerfCounter;
  50787. /**
  50788. * Gets the camera render time capture status
  50789. */
  50790. /**
  50791. * Enable or disable the camera render time capture
  50792. */
  50793. captureCameraRenderTime: boolean;
  50794. /**
  50795. * Gets the perf counter used for draw calls
  50796. */
  50797. readonly drawCallsCounter: PerfCounter;
  50798. /**
  50799. * Instantiates a new scene instrumentation.
  50800. * This class can be used to get instrumentation data from a Babylon engine
  50801. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  50802. * @param scene Defines the scene to instrument
  50803. */
  50804. constructor(
  50805. /**
  50806. * Defines the scene to instrument
  50807. */
  50808. scene: Scene);
  50809. /**
  50810. * Dispose and release associated resources.
  50811. */
  50812. dispose(): void;
  50813. }
  50814. }
  50815. declare module "babylonjs/Instrumentation/index" {
  50816. export * from "babylonjs/Instrumentation/engineInstrumentation";
  50817. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  50818. export * from "babylonjs/Instrumentation/timeToken";
  50819. }
  50820. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  50821. /** @hidden */
  50822. export var glowMapGenerationPixelShader: {
  50823. name: string;
  50824. shader: string;
  50825. };
  50826. }
  50827. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  50828. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  50829. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  50830. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  50831. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  50832. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  50833. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  50834. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  50835. /** @hidden */
  50836. export var glowMapGenerationVertexShader: {
  50837. name: string;
  50838. shader: string;
  50839. };
  50840. }
  50841. declare module "babylonjs/Layers/effectLayer" {
  50842. import { Observable } from "babylonjs/Misc/observable";
  50843. import { Nullable } from "babylonjs/types";
  50844. import { Camera } from "babylonjs/Cameras/camera";
  50845. import { Scene } from "babylonjs/scene";
  50846. import { ISize } from "babylonjs/Maths/math.size";
  50847. import { Color4 } from "babylonjs/Maths/math.color";
  50848. import { Engine } from "babylonjs/Engines/engine";
  50849. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50850. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50851. import { Mesh } from "babylonjs/Meshes/mesh";
  50852. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  50853. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50854. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  50855. import { Effect } from "babylonjs/Materials/effect";
  50856. import { Material } from "babylonjs/Materials/material";
  50857. import "babylonjs/Shaders/glowMapGeneration.fragment";
  50858. import "babylonjs/Shaders/glowMapGeneration.vertex";
  50859. /**
  50860. * Effect layer options. This helps customizing the behaviour
  50861. * of the effect layer.
  50862. */
  50863. export interface IEffectLayerOptions {
  50864. /**
  50865. * Multiplication factor apply to the canvas size to compute the render target size
  50866. * used to generated the objects (the smaller the faster).
  50867. */
  50868. mainTextureRatio: number;
  50869. /**
  50870. * Enforces a fixed size texture to ensure effect stability across devices.
  50871. */
  50872. mainTextureFixedSize?: number;
  50873. /**
  50874. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  50875. */
  50876. alphaBlendingMode: number;
  50877. /**
  50878. * The camera attached to the layer.
  50879. */
  50880. camera: Nullable<Camera>;
  50881. /**
  50882. * The rendering group to draw the layer in.
  50883. */
  50884. renderingGroupId: number;
  50885. }
  50886. /**
  50887. * The effect layer Helps adding post process effect blended with the main pass.
  50888. *
  50889. * This can be for instance use to generate glow or higlight effects on the scene.
  50890. *
  50891. * The effect layer class can not be used directly and is intented to inherited from to be
  50892. * customized per effects.
  50893. */
  50894. export abstract class EffectLayer {
  50895. private _vertexBuffers;
  50896. private _indexBuffer;
  50897. private _cachedDefines;
  50898. private _effectLayerMapGenerationEffect;
  50899. private _effectLayerOptions;
  50900. private _mergeEffect;
  50901. protected _scene: Scene;
  50902. protected _engine: Engine;
  50903. protected _maxSize: number;
  50904. protected _mainTextureDesiredSize: ISize;
  50905. protected _mainTexture: RenderTargetTexture;
  50906. protected _shouldRender: boolean;
  50907. protected _postProcesses: PostProcess[];
  50908. protected _textures: BaseTexture[];
  50909. protected _emissiveTextureAndColor: {
  50910. texture: Nullable<BaseTexture>;
  50911. color: Color4;
  50912. };
  50913. /**
  50914. * The name of the layer
  50915. */
  50916. name: string;
  50917. /**
  50918. * The clear color of the texture used to generate the glow map.
  50919. */
  50920. neutralColor: Color4;
  50921. /**
  50922. * Specifies wether the highlight layer is enabled or not.
  50923. */
  50924. isEnabled: boolean;
  50925. /**
  50926. * Gets the camera attached to the layer.
  50927. */
  50928. readonly camera: Nullable<Camera>;
  50929. /**
  50930. * Gets the rendering group id the layer should render in.
  50931. */
  50932. renderingGroupId: number;
  50933. /**
  50934. * An event triggered when the effect layer has been disposed.
  50935. */
  50936. onDisposeObservable: Observable<EffectLayer>;
  50937. /**
  50938. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  50939. */
  50940. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  50941. /**
  50942. * An event triggered when the generated texture is being merged in the scene.
  50943. */
  50944. onBeforeComposeObservable: Observable<EffectLayer>;
  50945. /**
  50946. * An event triggered when the generated texture has been merged in the scene.
  50947. */
  50948. onAfterComposeObservable: Observable<EffectLayer>;
  50949. /**
  50950. * An event triggered when the efffect layer changes its size.
  50951. */
  50952. onSizeChangedObservable: Observable<EffectLayer>;
  50953. /** @hidden */
  50954. static _SceneComponentInitialization: (scene: Scene) => void;
  50955. /**
  50956. * Instantiates a new effect Layer and references it in the scene.
  50957. * @param name The name of the layer
  50958. * @param scene The scene to use the layer in
  50959. */
  50960. constructor(
  50961. /** The Friendly of the effect in the scene */
  50962. name: string, scene: Scene);
  50963. /**
  50964. * Get the effect name of the layer.
  50965. * @return The effect name
  50966. */
  50967. abstract getEffectName(): string;
  50968. /**
  50969. * Checks for the readiness of the element composing the layer.
  50970. * @param subMesh the mesh to check for
  50971. * @param useInstances specify wether or not to use instances to render the mesh
  50972. * @return true if ready otherwise, false
  50973. */
  50974. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  50975. /**
  50976. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  50977. * @returns true if the effect requires stencil during the main canvas render pass.
  50978. */
  50979. abstract needStencil(): boolean;
  50980. /**
  50981. * Create the merge effect. This is the shader use to blit the information back
  50982. * to the main canvas at the end of the scene rendering.
  50983. * @returns The effect containing the shader used to merge the effect on the main canvas
  50984. */
  50985. protected abstract _createMergeEffect(): Effect;
  50986. /**
  50987. * Creates the render target textures and post processes used in the effect layer.
  50988. */
  50989. protected abstract _createTextureAndPostProcesses(): void;
  50990. /**
  50991. * Implementation specific of rendering the generating effect on the main canvas.
  50992. * @param effect The effect used to render through
  50993. */
  50994. protected abstract _internalRender(effect: Effect): void;
  50995. /**
  50996. * Sets the required values for both the emissive texture and and the main color.
  50997. */
  50998. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  50999. /**
  51000. * Free any resources and references associated to a mesh.
  51001. * Internal use
  51002. * @param mesh The mesh to free.
  51003. */
  51004. abstract _disposeMesh(mesh: Mesh): void;
  51005. /**
  51006. * Serializes this layer (Glow or Highlight for example)
  51007. * @returns a serialized layer object
  51008. */
  51009. abstract serialize?(): any;
  51010. /**
  51011. * Initializes the effect layer with the required options.
  51012. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  51013. */
  51014. protected _init(options: Partial<IEffectLayerOptions>): void;
  51015. /**
  51016. * Generates the index buffer of the full screen quad blending to the main canvas.
  51017. */
  51018. private _generateIndexBuffer;
  51019. /**
  51020. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  51021. */
  51022. private _generateVertexBuffer;
  51023. /**
  51024. * Sets the main texture desired size which is the closest power of two
  51025. * of the engine canvas size.
  51026. */
  51027. private _setMainTextureSize;
  51028. /**
  51029. * Creates the main texture for the effect layer.
  51030. */
  51031. protected _createMainTexture(): void;
  51032. /**
  51033. * Adds specific effects defines.
  51034. * @param defines The defines to add specifics to.
  51035. */
  51036. protected _addCustomEffectDefines(defines: string[]): void;
  51037. /**
  51038. * Checks for the readiness of the element composing the layer.
  51039. * @param subMesh the mesh to check for
  51040. * @param useInstances specify wether or not to use instances to render the mesh
  51041. * @param emissiveTexture the associated emissive texture used to generate the glow
  51042. * @return true if ready otherwise, false
  51043. */
  51044. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  51045. /**
  51046. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  51047. */
  51048. render(): void;
  51049. /**
  51050. * Determine if a given mesh will be used in the current effect.
  51051. * @param mesh mesh to test
  51052. * @returns true if the mesh will be used
  51053. */
  51054. hasMesh(mesh: AbstractMesh): boolean;
  51055. /**
  51056. * Returns true if the layer contains information to display, otherwise false.
  51057. * @returns true if the glow layer should be rendered
  51058. */
  51059. shouldRender(): boolean;
  51060. /**
  51061. * Returns true if the mesh should render, otherwise false.
  51062. * @param mesh The mesh to render
  51063. * @returns true if it should render otherwise false
  51064. */
  51065. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  51066. /**
  51067. * Returns true if the mesh can be rendered, otherwise false.
  51068. * @param mesh The mesh to render
  51069. * @param material The material used on the mesh
  51070. * @returns true if it can be rendered otherwise false
  51071. */
  51072. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  51073. /**
  51074. * Returns true if the mesh should render, otherwise false.
  51075. * @param mesh The mesh to render
  51076. * @returns true if it should render otherwise false
  51077. */
  51078. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  51079. /**
  51080. * Renders the submesh passed in parameter to the generation map.
  51081. */
  51082. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  51083. /**
  51084. * Rebuild the required buffers.
  51085. * @hidden Internal use only.
  51086. */
  51087. _rebuild(): void;
  51088. /**
  51089. * Dispose only the render target textures and post process.
  51090. */
  51091. private _disposeTextureAndPostProcesses;
  51092. /**
  51093. * Dispose the highlight layer and free resources.
  51094. */
  51095. dispose(): void;
  51096. /**
  51097. * Gets the class name of the effect layer
  51098. * @returns the string with the class name of the effect layer
  51099. */
  51100. getClassName(): string;
  51101. /**
  51102. * Creates an effect layer from parsed effect layer data
  51103. * @param parsedEffectLayer defines effect layer data
  51104. * @param scene defines the current scene
  51105. * @param rootUrl defines the root URL containing the effect layer information
  51106. * @returns a parsed effect Layer
  51107. */
  51108. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  51109. }
  51110. }
  51111. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  51112. import { Scene } from "babylonjs/scene";
  51113. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  51114. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  51115. import { AbstractScene } from "babylonjs/abstractScene";
  51116. module "babylonjs/abstractScene" {
  51117. interface AbstractScene {
  51118. /**
  51119. * The list of effect layers (highlights/glow) added to the scene
  51120. * @see http://doc.babylonjs.com/how_to/highlight_layer
  51121. * @see http://doc.babylonjs.com/how_to/glow_layer
  51122. */
  51123. effectLayers: Array<EffectLayer>;
  51124. /**
  51125. * Removes the given effect layer from this scene.
  51126. * @param toRemove defines the effect layer to remove
  51127. * @returns the index of the removed effect layer
  51128. */
  51129. removeEffectLayer(toRemove: EffectLayer): number;
  51130. /**
  51131. * Adds the given effect layer to this scene
  51132. * @param newEffectLayer defines the effect layer to add
  51133. */
  51134. addEffectLayer(newEffectLayer: EffectLayer): void;
  51135. }
  51136. }
  51137. /**
  51138. * Defines the layer scene component responsible to manage any effect layers
  51139. * in a given scene.
  51140. */
  51141. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  51142. /**
  51143. * The component name helpfull to identify the component in the list of scene components.
  51144. */
  51145. readonly name: string;
  51146. /**
  51147. * The scene the component belongs to.
  51148. */
  51149. scene: Scene;
  51150. private _engine;
  51151. private _renderEffects;
  51152. private _needStencil;
  51153. private _previousStencilState;
  51154. /**
  51155. * Creates a new instance of the component for the given scene
  51156. * @param scene Defines the scene to register the component in
  51157. */
  51158. constructor(scene: Scene);
  51159. /**
  51160. * Registers the component in a given scene
  51161. */
  51162. register(): void;
  51163. /**
  51164. * Rebuilds the elements related to this component in case of
  51165. * context lost for instance.
  51166. */
  51167. rebuild(): void;
  51168. /**
  51169. * Serializes the component data to the specified json object
  51170. * @param serializationObject The object to serialize to
  51171. */
  51172. serialize(serializationObject: any): void;
  51173. /**
  51174. * Adds all the elements from the container to the scene
  51175. * @param container the container holding the elements
  51176. */
  51177. addFromContainer(container: AbstractScene): void;
  51178. /**
  51179. * Removes all the elements in the container from the scene
  51180. * @param container contains the elements to remove
  51181. * @param dispose if the removed element should be disposed (default: false)
  51182. */
  51183. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  51184. /**
  51185. * Disposes the component and the associated ressources.
  51186. */
  51187. dispose(): void;
  51188. private _isReadyForMesh;
  51189. private _renderMainTexture;
  51190. private _setStencil;
  51191. private _setStencilBack;
  51192. private _draw;
  51193. private _drawCamera;
  51194. private _drawRenderingGroup;
  51195. }
  51196. }
  51197. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  51198. /** @hidden */
  51199. export var glowMapMergePixelShader: {
  51200. name: string;
  51201. shader: string;
  51202. };
  51203. }
  51204. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  51205. /** @hidden */
  51206. export var glowMapMergeVertexShader: {
  51207. name: string;
  51208. shader: string;
  51209. };
  51210. }
  51211. declare module "babylonjs/Layers/glowLayer" {
  51212. import { Nullable } from "babylonjs/types";
  51213. import { Camera } from "babylonjs/Cameras/camera";
  51214. import { Scene } from "babylonjs/scene";
  51215. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51216. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51217. import { Mesh } from "babylonjs/Meshes/mesh";
  51218. import { Texture } from "babylonjs/Materials/Textures/texture";
  51219. import { Effect } from "babylonjs/Materials/effect";
  51220. import { Material } from "babylonjs/Materials/material";
  51221. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  51222. import { Color4 } from "babylonjs/Maths/math.color";
  51223. import "babylonjs/Shaders/glowMapMerge.fragment";
  51224. import "babylonjs/Shaders/glowMapMerge.vertex";
  51225. import "babylonjs/Layers/effectLayerSceneComponent";
  51226. module "babylonjs/abstractScene" {
  51227. interface AbstractScene {
  51228. /**
  51229. * Return a the first highlight layer of the scene with a given name.
  51230. * @param name The name of the highlight layer to look for.
  51231. * @return The highlight layer if found otherwise null.
  51232. */
  51233. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  51234. }
  51235. }
  51236. /**
  51237. * Glow layer options. This helps customizing the behaviour
  51238. * of the glow layer.
  51239. */
  51240. export interface IGlowLayerOptions {
  51241. /**
  51242. * Multiplication factor apply to the canvas size to compute the render target size
  51243. * used to generated the glowing objects (the smaller the faster).
  51244. */
  51245. mainTextureRatio: number;
  51246. /**
  51247. * Enforces a fixed size texture to ensure resize independant blur.
  51248. */
  51249. mainTextureFixedSize?: number;
  51250. /**
  51251. * How big is the kernel of the blur texture.
  51252. */
  51253. blurKernelSize: number;
  51254. /**
  51255. * The camera attached to the layer.
  51256. */
  51257. camera: Nullable<Camera>;
  51258. /**
  51259. * Enable MSAA by chosing the number of samples.
  51260. */
  51261. mainTextureSamples?: number;
  51262. /**
  51263. * The rendering group to draw the layer in.
  51264. */
  51265. renderingGroupId: number;
  51266. }
  51267. /**
  51268. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  51269. *
  51270. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  51271. * glowy meshes to your scene.
  51272. *
  51273. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  51274. */
  51275. export class GlowLayer extends EffectLayer {
  51276. /**
  51277. * Effect Name of the layer.
  51278. */
  51279. static readonly EffectName: string;
  51280. /**
  51281. * The default blur kernel size used for the glow.
  51282. */
  51283. static DefaultBlurKernelSize: number;
  51284. /**
  51285. * The default texture size ratio used for the glow.
  51286. */
  51287. static DefaultTextureRatio: number;
  51288. /**
  51289. * Sets the kernel size of the blur.
  51290. */
  51291. /**
  51292. * Gets the kernel size of the blur.
  51293. */
  51294. blurKernelSize: number;
  51295. /**
  51296. * Sets the glow intensity.
  51297. */
  51298. /**
  51299. * Gets the glow intensity.
  51300. */
  51301. intensity: number;
  51302. private _options;
  51303. private _intensity;
  51304. private _horizontalBlurPostprocess1;
  51305. private _verticalBlurPostprocess1;
  51306. private _horizontalBlurPostprocess2;
  51307. private _verticalBlurPostprocess2;
  51308. private _blurTexture1;
  51309. private _blurTexture2;
  51310. private _postProcesses1;
  51311. private _postProcesses2;
  51312. private _includedOnlyMeshes;
  51313. private _excludedMeshes;
  51314. /**
  51315. * Callback used to let the user override the color selection on a per mesh basis
  51316. */
  51317. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  51318. /**
  51319. * Callback used to let the user override the texture selection on a per mesh basis
  51320. */
  51321. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  51322. /**
  51323. * Instantiates a new glow Layer and references it to the scene.
  51324. * @param name The name of the layer
  51325. * @param scene The scene to use the layer in
  51326. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  51327. */
  51328. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  51329. /**
  51330. * Get the effect name of the layer.
  51331. * @return The effect name
  51332. */
  51333. getEffectName(): string;
  51334. /**
  51335. * Create the merge effect. This is the shader use to blit the information back
  51336. * to the main canvas at the end of the scene rendering.
  51337. */
  51338. protected _createMergeEffect(): Effect;
  51339. /**
  51340. * Creates the render target textures and post processes used in the glow layer.
  51341. */
  51342. protected _createTextureAndPostProcesses(): void;
  51343. /**
  51344. * Checks for the readiness of the element composing the layer.
  51345. * @param subMesh the mesh to check for
  51346. * @param useInstances specify wether or not to use instances to render the mesh
  51347. * @param emissiveTexture the associated emissive texture used to generate the glow
  51348. * @return true if ready otherwise, false
  51349. */
  51350. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  51351. /**
  51352. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  51353. */
  51354. needStencil(): boolean;
  51355. /**
  51356. * Returns true if the mesh can be rendered, otherwise false.
  51357. * @param mesh The mesh to render
  51358. * @param material The material used on the mesh
  51359. * @returns true if it can be rendered otherwise false
  51360. */
  51361. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  51362. /**
  51363. * Implementation specific of rendering the generating effect on the main canvas.
  51364. * @param effect The effect used to render through
  51365. */
  51366. protected _internalRender(effect: Effect): void;
  51367. /**
  51368. * Sets the required values for both the emissive texture and and the main color.
  51369. */
  51370. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  51371. /**
  51372. * Returns true if the mesh should render, otherwise false.
  51373. * @param mesh The mesh to render
  51374. * @returns true if it should render otherwise false
  51375. */
  51376. protected _shouldRenderMesh(mesh: Mesh): boolean;
  51377. /**
  51378. * Adds specific effects defines.
  51379. * @param defines The defines to add specifics to.
  51380. */
  51381. protected _addCustomEffectDefines(defines: string[]): void;
  51382. /**
  51383. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  51384. * @param mesh The mesh to exclude from the glow layer
  51385. */
  51386. addExcludedMesh(mesh: Mesh): void;
  51387. /**
  51388. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  51389. * @param mesh The mesh to remove
  51390. */
  51391. removeExcludedMesh(mesh: Mesh): void;
  51392. /**
  51393. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  51394. * @param mesh The mesh to include in the glow layer
  51395. */
  51396. addIncludedOnlyMesh(mesh: Mesh): void;
  51397. /**
  51398. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  51399. * @param mesh The mesh to remove
  51400. */
  51401. removeIncludedOnlyMesh(mesh: Mesh): void;
  51402. /**
  51403. * Determine if a given mesh will be used in the glow layer
  51404. * @param mesh The mesh to test
  51405. * @returns true if the mesh will be highlighted by the current glow layer
  51406. */
  51407. hasMesh(mesh: AbstractMesh): boolean;
  51408. /**
  51409. * Free any resources and references associated to a mesh.
  51410. * Internal use
  51411. * @param mesh The mesh to free.
  51412. * @hidden
  51413. */
  51414. _disposeMesh(mesh: Mesh): void;
  51415. /**
  51416. * Gets the class name of the effect layer
  51417. * @returns the string with the class name of the effect layer
  51418. */
  51419. getClassName(): string;
  51420. /**
  51421. * Serializes this glow layer
  51422. * @returns a serialized glow layer object
  51423. */
  51424. serialize(): any;
  51425. /**
  51426. * Creates a Glow Layer from parsed glow layer data
  51427. * @param parsedGlowLayer defines glow layer data
  51428. * @param scene defines the current scene
  51429. * @param rootUrl defines the root URL containing the glow layer information
  51430. * @returns a parsed Glow Layer
  51431. */
  51432. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  51433. }
  51434. }
  51435. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  51436. /** @hidden */
  51437. export var glowBlurPostProcessPixelShader: {
  51438. name: string;
  51439. shader: string;
  51440. };
  51441. }
  51442. declare module "babylonjs/Layers/highlightLayer" {
  51443. import { Observable } from "babylonjs/Misc/observable";
  51444. import { Nullable } from "babylonjs/types";
  51445. import { Camera } from "babylonjs/Cameras/camera";
  51446. import { Scene } from "babylonjs/scene";
  51447. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51448. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51449. import { Mesh } from "babylonjs/Meshes/mesh";
  51450. import { Effect } from "babylonjs/Materials/effect";
  51451. import { Material } from "babylonjs/Materials/material";
  51452. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  51453. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  51454. import "babylonjs/Shaders/glowMapMerge.fragment";
  51455. import "babylonjs/Shaders/glowMapMerge.vertex";
  51456. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  51457. module "babylonjs/abstractScene" {
  51458. interface AbstractScene {
  51459. /**
  51460. * Return a the first highlight layer of the scene with a given name.
  51461. * @param name The name of the highlight layer to look for.
  51462. * @return The highlight layer if found otherwise null.
  51463. */
  51464. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  51465. }
  51466. }
  51467. /**
  51468. * Highlight layer options. This helps customizing the behaviour
  51469. * of the highlight layer.
  51470. */
  51471. export interface IHighlightLayerOptions {
  51472. /**
  51473. * Multiplication factor apply to the canvas size to compute the render target size
  51474. * used to generated the glowing objects (the smaller the faster).
  51475. */
  51476. mainTextureRatio: number;
  51477. /**
  51478. * Enforces a fixed size texture to ensure resize independant blur.
  51479. */
  51480. mainTextureFixedSize?: number;
  51481. /**
  51482. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  51483. * of the picture to blur (the smaller the faster).
  51484. */
  51485. blurTextureSizeRatio: number;
  51486. /**
  51487. * How big in texel of the blur texture is the vertical blur.
  51488. */
  51489. blurVerticalSize: number;
  51490. /**
  51491. * How big in texel of the blur texture is the horizontal blur.
  51492. */
  51493. blurHorizontalSize: number;
  51494. /**
  51495. * Alpha blending mode used to apply the blur. Default is combine.
  51496. */
  51497. alphaBlendingMode: number;
  51498. /**
  51499. * The camera attached to the layer.
  51500. */
  51501. camera: Nullable<Camera>;
  51502. /**
  51503. * Should we display highlight as a solid stroke?
  51504. */
  51505. isStroke?: boolean;
  51506. /**
  51507. * The rendering group to draw the layer in.
  51508. */
  51509. renderingGroupId: number;
  51510. }
  51511. /**
  51512. * The highlight layer Helps adding a glow effect around a mesh.
  51513. *
  51514. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  51515. * glowy meshes to your scene.
  51516. *
  51517. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  51518. */
  51519. export class HighlightLayer extends EffectLayer {
  51520. name: string;
  51521. /**
  51522. * Effect Name of the highlight layer.
  51523. */
  51524. static readonly EffectName: string;
  51525. /**
  51526. * The neutral color used during the preparation of the glow effect.
  51527. * This is black by default as the blend operation is a blend operation.
  51528. */
  51529. static NeutralColor: Color4;
  51530. /**
  51531. * Stencil value used for glowing meshes.
  51532. */
  51533. static GlowingMeshStencilReference: number;
  51534. /**
  51535. * Stencil value used for the other meshes in the scene.
  51536. */
  51537. static NormalMeshStencilReference: number;
  51538. /**
  51539. * Specifies whether or not the inner glow is ACTIVE in the layer.
  51540. */
  51541. innerGlow: boolean;
  51542. /**
  51543. * Specifies whether or not the outer glow is ACTIVE in the layer.
  51544. */
  51545. outerGlow: boolean;
  51546. /**
  51547. * Specifies the horizontal size of the blur.
  51548. */
  51549. /**
  51550. * Gets the horizontal size of the blur.
  51551. */
  51552. blurHorizontalSize: number;
  51553. /**
  51554. * Specifies the vertical size of the blur.
  51555. */
  51556. /**
  51557. * Gets the vertical size of the blur.
  51558. */
  51559. blurVerticalSize: number;
  51560. /**
  51561. * An event triggered when the highlight layer is being blurred.
  51562. */
  51563. onBeforeBlurObservable: Observable<HighlightLayer>;
  51564. /**
  51565. * An event triggered when the highlight layer has been blurred.
  51566. */
  51567. onAfterBlurObservable: Observable<HighlightLayer>;
  51568. private _instanceGlowingMeshStencilReference;
  51569. private _options;
  51570. private _downSamplePostprocess;
  51571. private _horizontalBlurPostprocess;
  51572. private _verticalBlurPostprocess;
  51573. private _blurTexture;
  51574. private _meshes;
  51575. private _excludedMeshes;
  51576. /**
  51577. * Instantiates a new highlight Layer and references it to the scene..
  51578. * @param name The name of the layer
  51579. * @param scene The scene to use the layer in
  51580. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  51581. */
  51582. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  51583. /**
  51584. * Get the effect name of the layer.
  51585. * @return The effect name
  51586. */
  51587. getEffectName(): string;
  51588. /**
  51589. * Create the merge effect. This is the shader use to blit the information back
  51590. * to the main canvas at the end of the scene rendering.
  51591. */
  51592. protected _createMergeEffect(): Effect;
  51593. /**
  51594. * Creates the render target textures and post processes used in the highlight layer.
  51595. */
  51596. protected _createTextureAndPostProcesses(): void;
  51597. /**
  51598. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  51599. */
  51600. needStencil(): boolean;
  51601. /**
  51602. * Checks for the readiness of the element composing the layer.
  51603. * @param subMesh the mesh to check for
  51604. * @param useInstances specify wether or not to use instances to render the mesh
  51605. * @param emissiveTexture the associated emissive texture used to generate the glow
  51606. * @return true if ready otherwise, false
  51607. */
  51608. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  51609. /**
  51610. * Implementation specific of rendering the generating effect on the main canvas.
  51611. * @param effect The effect used to render through
  51612. */
  51613. protected _internalRender(effect: Effect): void;
  51614. /**
  51615. * Returns true if the layer contains information to display, otherwise false.
  51616. */
  51617. shouldRender(): boolean;
  51618. /**
  51619. * Returns true if the mesh should render, otherwise false.
  51620. * @param mesh The mesh to render
  51621. * @returns true if it should render otherwise false
  51622. */
  51623. protected _shouldRenderMesh(mesh: Mesh): boolean;
  51624. /**
  51625. * Sets the required values for both the emissive texture and and the main color.
  51626. */
  51627. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  51628. /**
  51629. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  51630. * @param mesh The mesh to exclude from the highlight layer
  51631. */
  51632. addExcludedMesh(mesh: Mesh): void;
  51633. /**
  51634. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  51635. * @param mesh The mesh to highlight
  51636. */
  51637. removeExcludedMesh(mesh: Mesh): void;
  51638. /**
  51639. * Determine if a given mesh will be highlighted by the current HighlightLayer
  51640. * @param mesh mesh to test
  51641. * @returns true if the mesh will be highlighted by the current HighlightLayer
  51642. */
  51643. hasMesh(mesh: AbstractMesh): boolean;
  51644. /**
  51645. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  51646. * @param mesh The mesh to highlight
  51647. * @param color The color of the highlight
  51648. * @param glowEmissiveOnly Extract the glow from the emissive texture
  51649. */
  51650. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  51651. /**
  51652. * Remove a mesh from the highlight layer in order to make it stop glowing.
  51653. * @param mesh The mesh to highlight
  51654. */
  51655. removeMesh(mesh: Mesh): void;
  51656. /**
  51657. * Force the stencil to the normal expected value for none glowing parts
  51658. */
  51659. private _defaultStencilReference;
  51660. /**
  51661. * Free any resources and references associated to a mesh.
  51662. * Internal use
  51663. * @param mesh The mesh to free.
  51664. * @hidden
  51665. */
  51666. _disposeMesh(mesh: Mesh): void;
  51667. /**
  51668. * Dispose the highlight layer and free resources.
  51669. */
  51670. dispose(): void;
  51671. /**
  51672. * Gets the class name of the effect layer
  51673. * @returns the string with the class name of the effect layer
  51674. */
  51675. getClassName(): string;
  51676. /**
  51677. * Serializes this Highlight layer
  51678. * @returns a serialized Highlight layer object
  51679. */
  51680. serialize(): any;
  51681. /**
  51682. * Creates a Highlight layer from parsed Highlight layer data
  51683. * @param parsedHightlightLayer defines the Highlight layer data
  51684. * @param scene defines the current scene
  51685. * @param rootUrl defines the root URL containing the Highlight layer information
  51686. * @returns a parsed Highlight layer
  51687. */
  51688. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  51689. }
  51690. }
  51691. declare module "babylonjs/Layers/layerSceneComponent" {
  51692. import { Scene } from "babylonjs/scene";
  51693. import { ISceneComponent } from "babylonjs/sceneComponent";
  51694. import { Layer } from "babylonjs/Layers/layer";
  51695. import { AbstractScene } from "babylonjs/abstractScene";
  51696. module "babylonjs/abstractScene" {
  51697. interface AbstractScene {
  51698. /**
  51699. * The list of layers (background and foreground) of the scene
  51700. */
  51701. layers: Array<Layer>;
  51702. }
  51703. }
  51704. /**
  51705. * Defines the layer scene component responsible to manage any layers
  51706. * in a given scene.
  51707. */
  51708. export class LayerSceneComponent implements ISceneComponent {
  51709. /**
  51710. * The component name helpfull to identify the component in the list of scene components.
  51711. */
  51712. readonly name: string;
  51713. /**
  51714. * The scene the component belongs to.
  51715. */
  51716. scene: Scene;
  51717. private _engine;
  51718. /**
  51719. * Creates a new instance of the component for the given scene
  51720. * @param scene Defines the scene to register the component in
  51721. */
  51722. constructor(scene: Scene);
  51723. /**
  51724. * Registers the component in a given scene
  51725. */
  51726. register(): void;
  51727. /**
  51728. * Rebuilds the elements related to this component in case of
  51729. * context lost for instance.
  51730. */
  51731. rebuild(): void;
  51732. /**
  51733. * Disposes the component and the associated ressources.
  51734. */
  51735. dispose(): void;
  51736. private _draw;
  51737. private _drawCameraPredicate;
  51738. private _drawCameraBackground;
  51739. private _drawCameraForeground;
  51740. private _drawRenderTargetPredicate;
  51741. private _drawRenderTargetBackground;
  51742. private _drawRenderTargetForeground;
  51743. /**
  51744. * Adds all the elements from the container to the scene
  51745. * @param container the container holding the elements
  51746. */
  51747. addFromContainer(container: AbstractScene): void;
  51748. /**
  51749. * Removes all the elements in the container from the scene
  51750. * @param container contains the elements to remove
  51751. * @param dispose if the removed element should be disposed (default: false)
  51752. */
  51753. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  51754. }
  51755. }
  51756. declare module "babylonjs/Shaders/layer.fragment" {
  51757. /** @hidden */
  51758. export var layerPixelShader: {
  51759. name: string;
  51760. shader: string;
  51761. };
  51762. }
  51763. declare module "babylonjs/Shaders/layer.vertex" {
  51764. /** @hidden */
  51765. export var layerVertexShader: {
  51766. name: string;
  51767. shader: string;
  51768. };
  51769. }
  51770. declare module "babylonjs/Layers/layer" {
  51771. import { Observable } from "babylonjs/Misc/observable";
  51772. import { Nullable } from "babylonjs/types";
  51773. import { Scene } from "babylonjs/scene";
  51774. import { Vector2 } from "babylonjs/Maths/math.vector";
  51775. import { Color4 } from "babylonjs/Maths/math.color";
  51776. import { Texture } from "babylonjs/Materials/Textures/texture";
  51777. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  51778. import "babylonjs/Shaders/layer.fragment";
  51779. import "babylonjs/Shaders/layer.vertex";
  51780. /**
  51781. * This represents a full screen 2d layer.
  51782. * This can be useful to display a picture in the background of your scene for instance.
  51783. * @see https://www.babylonjs-playground.com/#08A2BS#1
  51784. */
  51785. export class Layer {
  51786. /**
  51787. * Define the name of the layer.
  51788. */
  51789. name: string;
  51790. /**
  51791. * Define the texture the layer should display.
  51792. */
  51793. texture: Nullable<Texture>;
  51794. /**
  51795. * Is the layer in background or foreground.
  51796. */
  51797. isBackground: boolean;
  51798. /**
  51799. * Define the color of the layer (instead of texture).
  51800. */
  51801. color: Color4;
  51802. /**
  51803. * Define the scale of the layer in order to zoom in out of the texture.
  51804. */
  51805. scale: Vector2;
  51806. /**
  51807. * Define an offset for the layer in order to shift the texture.
  51808. */
  51809. offset: Vector2;
  51810. /**
  51811. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  51812. */
  51813. alphaBlendingMode: number;
  51814. /**
  51815. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  51816. * Alpha test will not mix with the background color in case of transparency.
  51817. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  51818. */
  51819. alphaTest: boolean;
  51820. /**
  51821. * Define a mask to restrict the layer to only some of the scene cameras.
  51822. */
  51823. layerMask: number;
  51824. /**
  51825. * Define the list of render target the layer is visible into.
  51826. */
  51827. renderTargetTextures: RenderTargetTexture[];
  51828. /**
  51829. * Define if the layer is only used in renderTarget or if it also
  51830. * renders in the main frame buffer of the canvas.
  51831. */
  51832. renderOnlyInRenderTargetTextures: boolean;
  51833. private _scene;
  51834. private _vertexBuffers;
  51835. private _indexBuffer;
  51836. private _effect;
  51837. private _alphaTestEffect;
  51838. /**
  51839. * An event triggered when the layer is disposed.
  51840. */
  51841. onDisposeObservable: Observable<Layer>;
  51842. private _onDisposeObserver;
  51843. /**
  51844. * Back compatibility with callback before the onDisposeObservable existed.
  51845. * The set callback will be triggered when the layer has been disposed.
  51846. */
  51847. onDispose: () => void;
  51848. /**
  51849. * An event triggered before rendering the scene
  51850. */
  51851. onBeforeRenderObservable: Observable<Layer>;
  51852. private _onBeforeRenderObserver;
  51853. /**
  51854. * Back compatibility with callback before the onBeforeRenderObservable existed.
  51855. * The set callback will be triggered just before rendering the layer.
  51856. */
  51857. onBeforeRender: () => void;
  51858. /**
  51859. * An event triggered after rendering the scene
  51860. */
  51861. onAfterRenderObservable: Observable<Layer>;
  51862. private _onAfterRenderObserver;
  51863. /**
  51864. * Back compatibility with callback before the onAfterRenderObservable existed.
  51865. * The set callback will be triggered just after rendering the layer.
  51866. */
  51867. onAfterRender: () => void;
  51868. /**
  51869. * Instantiates a new layer.
  51870. * This represents a full screen 2d layer.
  51871. * This can be useful to display a picture in the background of your scene for instance.
  51872. * @see https://www.babylonjs-playground.com/#08A2BS#1
  51873. * @param name Define the name of the layer in the scene
  51874. * @param imgUrl Define the url of the texture to display in the layer
  51875. * @param scene Define the scene the layer belongs to
  51876. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  51877. * @param color Defines a color for the layer
  51878. */
  51879. constructor(
  51880. /**
  51881. * Define the name of the layer.
  51882. */
  51883. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  51884. private _createIndexBuffer;
  51885. /** @hidden */
  51886. _rebuild(): void;
  51887. /**
  51888. * Renders the layer in the scene.
  51889. */
  51890. render(): void;
  51891. /**
  51892. * Disposes and releases the associated ressources.
  51893. */
  51894. dispose(): void;
  51895. }
  51896. }
  51897. declare module "babylonjs/Layers/index" {
  51898. export * from "babylonjs/Layers/effectLayer";
  51899. export * from "babylonjs/Layers/effectLayerSceneComponent";
  51900. export * from "babylonjs/Layers/glowLayer";
  51901. export * from "babylonjs/Layers/highlightLayer";
  51902. export * from "babylonjs/Layers/layer";
  51903. export * from "babylonjs/Layers/layerSceneComponent";
  51904. }
  51905. declare module "babylonjs/Shaders/lensFlare.fragment" {
  51906. /** @hidden */
  51907. export var lensFlarePixelShader: {
  51908. name: string;
  51909. shader: string;
  51910. };
  51911. }
  51912. declare module "babylonjs/Shaders/lensFlare.vertex" {
  51913. /** @hidden */
  51914. export var lensFlareVertexShader: {
  51915. name: string;
  51916. shader: string;
  51917. };
  51918. }
  51919. declare module "babylonjs/LensFlares/lensFlareSystem" {
  51920. import { Scene } from "babylonjs/scene";
  51921. import { Vector3 } from "babylonjs/Maths/math.vector";
  51922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51923. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  51924. import "babylonjs/Shaders/lensFlare.fragment";
  51925. import "babylonjs/Shaders/lensFlare.vertex";
  51926. import { Viewport } from "babylonjs/Maths/math.viewport";
  51927. /**
  51928. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  51929. * It is usually composed of several `lensFlare`.
  51930. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51931. */
  51932. export class LensFlareSystem {
  51933. /**
  51934. * Define the name of the lens flare system
  51935. */
  51936. name: string;
  51937. /**
  51938. * List of lens flares used in this system.
  51939. */
  51940. lensFlares: LensFlare[];
  51941. /**
  51942. * Define a limit from the border the lens flare can be visible.
  51943. */
  51944. borderLimit: number;
  51945. /**
  51946. * Define a viewport border we do not want to see the lens flare in.
  51947. */
  51948. viewportBorder: number;
  51949. /**
  51950. * Define a predicate which could limit the list of meshes able to occlude the effect.
  51951. */
  51952. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51953. /**
  51954. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  51955. */
  51956. layerMask: number;
  51957. /**
  51958. * Define the id of the lens flare system in the scene.
  51959. * (equal to name by default)
  51960. */
  51961. id: string;
  51962. private _scene;
  51963. private _emitter;
  51964. private _vertexBuffers;
  51965. private _indexBuffer;
  51966. private _effect;
  51967. private _positionX;
  51968. private _positionY;
  51969. private _isEnabled;
  51970. /** @hidden */
  51971. static _SceneComponentInitialization: (scene: Scene) => void;
  51972. /**
  51973. * Instantiates a lens flare system.
  51974. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  51975. * It is usually composed of several `lensFlare`.
  51976. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51977. * @param name Define the name of the lens flare system in the scene
  51978. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  51979. * @param scene Define the scene the lens flare system belongs to
  51980. */
  51981. constructor(
  51982. /**
  51983. * Define the name of the lens flare system
  51984. */
  51985. name: string, emitter: any, scene: Scene);
  51986. /**
  51987. * Define if the lens flare system is enabled.
  51988. */
  51989. isEnabled: boolean;
  51990. /**
  51991. * Get the scene the effects belongs to.
  51992. * @returns the scene holding the lens flare system
  51993. */
  51994. getScene(): Scene;
  51995. /**
  51996. * Get the emitter of the lens flare system.
  51997. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  51998. * @returns the emitter of the lens flare system
  51999. */
  52000. getEmitter(): any;
  52001. /**
  52002. * Set the emitter of the lens flare system.
  52003. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  52004. * @param newEmitter Define the new emitter of the system
  52005. */
  52006. setEmitter(newEmitter: any): void;
  52007. /**
  52008. * Get the lens flare system emitter position.
  52009. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  52010. * @returns the position
  52011. */
  52012. getEmitterPosition(): Vector3;
  52013. /**
  52014. * @hidden
  52015. */
  52016. computeEffectivePosition(globalViewport: Viewport): boolean;
  52017. /** @hidden */
  52018. _isVisible(): boolean;
  52019. /**
  52020. * @hidden
  52021. */
  52022. render(): boolean;
  52023. /**
  52024. * Dispose and release the lens flare with its associated resources.
  52025. */
  52026. dispose(): void;
  52027. /**
  52028. * Parse a lens flare system from a JSON repressentation
  52029. * @param parsedLensFlareSystem Define the JSON to parse
  52030. * @param scene Define the scene the parsed system should be instantiated in
  52031. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  52032. * @returns the parsed system
  52033. */
  52034. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  52035. /**
  52036. * Serialize the current Lens Flare System into a JSON representation.
  52037. * @returns the serialized JSON
  52038. */
  52039. serialize(): any;
  52040. }
  52041. }
  52042. declare module "babylonjs/LensFlares/lensFlare" {
  52043. import { Nullable } from "babylonjs/types";
  52044. import { Color3 } from "babylonjs/Maths/math.color";
  52045. import { Texture } from "babylonjs/Materials/Textures/texture";
  52046. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  52047. /**
  52048. * This represents one of the lens effect in a `lensFlareSystem`.
  52049. * It controls one of the indiviual texture used in the effect.
  52050. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52051. */
  52052. export class LensFlare {
  52053. /**
  52054. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  52055. */
  52056. size: number;
  52057. /**
  52058. * 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.
  52059. */
  52060. position: number;
  52061. /**
  52062. * Define the lens color.
  52063. */
  52064. color: Color3;
  52065. /**
  52066. * Define the lens texture.
  52067. */
  52068. texture: Nullable<Texture>;
  52069. /**
  52070. * Define the alpha mode to render this particular lens.
  52071. */
  52072. alphaMode: number;
  52073. private _system;
  52074. /**
  52075. * Creates a new Lens Flare.
  52076. * This represents one of the lens effect in a `lensFlareSystem`.
  52077. * It controls one of the indiviual texture used in the effect.
  52078. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52079. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  52080. * @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.
  52081. * @param color Define the lens color
  52082. * @param imgUrl Define the lens texture url
  52083. * @param system Define the `lensFlareSystem` this flare is part of
  52084. * @returns The newly created Lens Flare
  52085. */
  52086. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  52087. /**
  52088. * Instantiates a new Lens Flare.
  52089. * This represents one of the lens effect in a `lensFlareSystem`.
  52090. * It controls one of the indiviual texture used in the effect.
  52091. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52092. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  52093. * @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.
  52094. * @param color Define the lens color
  52095. * @param imgUrl Define the lens texture url
  52096. * @param system Define the `lensFlareSystem` this flare is part of
  52097. */
  52098. constructor(
  52099. /**
  52100. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  52101. */
  52102. size: number,
  52103. /**
  52104. * 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.
  52105. */
  52106. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  52107. /**
  52108. * Dispose and release the lens flare with its associated resources.
  52109. */
  52110. dispose(): void;
  52111. }
  52112. }
  52113. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  52114. import { Nullable } from "babylonjs/types";
  52115. import { Scene } from "babylonjs/scene";
  52116. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52117. import { AbstractScene } from "babylonjs/abstractScene";
  52118. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  52119. module "babylonjs/abstractScene" {
  52120. interface AbstractScene {
  52121. /**
  52122. * The list of lens flare system added to the scene
  52123. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52124. */
  52125. lensFlareSystems: Array<LensFlareSystem>;
  52126. /**
  52127. * Removes the given lens flare system from this scene.
  52128. * @param toRemove The lens flare system to remove
  52129. * @returns The index of the removed lens flare system
  52130. */
  52131. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  52132. /**
  52133. * Adds the given lens flare system to this scene
  52134. * @param newLensFlareSystem The lens flare system to add
  52135. */
  52136. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  52137. /**
  52138. * Gets a lens flare system using its name
  52139. * @param name defines the name to look for
  52140. * @returns the lens flare system or null if not found
  52141. */
  52142. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  52143. /**
  52144. * Gets a lens flare system using its id
  52145. * @param id defines the id to look for
  52146. * @returns the lens flare system or null if not found
  52147. */
  52148. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  52149. }
  52150. }
  52151. /**
  52152. * Defines the lens flare scene component responsible to manage any lens flares
  52153. * in a given scene.
  52154. */
  52155. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  52156. /**
  52157. * The component name helpfull to identify the component in the list of scene components.
  52158. */
  52159. readonly name: string;
  52160. /**
  52161. * The scene the component belongs to.
  52162. */
  52163. scene: Scene;
  52164. /**
  52165. * Creates a new instance of the component for the given scene
  52166. * @param scene Defines the scene to register the component in
  52167. */
  52168. constructor(scene: Scene);
  52169. /**
  52170. * Registers the component in a given scene
  52171. */
  52172. register(): void;
  52173. /**
  52174. * Rebuilds the elements related to this component in case of
  52175. * context lost for instance.
  52176. */
  52177. rebuild(): void;
  52178. /**
  52179. * Adds all the elements from the container to the scene
  52180. * @param container the container holding the elements
  52181. */
  52182. addFromContainer(container: AbstractScene): void;
  52183. /**
  52184. * Removes all the elements in the container from the scene
  52185. * @param container contains the elements to remove
  52186. * @param dispose if the removed element should be disposed (default: false)
  52187. */
  52188. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52189. /**
  52190. * Serializes the component data to the specified json object
  52191. * @param serializationObject The object to serialize to
  52192. */
  52193. serialize(serializationObject: any): void;
  52194. /**
  52195. * Disposes the component and the associated ressources.
  52196. */
  52197. dispose(): void;
  52198. private _draw;
  52199. }
  52200. }
  52201. declare module "babylonjs/LensFlares/index" {
  52202. export * from "babylonjs/LensFlares/lensFlare";
  52203. export * from "babylonjs/LensFlares/lensFlareSystem";
  52204. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  52205. }
  52206. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  52207. import { Scene } from "babylonjs/scene";
  52208. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52209. import { AbstractScene } from "babylonjs/abstractScene";
  52210. /**
  52211. * Defines the shadow generator component responsible to manage any shadow generators
  52212. * in a given scene.
  52213. */
  52214. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  52215. /**
  52216. * The component name helpfull to identify the component in the list of scene components.
  52217. */
  52218. readonly name: string;
  52219. /**
  52220. * The scene the component belongs to.
  52221. */
  52222. scene: Scene;
  52223. /**
  52224. * Creates a new instance of the component for the given scene
  52225. * @param scene Defines the scene to register the component in
  52226. */
  52227. constructor(scene: Scene);
  52228. /**
  52229. * Registers the component in a given scene
  52230. */
  52231. register(): void;
  52232. /**
  52233. * Rebuilds the elements related to this component in case of
  52234. * context lost for instance.
  52235. */
  52236. rebuild(): void;
  52237. /**
  52238. * Serializes the component data to the specified json object
  52239. * @param serializationObject The object to serialize to
  52240. */
  52241. serialize(serializationObject: any): void;
  52242. /**
  52243. * Adds all the elements from the container to the scene
  52244. * @param container the container holding the elements
  52245. */
  52246. addFromContainer(container: AbstractScene): void;
  52247. /**
  52248. * Removes all the elements in the container from the scene
  52249. * @param container contains the elements to remove
  52250. * @param dispose if the removed element should be disposed (default: false)
  52251. */
  52252. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52253. /**
  52254. * Rebuilds the elements related to this component in case of
  52255. * context lost for instance.
  52256. */
  52257. dispose(): void;
  52258. private _gatherRenderTargets;
  52259. }
  52260. }
  52261. declare module "babylonjs/Lights/Shadows/index" {
  52262. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  52263. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  52264. }
  52265. declare module "babylonjs/Lights/pointLight" {
  52266. import { Scene } from "babylonjs/scene";
  52267. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  52268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52269. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  52270. import { Effect } from "babylonjs/Materials/effect";
  52271. /**
  52272. * A point light is a light defined by an unique point in world space.
  52273. * The light is emitted in every direction from this point.
  52274. * A good example of a point light is a standard light bulb.
  52275. * Documentation: https://doc.babylonjs.com/babylon101/lights
  52276. */
  52277. export class PointLight extends ShadowLight {
  52278. private _shadowAngle;
  52279. /**
  52280. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  52281. * This specifies what angle the shadow will use to be created.
  52282. *
  52283. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  52284. */
  52285. /**
  52286. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  52287. * This specifies what angle the shadow will use to be created.
  52288. *
  52289. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  52290. */
  52291. shadowAngle: number;
  52292. /**
  52293. * Gets the direction if it has been set.
  52294. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  52295. */
  52296. /**
  52297. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  52298. */
  52299. direction: Vector3;
  52300. /**
  52301. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  52302. * A PointLight emits the light in every direction.
  52303. * It can cast shadows.
  52304. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  52305. * ```javascript
  52306. * var pointLight = new PointLight("pl", camera.position, scene);
  52307. * ```
  52308. * Documentation : https://doc.babylonjs.com/babylon101/lights
  52309. * @param name The light friendly name
  52310. * @param position The position of the point light in the scene
  52311. * @param scene The scene the lights belongs to
  52312. */
  52313. constructor(name: string, position: Vector3, scene: Scene);
  52314. /**
  52315. * Returns the string "PointLight"
  52316. * @returns the class name
  52317. */
  52318. getClassName(): string;
  52319. /**
  52320. * Returns the integer 0.
  52321. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  52322. */
  52323. getTypeID(): number;
  52324. /**
  52325. * Specifies wether or not the shadowmap should be a cube texture.
  52326. * @returns true if the shadowmap needs to be a cube texture.
  52327. */
  52328. needCube(): boolean;
  52329. /**
  52330. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  52331. * @param faceIndex The index of the face we are computed the direction to generate shadow
  52332. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  52333. */
  52334. getShadowDirection(faceIndex?: number): Vector3;
  52335. /**
  52336. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  52337. * - fov = PI / 2
  52338. * - aspect ratio : 1.0
  52339. * - z-near and far equal to the active camera minZ and maxZ.
  52340. * Returns the PointLight.
  52341. */
  52342. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  52343. protected _buildUniformLayout(): void;
  52344. /**
  52345. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  52346. * @param effect The effect to update
  52347. * @param lightIndex The index of the light in the effect to update
  52348. * @returns The point light
  52349. */
  52350. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  52351. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  52352. /**
  52353. * Prepares the list of defines specific to the light type.
  52354. * @param defines the list of defines
  52355. * @param lightIndex defines the index of the light for the effect
  52356. */
  52357. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  52358. }
  52359. }
  52360. declare module "babylonjs/Lights/index" {
  52361. export * from "babylonjs/Lights/light";
  52362. export * from "babylonjs/Lights/shadowLight";
  52363. export * from "babylonjs/Lights/Shadows/index";
  52364. export * from "babylonjs/Lights/directionalLight";
  52365. export * from "babylonjs/Lights/hemisphericLight";
  52366. export * from "babylonjs/Lights/pointLight";
  52367. export * from "babylonjs/Lights/spotLight";
  52368. }
  52369. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  52370. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  52371. /**
  52372. * Header information of HDR texture files.
  52373. */
  52374. export interface HDRInfo {
  52375. /**
  52376. * The height of the texture in pixels.
  52377. */
  52378. height: number;
  52379. /**
  52380. * The width of the texture in pixels.
  52381. */
  52382. width: number;
  52383. /**
  52384. * The index of the beginning of the data in the binary file.
  52385. */
  52386. dataPosition: number;
  52387. }
  52388. /**
  52389. * This groups tools to convert HDR texture to native colors array.
  52390. */
  52391. export class HDRTools {
  52392. private static Ldexp;
  52393. private static Rgbe2float;
  52394. private static readStringLine;
  52395. /**
  52396. * Reads header information from an RGBE texture stored in a native array.
  52397. * More information on this format are available here:
  52398. * https://en.wikipedia.org/wiki/RGBE_image_format
  52399. *
  52400. * @param uint8array The binary file stored in native array.
  52401. * @return The header information.
  52402. */
  52403. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  52404. /**
  52405. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  52406. * This RGBE texture needs to store the information as a panorama.
  52407. *
  52408. * More information on this format are available here:
  52409. * https://en.wikipedia.org/wiki/RGBE_image_format
  52410. *
  52411. * @param buffer The binary file stored in an array buffer.
  52412. * @param size The expected size of the extracted cubemap.
  52413. * @return The Cube Map information.
  52414. */
  52415. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  52416. /**
  52417. * Returns the pixels data extracted from an RGBE texture.
  52418. * This pixels will be stored left to right up to down in the R G B order in one array.
  52419. *
  52420. * More information on this format are available here:
  52421. * https://en.wikipedia.org/wiki/RGBE_image_format
  52422. *
  52423. * @param uint8array The binary file stored in an array buffer.
  52424. * @param hdrInfo The header information of the file.
  52425. * @return The pixels data in RGB right to left up to down order.
  52426. */
  52427. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  52428. private static RGBE_ReadPixels_RLE;
  52429. }
  52430. }
  52431. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  52432. import { Nullable } from "babylonjs/types";
  52433. import { Scene } from "babylonjs/scene";
  52434. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  52435. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52436. import "babylonjs/Engines/Extensions/engine.rawTexture";
  52437. /**
  52438. * This represents a texture coming from an HDR input.
  52439. *
  52440. * The only supported format is currently panorama picture stored in RGBE format.
  52441. * Example of such files can be found on HDRLib: http://hdrlib.com/
  52442. */
  52443. export class HDRCubeTexture extends BaseTexture {
  52444. private static _facesMapping;
  52445. private _generateHarmonics;
  52446. private _noMipmap;
  52447. private _textureMatrix;
  52448. private _size;
  52449. private _onLoad;
  52450. private _onError;
  52451. /**
  52452. * The texture URL.
  52453. */
  52454. url: string;
  52455. /**
  52456. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  52457. */
  52458. coordinatesMode: number;
  52459. protected _isBlocking: boolean;
  52460. /**
  52461. * Sets wether or not the texture is blocking during loading.
  52462. */
  52463. /**
  52464. * Gets wether or not the texture is blocking during loading.
  52465. */
  52466. isBlocking: boolean;
  52467. protected _rotationY: number;
  52468. /**
  52469. * Sets texture matrix rotation angle around Y axis in radians.
  52470. */
  52471. /**
  52472. * Gets texture matrix rotation angle around Y axis radians.
  52473. */
  52474. rotationY: number;
  52475. /**
  52476. * Gets or sets the center of the bounding box associated with the cube texture
  52477. * It must define where the camera used to render the texture was set
  52478. */
  52479. boundingBoxPosition: Vector3;
  52480. private _boundingBoxSize;
  52481. /**
  52482. * Gets or sets the size of the bounding box associated with the cube texture
  52483. * When defined, the cubemap will switch to local mode
  52484. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  52485. * @example https://www.babylonjs-playground.com/#RNASML
  52486. */
  52487. boundingBoxSize: Vector3;
  52488. /**
  52489. * Instantiates an HDRTexture from the following parameters.
  52490. *
  52491. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  52492. * @param scene The scene the texture will be used in
  52493. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  52494. * @param noMipmap Forces to not generate the mipmap if true
  52495. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  52496. * @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)
  52497. * @param reserved Reserved flag for internal use.
  52498. */
  52499. 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>);
  52500. /**
  52501. * Get the current class name of the texture useful for serialization or dynamic coding.
  52502. * @returns "HDRCubeTexture"
  52503. */
  52504. getClassName(): string;
  52505. /**
  52506. * Occurs when the file is raw .hdr file.
  52507. */
  52508. private loadTexture;
  52509. clone(): HDRCubeTexture;
  52510. delayLoad(): void;
  52511. /**
  52512. * Get the texture reflection matrix used to rotate/transform the reflection.
  52513. * @returns the reflection matrix
  52514. */
  52515. getReflectionTextureMatrix(): Matrix;
  52516. /**
  52517. * Set the texture reflection matrix used to rotate/transform the reflection.
  52518. * @param value Define the reflection matrix to set
  52519. */
  52520. setReflectionTextureMatrix(value: Matrix): void;
  52521. /**
  52522. * Parses a JSON representation of an HDR Texture in order to create the texture
  52523. * @param parsedTexture Define the JSON representation
  52524. * @param scene Define the scene the texture should be created in
  52525. * @param rootUrl Define the root url in case we need to load relative dependencies
  52526. * @returns the newly created texture after parsing
  52527. */
  52528. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  52529. serialize(): any;
  52530. }
  52531. }
  52532. declare module "babylonjs/Physics/physicsEngine" {
  52533. import { Nullable } from "babylonjs/types";
  52534. import { Vector3 } from "babylonjs/Maths/math.vector";
  52535. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52536. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  52537. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  52538. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52539. /**
  52540. * Class used to control physics engine
  52541. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  52542. */
  52543. export class PhysicsEngine implements IPhysicsEngine {
  52544. private _physicsPlugin;
  52545. /**
  52546. * Global value used to control the smallest number supported by the simulation
  52547. */
  52548. static Epsilon: number;
  52549. private _impostors;
  52550. private _joints;
  52551. /**
  52552. * Gets the gravity vector used by the simulation
  52553. */
  52554. gravity: Vector3;
  52555. /**
  52556. * Factory used to create the default physics plugin.
  52557. * @returns The default physics plugin
  52558. */
  52559. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  52560. /**
  52561. * Creates a new Physics Engine
  52562. * @param gravity defines the gravity vector used by the simulation
  52563. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  52564. */
  52565. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  52566. /**
  52567. * Sets the gravity vector used by the simulation
  52568. * @param gravity defines the gravity vector to use
  52569. */
  52570. setGravity(gravity: Vector3): void;
  52571. /**
  52572. * Set the time step of the physics engine.
  52573. * Default is 1/60.
  52574. * To slow it down, enter 1/600 for example.
  52575. * To speed it up, 1/30
  52576. * @param newTimeStep defines the new timestep to apply to this world.
  52577. */
  52578. setTimeStep(newTimeStep?: number): void;
  52579. /**
  52580. * Get the time step of the physics engine.
  52581. * @returns the current time step
  52582. */
  52583. getTimeStep(): number;
  52584. /**
  52585. * Release all resources
  52586. */
  52587. dispose(): void;
  52588. /**
  52589. * Gets the name of the current physics plugin
  52590. * @returns the name of the plugin
  52591. */
  52592. getPhysicsPluginName(): string;
  52593. /**
  52594. * Adding a new impostor for the impostor tracking.
  52595. * This will be done by the impostor itself.
  52596. * @param impostor the impostor to add
  52597. */
  52598. addImpostor(impostor: PhysicsImpostor): void;
  52599. /**
  52600. * Remove an impostor from the engine.
  52601. * This impostor and its mesh will not longer be updated by the physics engine.
  52602. * @param impostor the impostor to remove
  52603. */
  52604. removeImpostor(impostor: PhysicsImpostor): void;
  52605. /**
  52606. * Add a joint to the physics engine
  52607. * @param mainImpostor defines the main impostor to which the joint is added.
  52608. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  52609. * @param joint defines the joint that will connect both impostors.
  52610. */
  52611. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  52612. /**
  52613. * Removes a joint from the simulation
  52614. * @param mainImpostor defines the impostor used with the joint
  52615. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  52616. * @param joint defines the joint to remove
  52617. */
  52618. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  52619. /**
  52620. * Called by the scene. No need to call it.
  52621. * @param delta defines the timespam between frames
  52622. */
  52623. _step(delta: number): void;
  52624. /**
  52625. * Gets the current plugin used to run the simulation
  52626. * @returns current plugin
  52627. */
  52628. getPhysicsPlugin(): IPhysicsEnginePlugin;
  52629. /**
  52630. * Gets the list of physic impostors
  52631. * @returns an array of PhysicsImpostor
  52632. */
  52633. getImpostors(): Array<PhysicsImpostor>;
  52634. /**
  52635. * Gets the impostor for a physics enabled object
  52636. * @param object defines the object impersonated by the impostor
  52637. * @returns the PhysicsImpostor or null if not found
  52638. */
  52639. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  52640. /**
  52641. * Gets the impostor for a physics body object
  52642. * @param body defines physics body used by the impostor
  52643. * @returns the PhysicsImpostor or null if not found
  52644. */
  52645. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  52646. /**
  52647. * Does a raycast in the physics world
  52648. * @param from when should the ray start?
  52649. * @param to when should the ray end?
  52650. * @returns PhysicsRaycastResult
  52651. */
  52652. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52653. }
  52654. }
  52655. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  52656. import { Nullable } from "babylonjs/types";
  52657. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  52658. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52659. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52660. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52661. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52662. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52663. /** @hidden */
  52664. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  52665. private _useDeltaForWorldStep;
  52666. world: any;
  52667. name: string;
  52668. private _physicsMaterials;
  52669. private _fixedTimeStep;
  52670. private _cannonRaycastResult;
  52671. private _raycastResult;
  52672. private _physicsBodysToRemoveAfterStep;
  52673. BJSCANNON: any;
  52674. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  52675. setGravity(gravity: Vector3): void;
  52676. setTimeStep(timeStep: number): void;
  52677. getTimeStep(): number;
  52678. executeStep(delta: number): void;
  52679. private _removeMarkedPhysicsBodiesFromWorld;
  52680. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52681. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52682. generatePhysicsBody(impostor: PhysicsImpostor): void;
  52683. private _processChildMeshes;
  52684. removePhysicsBody(impostor: PhysicsImpostor): void;
  52685. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  52686. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  52687. private _addMaterial;
  52688. private _checkWithEpsilon;
  52689. private _createShape;
  52690. private _createHeightmap;
  52691. private _minus90X;
  52692. private _plus90X;
  52693. private _tmpPosition;
  52694. private _tmpDeltaPosition;
  52695. private _tmpUnityRotation;
  52696. private _updatePhysicsBodyTransformation;
  52697. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  52698. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  52699. isSupported(): boolean;
  52700. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52701. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52702. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52703. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52704. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  52705. getBodyMass(impostor: PhysicsImpostor): number;
  52706. getBodyFriction(impostor: PhysicsImpostor): number;
  52707. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  52708. getBodyRestitution(impostor: PhysicsImpostor): number;
  52709. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  52710. sleepBody(impostor: PhysicsImpostor): void;
  52711. wakeUpBody(impostor: PhysicsImpostor): void;
  52712. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  52713. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  52714. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  52715. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  52716. getRadius(impostor: PhysicsImpostor): number;
  52717. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  52718. dispose(): void;
  52719. private _extendNamespace;
  52720. /**
  52721. * Does a raycast in the physics world
  52722. * @param from when should the ray start?
  52723. * @param to when should the ray end?
  52724. * @returns PhysicsRaycastResult
  52725. */
  52726. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52727. }
  52728. }
  52729. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  52730. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52731. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52732. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52734. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  52735. import { Nullable } from "babylonjs/types";
  52736. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52737. /** @hidden */
  52738. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  52739. world: any;
  52740. name: string;
  52741. BJSOIMO: any;
  52742. private _raycastResult;
  52743. constructor(iterations?: number, oimoInjection?: any);
  52744. setGravity(gravity: Vector3): void;
  52745. setTimeStep(timeStep: number): void;
  52746. getTimeStep(): number;
  52747. private _tmpImpostorsArray;
  52748. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  52749. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52750. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52751. generatePhysicsBody(impostor: PhysicsImpostor): void;
  52752. private _tmpPositionVector;
  52753. removePhysicsBody(impostor: PhysicsImpostor): void;
  52754. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  52755. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  52756. isSupported(): boolean;
  52757. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  52758. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  52759. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52760. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52761. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52762. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52763. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  52764. getBodyMass(impostor: PhysicsImpostor): number;
  52765. getBodyFriction(impostor: PhysicsImpostor): number;
  52766. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  52767. getBodyRestitution(impostor: PhysicsImpostor): number;
  52768. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  52769. sleepBody(impostor: PhysicsImpostor): void;
  52770. wakeUpBody(impostor: PhysicsImpostor): void;
  52771. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  52772. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  52773. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  52774. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  52775. getRadius(impostor: PhysicsImpostor): number;
  52776. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  52777. dispose(): void;
  52778. /**
  52779. * Does a raycast in the physics world
  52780. * @param from when should the ray start?
  52781. * @param to when should the ray end?
  52782. * @returns PhysicsRaycastResult
  52783. */
  52784. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52785. }
  52786. }
  52787. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  52788. import { Nullable } from "babylonjs/types";
  52789. import { Scene } from "babylonjs/scene";
  52790. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  52791. import { Color4 } from "babylonjs/Maths/math.color";
  52792. import { Mesh } from "babylonjs/Meshes/mesh";
  52793. /**
  52794. * Class containing static functions to help procedurally build meshes
  52795. */
  52796. export class RibbonBuilder {
  52797. /**
  52798. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  52799. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  52800. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  52801. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  52802. * * 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
  52803. * * 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
  52804. * * 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
  52805. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52806. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52807. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  52808. * * 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
  52809. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  52810. * * 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
  52811. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  52812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52813. * @param name defines the name of the mesh
  52814. * @param options defines the options used to create the mesh
  52815. * @param scene defines the hosting scene
  52816. * @returns the ribbon mesh
  52817. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  52818. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52819. */
  52820. static CreateRibbon(name: string, options: {
  52821. pathArray: Vector3[][];
  52822. closeArray?: boolean;
  52823. closePath?: boolean;
  52824. offset?: number;
  52825. updatable?: boolean;
  52826. sideOrientation?: number;
  52827. frontUVs?: Vector4;
  52828. backUVs?: Vector4;
  52829. instance?: Mesh;
  52830. invertUV?: boolean;
  52831. uvs?: Vector2[];
  52832. colors?: Color4[];
  52833. }, scene?: Nullable<Scene>): Mesh;
  52834. }
  52835. }
  52836. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  52837. import { Nullable } from "babylonjs/types";
  52838. import { Scene } from "babylonjs/scene";
  52839. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  52840. import { Mesh } from "babylonjs/Meshes/mesh";
  52841. /**
  52842. * Class containing static functions to help procedurally build meshes
  52843. */
  52844. export class ShapeBuilder {
  52845. /**
  52846. * 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.
  52847. * * 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.
  52848. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  52849. * * 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.
  52850. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  52851. * * 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
  52852. * * 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
  52853. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  52854. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52855. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52856. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  52857. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  52858. * @param name defines the name of the mesh
  52859. * @param options defines the options used to create the mesh
  52860. * @param scene defines the hosting scene
  52861. * @returns the extruded shape mesh
  52862. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52863. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  52864. */
  52865. static ExtrudeShape(name: string, options: {
  52866. shape: Vector3[];
  52867. path: Vector3[];
  52868. scale?: number;
  52869. rotation?: number;
  52870. cap?: number;
  52871. updatable?: boolean;
  52872. sideOrientation?: number;
  52873. frontUVs?: Vector4;
  52874. backUVs?: Vector4;
  52875. instance?: Mesh;
  52876. invertUV?: boolean;
  52877. }, scene?: Nullable<Scene>): Mesh;
  52878. /**
  52879. * Creates an custom extruded shape mesh.
  52880. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  52881. * * 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.
  52882. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  52883. * * 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
  52884. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  52885. * * 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
  52886. * * It must returns a float value that will be the scale value applied to the shape on each path point
  52887. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  52888. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  52889. * * 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
  52890. * * 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
  52891. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  52892. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52893. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52894. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  52895. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52896. * @param name defines the name of the mesh
  52897. * @param options defines the options used to create the mesh
  52898. * @param scene defines the hosting scene
  52899. * @returns the custom extruded shape mesh
  52900. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  52901. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52902. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  52903. */
  52904. static ExtrudeShapeCustom(name: string, options: {
  52905. shape: Vector3[];
  52906. path: Vector3[];
  52907. scaleFunction?: any;
  52908. rotationFunction?: any;
  52909. ribbonCloseArray?: boolean;
  52910. ribbonClosePath?: boolean;
  52911. cap?: number;
  52912. updatable?: boolean;
  52913. sideOrientation?: number;
  52914. frontUVs?: Vector4;
  52915. backUVs?: Vector4;
  52916. instance?: Mesh;
  52917. invertUV?: boolean;
  52918. }, scene?: Nullable<Scene>): Mesh;
  52919. private static _ExtrudeShapeGeneric;
  52920. }
  52921. }
  52922. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  52923. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  52924. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52925. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52926. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52927. import { Nullable } from "babylonjs/types";
  52928. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52929. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52930. /**
  52931. * AmmoJS Physics plugin
  52932. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  52933. * @see https://github.com/kripken/ammo.js/
  52934. */
  52935. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  52936. private _useDeltaForWorldStep;
  52937. /**
  52938. * Reference to the Ammo library
  52939. */
  52940. bjsAMMO: any;
  52941. /**
  52942. * Created ammoJS world which physics bodies are added to
  52943. */
  52944. world: any;
  52945. /**
  52946. * Name of the plugin
  52947. */
  52948. name: string;
  52949. private _timeStep;
  52950. private _fixedTimeStep;
  52951. private _maxSteps;
  52952. private _tmpQuaternion;
  52953. private _tmpAmmoTransform;
  52954. private _tmpAmmoQuaternion;
  52955. private _tmpAmmoConcreteContactResultCallback;
  52956. private _collisionConfiguration;
  52957. private _dispatcher;
  52958. private _overlappingPairCache;
  52959. private _solver;
  52960. private _softBodySolver;
  52961. private _tmpAmmoVectorA;
  52962. private _tmpAmmoVectorB;
  52963. private _tmpAmmoVectorC;
  52964. private _tmpAmmoVectorD;
  52965. private _tmpContactCallbackResult;
  52966. private _tmpAmmoVectorRCA;
  52967. private _tmpAmmoVectorRCB;
  52968. private _raycastResult;
  52969. private static readonly DISABLE_COLLISION_FLAG;
  52970. private static readonly KINEMATIC_FLAG;
  52971. private static readonly DISABLE_DEACTIVATION_FLAG;
  52972. /**
  52973. * Initializes the ammoJS plugin
  52974. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  52975. * @param ammoInjection can be used to inject your own ammo reference
  52976. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  52977. */
  52978. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  52979. /**
  52980. * Sets the gravity of the physics world (m/(s^2))
  52981. * @param gravity Gravity to set
  52982. */
  52983. setGravity(gravity: Vector3): void;
  52984. /**
  52985. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  52986. * @param timeStep timestep to use in seconds
  52987. */
  52988. setTimeStep(timeStep: number): void;
  52989. /**
  52990. * 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)
  52991. * @param fixedTimeStep fixedTimeStep to use in seconds
  52992. */
  52993. setFixedTimeStep(fixedTimeStep: number): void;
  52994. /**
  52995. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  52996. * @param maxSteps the maximum number of steps by the physics engine per frame
  52997. */
  52998. setMaxSteps(maxSteps: number): void;
  52999. /**
  53000. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  53001. * @returns the current timestep in seconds
  53002. */
  53003. getTimeStep(): number;
  53004. private _isImpostorInContact;
  53005. private _isImpostorPairInContact;
  53006. private _stepSimulation;
  53007. /**
  53008. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  53009. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  53010. * After the step the babylon meshes are set to the position of the physics imposters
  53011. * @param delta amount of time to step forward
  53012. * @param impostors array of imposters to update before/after the step
  53013. */
  53014. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  53015. /**
  53016. * Update babylon mesh to match physics world object
  53017. * @param impostor imposter to match
  53018. */
  53019. private _afterSoftStep;
  53020. /**
  53021. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  53022. * @param impostor imposter to match
  53023. */
  53024. private _ropeStep;
  53025. /**
  53026. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  53027. * @param impostor imposter to match
  53028. */
  53029. private _softbodyOrClothStep;
  53030. private _tmpVector;
  53031. private _tmpMatrix;
  53032. /**
  53033. * Applies an impulse on the imposter
  53034. * @param impostor imposter to apply impulse to
  53035. * @param force amount of force to be applied to the imposter
  53036. * @param contactPoint the location to apply the impulse on the imposter
  53037. */
  53038. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53039. /**
  53040. * Applies a force on the imposter
  53041. * @param impostor imposter to apply force
  53042. * @param force amount of force to be applied to the imposter
  53043. * @param contactPoint the location to apply the force on the imposter
  53044. */
  53045. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53046. /**
  53047. * Creates a physics body using the plugin
  53048. * @param impostor the imposter to create the physics body on
  53049. */
  53050. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53051. /**
  53052. * Removes the physics body from the imposter and disposes of the body's memory
  53053. * @param impostor imposter to remove the physics body from
  53054. */
  53055. removePhysicsBody(impostor: PhysicsImpostor): void;
  53056. /**
  53057. * Generates a joint
  53058. * @param impostorJoint the imposter joint to create the joint with
  53059. */
  53060. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53061. /**
  53062. * Removes a joint
  53063. * @param impostorJoint the imposter joint to remove the joint from
  53064. */
  53065. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53066. private _addMeshVerts;
  53067. /**
  53068. * Initialise the soft body vertices to match its object's (mesh) vertices
  53069. * Softbody vertices (nodes) are in world space and to match this
  53070. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  53071. * @param impostor to create the softbody for
  53072. */
  53073. private _softVertexData;
  53074. /**
  53075. * Create an impostor's soft body
  53076. * @param impostor to create the softbody for
  53077. */
  53078. private _createSoftbody;
  53079. /**
  53080. * Create cloth for an impostor
  53081. * @param impostor to create the softbody for
  53082. */
  53083. private _createCloth;
  53084. /**
  53085. * Create rope for an impostor
  53086. * @param impostor to create the softbody for
  53087. */
  53088. private _createRope;
  53089. private _addHullVerts;
  53090. private _createShape;
  53091. /**
  53092. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  53093. * @param impostor imposter containing the physics body and babylon object
  53094. */
  53095. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53096. /**
  53097. * Sets the babylon object's position/rotation from the physics body's position/rotation
  53098. * @param impostor imposter containing the physics body and babylon object
  53099. * @param newPosition new position
  53100. * @param newRotation new rotation
  53101. */
  53102. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53103. /**
  53104. * If this plugin is supported
  53105. * @returns true if its supported
  53106. */
  53107. isSupported(): boolean;
  53108. /**
  53109. * Sets the linear velocity of the physics body
  53110. * @param impostor imposter to set the velocity on
  53111. * @param velocity velocity to set
  53112. */
  53113. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53114. /**
  53115. * Sets the angular velocity of the physics body
  53116. * @param impostor imposter to set the velocity on
  53117. * @param velocity velocity to set
  53118. */
  53119. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53120. /**
  53121. * gets the linear velocity
  53122. * @param impostor imposter to get linear velocity from
  53123. * @returns linear velocity
  53124. */
  53125. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53126. /**
  53127. * gets the angular velocity
  53128. * @param impostor imposter to get angular velocity from
  53129. * @returns angular velocity
  53130. */
  53131. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53132. /**
  53133. * Sets the mass of physics body
  53134. * @param impostor imposter to set the mass on
  53135. * @param mass mass to set
  53136. */
  53137. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53138. /**
  53139. * Gets the mass of the physics body
  53140. * @param impostor imposter to get the mass from
  53141. * @returns mass
  53142. */
  53143. getBodyMass(impostor: PhysicsImpostor): number;
  53144. /**
  53145. * Gets friction of the impostor
  53146. * @param impostor impostor to get friction from
  53147. * @returns friction value
  53148. */
  53149. getBodyFriction(impostor: PhysicsImpostor): number;
  53150. /**
  53151. * Sets friction of the impostor
  53152. * @param impostor impostor to set friction on
  53153. * @param friction friction value
  53154. */
  53155. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53156. /**
  53157. * Gets restitution of the impostor
  53158. * @param impostor impostor to get restitution from
  53159. * @returns restitution value
  53160. */
  53161. getBodyRestitution(impostor: PhysicsImpostor): number;
  53162. /**
  53163. * Sets resitution of the impostor
  53164. * @param impostor impostor to set resitution on
  53165. * @param restitution resitution value
  53166. */
  53167. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53168. /**
  53169. * Gets pressure inside the impostor
  53170. * @param impostor impostor to get pressure from
  53171. * @returns pressure value
  53172. */
  53173. getBodyPressure(impostor: PhysicsImpostor): number;
  53174. /**
  53175. * Sets pressure inside a soft body impostor
  53176. * Cloth and rope must remain 0 pressure
  53177. * @param impostor impostor to set pressure on
  53178. * @param pressure pressure value
  53179. */
  53180. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  53181. /**
  53182. * Gets stiffness of the impostor
  53183. * @param impostor impostor to get stiffness from
  53184. * @returns pressure value
  53185. */
  53186. getBodyStiffness(impostor: PhysicsImpostor): number;
  53187. /**
  53188. * Sets stiffness of the impostor
  53189. * @param impostor impostor to set stiffness on
  53190. * @param stiffness stiffness value from 0 to 1
  53191. */
  53192. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  53193. /**
  53194. * Gets velocityIterations of the impostor
  53195. * @param impostor impostor to get velocity iterations from
  53196. * @returns velocityIterations value
  53197. */
  53198. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  53199. /**
  53200. * Sets velocityIterations of the impostor
  53201. * @param impostor impostor to set velocity iterations on
  53202. * @param velocityIterations velocityIterations value
  53203. */
  53204. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  53205. /**
  53206. * Gets positionIterations of the impostor
  53207. * @param impostor impostor to get position iterations from
  53208. * @returns positionIterations value
  53209. */
  53210. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  53211. /**
  53212. * Sets positionIterations of the impostor
  53213. * @param impostor impostor to set position on
  53214. * @param positionIterations positionIterations value
  53215. */
  53216. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  53217. /**
  53218. * Append an anchor to a cloth object
  53219. * @param impostor is the cloth impostor to add anchor to
  53220. * @param otherImpostor is the rigid impostor to anchor to
  53221. * @param width ratio across width from 0 to 1
  53222. * @param height ratio up height from 0 to 1
  53223. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  53224. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  53225. */
  53226. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  53227. /**
  53228. * Append an hook to a rope object
  53229. * @param impostor is the rope impostor to add hook to
  53230. * @param otherImpostor is the rigid impostor to hook to
  53231. * @param length ratio along the rope from 0 to 1
  53232. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  53233. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  53234. */
  53235. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  53236. /**
  53237. * Sleeps the physics body and stops it from being active
  53238. * @param impostor impostor to sleep
  53239. */
  53240. sleepBody(impostor: PhysicsImpostor): void;
  53241. /**
  53242. * Activates the physics body
  53243. * @param impostor impostor to activate
  53244. */
  53245. wakeUpBody(impostor: PhysicsImpostor): void;
  53246. /**
  53247. * Updates the distance parameters of the joint
  53248. * @param joint joint to update
  53249. * @param maxDistance maximum distance of the joint
  53250. * @param minDistance minimum distance of the joint
  53251. */
  53252. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  53253. /**
  53254. * Sets a motor on the joint
  53255. * @param joint joint to set motor on
  53256. * @param speed speed of the motor
  53257. * @param maxForce maximum force of the motor
  53258. * @param motorIndex index of the motor
  53259. */
  53260. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  53261. /**
  53262. * Sets the motors limit
  53263. * @param joint joint to set limit on
  53264. * @param upperLimit upper limit
  53265. * @param lowerLimit lower limit
  53266. */
  53267. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  53268. /**
  53269. * Syncs the position and rotation of a mesh with the impostor
  53270. * @param mesh mesh to sync
  53271. * @param impostor impostor to update the mesh with
  53272. */
  53273. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53274. /**
  53275. * Gets the radius of the impostor
  53276. * @param impostor impostor to get radius from
  53277. * @returns the radius
  53278. */
  53279. getRadius(impostor: PhysicsImpostor): number;
  53280. /**
  53281. * Gets the box size of the impostor
  53282. * @param impostor impostor to get box size from
  53283. * @param result the resulting box size
  53284. */
  53285. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53286. /**
  53287. * Disposes of the impostor
  53288. */
  53289. dispose(): void;
  53290. /**
  53291. * Does a raycast in the physics world
  53292. * @param from when should the ray start?
  53293. * @param to when should the ray end?
  53294. * @returns PhysicsRaycastResult
  53295. */
  53296. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53297. }
  53298. }
  53299. declare module "babylonjs/Probes/reflectionProbe" {
  53300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53301. import { Vector3 } from "babylonjs/Maths/math.vector";
  53302. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53303. import { Nullable } from "babylonjs/types";
  53304. import { Scene } from "babylonjs/scene";
  53305. module "babylonjs/abstractScene" {
  53306. interface AbstractScene {
  53307. /**
  53308. * The list of reflection probes added to the scene
  53309. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  53310. */
  53311. reflectionProbes: Array<ReflectionProbe>;
  53312. /**
  53313. * Removes the given reflection probe from this scene.
  53314. * @param toRemove The reflection probe to remove
  53315. * @returns The index of the removed reflection probe
  53316. */
  53317. removeReflectionProbe(toRemove: ReflectionProbe): number;
  53318. /**
  53319. * Adds the given reflection probe to this scene.
  53320. * @param newReflectionProbe The reflection probe to add
  53321. */
  53322. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  53323. }
  53324. }
  53325. /**
  53326. * Class used to generate realtime reflection / refraction cube textures
  53327. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  53328. */
  53329. export class ReflectionProbe {
  53330. /** defines the name of the probe */
  53331. name: string;
  53332. private _scene;
  53333. private _renderTargetTexture;
  53334. private _projectionMatrix;
  53335. private _viewMatrix;
  53336. private _target;
  53337. private _add;
  53338. private _attachedMesh;
  53339. private _invertYAxis;
  53340. /** Gets or sets probe position (center of the cube map) */
  53341. position: Vector3;
  53342. /**
  53343. * Creates a new reflection probe
  53344. * @param name defines the name of the probe
  53345. * @param size defines the texture resolution (for each face)
  53346. * @param scene defines the hosting scene
  53347. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  53348. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  53349. */
  53350. constructor(
  53351. /** defines the name of the probe */
  53352. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  53353. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  53354. samples: number;
  53355. /** Gets or sets the refresh rate to use (on every frame by default) */
  53356. refreshRate: number;
  53357. /**
  53358. * Gets the hosting scene
  53359. * @returns a Scene
  53360. */
  53361. getScene(): Scene;
  53362. /** Gets the internal CubeTexture used to render to */
  53363. readonly cubeTexture: RenderTargetTexture;
  53364. /** Gets the list of meshes to render */
  53365. readonly renderList: Nullable<AbstractMesh[]>;
  53366. /**
  53367. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  53368. * @param mesh defines the mesh to attach to
  53369. */
  53370. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  53371. /**
  53372. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  53373. * @param renderingGroupId The rendering group id corresponding to its index
  53374. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  53375. */
  53376. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  53377. /**
  53378. * Clean all associated resources
  53379. */
  53380. dispose(): void;
  53381. /**
  53382. * Converts the reflection probe information to a readable string for debug purpose.
  53383. * @param fullDetails Supports for multiple levels of logging within scene loading
  53384. * @returns the human readable reflection probe info
  53385. */
  53386. toString(fullDetails?: boolean): string;
  53387. /**
  53388. * Get the class name of the relfection probe.
  53389. * @returns "ReflectionProbe"
  53390. */
  53391. getClassName(): string;
  53392. /**
  53393. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  53394. * @returns The JSON representation of the texture
  53395. */
  53396. serialize(): any;
  53397. /**
  53398. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  53399. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  53400. * @param scene Define the scene the parsed reflection probe should be instantiated in
  53401. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  53402. * @returns The parsed reflection probe if successful
  53403. */
  53404. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  53405. }
  53406. }
  53407. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  53408. /** @hidden */
  53409. export var _BabylonLoaderRegistered: boolean;
  53410. }
  53411. declare module "babylonjs/Loading/Plugins/index" {
  53412. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  53413. }
  53414. declare module "babylonjs/Loading/index" {
  53415. export * from "babylonjs/Loading/loadingScreen";
  53416. export * from "babylonjs/Loading/Plugins/index";
  53417. export * from "babylonjs/Loading/sceneLoader";
  53418. export * from "babylonjs/Loading/sceneLoaderFlags";
  53419. }
  53420. declare module "babylonjs/Materials/Background/index" {
  53421. export * from "babylonjs/Materials/Background/backgroundMaterial";
  53422. }
  53423. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  53424. import { Scene } from "babylonjs/scene";
  53425. import { Color3 } from "babylonjs/Maths/math.color";
  53426. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  53427. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53428. /**
  53429. * The Physically based simple base material of BJS.
  53430. *
  53431. * This enables better naming and convention enforcements on top of the pbrMaterial.
  53432. * It is used as the base class for both the specGloss and metalRough conventions.
  53433. */
  53434. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  53435. /**
  53436. * Number of Simultaneous lights allowed on the material.
  53437. */
  53438. maxSimultaneousLights: number;
  53439. /**
  53440. * If sets to true, disables all the lights affecting the material.
  53441. */
  53442. disableLighting: boolean;
  53443. /**
  53444. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  53445. */
  53446. environmentTexture: BaseTexture;
  53447. /**
  53448. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  53449. */
  53450. invertNormalMapX: boolean;
  53451. /**
  53452. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  53453. */
  53454. invertNormalMapY: boolean;
  53455. /**
  53456. * Normal map used in the model.
  53457. */
  53458. normalTexture: BaseTexture;
  53459. /**
  53460. * Emissivie color used to self-illuminate the model.
  53461. */
  53462. emissiveColor: Color3;
  53463. /**
  53464. * Emissivie texture used to self-illuminate the model.
  53465. */
  53466. emissiveTexture: BaseTexture;
  53467. /**
  53468. * Occlusion Channel Strenght.
  53469. */
  53470. occlusionStrength: number;
  53471. /**
  53472. * Occlusion Texture of the material (adding extra occlusion effects).
  53473. */
  53474. occlusionTexture: BaseTexture;
  53475. /**
  53476. * Defines the alpha limits in alpha test mode.
  53477. */
  53478. alphaCutOff: number;
  53479. /**
  53480. * Gets the current double sided mode.
  53481. */
  53482. /**
  53483. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  53484. */
  53485. doubleSided: boolean;
  53486. /**
  53487. * Stores the pre-calculated light information of a mesh in a texture.
  53488. */
  53489. lightmapTexture: BaseTexture;
  53490. /**
  53491. * If true, the light map contains occlusion information instead of lighting info.
  53492. */
  53493. useLightmapAsShadowmap: boolean;
  53494. /**
  53495. * Instantiates a new PBRMaterial instance.
  53496. *
  53497. * @param name The material name
  53498. * @param scene The scene the material will be use in.
  53499. */
  53500. constructor(name: string, scene: Scene);
  53501. getClassName(): string;
  53502. }
  53503. }
  53504. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  53505. import { Scene } from "babylonjs/scene";
  53506. import { Color3 } from "babylonjs/Maths/math.color";
  53507. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53508. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  53509. /**
  53510. * The PBR material of BJS following the metal roughness convention.
  53511. *
  53512. * This fits to the PBR convention in the GLTF definition:
  53513. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  53514. */
  53515. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  53516. /**
  53517. * The base color has two different interpretations depending on the value of metalness.
  53518. * When the material is a metal, the base color is the specific measured reflectance value
  53519. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  53520. * of the material.
  53521. */
  53522. baseColor: Color3;
  53523. /**
  53524. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  53525. * well as opacity information in the alpha channel.
  53526. */
  53527. baseTexture: BaseTexture;
  53528. /**
  53529. * Specifies the metallic scalar value of the material.
  53530. * Can also be used to scale the metalness values of the metallic texture.
  53531. */
  53532. metallic: number;
  53533. /**
  53534. * Specifies the roughness scalar value of the material.
  53535. * Can also be used to scale the roughness values of the metallic texture.
  53536. */
  53537. roughness: number;
  53538. /**
  53539. * Texture containing both the metallic value in the B channel and the
  53540. * roughness value in the G channel to keep better precision.
  53541. */
  53542. metallicRoughnessTexture: BaseTexture;
  53543. /**
  53544. * Instantiates a new PBRMetalRoughnessMaterial instance.
  53545. *
  53546. * @param name The material name
  53547. * @param scene The scene the material will be use in.
  53548. */
  53549. constructor(name: string, scene: Scene);
  53550. /**
  53551. * Return the currrent class name of the material.
  53552. */
  53553. getClassName(): string;
  53554. /**
  53555. * Makes a duplicate of the current material.
  53556. * @param name - name to use for the new material.
  53557. */
  53558. clone(name: string): PBRMetallicRoughnessMaterial;
  53559. /**
  53560. * Serialize the material to a parsable JSON object.
  53561. */
  53562. serialize(): any;
  53563. /**
  53564. * Parses a JSON object correponding to the serialize function.
  53565. */
  53566. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  53567. }
  53568. }
  53569. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  53570. import { Scene } from "babylonjs/scene";
  53571. import { Color3 } from "babylonjs/Maths/math.color";
  53572. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53573. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  53574. /**
  53575. * The PBR material of BJS following the specular glossiness convention.
  53576. *
  53577. * This fits to the PBR convention in the GLTF definition:
  53578. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  53579. */
  53580. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  53581. /**
  53582. * Specifies the diffuse color of the material.
  53583. */
  53584. diffuseColor: Color3;
  53585. /**
  53586. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  53587. * channel.
  53588. */
  53589. diffuseTexture: BaseTexture;
  53590. /**
  53591. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  53592. */
  53593. specularColor: Color3;
  53594. /**
  53595. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  53596. */
  53597. glossiness: number;
  53598. /**
  53599. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  53600. */
  53601. specularGlossinessTexture: BaseTexture;
  53602. /**
  53603. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  53604. *
  53605. * @param name The material name
  53606. * @param scene The scene the material will be use in.
  53607. */
  53608. constructor(name: string, scene: Scene);
  53609. /**
  53610. * Return the currrent class name of the material.
  53611. */
  53612. getClassName(): string;
  53613. /**
  53614. * Makes a duplicate of the current material.
  53615. * @param name - name to use for the new material.
  53616. */
  53617. clone(name: string): PBRSpecularGlossinessMaterial;
  53618. /**
  53619. * Serialize the material to a parsable JSON object.
  53620. */
  53621. serialize(): any;
  53622. /**
  53623. * Parses a JSON object correponding to the serialize function.
  53624. */
  53625. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  53626. }
  53627. }
  53628. declare module "babylonjs/Materials/PBR/index" {
  53629. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  53630. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  53631. export * from "babylonjs/Materials/PBR/pbrMaterial";
  53632. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  53633. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  53634. }
  53635. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  53636. import { Nullable } from "babylonjs/types";
  53637. import { Scene } from "babylonjs/scene";
  53638. import { Matrix } from "babylonjs/Maths/math.vector";
  53639. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53640. /**
  53641. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  53642. * It can help converting any input color in a desired output one. This can then be used to create effects
  53643. * from sepia, black and white to sixties or futuristic rendering...
  53644. *
  53645. * The only supported format is currently 3dl.
  53646. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  53647. */
  53648. export class ColorGradingTexture extends BaseTexture {
  53649. /**
  53650. * The current texture matrix. (will always be identity in color grading texture)
  53651. */
  53652. private _textureMatrix;
  53653. /**
  53654. * The texture URL.
  53655. */
  53656. url: string;
  53657. /**
  53658. * Empty line regex stored for GC.
  53659. */
  53660. private static _noneEmptyLineRegex;
  53661. private _engine;
  53662. /**
  53663. * Instantiates a ColorGradingTexture from the following parameters.
  53664. *
  53665. * @param url The location of the color gradind data (currently only supporting 3dl)
  53666. * @param scene The scene the texture will be used in
  53667. */
  53668. constructor(url: string, scene: Scene);
  53669. /**
  53670. * Returns the texture matrix used in most of the material.
  53671. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  53672. */
  53673. getTextureMatrix(): Matrix;
  53674. /**
  53675. * Occurs when the file being loaded is a .3dl LUT file.
  53676. */
  53677. private load3dlTexture;
  53678. /**
  53679. * Starts the loading process of the texture.
  53680. */
  53681. private loadTexture;
  53682. /**
  53683. * Clones the color gradind texture.
  53684. */
  53685. clone(): ColorGradingTexture;
  53686. /**
  53687. * Called during delayed load for textures.
  53688. */
  53689. delayLoad(): void;
  53690. /**
  53691. * Parses a color grading texture serialized by Babylon.
  53692. * @param parsedTexture The texture information being parsedTexture
  53693. * @param scene The scene to load the texture in
  53694. * @param rootUrl The root url of the data assets to load
  53695. * @return A color gradind texture
  53696. */
  53697. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  53698. /**
  53699. * Serializes the LUT texture to json format.
  53700. */
  53701. serialize(): any;
  53702. }
  53703. }
  53704. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  53705. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53706. import { Scene } from "babylonjs/scene";
  53707. import { Nullable } from "babylonjs/types";
  53708. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53709. /**
  53710. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  53711. */
  53712. export class EquiRectangularCubeTexture extends BaseTexture {
  53713. /** The six faces of the cube. */
  53714. private static _FacesMapping;
  53715. private _noMipmap;
  53716. private _onLoad;
  53717. private _onError;
  53718. /** The size of the cubemap. */
  53719. private _size;
  53720. /** The buffer of the image. */
  53721. private _buffer;
  53722. /** The width of the input image. */
  53723. private _width;
  53724. /** The height of the input image. */
  53725. private _height;
  53726. /** The URL to the image. */
  53727. url: string;
  53728. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  53729. coordinatesMode: number;
  53730. /**
  53731. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  53732. * @param url The location of the image
  53733. * @param scene The scene the texture will be used in
  53734. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53735. * @param noMipmap Forces to not generate the mipmap if true
  53736. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  53737. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  53738. * @param onLoad — defines a callback called when texture is loaded
  53739. * @param onError — defines a callback called if there is an error
  53740. */
  53741. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  53742. /**
  53743. * Load the image data, by putting the image on a canvas and extracting its buffer.
  53744. */
  53745. private loadImage;
  53746. /**
  53747. * Convert the image buffer into a cubemap and create a CubeTexture.
  53748. */
  53749. private loadTexture;
  53750. /**
  53751. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  53752. * @param buffer The ArrayBuffer that should be converted.
  53753. * @returns The buffer as Float32Array.
  53754. */
  53755. private getFloat32ArrayFromArrayBuffer;
  53756. /**
  53757. * Get the current class name of the texture useful for serialization or dynamic coding.
  53758. * @returns "EquiRectangularCubeTexture"
  53759. */
  53760. getClassName(): string;
  53761. /**
  53762. * Create a clone of the current EquiRectangularCubeTexture and return it.
  53763. * @returns A clone of the current EquiRectangularCubeTexture.
  53764. */
  53765. clone(): EquiRectangularCubeTexture;
  53766. }
  53767. }
  53768. declare module "babylonjs/Misc/tga" {
  53769. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53770. /**
  53771. * Based on jsTGALoader - Javascript loader for TGA file
  53772. * By Vincent Thibault
  53773. * @see http://blog.robrowser.com/javascript-tga-loader.html
  53774. */
  53775. export class TGATools {
  53776. private static _TYPE_INDEXED;
  53777. private static _TYPE_RGB;
  53778. private static _TYPE_GREY;
  53779. private static _TYPE_RLE_INDEXED;
  53780. private static _TYPE_RLE_RGB;
  53781. private static _TYPE_RLE_GREY;
  53782. private static _ORIGIN_MASK;
  53783. private static _ORIGIN_SHIFT;
  53784. private static _ORIGIN_BL;
  53785. private static _ORIGIN_BR;
  53786. private static _ORIGIN_UL;
  53787. private static _ORIGIN_UR;
  53788. /**
  53789. * Gets the header of a TGA file
  53790. * @param data defines the TGA data
  53791. * @returns the header
  53792. */
  53793. static GetTGAHeader(data: Uint8Array): any;
  53794. /**
  53795. * Uploads TGA content to a Babylon Texture
  53796. * @hidden
  53797. */
  53798. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  53799. /** @hidden */
  53800. 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;
  53801. /** @hidden */
  53802. 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;
  53803. /** @hidden */
  53804. 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;
  53805. /** @hidden */
  53806. 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;
  53807. /** @hidden */
  53808. 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;
  53809. /** @hidden */
  53810. 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;
  53811. }
  53812. }
  53813. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  53814. import { Nullable } from "babylonjs/types";
  53815. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53816. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  53817. /**
  53818. * Implementation of the TGA Texture Loader.
  53819. * @hidden
  53820. */
  53821. export class _TGATextureLoader implements IInternalTextureLoader {
  53822. /**
  53823. * Defines wether the loader supports cascade loading the different faces.
  53824. */
  53825. readonly supportCascades: boolean;
  53826. /**
  53827. * This returns if the loader support the current file information.
  53828. * @param extension defines the file extension of the file being loaded
  53829. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53830. * @param fallback defines the fallback internal texture if any
  53831. * @param isBase64 defines whether the texture is encoded as a base64
  53832. * @param isBuffer defines whether the texture data are stored as a buffer
  53833. * @returns true if the loader can load the specified file
  53834. */
  53835. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  53836. /**
  53837. * Transform the url before loading if required.
  53838. * @param rootUrl the url of the texture
  53839. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53840. * @returns the transformed texture
  53841. */
  53842. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  53843. /**
  53844. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  53845. * @param rootUrl the url of the texture
  53846. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53847. * @returns the fallback texture
  53848. */
  53849. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  53850. /**
  53851. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  53852. * @param data contains the texture data
  53853. * @param texture defines the BabylonJS internal texture
  53854. * @param createPolynomials will be true if polynomials have been requested
  53855. * @param onLoad defines the callback to trigger once the texture is ready
  53856. * @param onError defines the callback to trigger in case of error
  53857. */
  53858. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  53859. /**
  53860. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  53861. * @param data contains the texture data
  53862. * @param texture defines the BabylonJS internal texture
  53863. * @param callback defines the method to call once ready to upload
  53864. */
  53865. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  53866. }
  53867. }
  53868. declare module "babylonjs/Misc/basis" {
  53869. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53870. /**
  53871. * Info about the .basis files
  53872. */
  53873. class BasisFileInfo {
  53874. /**
  53875. * If the file has alpha
  53876. */
  53877. hasAlpha: boolean;
  53878. /**
  53879. * Info about each image of the basis file
  53880. */
  53881. images: Array<{
  53882. levels: Array<{
  53883. width: number;
  53884. height: number;
  53885. transcodedPixels: ArrayBufferView;
  53886. }>;
  53887. }>;
  53888. }
  53889. /**
  53890. * Result of transcoding a basis file
  53891. */
  53892. class TranscodeResult {
  53893. /**
  53894. * Info about the .basis file
  53895. */
  53896. fileInfo: BasisFileInfo;
  53897. /**
  53898. * Format to use when loading the file
  53899. */
  53900. format: number;
  53901. }
  53902. /**
  53903. * Configuration options for the Basis transcoder
  53904. */
  53905. export class BasisTranscodeConfiguration {
  53906. /**
  53907. * Supported compression formats used to determine the supported output format of the transcoder
  53908. */
  53909. supportedCompressionFormats?: {
  53910. /**
  53911. * etc1 compression format
  53912. */
  53913. etc1?: boolean;
  53914. /**
  53915. * s3tc compression format
  53916. */
  53917. s3tc?: boolean;
  53918. /**
  53919. * pvrtc compression format
  53920. */
  53921. pvrtc?: boolean;
  53922. /**
  53923. * etc2 compression format
  53924. */
  53925. etc2?: boolean;
  53926. };
  53927. /**
  53928. * If mipmap levels should be loaded for transcoded images (Default: true)
  53929. */
  53930. loadMipmapLevels?: boolean;
  53931. /**
  53932. * Index of a single image to load (Default: all images)
  53933. */
  53934. loadSingleImage?: number;
  53935. }
  53936. /**
  53937. * Used to load .Basis files
  53938. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  53939. */
  53940. export class BasisTools {
  53941. private static _IgnoreSupportedFormats;
  53942. /**
  53943. * URL to use when loading the basis transcoder
  53944. */
  53945. static JSModuleURL: string;
  53946. /**
  53947. * URL to use when loading the wasm module for the transcoder
  53948. */
  53949. static WasmModuleURL: string;
  53950. /**
  53951. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  53952. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  53953. * @returns internal format corresponding to the Basis format
  53954. */
  53955. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  53956. private static _WorkerPromise;
  53957. private static _Worker;
  53958. private static _actionId;
  53959. private static _CreateWorkerAsync;
  53960. /**
  53961. * Transcodes a loaded image file to compressed pixel data
  53962. * @param imageData image data to transcode
  53963. * @param config configuration options for the transcoding
  53964. * @returns a promise resulting in the transcoded image
  53965. */
  53966. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  53967. /**
  53968. * Loads a texture from the transcode result
  53969. * @param texture texture load to
  53970. * @param transcodeResult the result of transcoding the basis file to load from
  53971. */
  53972. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  53973. }
  53974. }
  53975. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  53976. import { Nullable } from "babylonjs/types";
  53977. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53978. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  53979. /**
  53980. * Loader for .basis file format
  53981. */
  53982. export class _BasisTextureLoader implements IInternalTextureLoader {
  53983. /**
  53984. * Defines whether the loader supports cascade loading the different faces.
  53985. */
  53986. readonly supportCascades: boolean;
  53987. /**
  53988. * This returns if the loader support the current file information.
  53989. * @param extension defines the file extension of the file being loaded
  53990. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53991. * @param fallback defines the fallback internal texture if any
  53992. * @param isBase64 defines whether the texture is encoded as a base64
  53993. * @param isBuffer defines whether the texture data are stored as a buffer
  53994. * @returns true if the loader can load the specified file
  53995. */
  53996. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  53997. /**
  53998. * Transform the url before loading if required.
  53999. * @param rootUrl the url of the texture
  54000. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54001. * @returns the transformed texture
  54002. */
  54003. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  54004. /**
  54005. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  54006. * @param rootUrl the url of the texture
  54007. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54008. * @returns the fallback texture
  54009. */
  54010. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  54011. /**
  54012. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  54013. * @param data contains the texture data
  54014. * @param texture defines the BabylonJS internal texture
  54015. * @param createPolynomials will be true if polynomials have been requested
  54016. * @param onLoad defines the callback to trigger once the texture is ready
  54017. * @param onError defines the callback to trigger in case of error
  54018. */
  54019. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  54020. /**
  54021. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  54022. * @param data contains the texture data
  54023. * @param texture defines the BabylonJS internal texture
  54024. * @param callback defines the method to call once ready to upload
  54025. */
  54026. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  54027. }
  54028. }
  54029. declare module "babylonjs/Materials/Textures/Loaders/index" {
  54030. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  54031. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  54032. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  54033. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  54034. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  54035. }
  54036. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  54037. import { Scene } from "babylonjs/scene";
  54038. import { Texture } from "babylonjs/Materials/Textures/texture";
  54039. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  54040. /**
  54041. * 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.
  54042. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  54043. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  54044. */
  54045. export class CustomProceduralTexture extends ProceduralTexture {
  54046. private _animate;
  54047. private _time;
  54048. private _config;
  54049. private _texturePath;
  54050. /**
  54051. * Instantiates a new Custom Procedural Texture.
  54052. * 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.
  54053. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  54054. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  54055. * @param name Define the name of the texture
  54056. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  54057. * @param size Define the size of the texture to create
  54058. * @param scene Define the scene the texture belongs to
  54059. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  54060. * @param generateMipMaps Define if the texture should creates mip maps or not
  54061. */
  54062. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  54063. private _loadJson;
  54064. /**
  54065. * Is the texture ready to be used ? (rendered at least once)
  54066. * @returns true if ready, otherwise, false.
  54067. */
  54068. isReady(): boolean;
  54069. /**
  54070. * Render the texture to its associated render target.
  54071. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  54072. */
  54073. render(useCameraPostProcess?: boolean): void;
  54074. /**
  54075. * Update the list of dependant textures samplers in the shader.
  54076. */
  54077. updateTextures(): void;
  54078. /**
  54079. * Update the uniform values of the procedural texture in the shader.
  54080. */
  54081. updateShaderUniforms(): void;
  54082. /**
  54083. * Define if the texture animates or not.
  54084. */
  54085. animate: boolean;
  54086. }
  54087. }
  54088. declare module "babylonjs/Shaders/noise.fragment" {
  54089. /** @hidden */
  54090. export var noisePixelShader: {
  54091. name: string;
  54092. shader: string;
  54093. };
  54094. }
  54095. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  54096. import { Nullable } from "babylonjs/types";
  54097. import { Scene } from "babylonjs/scene";
  54098. import { Texture } from "babylonjs/Materials/Textures/texture";
  54099. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  54100. import "babylonjs/Shaders/noise.fragment";
  54101. /**
  54102. * Class used to generate noise procedural textures
  54103. */
  54104. export class NoiseProceduralTexture extends ProceduralTexture {
  54105. private _time;
  54106. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  54107. brightness: number;
  54108. /** Defines the number of octaves to process */
  54109. octaves: number;
  54110. /** Defines the level of persistence (0.8 by default) */
  54111. persistence: number;
  54112. /** Gets or sets animation speed factor (default is 1) */
  54113. animationSpeedFactor: number;
  54114. /**
  54115. * Creates a new NoiseProceduralTexture
  54116. * @param name defines the name fo the texture
  54117. * @param size defines the size of the texture (default is 256)
  54118. * @param scene defines the hosting scene
  54119. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  54120. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  54121. */
  54122. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  54123. private _updateShaderUniforms;
  54124. protected _getDefines(): string;
  54125. /** Generate the current state of the procedural texture */
  54126. render(useCameraPostProcess?: boolean): void;
  54127. /**
  54128. * Serializes this noise procedural texture
  54129. * @returns a serialized noise procedural texture object
  54130. */
  54131. serialize(): any;
  54132. /**
  54133. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  54134. * @param parsedTexture defines parsed texture data
  54135. * @param scene defines the current scene
  54136. * @param rootUrl defines the root URL containing noise procedural texture information
  54137. * @returns a parsed NoiseProceduralTexture
  54138. */
  54139. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  54140. }
  54141. }
  54142. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  54143. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  54144. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  54145. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  54146. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  54147. }
  54148. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  54149. import { Nullable } from "babylonjs/types";
  54150. import { Scene } from "babylonjs/scene";
  54151. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54152. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54153. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  54154. import "babylonjs/Engines/Extensions/engine.rawTexture";
  54155. /**
  54156. * Raw cube texture where the raw buffers are passed in
  54157. */
  54158. export class RawCubeTexture extends CubeTexture {
  54159. /**
  54160. * Creates a cube texture where the raw buffers are passed in.
  54161. * @param scene defines the scene the texture is attached to
  54162. * @param data defines the array of data to use to create each face
  54163. * @param size defines the size of the textures
  54164. * @param format defines the format of the data
  54165. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  54166. * @param generateMipMaps defines if the engine should generate the mip levels
  54167. * @param invertY defines if data must be stored with Y axis inverted
  54168. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  54169. * @param compression defines the compression used (null by default)
  54170. */
  54171. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  54172. /**
  54173. * Updates the raw cube texture.
  54174. * @param data defines the data to store
  54175. * @param format defines the data format
  54176. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  54177. * @param invertY defines if data must be stored with Y axis inverted
  54178. * @param compression defines the compression used (null by default)
  54179. * @param level defines which level of the texture to update
  54180. */
  54181. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  54182. /**
  54183. * Updates a raw cube texture with RGBD encoded data.
  54184. * @param data defines the array of data [mipmap][face] to use to create each face
  54185. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  54186. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54187. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54188. * @returns a promsie that resolves when the operation is complete
  54189. */
  54190. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  54191. /**
  54192. * Clones the raw cube texture.
  54193. * @return a new cube texture
  54194. */
  54195. clone(): CubeTexture;
  54196. /** @hidden */
  54197. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54198. }
  54199. }
  54200. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  54201. import { Scene } from "babylonjs/scene";
  54202. import { Texture } from "babylonjs/Materials/Textures/texture";
  54203. import "babylonjs/Engines/Extensions/engine.rawTexture";
  54204. /**
  54205. * Class used to store 3D textures containing user data
  54206. */
  54207. export class RawTexture3D extends Texture {
  54208. /** Gets or sets the texture format to use */
  54209. format: number;
  54210. private _engine;
  54211. /**
  54212. * Create a new RawTexture3D
  54213. * @param data defines the data of the texture
  54214. * @param width defines the width of the texture
  54215. * @param height defines the height of the texture
  54216. * @param depth defines the depth of the texture
  54217. * @param format defines the texture format to use
  54218. * @param scene defines the hosting scene
  54219. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  54220. * @param invertY defines if texture must be stored with Y axis inverted
  54221. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  54222. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  54223. */
  54224. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  54225. /** Gets or sets the texture format to use */
  54226. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  54227. /**
  54228. * Update the texture with new data
  54229. * @param data defines the data to store in the texture
  54230. */
  54231. update(data: ArrayBufferView): void;
  54232. }
  54233. }
  54234. declare module "babylonjs/Materials/Textures/refractionTexture" {
  54235. import { Scene } from "babylonjs/scene";
  54236. import { Plane } from "babylonjs/Maths/math.plane";
  54237. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54238. /**
  54239. * Creates a refraction texture used by refraction channel of the standard material.
  54240. * It is like a mirror but to see through a material.
  54241. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  54242. */
  54243. export class RefractionTexture extends RenderTargetTexture {
  54244. /**
  54245. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  54246. * 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.
  54247. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  54248. */
  54249. refractionPlane: Plane;
  54250. /**
  54251. * Define how deep under the surface we should see.
  54252. */
  54253. depth: number;
  54254. /**
  54255. * Creates a refraction texture used by refraction channel of the standard material.
  54256. * It is like a mirror but to see through a material.
  54257. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  54258. * @param name Define the texture name
  54259. * @param size Define the size of the underlying texture
  54260. * @param scene Define the scene the refraction belongs to
  54261. * @param generateMipMaps Define if we need to generate mips level for the refraction
  54262. */
  54263. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  54264. /**
  54265. * Clone the refraction texture.
  54266. * @returns the cloned texture
  54267. */
  54268. clone(): RefractionTexture;
  54269. /**
  54270. * Serialize the texture to a JSON representation you could use in Parse later on
  54271. * @returns the serialized JSON representation
  54272. */
  54273. serialize(): any;
  54274. }
  54275. }
  54276. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  54277. import { Nullable } from "babylonjs/types";
  54278. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54279. import { Matrix } from "babylonjs/Maths/math.vector";
  54280. import { Engine } from "babylonjs/Engines/engine";
  54281. import { Scene } from "babylonjs/scene";
  54282. /**
  54283. * Defines the options related to the creation of an HtmlElementTexture
  54284. */
  54285. export interface IHtmlElementTextureOptions {
  54286. /**
  54287. * Defines wether mip maps should be created or not.
  54288. */
  54289. generateMipMaps?: boolean;
  54290. /**
  54291. * Defines the sampling mode of the texture.
  54292. */
  54293. samplingMode?: number;
  54294. /**
  54295. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  54296. */
  54297. engine: Nullable<Engine>;
  54298. /**
  54299. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  54300. */
  54301. scene: Nullable<Scene>;
  54302. }
  54303. /**
  54304. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  54305. * To be as efficient as possible depending on your constraints nothing aside the first upload
  54306. * is automatically managed.
  54307. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  54308. * in your application.
  54309. *
  54310. * As the update is not automatic, you need to call them manually.
  54311. */
  54312. export class HtmlElementTexture extends BaseTexture {
  54313. /**
  54314. * The texture URL.
  54315. */
  54316. element: HTMLVideoElement | HTMLCanvasElement;
  54317. private static readonly DefaultOptions;
  54318. private _textureMatrix;
  54319. private _engine;
  54320. private _isVideo;
  54321. private _generateMipMaps;
  54322. private _samplingMode;
  54323. /**
  54324. * Instantiates a HtmlElementTexture from the following parameters.
  54325. *
  54326. * @param name Defines the name of the texture
  54327. * @param element Defines the video or canvas the texture is filled with
  54328. * @param options Defines the other none mandatory texture creation options
  54329. */
  54330. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  54331. private _createInternalTexture;
  54332. /**
  54333. * Returns the texture matrix used in most of the material.
  54334. */
  54335. getTextureMatrix(): Matrix;
  54336. /**
  54337. * Updates the content of the texture.
  54338. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  54339. */
  54340. update(invertY?: Nullable<boolean>): void;
  54341. }
  54342. }
  54343. declare module "babylonjs/Materials/Textures/index" {
  54344. export * from "babylonjs/Materials/Textures/baseTexture";
  54345. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  54346. export * from "babylonjs/Materials/Textures/cubeTexture";
  54347. export * from "babylonjs/Materials/Textures/dynamicTexture";
  54348. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  54349. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  54350. export * from "babylonjs/Materials/Textures/internalTexture";
  54351. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  54352. export * from "babylonjs/Materials/Textures/Loaders/index";
  54353. export * from "babylonjs/Materials/Textures/mirrorTexture";
  54354. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  54355. export * from "babylonjs/Materials/Textures/Procedurals/index";
  54356. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  54357. export * from "babylonjs/Materials/Textures/rawTexture";
  54358. export * from "babylonjs/Materials/Textures/rawTexture3D";
  54359. export * from "babylonjs/Materials/Textures/refractionTexture";
  54360. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  54361. export * from "babylonjs/Materials/Textures/texture";
  54362. export * from "babylonjs/Materials/Textures/videoTexture";
  54363. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  54364. }
  54365. declare module "babylonjs/Materials/Node/nodeMaterialBlockTargets" {
  54366. /**
  54367. * Enum used to define the target of a block
  54368. */
  54369. export enum NodeMaterialBlockTargets {
  54370. /** Vertex shader */
  54371. Vertex = 1,
  54372. /** Fragment shader */
  54373. Fragment = 2,
  54374. /** Neutral */
  54375. Neutral = 4,
  54376. /** Vertex and Fragment */
  54377. VertexAndFragment = 3
  54378. }
  54379. }
  54380. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes" {
  54381. /**
  54382. * Defines the kind of connection point for node based material
  54383. */
  54384. export enum NodeMaterialBlockConnectionPointTypes {
  54385. /** Float */
  54386. Float = 1,
  54387. /** Int */
  54388. Int = 2,
  54389. /** Vector2 */
  54390. Vector2 = 4,
  54391. /** Vector3 */
  54392. Vector3 = 8,
  54393. /** Vector4 */
  54394. Vector4 = 16,
  54395. /** Color3 */
  54396. Color3 = 32,
  54397. /** Color4 */
  54398. Color4 = 64,
  54399. /** Matrix */
  54400. Matrix = 128,
  54401. /** Detect type based on connection */
  54402. AutoDetect = 1024,
  54403. /** Output type that will be defined by input type */
  54404. BasedOnInput = 2048
  54405. }
  54406. }
  54407. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  54408. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54409. /**
  54410. * Root class for all node material optimizers
  54411. */
  54412. export class NodeMaterialOptimizer {
  54413. /**
  54414. * Function used to optimize a NodeMaterial graph
  54415. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  54416. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  54417. */
  54418. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  54419. }
  54420. }
  54421. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  54422. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54423. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54424. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54425. import { Scene } from "babylonjs/scene";
  54426. /**
  54427. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  54428. */
  54429. export class TransformBlock extends NodeMaterialBlock {
  54430. /**
  54431. * Defines the value to use to complement W value to transform it to a Vector4
  54432. */
  54433. complementW: number;
  54434. /**
  54435. * Defines the value to use to complement z value to transform it to a Vector4
  54436. */
  54437. complementZ: number;
  54438. /**
  54439. * Creates a new TransformBlock
  54440. * @param name defines the block name
  54441. */
  54442. constructor(name: string);
  54443. /**
  54444. * Gets the current class name
  54445. * @returns the class name
  54446. */
  54447. getClassName(): string;
  54448. /**
  54449. * Gets the vector input
  54450. */
  54451. readonly vector: NodeMaterialConnectionPoint;
  54452. /**
  54453. * Gets the output component
  54454. */
  54455. readonly output: NodeMaterialConnectionPoint;
  54456. /**
  54457. * Gets the matrix transform input
  54458. */
  54459. readonly transform: NodeMaterialConnectionPoint;
  54460. protected _buildBlock(state: NodeMaterialBuildState): this;
  54461. serialize(): any;
  54462. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  54463. protected _dumpPropertiesCode(): string;
  54464. }
  54465. }
  54466. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  54467. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54468. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54469. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54470. /**
  54471. * Block used to output the vertex position
  54472. */
  54473. export class VertexOutputBlock extends NodeMaterialBlock {
  54474. /**
  54475. * Creates a new VertexOutputBlock
  54476. * @param name defines the block name
  54477. */
  54478. constructor(name: string);
  54479. /**
  54480. * Gets the current class name
  54481. * @returns the class name
  54482. */
  54483. getClassName(): string;
  54484. /**
  54485. * Gets the vector input component
  54486. */
  54487. readonly vector: NodeMaterialConnectionPoint;
  54488. protected _buildBlock(state: NodeMaterialBuildState): this;
  54489. }
  54490. }
  54491. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  54492. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54493. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54494. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54495. /**
  54496. * Block used to output the final color
  54497. */
  54498. export class FragmentOutputBlock extends NodeMaterialBlock {
  54499. /**
  54500. * Create a new FragmentOutputBlock
  54501. * @param name defines the block name
  54502. */
  54503. constructor(name: string);
  54504. /**
  54505. * Gets the current class name
  54506. * @returns the class name
  54507. */
  54508. getClassName(): string;
  54509. /**
  54510. * Gets the rgba input component
  54511. */
  54512. readonly rgba: NodeMaterialConnectionPoint;
  54513. /**
  54514. * Gets the rgb input component
  54515. */
  54516. readonly rgb: NodeMaterialConnectionPoint;
  54517. /**
  54518. * Gets the a input component
  54519. */
  54520. readonly a: NodeMaterialConnectionPoint;
  54521. protected _buildBlock(state: NodeMaterialBuildState): this;
  54522. }
  54523. }
  54524. declare module "babylonjs/Materials/Node/nodeMaterialSystemValues" {
  54525. /**
  54526. * Enum used to define system values e.g. values automatically provided by the system
  54527. */
  54528. export enum NodeMaterialSystemValues {
  54529. /** World */
  54530. World = 1,
  54531. /** View */
  54532. View = 2,
  54533. /** Projection */
  54534. Projection = 3,
  54535. /** ViewProjection */
  54536. ViewProjection = 4,
  54537. /** WorldView */
  54538. WorldView = 5,
  54539. /** WorldViewProjection */
  54540. WorldViewProjection = 6,
  54541. /** CameraPosition */
  54542. CameraPosition = 7,
  54543. /** Fog Color */
  54544. FogColor = 8
  54545. }
  54546. }
  54547. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  54548. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54549. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54550. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54551. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54552. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54553. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  54554. import { Effect } from "babylonjs/Materials/effect";
  54555. import { Mesh } from "babylonjs/Meshes/mesh";
  54556. import { Nullable } from "babylonjs/types";
  54557. import { Scene } from "babylonjs/scene";
  54558. /**
  54559. * Block used to read a reflection texture from a sampler
  54560. */
  54561. export class ReflectionTextureBlock extends NodeMaterialBlock {
  54562. private _define3DName;
  54563. private _defineCubicName;
  54564. private _defineExplicitName;
  54565. private _defineProjectionName;
  54566. private _defineLocalCubicName;
  54567. private _defineSphericalName;
  54568. private _definePlanarName;
  54569. private _defineEquirectangularName;
  54570. private _defineMirroredEquirectangularFixedName;
  54571. private _defineEquirectangularFixedName;
  54572. private _defineSkyboxName;
  54573. private _cubeSamplerName;
  54574. private _2DSamplerName;
  54575. private _positionUVWName;
  54576. private _directionWName;
  54577. private _reflectionCoordsName;
  54578. private _reflection2DCoordsName;
  54579. private _reflectionColorName;
  54580. private _reflectionMatrixName;
  54581. /**
  54582. * Gets or sets the texture associated with the node
  54583. */
  54584. texture: Nullable<BaseTexture>;
  54585. /**
  54586. * Create a new TextureBlock
  54587. * @param name defines the block name
  54588. */
  54589. constructor(name: string);
  54590. /**
  54591. * Gets the current class name
  54592. * @returns the class name
  54593. */
  54594. getClassName(): string;
  54595. /**
  54596. * Gets the world position input component
  54597. */
  54598. readonly position: NodeMaterialConnectionPoint;
  54599. /**
  54600. * Gets the world position input component
  54601. */
  54602. readonly worldPosition: NodeMaterialConnectionPoint;
  54603. /**
  54604. * Gets the world normal input component
  54605. */
  54606. readonly worldNormal: NodeMaterialConnectionPoint;
  54607. /**
  54608. * Gets the world input component
  54609. */
  54610. readonly world: NodeMaterialConnectionPoint;
  54611. /**
  54612. * Gets the camera (or eye) position component
  54613. */
  54614. readonly cameraPosition: NodeMaterialConnectionPoint;
  54615. /**
  54616. * Gets the view input component
  54617. */
  54618. readonly view: NodeMaterialConnectionPoint;
  54619. /**
  54620. * Gets the rgb output component
  54621. */
  54622. readonly rgb: NodeMaterialConnectionPoint;
  54623. /**
  54624. * Gets the r output component
  54625. */
  54626. readonly r: NodeMaterialConnectionPoint;
  54627. /**
  54628. * Gets the g output component
  54629. */
  54630. readonly g: NodeMaterialConnectionPoint;
  54631. /**
  54632. * Gets the b output component
  54633. */
  54634. readonly b: NodeMaterialConnectionPoint;
  54635. autoConfigure(material: NodeMaterial): void;
  54636. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  54637. isReady(): boolean;
  54638. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  54639. private _injectVertexCode;
  54640. private _writeOutput;
  54641. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  54642. serialize(): any;
  54643. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  54644. }
  54645. }
  54646. declare module "babylonjs/Materials/Node/nodeMaterial" {
  54647. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54648. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  54649. import { Scene } from "babylonjs/scene";
  54650. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54651. import { Matrix } from "babylonjs/Maths/math.vector";
  54652. import { Mesh } from "babylonjs/Meshes/mesh";
  54653. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54654. import { Observable } from "babylonjs/Misc/observable";
  54655. import { SubMesh } from "babylonjs/Meshes/subMesh";
  54656. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  54657. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  54658. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  54659. import { Nullable } from "babylonjs/types";
  54660. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  54661. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  54662. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  54663. /**
  54664. * Interface used to configure the node material editor
  54665. */
  54666. export interface INodeMaterialEditorOptions {
  54667. /** Define the URl to load node editor script */
  54668. editorURL?: string;
  54669. }
  54670. /** @hidden */
  54671. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  54672. /** BONES */
  54673. NUM_BONE_INFLUENCERS: number;
  54674. BonesPerMesh: number;
  54675. BONETEXTURE: boolean;
  54676. /** MORPH TARGETS */
  54677. MORPHTARGETS: boolean;
  54678. MORPHTARGETS_NORMAL: boolean;
  54679. MORPHTARGETS_TANGENT: boolean;
  54680. MORPHTARGETS_UV: boolean;
  54681. NUM_MORPH_INFLUENCERS: number;
  54682. /** IMAGE PROCESSING */
  54683. IMAGEPROCESSING: boolean;
  54684. VIGNETTE: boolean;
  54685. VIGNETTEBLENDMODEMULTIPLY: boolean;
  54686. VIGNETTEBLENDMODEOPAQUE: boolean;
  54687. TONEMAPPING: boolean;
  54688. TONEMAPPING_ACES: boolean;
  54689. CONTRAST: boolean;
  54690. EXPOSURE: boolean;
  54691. COLORCURVES: boolean;
  54692. COLORGRADING: boolean;
  54693. COLORGRADING3D: boolean;
  54694. SAMPLER3DGREENDEPTH: boolean;
  54695. SAMPLER3DBGRMAP: boolean;
  54696. IMAGEPROCESSINGPOSTPROCESS: boolean;
  54697. /** MISC. */
  54698. BUMPDIRECTUV: number;
  54699. constructor();
  54700. setValue(name: string, value: boolean): void;
  54701. }
  54702. /**
  54703. * Class used to configure NodeMaterial
  54704. */
  54705. export interface INodeMaterialOptions {
  54706. /**
  54707. * Defines if blocks should emit comments
  54708. */
  54709. emitComments: boolean;
  54710. }
  54711. /**
  54712. * Class used to create a node based material built by assembling shader blocks
  54713. */
  54714. export class NodeMaterial extends PushMaterial {
  54715. private static _BuildIdGenerator;
  54716. private _options;
  54717. private _vertexCompilationState;
  54718. private _fragmentCompilationState;
  54719. private _sharedData;
  54720. private _buildId;
  54721. private _buildWasSuccessful;
  54722. private _cachedWorldViewMatrix;
  54723. private _cachedWorldViewProjectionMatrix;
  54724. private _optimizers;
  54725. private _animationFrame;
  54726. /** Define the URl to load node editor script */
  54727. static EditorURL: string;
  54728. private BJSNODEMATERIALEDITOR;
  54729. /** Get the inspector from bundle or global */
  54730. private _getGlobalNodeMaterialEditor;
  54731. /**
  54732. * 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)
  54733. */
  54734. ignoreAlpha: boolean;
  54735. /**
  54736. * Defines the maximum number of lights that can be used in the material
  54737. */
  54738. maxSimultaneousLights: number;
  54739. /**
  54740. * Observable raised when the material is built
  54741. */
  54742. onBuildObservable: Observable<NodeMaterial>;
  54743. /**
  54744. * Gets or sets the root nodes of the material vertex shader
  54745. */
  54746. _vertexOutputNodes: NodeMaterialBlock[];
  54747. /**
  54748. * Gets or sets the root nodes of the material fragment (pixel) shader
  54749. */
  54750. _fragmentOutputNodes: NodeMaterialBlock[];
  54751. /** Gets or sets options to control the node material overall behavior */
  54752. options: INodeMaterialOptions;
  54753. /**
  54754. * Default configuration related to image processing available in the standard Material.
  54755. */
  54756. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  54757. /**
  54758. * Gets the image processing configuration used either in this material.
  54759. */
  54760. /**
  54761. * Sets the Default image processing configuration used either in the this material.
  54762. *
  54763. * If sets to null, the scene one is in use.
  54764. */
  54765. imageProcessingConfiguration: ImageProcessingConfiguration;
  54766. /**
  54767. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  54768. */
  54769. attachedBlocks: NodeMaterialBlock[];
  54770. /**
  54771. * Create a new node based material
  54772. * @param name defines the material name
  54773. * @param scene defines the hosting scene
  54774. * @param options defines creation option
  54775. */
  54776. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  54777. /**
  54778. * Gets the current class name of the material e.g. "NodeMaterial"
  54779. * @returns the class name
  54780. */
  54781. getClassName(): string;
  54782. /**
  54783. * Keep track of the image processing observer to allow dispose and replace.
  54784. */
  54785. private _imageProcessingObserver;
  54786. /**
  54787. * Attaches a new image processing configuration to the Standard Material.
  54788. * @param configuration
  54789. */
  54790. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  54791. /**
  54792. * Get a block by its name
  54793. * @param name defines the name of the block to retrieve
  54794. * @returns the required block or null if not found
  54795. */
  54796. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  54797. /**
  54798. * Get a block by its name
  54799. * @param predicate defines the predicate used to find the good candidate
  54800. * @returns the required block or null if not found
  54801. */
  54802. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  54803. /**
  54804. * Get an input block by its name
  54805. * @param predicate defines the predicate used to find the good candidate
  54806. * @returns the required input block or null if not found
  54807. */
  54808. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  54809. /**
  54810. * Gets the list of input blocks attached to this material
  54811. * @returns an array of InputBlocks
  54812. */
  54813. getInputBlocks(): InputBlock[];
  54814. /**
  54815. * Adds a new optimizer to the list of optimizers
  54816. * @param optimizer defines the optimizers to add
  54817. * @returns the current material
  54818. */
  54819. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  54820. /**
  54821. * Remove an optimizer from the list of optimizers
  54822. * @param optimizer defines the optimizers to remove
  54823. * @returns the current material
  54824. */
  54825. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  54826. /**
  54827. * Add a new block to the list of output nodes
  54828. * @param node defines the node to add
  54829. * @returns the current material
  54830. */
  54831. addOutputNode(node: NodeMaterialBlock): this;
  54832. /**
  54833. * Remove a block from the list of root nodes
  54834. * @param node defines the node to remove
  54835. * @returns the current material
  54836. */
  54837. removeOutputNode(node: NodeMaterialBlock): this;
  54838. private _addVertexOutputNode;
  54839. private _removeVertexOutputNode;
  54840. private _addFragmentOutputNode;
  54841. private _removeFragmentOutputNode;
  54842. /**
  54843. * Specifies if the material will require alpha blending
  54844. * @returns a boolean specifying if alpha blending is needed
  54845. */
  54846. needAlphaBlending(): boolean;
  54847. /**
  54848. * Specifies if this material should be rendered in alpha test mode
  54849. * @returns a boolean specifying if an alpha test is needed.
  54850. */
  54851. needAlphaTesting(): boolean;
  54852. private _initializeBlock;
  54853. private _resetDualBlocks;
  54854. /**
  54855. * Build the material and generates the inner effect
  54856. * @param verbose defines if the build should log activity
  54857. */
  54858. build(verbose?: boolean): void;
  54859. /**
  54860. * Runs an otpimization phase to try to improve the shader code
  54861. */
  54862. optimize(): void;
  54863. private _prepareDefinesForAttributes;
  54864. /**
  54865. * Get if the submesh is ready to be used and all its information available.
  54866. * Child classes can use it to update shaders
  54867. * @param mesh defines the mesh to check
  54868. * @param subMesh defines which submesh to check
  54869. * @param useInstances specifies that instances should be used
  54870. * @returns a boolean indicating that the submesh is ready or not
  54871. */
  54872. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  54873. /**
  54874. * Get a string representing the shaders built by the current node graph
  54875. */
  54876. readonly compiledShaders: string;
  54877. /**
  54878. * Binds the world matrix to the material
  54879. * @param world defines the world transformation matrix
  54880. */
  54881. bindOnlyWorldMatrix(world: Matrix): void;
  54882. /**
  54883. * Binds the submesh to this material by preparing the effect and shader to draw
  54884. * @param world defines the world transformation matrix
  54885. * @param mesh defines the mesh containing the submesh
  54886. * @param subMesh defines the submesh to bind the material to
  54887. */
  54888. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  54889. /**
  54890. * Gets the active textures from the material
  54891. * @returns an array of textures
  54892. */
  54893. getActiveTextures(): BaseTexture[];
  54894. /**
  54895. * Gets the list of texture blocks
  54896. * @returns an array of texture blocks
  54897. */
  54898. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  54899. /**
  54900. * Specifies if the material uses a texture
  54901. * @param texture defines the texture to check against the material
  54902. * @returns a boolean specifying if the material uses the texture
  54903. */
  54904. hasTexture(texture: BaseTexture): boolean;
  54905. /**
  54906. * Disposes the material
  54907. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  54908. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  54909. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  54910. */
  54911. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  54912. /** Creates the node editor window. */
  54913. private _createNodeEditor;
  54914. /**
  54915. * Launch the node material editor
  54916. * @param config Define the configuration of the editor
  54917. * @return a promise fulfilled when the node editor is visible
  54918. */
  54919. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  54920. /**
  54921. * Clear the current material
  54922. */
  54923. clear(): void;
  54924. /**
  54925. * Clear the current material and set it to a default state
  54926. */
  54927. setToDefault(): void;
  54928. /**
  54929. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  54930. * @param url defines the url to load from
  54931. * @returns a promise that will fullfil when the material is fully loaded
  54932. */
  54933. loadAsync(url: string): Promise<unknown>;
  54934. private _gatherBlocks;
  54935. /**
  54936. * Generate a string containing the code declaration required to create an equivalent of this material
  54937. * @returns a string
  54938. */
  54939. generateCode(): string;
  54940. /**
  54941. * Serializes this material in a JSON representation
  54942. * @returns the serialized material object
  54943. */
  54944. serialize(): any;
  54945. private _restoreConnections;
  54946. /**
  54947. * Clear the current graph and load a new one from a serialization object
  54948. * @param source defines the JSON representation of the material
  54949. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  54950. */
  54951. loadFromSerialization(source: any, rootUrl?: string): void;
  54952. /**
  54953. * Creates a node material from parsed material data
  54954. * @param source defines the JSON representation of the material
  54955. * @param scene defines the hosting scene
  54956. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  54957. * @returns a new node material
  54958. */
  54959. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  54960. /**
  54961. * Creates a new node material set to default basic configuration
  54962. * @param name defines the name of the material
  54963. * @param scene defines the hosting scene
  54964. * @returns a new NodeMaterial
  54965. */
  54966. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  54967. }
  54968. }
  54969. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  54970. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54971. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54972. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  54973. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54974. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54975. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  54976. import { Effect } from "babylonjs/Materials/effect";
  54977. import { Mesh } from "babylonjs/Meshes/mesh";
  54978. import { Nullable } from "babylonjs/types";
  54979. import { Texture } from "babylonjs/Materials/Textures/texture";
  54980. import { Scene } from "babylonjs/scene";
  54981. /**
  54982. * Block used to read a texture from a sampler
  54983. */
  54984. export class TextureBlock extends NodeMaterialBlock {
  54985. private _defineName;
  54986. private _samplerName;
  54987. private _transformedUVName;
  54988. private _textureTransformName;
  54989. private _textureInfoName;
  54990. private _mainUVName;
  54991. private _mainUVDefineName;
  54992. /**
  54993. * Gets or sets the texture associated with the node
  54994. */
  54995. texture: Nullable<Texture>;
  54996. /**
  54997. * Create a new TextureBlock
  54998. * @param name defines the block name
  54999. */
  55000. constructor(name: string);
  55001. /**
  55002. * Gets the current class name
  55003. * @returns the class name
  55004. */
  55005. getClassName(): string;
  55006. /**
  55007. * Gets the uv input component
  55008. */
  55009. readonly uv: NodeMaterialConnectionPoint;
  55010. /**
  55011. * Gets the rgba output component
  55012. */
  55013. readonly rgba: NodeMaterialConnectionPoint;
  55014. /**
  55015. * Gets the rgb output component
  55016. */
  55017. readonly rgb: NodeMaterialConnectionPoint;
  55018. /**
  55019. * Gets the r output component
  55020. */
  55021. readonly r: NodeMaterialConnectionPoint;
  55022. /**
  55023. * Gets the g output component
  55024. */
  55025. readonly g: NodeMaterialConnectionPoint;
  55026. /**
  55027. * Gets the b output component
  55028. */
  55029. readonly b: NodeMaterialConnectionPoint;
  55030. /**
  55031. * Gets the a output component
  55032. */
  55033. readonly a: NodeMaterialConnectionPoint;
  55034. readonly target: NodeMaterialBlockTargets;
  55035. autoConfigure(material: NodeMaterial): void;
  55036. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  55037. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55038. isReady(): boolean;
  55039. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55040. private readonly _isMixed;
  55041. private _injectVertexCode;
  55042. private _writeOutput;
  55043. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  55044. protected _dumpPropertiesCode(): string;
  55045. serialize(): any;
  55046. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55047. }
  55048. }
  55049. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  55050. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55051. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55052. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55053. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  55054. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  55055. /**
  55056. * Class used to store shared data between 2 NodeMaterialBuildState
  55057. */
  55058. export class NodeMaterialBuildStateSharedData {
  55059. /**
  55060. * Gets the list of emitted varyings
  55061. */
  55062. temps: string[];
  55063. /**
  55064. * Gets the list of emitted varyings
  55065. */
  55066. varyings: string[];
  55067. /**
  55068. * Gets the varying declaration string
  55069. */
  55070. varyingDeclaration: string;
  55071. /**
  55072. * Input blocks
  55073. */
  55074. inputBlocks: InputBlock[];
  55075. /**
  55076. * Input blocks
  55077. */
  55078. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  55079. /**
  55080. * Bindable blocks (Blocks that need to set data to the effect)
  55081. */
  55082. bindableBlocks: NodeMaterialBlock[];
  55083. /**
  55084. * List of blocks that can provide a compilation fallback
  55085. */
  55086. blocksWithFallbacks: NodeMaterialBlock[];
  55087. /**
  55088. * List of blocks that can provide a define update
  55089. */
  55090. blocksWithDefines: NodeMaterialBlock[];
  55091. /**
  55092. * List of blocks that can provide a repeatable content
  55093. */
  55094. repeatableContentBlocks: NodeMaterialBlock[];
  55095. /**
  55096. * List of blocks that can provide a dynamic list of uniforms
  55097. */
  55098. dynamicUniformBlocks: NodeMaterialBlock[];
  55099. /**
  55100. * List of blocks that can block the isReady function for the material
  55101. */
  55102. blockingBlocks: NodeMaterialBlock[];
  55103. /**
  55104. * Gets the list of animated inputs
  55105. */
  55106. animatedInputs: InputBlock[];
  55107. /**
  55108. * Build Id used to avoid multiple recompilations
  55109. */
  55110. buildId: number;
  55111. /** List of emitted variables */
  55112. variableNames: {
  55113. [key: string]: number;
  55114. };
  55115. /** List of emitted defines */
  55116. defineNames: {
  55117. [key: string]: number;
  55118. };
  55119. /** Should emit comments? */
  55120. emitComments: boolean;
  55121. /** Emit build activity */
  55122. verbose: boolean;
  55123. /**
  55124. * Gets the compilation hints emitted at compilation time
  55125. */
  55126. hints: {
  55127. needWorldViewMatrix: boolean;
  55128. needWorldViewProjectionMatrix: boolean;
  55129. needAlphaBlending: boolean;
  55130. needAlphaTesting: boolean;
  55131. };
  55132. /**
  55133. * List of compilation checks
  55134. */
  55135. checks: {
  55136. emitVertex: boolean;
  55137. emitFragment: boolean;
  55138. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  55139. };
  55140. /** Creates a new shared data */
  55141. constructor();
  55142. /**
  55143. * Emits console errors and exceptions if there is a failing check
  55144. */
  55145. emitErrors(): void;
  55146. }
  55147. }
  55148. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  55149. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  55150. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  55151. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  55152. /**
  55153. * Class used to store node based material build state
  55154. */
  55155. export class NodeMaterialBuildState {
  55156. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  55157. supportUniformBuffers: boolean;
  55158. /**
  55159. * Gets the list of emitted attributes
  55160. */
  55161. attributes: string[];
  55162. /**
  55163. * Gets the list of emitted uniforms
  55164. */
  55165. uniforms: string[];
  55166. /**
  55167. * Gets the list of emitted uniform buffers
  55168. */
  55169. uniformBuffers: string[];
  55170. /**
  55171. * Gets the list of emitted samplers
  55172. */
  55173. samplers: string[];
  55174. /**
  55175. * Gets the list of emitted functions
  55176. */
  55177. functions: {
  55178. [key: string]: string;
  55179. };
  55180. /**
  55181. * Gets the list of emitted extensions
  55182. */
  55183. extensions: {
  55184. [key: string]: string;
  55185. };
  55186. /**
  55187. * Gets the target of the compilation state
  55188. */
  55189. target: NodeMaterialBlockTargets;
  55190. /**
  55191. * Gets the list of emitted counters
  55192. */
  55193. counters: {
  55194. [key: string]: number;
  55195. };
  55196. /**
  55197. * Shared data between multiple NodeMaterialBuildState instances
  55198. */
  55199. sharedData: NodeMaterialBuildStateSharedData;
  55200. /** @hidden */
  55201. _vertexState: NodeMaterialBuildState;
  55202. /** @hidden */
  55203. _attributeDeclaration: string;
  55204. /** @hidden */
  55205. _uniformDeclaration: string;
  55206. /** @hidden */
  55207. _samplerDeclaration: string;
  55208. /** @hidden */
  55209. _varyingTransfer: string;
  55210. private _repeatableContentAnchorIndex;
  55211. /** @hidden */
  55212. _builtCompilationString: string;
  55213. /**
  55214. * Gets the emitted compilation strings
  55215. */
  55216. compilationString: string;
  55217. /**
  55218. * Finalize the compilation strings
  55219. * @param state defines the current compilation state
  55220. */
  55221. finalize(state: NodeMaterialBuildState): void;
  55222. /** @hidden */
  55223. readonly _repeatableContentAnchor: string;
  55224. /** @hidden */
  55225. _getFreeVariableName(prefix: string): string;
  55226. /** @hidden */
  55227. _getFreeDefineName(prefix: string): string;
  55228. /** @hidden */
  55229. _excludeVariableName(name: string): void;
  55230. /** @hidden */
  55231. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  55232. /** @hidden */
  55233. _emitExtension(name: string, extension: string): void;
  55234. /** @hidden */
  55235. _emitFunction(name: string, code: string, comments: string): void;
  55236. /** @hidden */
  55237. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  55238. replaceStrings?: {
  55239. search: RegExp;
  55240. replace: string;
  55241. }[];
  55242. repeatKey?: string;
  55243. }): string;
  55244. /** @hidden */
  55245. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  55246. repeatKey?: string;
  55247. removeAttributes?: boolean;
  55248. removeUniforms?: boolean;
  55249. removeVaryings?: boolean;
  55250. removeIfDef?: boolean;
  55251. replaceStrings?: {
  55252. search: RegExp;
  55253. replace: string;
  55254. }[];
  55255. }, storeKey?: string): void;
  55256. /** @hidden */
  55257. _registerTempVariable(name: string): boolean;
  55258. /** @hidden */
  55259. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  55260. /** @hidden */
  55261. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  55262. }
  55263. }
  55264. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  55265. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  55266. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55267. import { Nullable } from "babylonjs/types";
  55268. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55269. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  55270. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  55271. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55272. import { Mesh } from "babylonjs/Meshes/mesh";
  55273. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55274. import { Scene } from "babylonjs/scene";
  55275. /**
  55276. * Defines a block that can be used inside a node based material
  55277. */
  55278. export class NodeMaterialBlock {
  55279. private _buildId;
  55280. private _buildTarget;
  55281. private _target;
  55282. private _isFinalMerger;
  55283. private _isInput;
  55284. /** @hidden */
  55285. _codeVariableName: string;
  55286. /** @hidden */
  55287. _inputs: NodeMaterialConnectionPoint[];
  55288. /** @hidden */
  55289. _outputs: NodeMaterialConnectionPoint[];
  55290. /** @hidden */
  55291. _preparationId: number;
  55292. /**
  55293. * Gets or sets the name of the block
  55294. */
  55295. name: string;
  55296. /**
  55297. * Gets or sets the unique id of the node
  55298. */
  55299. uniqueId: number;
  55300. /**
  55301. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  55302. */
  55303. readonly isFinalMerger: boolean;
  55304. /**
  55305. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  55306. */
  55307. readonly isInput: boolean;
  55308. /**
  55309. * Gets or sets the build Id
  55310. */
  55311. buildId: number;
  55312. /**
  55313. * Gets or sets the target of the block
  55314. */
  55315. target: NodeMaterialBlockTargets;
  55316. /**
  55317. * Gets the list of input points
  55318. */
  55319. readonly inputs: NodeMaterialConnectionPoint[];
  55320. /** Gets the list of output points */
  55321. readonly outputs: NodeMaterialConnectionPoint[];
  55322. /**
  55323. * Find an input by its name
  55324. * @param name defines the name of the input to look for
  55325. * @returns the input or null if not found
  55326. */
  55327. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  55328. /**
  55329. * Find an output by its name
  55330. * @param name defines the name of the outputto look for
  55331. * @returns the output or null if not found
  55332. */
  55333. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  55334. /**
  55335. * Creates a new NodeMaterialBlock
  55336. * @param name defines the block name
  55337. * @param target defines the target of that block (Vertex by default)
  55338. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  55339. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  55340. */
  55341. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  55342. /**
  55343. * Initialize the block and prepare the context for build
  55344. * @param state defines the state that will be used for the build
  55345. */
  55346. initialize(state: NodeMaterialBuildState): void;
  55347. /**
  55348. * Bind data to effect. Will only be called for blocks with isBindable === true
  55349. * @param effect defines the effect to bind data to
  55350. * @param nodeMaterial defines the hosting NodeMaterial
  55351. * @param mesh defines the mesh that will be rendered
  55352. */
  55353. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55354. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  55355. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  55356. protected _writeFloat(value: number): string;
  55357. /**
  55358. * Gets the current class name e.g. "NodeMaterialBlock"
  55359. * @returns the class name
  55360. */
  55361. getClassName(): string;
  55362. /**
  55363. * Register a new input. Must be called inside a block constructor
  55364. * @param name defines the connection point name
  55365. * @param type defines the connection point type
  55366. * @param isOptional defines a boolean indicating that this input can be omitted
  55367. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  55368. * @returns the current block
  55369. */
  55370. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  55371. /**
  55372. * Register a new output. Must be called inside a block constructor
  55373. * @param name defines the connection point name
  55374. * @param type defines the connection point type
  55375. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  55376. * @returns the current block
  55377. */
  55378. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  55379. /**
  55380. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  55381. * @param forOutput defines an optional connection point to check compatibility with
  55382. * @returns the first available input or null
  55383. */
  55384. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  55385. /**
  55386. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  55387. * @param forBlock defines an optional block to check compatibility with
  55388. * @returns the first available input or null
  55389. */
  55390. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  55391. /**
  55392. * Gets the sibling of the given output
  55393. * @param current defines the current output
  55394. * @returns the next output in the list or null
  55395. */
  55396. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  55397. /**
  55398. * Connect current block with another block
  55399. * @param other defines the block to connect with
  55400. * @param options define the various options to help pick the right connections
  55401. * @returns the current block
  55402. */
  55403. connectTo(other: NodeMaterialBlock, options?: {
  55404. input?: string;
  55405. output?: string;
  55406. outputSwizzle?: string;
  55407. }): this | undefined;
  55408. protected _buildBlock(state: NodeMaterialBuildState): void;
  55409. /**
  55410. * Add uniforms, samplers and uniform buffers at compilation time
  55411. * @param state defines the state to update
  55412. * @param nodeMaterial defines the node material requesting the update
  55413. * @param defines defines the material defines to update
  55414. */
  55415. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55416. /**
  55417. * Add potential fallbacks if shader compilation fails
  55418. * @param mesh defines the mesh to be rendered
  55419. * @param fallbacks defines the current prioritized list of fallbacks
  55420. */
  55421. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  55422. /**
  55423. * Update defines for shader compilation
  55424. * @param mesh defines the mesh to be rendered
  55425. * @param nodeMaterial defines the node material requesting the update
  55426. * @param defines defines the material defines to update
  55427. * @param useInstances specifies that instances should be used
  55428. */
  55429. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  55430. /**
  55431. * Initialize defines for shader compilation
  55432. * @param mesh defines the mesh to be rendered
  55433. * @param nodeMaterial defines the node material requesting the update
  55434. * @param defines defines the material defines to be prepared
  55435. * @param useInstances specifies that instances should be used
  55436. */
  55437. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  55438. /**
  55439. * Lets the block try to connect some inputs automatically
  55440. * @param material defines the hosting NodeMaterial
  55441. */
  55442. autoConfigure(material: NodeMaterial): void;
  55443. /**
  55444. * Function called when a block is declared as repeatable content generator
  55445. * @param vertexShaderState defines the current compilation state for the vertex shader
  55446. * @param fragmentShaderState defines the current compilation state for the fragment shader
  55447. * @param mesh defines the mesh to be rendered
  55448. * @param defines defines the material defines to update
  55449. */
  55450. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  55451. /**
  55452. * Checks if the block is ready
  55453. * @param mesh defines the mesh to be rendered
  55454. * @param nodeMaterial defines the node material requesting the update
  55455. * @param defines defines the material defines to update
  55456. * @param useInstances specifies that instances should be used
  55457. * @returns true if the block is ready
  55458. */
  55459. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  55460. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  55461. private _processBuild;
  55462. /**
  55463. * Compile the current node and generate the shader code
  55464. * @param state defines the current compilation state (uniforms, samplers, current string)
  55465. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  55466. * @returns true if already built
  55467. */
  55468. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  55469. protected _inputRename(name: string): string;
  55470. protected _outputRename(name: string): string;
  55471. protected _dumpPropertiesCode(): string;
  55472. /** @hidden */
  55473. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  55474. /**
  55475. * Clone the current block to a new identical block
  55476. * @param scene defines the hosting scene
  55477. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  55478. * @returns a copy of the current block
  55479. */
  55480. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  55481. /**
  55482. * Serializes this block in a JSON representation
  55483. * @returns the serialized block object
  55484. */
  55485. serialize(): any;
  55486. /** @hidden */
  55487. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55488. }
  55489. }
  55490. declare module "babylonjs/Materials/Node/NodeMaterialBlockConnectionPointMode" {
  55491. /**
  55492. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55493. */
  55494. export enum NodeMaterialBlockConnectionPointMode {
  55495. /** Value is an uniform */
  55496. Uniform = 0,
  55497. /** Value is a mesh attribute */
  55498. Attribute = 1,
  55499. /** Value is a varying between vertex and fragment shaders */
  55500. Varying = 2,
  55501. /** Mode is undefined */
  55502. Undefined = 3
  55503. }
  55504. }
  55505. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  55506. /**
  55507. * Enum defining the type of animations supported by InputBlock
  55508. */
  55509. export enum AnimatedInputBlockTypes {
  55510. /** No animation */
  55511. None = 0,
  55512. /** Time based animation. Will only work for floats */
  55513. Time = 1
  55514. }
  55515. }
  55516. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  55517. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55518. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  55519. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/nodeMaterialSystemValues";
  55520. import { Nullable } from "babylonjs/types";
  55521. import { Effect } from "babylonjs/Materials/effect";
  55522. import { Matrix } from "babylonjs/Maths/math.vector";
  55523. import { Scene } from "babylonjs/scene";
  55524. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55525. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55526. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  55527. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  55528. /**
  55529. * Block used to expose an input value
  55530. */
  55531. export class InputBlock extends NodeMaterialBlock {
  55532. private _mode;
  55533. private _associatedVariableName;
  55534. private _storedValue;
  55535. private _valueCallback;
  55536. private _type;
  55537. private _animationType;
  55538. /** Gets or set a value used to limit the range of float values */
  55539. min: number;
  55540. /** Gets or set a value used to limit the range of float values */
  55541. max: number;
  55542. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  55543. matrixMode: number;
  55544. /** @hidden */
  55545. _systemValue: Nullable<NodeMaterialSystemValues>;
  55546. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  55547. visibleInInspector: boolean;
  55548. /**
  55549. * Gets or sets the connection point type (default is float)
  55550. */
  55551. readonly type: NodeMaterialBlockConnectionPointTypes;
  55552. /**
  55553. * Creates a new InputBlock
  55554. * @param name defines the block name
  55555. * @param target defines the target of that block (Vertex by default)
  55556. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  55557. */
  55558. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  55559. /**
  55560. * Gets the output component
  55561. */
  55562. readonly output: NodeMaterialConnectionPoint;
  55563. /**
  55564. * Set the source of this connection point to a vertex attribute
  55565. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  55566. * @returns the current connection point
  55567. */
  55568. setAsAttribute(attributeName?: string): InputBlock;
  55569. /**
  55570. * Set the source of this connection point to a system value
  55571. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  55572. * @returns the current connection point
  55573. */
  55574. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  55575. /**
  55576. * Gets or sets the value of that point.
  55577. * Please note that this value will be ignored if valueCallback is defined
  55578. */
  55579. value: any;
  55580. /**
  55581. * Gets or sets a callback used to get the value of that point.
  55582. * Please note that setting this value will force the connection point to ignore the value property
  55583. */
  55584. valueCallback: () => any;
  55585. /**
  55586. * Gets or sets the associated variable name in the shader
  55587. */
  55588. associatedVariableName: string;
  55589. /** Gets or sets the type of animation applied to the input */
  55590. animationType: AnimatedInputBlockTypes;
  55591. /**
  55592. * Gets a boolean indicating that this connection point not defined yet
  55593. */
  55594. readonly isUndefined: boolean;
  55595. /**
  55596. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  55597. * In this case the connection point name must be the name of the uniform to use.
  55598. * Can only be set on inputs
  55599. */
  55600. isUniform: boolean;
  55601. /**
  55602. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  55603. * In this case the connection point name must be the name of the attribute to use
  55604. * Can only be set on inputs
  55605. */
  55606. isAttribute: boolean;
  55607. /**
  55608. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  55609. * Can only be set on exit points
  55610. */
  55611. isVarying: boolean;
  55612. /**
  55613. * Gets a boolean indicating that the current connection point is a system value
  55614. */
  55615. readonly isSystemValue: boolean;
  55616. /**
  55617. * Gets or sets the current well known value or null if not defined as a system value
  55618. */
  55619. systemValue: Nullable<NodeMaterialSystemValues>;
  55620. /**
  55621. * Gets the current class name
  55622. * @returns the class name
  55623. */
  55624. getClassName(): string;
  55625. /**
  55626. * Animate the input if animationType !== None
  55627. * @param scene defines the rendering scene
  55628. */
  55629. animate(scene: Scene): void;
  55630. private _emitDefine;
  55631. initialize(state: NodeMaterialBuildState): void;
  55632. /**
  55633. * Set the input block to its default value (based on its type)
  55634. */
  55635. setDefaultValue(): void;
  55636. protected _dumpPropertiesCode(): string;
  55637. private _emit;
  55638. /** @hidden */
  55639. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  55640. /** @hidden */
  55641. _transmit(effect: Effect, scene: Scene): void;
  55642. protected _buildBlock(state: NodeMaterialBuildState): void;
  55643. serialize(): any;
  55644. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55645. }
  55646. }
  55647. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  55648. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  55649. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  55650. import { Nullable } from "babylonjs/types";
  55651. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55652. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55653. /**
  55654. * Defines a connection point for a block
  55655. */
  55656. export class NodeMaterialConnectionPoint {
  55657. /** @hidden */
  55658. _ownerBlock: NodeMaterialBlock;
  55659. /** @hidden */
  55660. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  55661. private _endpoints;
  55662. private _associatedVariableName;
  55663. /** @hidden */
  55664. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  55665. /** @hidden */
  55666. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  55667. private _type;
  55668. /** @hidden */
  55669. _enforceAssociatedVariableName: boolean;
  55670. /**
  55671. * Gets or sets the additional types supported byt this connection point
  55672. */
  55673. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  55674. /**
  55675. * Gets or sets the associated variable name in the shader
  55676. */
  55677. associatedVariableName: string;
  55678. /**
  55679. * Gets or sets the connection point type (default is float)
  55680. */
  55681. type: NodeMaterialBlockConnectionPointTypes;
  55682. /**
  55683. * Gets or sets the connection point name
  55684. */
  55685. name: string;
  55686. /**
  55687. * Gets or sets a boolean indicating that this connection point can be omitted
  55688. */
  55689. isOptional: boolean;
  55690. /**
  55691. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  55692. */
  55693. define: string;
  55694. /** Gets or sets the target of that connection point */
  55695. target: NodeMaterialBlockTargets;
  55696. /**
  55697. * Gets a boolean indicating that the current point is connected
  55698. */
  55699. readonly isConnected: boolean;
  55700. /**
  55701. * Gets a boolean indicating that the current point is connected to an input block
  55702. */
  55703. readonly isConnectedToInputBlock: boolean;
  55704. /**
  55705. * Gets a the connected input block (if any)
  55706. */
  55707. readonly connectInputBlock: Nullable<InputBlock>;
  55708. /** Get the other side of the connection (if any) */
  55709. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  55710. /** Get the block that owns this connection point */
  55711. readonly ownerBlock: NodeMaterialBlock;
  55712. /** Get the block connected on the other side of this connection (if any) */
  55713. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  55714. /** Get the block connected on the endpoints of this connection (if any) */
  55715. readonly connectedBlocks: Array<NodeMaterialBlock>;
  55716. /** Gets the list of connected endpoints */
  55717. readonly endpoints: NodeMaterialConnectionPoint[];
  55718. /** Gets a boolean indicating if that output point is connected to at least one input */
  55719. readonly hasEndpoints: boolean;
  55720. /**
  55721. * Creates a new connection point
  55722. * @param name defines the connection point name
  55723. * @param ownerBlock defines the block hosting this connection point
  55724. */
  55725. constructor(name: string, ownerBlock: NodeMaterialBlock);
  55726. /**
  55727. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  55728. * @returns the class name
  55729. */
  55730. getClassName(): string;
  55731. /**
  55732. * Gets an boolean indicating if the current point can be connected to another point
  55733. * @param connectionPoint defines the other connection point
  55734. * @returns true if the connection is possible
  55735. */
  55736. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  55737. /**
  55738. * Connect this point to another connection point
  55739. * @param connectionPoint defines the other connection point
  55740. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  55741. * @returns the current connection point
  55742. */
  55743. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  55744. /**
  55745. * Disconnect this point from one of his endpoint
  55746. * @param endpoint defines the other connection point
  55747. * @returns the current connection point
  55748. */
  55749. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  55750. /**
  55751. * Serializes this point in a JSON representation
  55752. * @returns the serialized point object
  55753. */
  55754. serialize(): any;
  55755. }
  55756. }
  55757. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  55758. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55759. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55760. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55761. import { Mesh } from "babylonjs/Meshes/mesh";
  55762. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  55763. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55764. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55765. /**
  55766. * Block used to add support for vertex skinning (bones)
  55767. */
  55768. export class BonesBlock extends NodeMaterialBlock {
  55769. /**
  55770. * Creates a new BonesBlock
  55771. * @param name defines the block name
  55772. */
  55773. constructor(name: string);
  55774. /**
  55775. * Initialize the block and prepare the context for build
  55776. * @param state defines the state that will be used for the build
  55777. */
  55778. initialize(state: NodeMaterialBuildState): void;
  55779. /**
  55780. * Gets the current class name
  55781. * @returns the class name
  55782. */
  55783. getClassName(): string;
  55784. /**
  55785. * Gets the matrix indices input component
  55786. */
  55787. readonly matricesIndices: NodeMaterialConnectionPoint;
  55788. /**
  55789. * Gets the matrix weights input component
  55790. */
  55791. readonly matricesWeights: NodeMaterialConnectionPoint;
  55792. /**
  55793. * Gets the extra matrix indices input component
  55794. */
  55795. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  55796. /**
  55797. * Gets the extra matrix weights input component
  55798. */
  55799. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  55800. /**
  55801. * Gets the world input component
  55802. */
  55803. readonly world: NodeMaterialConnectionPoint;
  55804. /**
  55805. * Gets the output component
  55806. */
  55807. readonly output: NodeMaterialConnectionPoint;
  55808. autoConfigure(material: NodeMaterial): void;
  55809. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  55810. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55811. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55812. protected _buildBlock(state: NodeMaterialBuildState): this;
  55813. }
  55814. }
  55815. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  55816. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55817. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55818. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55819. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55820. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55821. /**
  55822. * Block used to add support for instances
  55823. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  55824. */
  55825. export class InstancesBlock extends NodeMaterialBlock {
  55826. /**
  55827. * Creates a new InstancesBlock
  55828. * @param name defines the block name
  55829. */
  55830. constructor(name: string);
  55831. /**
  55832. * Gets the current class name
  55833. * @returns the class name
  55834. */
  55835. getClassName(): string;
  55836. /**
  55837. * Gets the first world row input component
  55838. */
  55839. readonly world0: NodeMaterialConnectionPoint;
  55840. /**
  55841. * Gets the second world row input component
  55842. */
  55843. readonly world1: NodeMaterialConnectionPoint;
  55844. /**
  55845. * Gets the third world row input component
  55846. */
  55847. readonly world2: NodeMaterialConnectionPoint;
  55848. /**
  55849. * Gets the forth world row input component
  55850. */
  55851. readonly world3: NodeMaterialConnectionPoint;
  55852. /**
  55853. * Gets the world input component
  55854. */
  55855. readonly world: NodeMaterialConnectionPoint;
  55856. /**
  55857. * Gets the output component
  55858. */
  55859. readonly output: NodeMaterialConnectionPoint;
  55860. autoConfigure(material: NodeMaterial): void;
  55861. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  55862. protected _buildBlock(state: NodeMaterialBuildState): this;
  55863. }
  55864. }
  55865. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  55866. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55867. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55868. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55869. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55870. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55871. import { Effect } from "babylonjs/Materials/effect";
  55872. import { Mesh } from "babylonjs/Meshes/mesh";
  55873. /**
  55874. * Block used to add morph targets support to vertex shader
  55875. */
  55876. export class MorphTargetsBlock extends NodeMaterialBlock {
  55877. private _repeatableContentAnchor;
  55878. private _repeatebleContentGenerated;
  55879. /**
  55880. * Create a new MorphTargetsBlock
  55881. * @param name defines the block name
  55882. */
  55883. constructor(name: string);
  55884. /**
  55885. * Gets the current class name
  55886. * @returns the class name
  55887. */
  55888. getClassName(): string;
  55889. /**
  55890. * Gets the position input component
  55891. */
  55892. readonly position: NodeMaterialConnectionPoint;
  55893. /**
  55894. * Gets the normal input component
  55895. */
  55896. readonly normal: NodeMaterialConnectionPoint;
  55897. /**
  55898. * Gets the tangent input component
  55899. */
  55900. readonly tangent: NodeMaterialConnectionPoint;
  55901. /**
  55902. * Gets the tangent input component
  55903. */
  55904. readonly uv: NodeMaterialConnectionPoint;
  55905. /**
  55906. * Gets the position output component
  55907. */
  55908. readonly positionOutput: NodeMaterialConnectionPoint;
  55909. /**
  55910. * Gets the normal output component
  55911. */
  55912. readonly normalOutput: NodeMaterialConnectionPoint;
  55913. /**
  55914. * Gets the tangent output component
  55915. */
  55916. readonly tangentOutput: NodeMaterialConnectionPoint;
  55917. /**
  55918. * Gets the tangent output component
  55919. */
  55920. readonly uvOutput: NodeMaterialConnectionPoint;
  55921. initialize(state: NodeMaterialBuildState): void;
  55922. autoConfigure(material: NodeMaterial): void;
  55923. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55924. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55925. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  55926. protected _buildBlock(state: NodeMaterialBuildState): this;
  55927. }
  55928. }
  55929. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  55930. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55931. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55932. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55933. import { Nullable } from "babylonjs/types";
  55934. import { Scene } from "babylonjs/scene";
  55935. import { Effect } from "babylonjs/Materials/effect";
  55936. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  55937. import { Mesh } from "babylonjs/Meshes/mesh";
  55938. import { Light } from "babylonjs/Lights/light";
  55939. /**
  55940. * Block used to get data information from a light
  55941. */
  55942. export class LightInformationBlock extends NodeMaterialBlock {
  55943. private _lightDataDefineName;
  55944. private _lightColorDefineName;
  55945. /**
  55946. * Gets or sets the light associated with this block
  55947. */
  55948. light: Nullable<Light>;
  55949. /**
  55950. * Creates a new LightInformationBlock
  55951. * @param name defines the block name
  55952. */
  55953. constructor(name: string);
  55954. /**
  55955. * Gets the current class name
  55956. * @returns the class name
  55957. */
  55958. getClassName(): string;
  55959. /**
  55960. * Gets the world position input component
  55961. */
  55962. readonly worldPosition: NodeMaterialConnectionPoint;
  55963. /**
  55964. * Gets the direction output component
  55965. */
  55966. readonly direction: NodeMaterialConnectionPoint;
  55967. /**
  55968. * Gets the direction output component
  55969. */
  55970. readonly color: NodeMaterialConnectionPoint;
  55971. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55972. protected _buildBlock(state: NodeMaterialBuildState): this;
  55973. serialize(): any;
  55974. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55975. }
  55976. }
  55977. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  55978. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  55979. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  55980. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  55981. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  55982. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  55983. }
  55984. declare module "babylonjs/Materials/Node/Blocks/Fragment/alphaTestBlock" {
  55985. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55986. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55987. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55988. import { Scene } from "babylonjs/scene";
  55989. /**
  55990. * Block used to add an alpha test in the fragment shader
  55991. */
  55992. export class AlphaTestBlock extends NodeMaterialBlock {
  55993. /**
  55994. * Gets or sets the alpha value where alpha testing happens
  55995. */
  55996. alphaCutOff: number;
  55997. /**
  55998. * Create a new AlphaTestBlock
  55999. * @param name defines the block name
  56000. */
  56001. constructor(name: string);
  56002. /**
  56003. * Gets the current class name
  56004. * @returns the class name
  56005. */
  56006. getClassName(): string;
  56007. /**
  56008. * Gets the color input component
  56009. */
  56010. readonly color: NodeMaterialConnectionPoint;
  56011. /**
  56012. * Gets the alpha input component
  56013. */
  56014. readonly alpha: NodeMaterialConnectionPoint;
  56015. protected _buildBlock(state: NodeMaterialBuildState): this;
  56016. protected _dumpPropertiesCode(): string;
  56017. serialize(): any;
  56018. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56019. }
  56020. }
  56021. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  56022. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56023. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56024. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56025. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56026. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56027. import { Effect } from "babylonjs/Materials/effect";
  56028. import { Mesh } from "babylonjs/Meshes/mesh";
  56029. /**
  56030. * Block used to add image processing support to fragment shader
  56031. */
  56032. export class ImageProcessingBlock extends NodeMaterialBlock {
  56033. /**
  56034. * Create a new ImageProcessingBlock
  56035. * @param name defines the block name
  56036. */
  56037. constructor(name: string);
  56038. /**
  56039. * Gets the current class name
  56040. * @returns the class name
  56041. */
  56042. getClassName(): string;
  56043. /**
  56044. * Gets the color input component
  56045. */
  56046. readonly color: NodeMaterialConnectionPoint;
  56047. /**
  56048. * Gets the output component
  56049. */
  56050. readonly output: NodeMaterialConnectionPoint;
  56051. /**
  56052. * Initialize the block and prepare the context for build
  56053. * @param state defines the state that will be used for the build
  56054. */
  56055. initialize(state: NodeMaterialBuildState): void;
  56056. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  56057. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56058. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56059. protected _buildBlock(state: NodeMaterialBuildState): this;
  56060. }
  56061. }
  56062. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  56063. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56064. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56065. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56066. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56067. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56068. import { Effect } from "babylonjs/Materials/effect";
  56069. import { Mesh } from "babylonjs/Meshes/mesh";
  56070. import { Scene } from "babylonjs/scene";
  56071. /**
  56072. * Block used to pertub normals based on a normal map
  56073. */
  56074. export class PerturbNormalBlock extends NodeMaterialBlock {
  56075. private _tangentSpaceParameterName;
  56076. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  56077. invertX: boolean;
  56078. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  56079. invertY: boolean;
  56080. /**
  56081. * Create a new PerturbNormalBlock
  56082. * @param name defines the block name
  56083. */
  56084. constructor(name: string);
  56085. /**
  56086. * Gets the current class name
  56087. * @returns the class name
  56088. */
  56089. getClassName(): string;
  56090. /**
  56091. * Gets the world position input component
  56092. */
  56093. readonly worldPosition: NodeMaterialConnectionPoint;
  56094. /**
  56095. * Gets the world normal input component
  56096. */
  56097. readonly worldNormal: NodeMaterialConnectionPoint;
  56098. /**
  56099. * Gets the uv input component
  56100. */
  56101. readonly uv: NodeMaterialConnectionPoint;
  56102. /**
  56103. * Gets the normal map color input component
  56104. */
  56105. readonly normalMapColor: NodeMaterialConnectionPoint;
  56106. /**
  56107. * Gets the strength input component
  56108. */
  56109. readonly strength: NodeMaterialConnectionPoint;
  56110. /**
  56111. * Gets the output component
  56112. */
  56113. readonly output: NodeMaterialConnectionPoint;
  56114. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56115. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56116. autoConfigure(material: NodeMaterial): void;
  56117. protected _buildBlock(state: NodeMaterialBuildState): this;
  56118. protected _dumpPropertiesCode(): string;
  56119. serialize(): any;
  56120. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56121. }
  56122. }
  56123. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  56124. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  56125. export * from "babylonjs/Materials/Node/Blocks/Fragment/alphaTestBlock";
  56126. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  56127. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  56128. }
  56129. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  56130. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56131. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56132. import { Mesh } from "babylonjs/Meshes/mesh";
  56133. import { Effect } from "babylonjs/Materials/effect";
  56134. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56135. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56136. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56137. /**
  56138. * Block used to add support for scene fog
  56139. */
  56140. export class FogBlock extends NodeMaterialBlock {
  56141. private _fogDistanceName;
  56142. private _fogParameters;
  56143. /**
  56144. * Create a new FogBlock
  56145. * @param name defines the block name
  56146. */
  56147. constructor(name: string);
  56148. /**
  56149. * Gets the current class name
  56150. * @returns the class name
  56151. */
  56152. getClassName(): string;
  56153. /**
  56154. * Gets the world position input component
  56155. */
  56156. readonly worldPosition: NodeMaterialConnectionPoint;
  56157. /**
  56158. * Gets the view input component
  56159. */
  56160. readonly view: NodeMaterialConnectionPoint;
  56161. /**
  56162. * Gets the color input component
  56163. */
  56164. readonly input: NodeMaterialConnectionPoint;
  56165. /**
  56166. * Gets the fog color input component
  56167. */
  56168. readonly fogColor: NodeMaterialConnectionPoint;
  56169. /**
  56170. * Gets the output component
  56171. */
  56172. readonly output: NodeMaterialConnectionPoint;
  56173. autoConfigure(material: NodeMaterial): void;
  56174. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56175. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56176. protected _buildBlock(state: NodeMaterialBuildState): this;
  56177. }
  56178. }
  56179. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  56180. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56181. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56182. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56183. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56184. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56185. import { Effect } from "babylonjs/Materials/effect";
  56186. import { Mesh } from "babylonjs/Meshes/mesh";
  56187. import { Light } from "babylonjs/Lights/light";
  56188. import { Nullable } from "babylonjs/types";
  56189. import { Scene } from "babylonjs/scene";
  56190. /**
  56191. * Block used to add light in the fragment shader
  56192. */
  56193. export class LightBlock extends NodeMaterialBlock {
  56194. private _lightId;
  56195. /**
  56196. * Gets or sets the light associated with this block
  56197. */
  56198. light: Nullable<Light>;
  56199. /**
  56200. * Create a new LightBlock
  56201. * @param name defines the block name
  56202. */
  56203. constructor(name: string);
  56204. /**
  56205. * Gets the current class name
  56206. * @returns the class name
  56207. */
  56208. getClassName(): string;
  56209. /**
  56210. * Gets the world position input component
  56211. */
  56212. readonly worldPosition: NodeMaterialConnectionPoint;
  56213. /**
  56214. * Gets the world normal input component
  56215. */
  56216. readonly worldNormal: NodeMaterialConnectionPoint;
  56217. /**
  56218. * Gets the camera (or eye) position component
  56219. */
  56220. readonly cameraPosition: NodeMaterialConnectionPoint;
  56221. /**
  56222. * Gets the diffuse output component
  56223. */
  56224. readonly diffuseOutput: NodeMaterialConnectionPoint;
  56225. /**
  56226. * Gets the specular output component
  56227. */
  56228. readonly specularOutput: NodeMaterialConnectionPoint;
  56229. autoConfigure(material: NodeMaterial): void;
  56230. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56231. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56232. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56233. private _injectVertexCode;
  56234. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56235. serialize(): any;
  56236. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56237. }
  56238. }
  56239. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  56240. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  56241. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  56242. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56243. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56244. }
  56245. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  56246. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56247. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  56248. }
  56249. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  56250. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56251. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56252. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56253. /**
  56254. * Block used to multiply 2 values
  56255. */
  56256. export class MultiplyBlock extends NodeMaterialBlock {
  56257. /**
  56258. * Creates a new MultiplyBlock
  56259. * @param name defines the block name
  56260. */
  56261. constructor(name: string);
  56262. /**
  56263. * Gets the current class name
  56264. * @returns the class name
  56265. */
  56266. getClassName(): string;
  56267. /**
  56268. * Gets the left operand input component
  56269. */
  56270. readonly left: NodeMaterialConnectionPoint;
  56271. /**
  56272. * Gets the right operand input component
  56273. */
  56274. readonly right: NodeMaterialConnectionPoint;
  56275. /**
  56276. * Gets the output component
  56277. */
  56278. readonly output: NodeMaterialConnectionPoint;
  56279. protected _buildBlock(state: NodeMaterialBuildState): this;
  56280. }
  56281. }
  56282. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  56283. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56284. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56285. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56286. /**
  56287. * Block used to add 2 vectors
  56288. */
  56289. export class AddBlock extends NodeMaterialBlock {
  56290. /**
  56291. * Creates a new AddBlock
  56292. * @param name defines the block name
  56293. */
  56294. constructor(name: string);
  56295. /**
  56296. * Gets the current class name
  56297. * @returns the class name
  56298. */
  56299. getClassName(): string;
  56300. /**
  56301. * Gets the left operand input component
  56302. */
  56303. readonly left: NodeMaterialConnectionPoint;
  56304. /**
  56305. * Gets the right operand input component
  56306. */
  56307. readonly right: NodeMaterialConnectionPoint;
  56308. /**
  56309. * Gets the output component
  56310. */
  56311. readonly output: NodeMaterialConnectionPoint;
  56312. protected _buildBlock(state: NodeMaterialBuildState): this;
  56313. }
  56314. }
  56315. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  56316. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56317. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56318. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56319. /**
  56320. * Block used to scale a vector by a float
  56321. */
  56322. export class ScaleBlock extends NodeMaterialBlock {
  56323. /**
  56324. * Creates a new ScaleBlock
  56325. * @param name defines the block name
  56326. */
  56327. constructor(name: string);
  56328. /**
  56329. * Gets the current class name
  56330. * @returns the class name
  56331. */
  56332. getClassName(): string;
  56333. /**
  56334. * Gets the input component
  56335. */
  56336. readonly input: NodeMaterialConnectionPoint;
  56337. /**
  56338. * Gets the factor input component
  56339. */
  56340. readonly factor: NodeMaterialConnectionPoint;
  56341. /**
  56342. * Gets the output component
  56343. */
  56344. readonly output: NodeMaterialConnectionPoint;
  56345. protected _buildBlock(state: NodeMaterialBuildState): this;
  56346. }
  56347. }
  56348. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  56349. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56350. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56351. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56352. import { Scene } from "babylonjs/scene";
  56353. /**
  56354. * Block used to clamp a float
  56355. */
  56356. export class ClampBlock extends NodeMaterialBlock {
  56357. /** Gets or sets the minimum range */
  56358. minimum: number;
  56359. /** Gets or sets the maximum range */
  56360. maximum: number;
  56361. /**
  56362. * Creates a new ClampBlock
  56363. * @param name defines the block name
  56364. */
  56365. constructor(name: string);
  56366. /**
  56367. * Gets the current class name
  56368. * @returns the class name
  56369. */
  56370. getClassName(): string;
  56371. /**
  56372. * Gets the value input component
  56373. */
  56374. readonly value: NodeMaterialConnectionPoint;
  56375. /**
  56376. * Gets the output component
  56377. */
  56378. readonly output: NodeMaterialConnectionPoint;
  56379. protected _buildBlock(state: NodeMaterialBuildState): this;
  56380. protected _dumpPropertiesCode(): string;
  56381. serialize(): any;
  56382. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56383. }
  56384. }
  56385. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  56386. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56387. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56388. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56389. /**
  56390. * Block used to apply a cross product between 2 vectors
  56391. */
  56392. export class CrossBlock extends NodeMaterialBlock {
  56393. /**
  56394. * Creates a new CrossBlock
  56395. * @param name defines the block name
  56396. */
  56397. constructor(name: string);
  56398. /**
  56399. * Gets the current class name
  56400. * @returns the class name
  56401. */
  56402. getClassName(): string;
  56403. /**
  56404. * Gets the left operand input component
  56405. */
  56406. readonly left: NodeMaterialConnectionPoint;
  56407. /**
  56408. * Gets the right operand input component
  56409. */
  56410. readonly right: NodeMaterialConnectionPoint;
  56411. /**
  56412. * Gets the output component
  56413. */
  56414. readonly output: NodeMaterialConnectionPoint;
  56415. protected _buildBlock(state: NodeMaterialBuildState): this;
  56416. }
  56417. }
  56418. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  56419. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56420. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56421. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56422. /**
  56423. * Block used to apply a dot product between 2 vectors
  56424. */
  56425. export class DotBlock extends NodeMaterialBlock {
  56426. /**
  56427. * Creates a new DotBlock
  56428. * @param name defines the block name
  56429. */
  56430. constructor(name: string);
  56431. /**
  56432. * Gets the current class name
  56433. * @returns the class name
  56434. */
  56435. getClassName(): string;
  56436. /**
  56437. * Gets the left operand input component
  56438. */
  56439. readonly left: NodeMaterialConnectionPoint;
  56440. /**
  56441. * Gets the right operand input component
  56442. */
  56443. readonly right: NodeMaterialConnectionPoint;
  56444. /**
  56445. * Gets the output component
  56446. */
  56447. readonly output: NodeMaterialConnectionPoint;
  56448. protected _buildBlock(state: NodeMaterialBuildState): this;
  56449. }
  56450. }
  56451. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  56452. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56453. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56454. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56455. import { Vector2 } from "babylonjs/Maths/math.vector";
  56456. import { Scene } from "babylonjs/scene";
  56457. /**
  56458. * Block used to remap a float from a range to a new one
  56459. */
  56460. export class RemapBlock extends NodeMaterialBlock {
  56461. /**
  56462. * Gets or sets the source range
  56463. */
  56464. sourceRange: Vector2;
  56465. /**
  56466. * Gets or sets the target range
  56467. */
  56468. targetRange: Vector2;
  56469. /**
  56470. * Creates a new RemapBlock
  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 input component
  56481. */
  56482. readonly input: NodeMaterialConnectionPoint;
  56483. /**
  56484. * Gets the source min input component
  56485. */
  56486. readonly sourceMin: NodeMaterialConnectionPoint;
  56487. /**
  56488. * Gets the source max input component
  56489. */
  56490. readonly sourceMax: NodeMaterialConnectionPoint;
  56491. /**
  56492. * Gets the target min input component
  56493. */
  56494. readonly targetMin: NodeMaterialConnectionPoint;
  56495. /**
  56496. * Gets the target max input component
  56497. */
  56498. readonly targetMax: NodeMaterialConnectionPoint;
  56499. /**
  56500. * Gets the output component
  56501. */
  56502. readonly output: NodeMaterialConnectionPoint;
  56503. protected _buildBlock(state: NodeMaterialBuildState): this;
  56504. protected _dumpPropertiesCode(): string;
  56505. serialize(): any;
  56506. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56507. }
  56508. }
  56509. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  56510. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56511. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56512. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56513. /**
  56514. * Block used to normalize a vector
  56515. */
  56516. export class NormalizeBlock extends NodeMaterialBlock {
  56517. /**
  56518. * Creates a new NormalizeBlock
  56519. * @param name defines the block name
  56520. */
  56521. constructor(name: string);
  56522. /**
  56523. * Gets the current class name
  56524. * @returns the class name
  56525. */
  56526. getClassName(): string;
  56527. /**
  56528. * Gets the input component
  56529. */
  56530. readonly input: NodeMaterialConnectionPoint;
  56531. /**
  56532. * Gets the output component
  56533. */
  56534. readonly output: NodeMaterialConnectionPoint;
  56535. protected _buildBlock(state: NodeMaterialBuildState): this;
  56536. }
  56537. }
  56538. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  56539. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56540. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56541. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56542. import { Scene } from "babylonjs/scene";
  56543. /**
  56544. * Operations supported by the Trigonometry block
  56545. */
  56546. export enum TrigonometryBlockOperations {
  56547. /** Cos */
  56548. Cos = 0,
  56549. /** Sin */
  56550. Sin = 1,
  56551. /** Abs */
  56552. Abs = 2,
  56553. /** Exp */
  56554. Exp = 3,
  56555. /** Exp2 */
  56556. Exp2 = 4,
  56557. /** Round */
  56558. Round = 5,
  56559. /** Floor */
  56560. Floor = 6,
  56561. /** Ceiling */
  56562. Ceiling = 7
  56563. }
  56564. /**
  56565. * Block used to apply trigonometry operation to floats
  56566. */
  56567. export class TrigonometryBlock extends NodeMaterialBlock {
  56568. /**
  56569. * Gets or sets the operation applied by the block
  56570. */
  56571. operation: TrigonometryBlockOperations;
  56572. /**
  56573. * Creates a new TrigonometryBlock
  56574. * @param name defines the block name
  56575. */
  56576. constructor(name: string);
  56577. /**
  56578. * Gets the current class name
  56579. * @returns the class name
  56580. */
  56581. getClassName(): string;
  56582. /**
  56583. * Gets the input component
  56584. */
  56585. readonly input: NodeMaterialConnectionPoint;
  56586. /**
  56587. * Gets the output component
  56588. */
  56589. readonly output: NodeMaterialConnectionPoint;
  56590. protected _buildBlock(state: NodeMaterialBuildState): this;
  56591. serialize(): any;
  56592. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56593. }
  56594. }
  56595. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  56596. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56597. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56598. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56599. /**
  56600. * Block used to create a Color3/4 out of individual inputs (one for each component)
  56601. */
  56602. export class ColorMergerBlock extends NodeMaterialBlock {
  56603. /**
  56604. * Create a new ColorMergerBlock
  56605. * @param name defines the block name
  56606. */
  56607. constructor(name: string);
  56608. /**
  56609. * Gets the current class name
  56610. * @returns the class name
  56611. */
  56612. getClassName(): string;
  56613. /**
  56614. * Gets the r component (input)
  56615. */
  56616. readonly r: NodeMaterialConnectionPoint;
  56617. /**
  56618. * Gets the g component (input)
  56619. */
  56620. readonly g: NodeMaterialConnectionPoint;
  56621. /**
  56622. * Gets the b component (input)
  56623. */
  56624. readonly b: NodeMaterialConnectionPoint;
  56625. /**
  56626. * Gets the a component (input)
  56627. */
  56628. readonly a: NodeMaterialConnectionPoint;
  56629. /**
  56630. * Gets the rgba component (output)
  56631. */
  56632. readonly rgba: NodeMaterialConnectionPoint;
  56633. /**
  56634. * Gets the rgb component (output)
  56635. */
  56636. readonly rgb: NodeMaterialConnectionPoint;
  56637. protected _buildBlock(state: NodeMaterialBuildState): this;
  56638. }
  56639. }
  56640. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  56641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56642. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56643. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56644. /**
  56645. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  56646. */
  56647. export class VectorMergerBlock extends NodeMaterialBlock {
  56648. /**
  56649. * Create a new VectorMergerBlock
  56650. * @param name defines the block name
  56651. */
  56652. constructor(name: string);
  56653. /**
  56654. * Gets the current class name
  56655. * @returns the class name
  56656. */
  56657. getClassName(): string;
  56658. /**
  56659. * Gets the x component (input)
  56660. */
  56661. readonly x: NodeMaterialConnectionPoint;
  56662. /**
  56663. * Gets the y component (input)
  56664. */
  56665. readonly y: NodeMaterialConnectionPoint;
  56666. /**
  56667. * Gets the z component (input)
  56668. */
  56669. readonly z: NodeMaterialConnectionPoint;
  56670. /**
  56671. * Gets the w component (input)
  56672. */
  56673. readonly w: NodeMaterialConnectionPoint;
  56674. /**
  56675. * Gets the xyzw component (output)
  56676. */
  56677. readonly xyzw: NodeMaterialConnectionPoint;
  56678. /**
  56679. * Gets the xyz component (output)
  56680. */
  56681. readonly xyz: NodeMaterialConnectionPoint;
  56682. /**
  56683. * Gets the xy component (output)
  56684. */
  56685. readonly xy: NodeMaterialConnectionPoint;
  56686. protected _buildBlock(state: NodeMaterialBuildState): this;
  56687. }
  56688. }
  56689. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  56690. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56691. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56692. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56693. /**
  56694. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  56695. */
  56696. export class ColorSplitterBlock extends NodeMaterialBlock {
  56697. /**
  56698. * Create a new ColorSplitterBlock
  56699. * @param name defines the block name
  56700. */
  56701. constructor(name: string);
  56702. /**
  56703. * Gets the current class name
  56704. * @returns the class name
  56705. */
  56706. getClassName(): string;
  56707. /**
  56708. * Gets the rgba component (input)
  56709. */
  56710. readonly rgba: NodeMaterialConnectionPoint;
  56711. /**
  56712. * Gets the rgb component (input)
  56713. */
  56714. readonly rgbIn: NodeMaterialConnectionPoint;
  56715. /**
  56716. * Gets the rgb component (output)
  56717. */
  56718. readonly rgbOut: NodeMaterialConnectionPoint;
  56719. /**
  56720. * Gets the r component (output)
  56721. */
  56722. readonly r: NodeMaterialConnectionPoint;
  56723. /**
  56724. * Gets the g component (output)
  56725. */
  56726. readonly g: NodeMaterialConnectionPoint;
  56727. /**
  56728. * Gets the b component (output)
  56729. */
  56730. readonly b: NodeMaterialConnectionPoint;
  56731. /**
  56732. * Gets the a component (output)
  56733. */
  56734. readonly a: NodeMaterialConnectionPoint;
  56735. protected _inputRename(name: string): string;
  56736. protected _outputRename(name: string): string;
  56737. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56738. }
  56739. }
  56740. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  56741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56742. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56743. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56744. /**
  56745. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  56746. */
  56747. export class VectorSplitterBlock extends NodeMaterialBlock {
  56748. /**
  56749. * Create a new VectorSplitterBlock
  56750. * @param name defines the block name
  56751. */
  56752. constructor(name: string);
  56753. /**
  56754. * Gets the current class name
  56755. * @returns the class name
  56756. */
  56757. getClassName(): string;
  56758. /**
  56759. * Gets the xyzw component (input)
  56760. */
  56761. readonly xyzw: NodeMaterialConnectionPoint;
  56762. /**
  56763. * Gets the xyz component (input)
  56764. */
  56765. readonly xyzIn: NodeMaterialConnectionPoint;
  56766. /**
  56767. * Gets the xy component (input)
  56768. */
  56769. readonly xyIn: NodeMaterialConnectionPoint;
  56770. /**
  56771. * Gets the xyz component (output)
  56772. */
  56773. readonly xyzOut: NodeMaterialConnectionPoint;
  56774. /**
  56775. * Gets the xy component (output)
  56776. */
  56777. readonly xyOut: NodeMaterialConnectionPoint;
  56778. /**
  56779. * Gets the x component (output)
  56780. */
  56781. readonly x: NodeMaterialConnectionPoint;
  56782. /**
  56783. * Gets the y component (output)
  56784. */
  56785. readonly y: NodeMaterialConnectionPoint;
  56786. /**
  56787. * Gets the z component (output)
  56788. */
  56789. readonly z: NodeMaterialConnectionPoint;
  56790. /**
  56791. * Gets the w component (output)
  56792. */
  56793. readonly w: NodeMaterialConnectionPoint;
  56794. protected _inputRename(name: string): string;
  56795. protected _outputRename(name: string): string;
  56796. protected _buildBlock(state: NodeMaterialBuildState): this;
  56797. }
  56798. }
  56799. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  56800. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56801. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56802. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56803. /**
  56804. * Block used to lerp 2 values
  56805. */
  56806. export class LerpBlock extends NodeMaterialBlock {
  56807. /**
  56808. * Creates a new LerpBlock
  56809. * @param name defines the block name
  56810. */
  56811. constructor(name: string);
  56812. /**
  56813. * Gets the current class name
  56814. * @returns the class name
  56815. */
  56816. getClassName(): string;
  56817. /**
  56818. * Gets the left operand input component
  56819. */
  56820. readonly left: NodeMaterialConnectionPoint;
  56821. /**
  56822. * Gets the right operand input component
  56823. */
  56824. readonly right: NodeMaterialConnectionPoint;
  56825. /**
  56826. * Gets the gradient operand input component
  56827. */
  56828. readonly gradient: NodeMaterialConnectionPoint;
  56829. /**
  56830. * Gets the output component
  56831. */
  56832. readonly output: NodeMaterialConnectionPoint;
  56833. protected _buildBlock(state: NodeMaterialBuildState): this;
  56834. }
  56835. }
  56836. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  56837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56840. /**
  56841. * Block used to divide 2 vectors
  56842. */
  56843. export class DivideBlock extends NodeMaterialBlock {
  56844. /**
  56845. * Creates a new DivideBlock
  56846. * @param name defines the block name
  56847. */
  56848. constructor(name: string);
  56849. /**
  56850. * Gets the current class name
  56851. * @returns the class name
  56852. */
  56853. getClassName(): string;
  56854. /**
  56855. * Gets the left operand input component
  56856. */
  56857. readonly left: NodeMaterialConnectionPoint;
  56858. /**
  56859. * Gets the right operand input component
  56860. */
  56861. readonly right: NodeMaterialConnectionPoint;
  56862. /**
  56863. * Gets the output component
  56864. */
  56865. readonly output: NodeMaterialConnectionPoint;
  56866. protected _buildBlock(state: NodeMaterialBuildState): this;
  56867. }
  56868. }
  56869. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  56870. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56871. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56872. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56873. /**
  56874. * Block used to subtract 2 vectors
  56875. */
  56876. export class SubtractBlock extends NodeMaterialBlock {
  56877. /**
  56878. * Creates a new SubtractBlock
  56879. * @param name defines the block name
  56880. */
  56881. constructor(name: string);
  56882. /**
  56883. * Gets the current class name
  56884. * @returns the class name
  56885. */
  56886. getClassName(): string;
  56887. /**
  56888. * Gets the left operand input component
  56889. */
  56890. readonly left: NodeMaterialConnectionPoint;
  56891. /**
  56892. * Gets the right operand input component
  56893. */
  56894. readonly right: NodeMaterialConnectionPoint;
  56895. /**
  56896. * Gets the output component
  56897. */
  56898. readonly output: NodeMaterialConnectionPoint;
  56899. protected _buildBlock(state: NodeMaterialBuildState): this;
  56900. }
  56901. }
  56902. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  56903. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56904. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56905. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56906. /**
  56907. * Block used to step a value
  56908. */
  56909. export class StepBlock extends NodeMaterialBlock {
  56910. /**
  56911. * Creates a new AddBlock
  56912. * @param name defines the block name
  56913. */
  56914. constructor(name: string);
  56915. /**
  56916. * Gets the current class name
  56917. * @returns the class name
  56918. */
  56919. getClassName(): string;
  56920. /**
  56921. * Gets the value operand input component
  56922. */
  56923. readonly value: NodeMaterialConnectionPoint;
  56924. /**
  56925. * Gets the edge operand input component
  56926. */
  56927. readonly edge: NodeMaterialConnectionPoint;
  56928. /**
  56929. * Gets the output component
  56930. */
  56931. readonly output: NodeMaterialConnectionPoint;
  56932. protected _buildBlock(state: NodeMaterialBuildState): this;
  56933. }
  56934. }
  56935. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  56936. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56937. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56938. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56939. /**
  56940. * Block used to get the opposite (1 - x) of a value
  56941. */
  56942. export class OneMinusBlock extends NodeMaterialBlock {
  56943. /**
  56944. * Creates a new OneMinusBlock
  56945. * @param name defines the block name
  56946. */
  56947. constructor(name: string);
  56948. /**
  56949. * Gets the current class name
  56950. * @returns the class name
  56951. */
  56952. getClassName(): string;
  56953. /**
  56954. * Gets the input component
  56955. */
  56956. readonly input: NodeMaterialConnectionPoint;
  56957. /**
  56958. * Gets the output component
  56959. */
  56960. readonly output: NodeMaterialConnectionPoint;
  56961. protected _buildBlock(state: NodeMaterialBuildState): this;
  56962. }
  56963. }
  56964. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  56965. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56966. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56967. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56968. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  56969. /**
  56970. * Block used to get the view direction
  56971. */
  56972. export class ViewDirectionBlock extends NodeMaterialBlock {
  56973. /**
  56974. * Creates a new ViewDirectionBlock
  56975. * @param name defines the block name
  56976. */
  56977. constructor(name: string);
  56978. /**
  56979. * Gets the current class name
  56980. * @returns the class name
  56981. */
  56982. getClassName(): string;
  56983. /**
  56984. * Gets the world position component
  56985. */
  56986. readonly worldPosition: NodeMaterialConnectionPoint;
  56987. /**
  56988. * Gets the camera position component
  56989. */
  56990. readonly cameraPosition: NodeMaterialConnectionPoint;
  56991. /**
  56992. * Gets the output component
  56993. */
  56994. readonly output: NodeMaterialConnectionPoint;
  56995. autoConfigure(material: NodeMaterial): void;
  56996. protected _buildBlock(state: NodeMaterialBuildState): this;
  56997. }
  56998. }
  56999. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  57000. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57001. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57002. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57003. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  57004. /**
  57005. * Block used to compute fresnel value
  57006. */
  57007. export class FresnelBlock extends NodeMaterialBlock {
  57008. /**
  57009. * Create a new FresnelBlock
  57010. * @param name defines the block name
  57011. */
  57012. constructor(name: string);
  57013. /**
  57014. * Gets the current class name
  57015. * @returns the class name
  57016. */
  57017. getClassName(): string;
  57018. /**
  57019. * Gets the world normal input component
  57020. */
  57021. readonly worldNormal: NodeMaterialConnectionPoint;
  57022. /**
  57023. * Gets the view direction input component
  57024. */
  57025. readonly viewDirection: NodeMaterialConnectionPoint;
  57026. /**
  57027. * Gets the bias input component
  57028. */
  57029. readonly bias: NodeMaterialConnectionPoint;
  57030. /**
  57031. * Gets the camera (or eye) position component
  57032. */
  57033. readonly power: NodeMaterialConnectionPoint;
  57034. /**
  57035. * Gets the fresnel output component
  57036. */
  57037. readonly fresnel: NodeMaterialConnectionPoint;
  57038. autoConfigure(material: NodeMaterial): void;
  57039. protected _buildBlock(state: NodeMaterialBuildState): this;
  57040. }
  57041. }
  57042. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  57043. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57044. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57045. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57046. /**
  57047. * Block used to get the max of 2 values
  57048. */
  57049. export class MaxBlock extends NodeMaterialBlock {
  57050. /**
  57051. * Creates a new MaxBlock
  57052. * @param name defines the block name
  57053. */
  57054. constructor(name: string);
  57055. /**
  57056. * Gets the current class name
  57057. * @returns the class name
  57058. */
  57059. getClassName(): string;
  57060. /**
  57061. * Gets the left operand input component
  57062. */
  57063. readonly left: NodeMaterialConnectionPoint;
  57064. /**
  57065. * Gets the right operand input component
  57066. */
  57067. readonly right: NodeMaterialConnectionPoint;
  57068. /**
  57069. * Gets the output component
  57070. */
  57071. readonly output: NodeMaterialConnectionPoint;
  57072. protected _buildBlock(state: NodeMaterialBuildState): this;
  57073. }
  57074. }
  57075. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  57076. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57077. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57078. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57079. /**
  57080. * Block used to get the min of 2 values
  57081. */
  57082. export class MinBlock extends NodeMaterialBlock {
  57083. /**
  57084. * Creates a new MinBlock
  57085. * @param name defines the block name
  57086. */
  57087. constructor(name: string);
  57088. /**
  57089. * Gets the current class name
  57090. * @returns the class name
  57091. */
  57092. getClassName(): string;
  57093. /**
  57094. * Gets the left operand input component
  57095. */
  57096. readonly left: NodeMaterialConnectionPoint;
  57097. /**
  57098. * Gets the right operand input component
  57099. */
  57100. readonly right: NodeMaterialConnectionPoint;
  57101. /**
  57102. * Gets the output component
  57103. */
  57104. readonly output: NodeMaterialConnectionPoint;
  57105. protected _buildBlock(state: NodeMaterialBuildState): this;
  57106. }
  57107. }
  57108. declare module "babylonjs/Materials/Node/Blocks/index" {
  57109. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  57110. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  57111. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  57112. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  57113. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  57114. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  57115. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  57116. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  57117. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  57118. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  57119. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  57120. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  57121. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  57122. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  57123. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  57124. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  57125. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  57126. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  57127. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  57128. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  57129. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  57130. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  57131. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  57132. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  57133. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  57134. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  57135. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  57136. }
  57137. declare module "babylonjs/Materials/Node/Optimizers/index" {
  57138. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  57139. }
  57140. declare module "babylonjs/Materials/Node/index" {
  57141. export * from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  57142. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  57143. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57144. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  57145. export * from "babylonjs/Materials/Node/nodeMaterial";
  57146. export * from "babylonjs/Materials/Node/nodeMaterialSystemValues";
  57147. export * from "babylonjs/Materials/Node/Blocks/index";
  57148. export * from "babylonjs/Materials/Node/Optimizers/index";
  57149. }
  57150. declare module "babylonjs/Materials/effectRenderer" {
  57151. import { Nullable } from "babylonjs/types";
  57152. import { Texture } from "babylonjs/Materials/Textures/texture";
  57153. import { Engine } from "babylonjs/Engines/engine";
  57154. import { Viewport } from "babylonjs/Maths/math.viewport";
  57155. import { Observable } from "babylonjs/Misc/observable";
  57156. import { Effect } from "babylonjs/Materials/effect";
  57157. import "babylonjs/Shaders/postprocess.vertex";
  57158. /**
  57159. * Effect Render Options
  57160. */
  57161. export interface IEffectRendererOptions {
  57162. /**
  57163. * Defines the vertices positions.
  57164. */
  57165. positions?: number[];
  57166. /**
  57167. * Defines the indices.
  57168. */
  57169. indices?: number[];
  57170. }
  57171. /**
  57172. * Helper class to render one or more effects
  57173. */
  57174. export class EffectRenderer {
  57175. private engine;
  57176. private static _DefaultOptions;
  57177. private _vertexBuffers;
  57178. private _indexBuffer;
  57179. private _ringBufferIndex;
  57180. private _ringScreenBuffer;
  57181. private _fullscreenViewport;
  57182. private _getNextFrameBuffer;
  57183. /**
  57184. * Creates an effect renderer
  57185. * @param engine the engine to use for rendering
  57186. * @param options defines the options of the effect renderer
  57187. */
  57188. constructor(engine: Engine, options?: IEffectRendererOptions);
  57189. /**
  57190. * Sets the current viewport in normalized coordinates 0-1
  57191. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  57192. */
  57193. setViewport(viewport?: Viewport): void;
  57194. /**
  57195. * Binds the embedded attributes buffer to the effect.
  57196. * @param effect Defines the effect to bind the attributes for
  57197. */
  57198. bindBuffers(effect: Effect): void;
  57199. /**
  57200. * Sets the current effect wrapper to use during draw.
  57201. * The effect needs to be ready before calling this api.
  57202. * This also sets the default full screen position attribute.
  57203. * @param effectWrapper Defines the effect to draw with
  57204. */
  57205. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  57206. /**
  57207. * Draws a full screen quad.
  57208. */
  57209. draw(): void;
  57210. /**
  57211. * renders one or more effects to a specified texture
  57212. * @param effectWrappers list of effects to renderer
  57213. * @param outputTexture texture to draw to, if null it will render to the screen
  57214. */
  57215. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  57216. /**
  57217. * Disposes of the effect renderer
  57218. */
  57219. dispose(): void;
  57220. }
  57221. /**
  57222. * Options to create an EffectWrapper
  57223. */
  57224. interface EffectWrapperCreationOptions {
  57225. /**
  57226. * Engine to use to create the effect
  57227. */
  57228. engine: Engine;
  57229. /**
  57230. * Fragment shader for the effect
  57231. */
  57232. fragmentShader: string;
  57233. /**
  57234. * Vertex shader for the effect
  57235. */
  57236. vertexShader?: string;
  57237. /**
  57238. * Attributes to use in the shader
  57239. */
  57240. attributeNames?: Array<string>;
  57241. /**
  57242. * Uniforms to use in the shader
  57243. */
  57244. uniformNames?: Array<string>;
  57245. /**
  57246. * Texture sampler names to use in the shader
  57247. */
  57248. samplerNames?: Array<string>;
  57249. /**
  57250. * The friendly name of the effect displayed in Spector.
  57251. */
  57252. name?: string;
  57253. }
  57254. /**
  57255. * Wraps an effect to be used for rendering
  57256. */
  57257. export class EffectWrapper {
  57258. /**
  57259. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  57260. */
  57261. onApplyObservable: Observable<{}>;
  57262. /**
  57263. * The underlying effect
  57264. */
  57265. effect: Effect;
  57266. /**
  57267. * Creates an effect to be renderer
  57268. * @param creationOptions options to create the effect
  57269. */
  57270. constructor(creationOptions: EffectWrapperCreationOptions);
  57271. /**
  57272. * Disposes of the effect wrapper
  57273. */
  57274. dispose(): void;
  57275. }
  57276. }
  57277. declare module "babylonjs/Materials/index" {
  57278. export * from "babylonjs/Materials/Background/index";
  57279. export * from "babylonjs/Materials/colorCurves";
  57280. export * from "babylonjs/Materials/effect";
  57281. export * from "babylonjs/Materials/fresnelParameters";
  57282. export * from "babylonjs/Materials/imageProcessingConfiguration";
  57283. export * from "babylonjs/Materials/material";
  57284. export * from "babylonjs/Materials/materialDefines";
  57285. export * from "babylonjs/Materials/materialHelper";
  57286. export * from "babylonjs/Materials/multiMaterial";
  57287. export * from "babylonjs/Materials/PBR/index";
  57288. export * from "babylonjs/Materials/pushMaterial";
  57289. export * from "babylonjs/Materials/shaderMaterial";
  57290. export * from "babylonjs/Materials/standardMaterial";
  57291. export * from "babylonjs/Materials/Textures/index";
  57292. export * from "babylonjs/Materials/uniformBuffer";
  57293. export * from "babylonjs/Materials/materialFlags";
  57294. export * from "babylonjs/Materials/Node/index";
  57295. export * from "babylonjs/Materials/effectRenderer";
  57296. }
  57297. declare module "babylonjs/Maths/index" {
  57298. export * from "babylonjs/Maths/math.scalar";
  57299. export * from "babylonjs/Maths/math";
  57300. export * from "babylonjs/Maths/sphericalPolynomial";
  57301. }
  57302. declare module "babylonjs/Misc/workerPool" {
  57303. import { IDisposable } from "babylonjs/scene";
  57304. /**
  57305. * Helper class to push actions to a pool of workers.
  57306. */
  57307. export class WorkerPool implements IDisposable {
  57308. private _workerInfos;
  57309. private _pendingActions;
  57310. /**
  57311. * Constructor
  57312. * @param workers Array of workers to use for actions
  57313. */
  57314. constructor(workers: Array<Worker>);
  57315. /**
  57316. * Terminates all workers and clears any pending actions.
  57317. */
  57318. dispose(): void;
  57319. /**
  57320. * Pushes an action to the worker pool. If all the workers are active, the action will be
  57321. * pended until a worker has completed its action.
  57322. * @param action The action to perform. Call onComplete when the action is complete.
  57323. */
  57324. push(action: (worker: Worker, onComplete: () => void) => void): void;
  57325. private _execute;
  57326. }
  57327. }
  57328. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  57329. import { IDisposable } from "babylonjs/scene";
  57330. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  57331. /**
  57332. * Configuration for Draco compression
  57333. */
  57334. export interface IDracoCompressionConfiguration {
  57335. /**
  57336. * Configuration for the decoder.
  57337. */
  57338. decoder: {
  57339. /**
  57340. * The url to the WebAssembly module.
  57341. */
  57342. wasmUrl?: string;
  57343. /**
  57344. * The url to the WebAssembly binary.
  57345. */
  57346. wasmBinaryUrl?: string;
  57347. /**
  57348. * The url to the fallback JavaScript module.
  57349. */
  57350. fallbackUrl?: string;
  57351. };
  57352. }
  57353. /**
  57354. * Draco compression (https://google.github.io/draco/)
  57355. *
  57356. * This class wraps the Draco module.
  57357. *
  57358. * **Encoder**
  57359. *
  57360. * The encoder is not currently implemented.
  57361. *
  57362. * **Decoder**
  57363. *
  57364. * 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.
  57365. *
  57366. * To update the configuration, use the following code:
  57367. * ```javascript
  57368. * DracoCompression.Configuration = {
  57369. * decoder: {
  57370. * wasmUrl: "<url to the WebAssembly library>",
  57371. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  57372. * fallbackUrl: "<url to the fallback JavaScript library>",
  57373. * }
  57374. * };
  57375. * ```
  57376. *
  57377. * 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.
  57378. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  57379. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  57380. *
  57381. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  57382. * ```javascript
  57383. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  57384. * ```
  57385. *
  57386. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  57387. */
  57388. export class DracoCompression implements IDisposable {
  57389. private _workerPoolPromise?;
  57390. private _decoderModulePromise?;
  57391. /**
  57392. * The configuration. Defaults to the following urls:
  57393. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  57394. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  57395. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  57396. */
  57397. static Configuration: IDracoCompressionConfiguration;
  57398. /**
  57399. * Returns true if the decoder configuration is available.
  57400. */
  57401. static readonly DecoderAvailable: boolean;
  57402. /**
  57403. * Default number of workers to create when creating the draco compression object.
  57404. */
  57405. static DefaultNumWorkers: number;
  57406. private static GetDefaultNumWorkers;
  57407. private static _Default;
  57408. /**
  57409. * Default instance for the draco compression object.
  57410. */
  57411. static readonly Default: DracoCompression;
  57412. /**
  57413. * Constructor
  57414. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  57415. */
  57416. constructor(numWorkers?: number);
  57417. /**
  57418. * Stop all async operations and release resources.
  57419. */
  57420. dispose(): void;
  57421. /**
  57422. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  57423. * @returns a promise that resolves when ready
  57424. */
  57425. whenReadyAsync(): Promise<void>;
  57426. /**
  57427. * Decode Draco compressed mesh data to vertex data.
  57428. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  57429. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  57430. * @returns A promise that resolves with the decoded vertex data
  57431. */
  57432. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  57433. [kind: string]: number;
  57434. }): Promise<VertexData>;
  57435. }
  57436. }
  57437. declare module "babylonjs/Meshes/Compression/index" {
  57438. export * from "babylonjs/Meshes/Compression/dracoCompression";
  57439. }
  57440. declare module "babylonjs/Meshes/csg" {
  57441. import { Nullable } from "babylonjs/types";
  57442. import { Scene } from "babylonjs/scene";
  57443. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  57444. import { Mesh } from "babylonjs/Meshes/mesh";
  57445. import { Material } from "babylonjs/Materials/material";
  57446. /**
  57447. * Class for building Constructive Solid Geometry
  57448. */
  57449. export class CSG {
  57450. private polygons;
  57451. /**
  57452. * The world matrix
  57453. */
  57454. matrix: Matrix;
  57455. /**
  57456. * Stores the position
  57457. */
  57458. position: Vector3;
  57459. /**
  57460. * Stores the rotation
  57461. */
  57462. rotation: Vector3;
  57463. /**
  57464. * Stores the rotation quaternion
  57465. */
  57466. rotationQuaternion: Nullable<Quaternion>;
  57467. /**
  57468. * Stores the scaling vector
  57469. */
  57470. scaling: Vector3;
  57471. /**
  57472. * Convert the Mesh to CSG
  57473. * @param mesh The Mesh to convert to CSG
  57474. * @returns A new CSG from the Mesh
  57475. */
  57476. static FromMesh(mesh: Mesh): CSG;
  57477. /**
  57478. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  57479. * @param polygons Polygons used to construct a CSG solid
  57480. */
  57481. private static FromPolygons;
  57482. /**
  57483. * Clones, or makes a deep copy, of the CSG
  57484. * @returns A new CSG
  57485. */
  57486. clone(): CSG;
  57487. /**
  57488. * Unions this CSG with another CSG
  57489. * @param csg The CSG to union against this CSG
  57490. * @returns The unioned CSG
  57491. */
  57492. union(csg: CSG): CSG;
  57493. /**
  57494. * Unions this CSG with another CSG in place
  57495. * @param csg The CSG to union against this CSG
  57496. */
  57497. unionInPlace(csg: CSG): void;
  57498. /**
  57499. * Subtracts this CSG with another CSG
  57500. * @param csg The CSG to subtract against this CSG
  57501. * @returns A new CSG
  57502. */
  57503. subtract(csg: CSG): CSG;
  57504. /**
  57505. * Subtracts this CSG with another CSG in place
  57506. * @param csg The CSG to subtact against this CSG
  57507. */
  57508. subtractInPlace(csg: CSG): void;
  57509. /**
  57510. * Intersect this CSG with another CSG
  57511. * @param csg The CSG to intersect against this CSG
  57512. * @returns A new CSG
  57513. */
  57514. intersect(csg: CSG): CSG;
  57515. /**
  57516. * Intersects this CSG with another CSG in place
  57517. * @param csg The CSG to intersect against this CSG
  57518. */
  57519. intersectInPlace(csg: CSG): void;
  57520. /**
  57521. * Return a new CSG solid with solid and empty space switched. This solid is
  57522. * not modified.
  57523. * @returns A new CSG solid with solid and empty space switched
  57524. */
  57525. inverse(): CSG;
  57526. /**
  57527. * Inverses the CSG in place
  57528. */
  57529. inverseInPlace(): void;
  57530. /**
  57531. * This is used to keep meshes transformations so they can be restored
  57532. * when we build back a Babylon Mesh
  57533. * NB : All CSG operations are performed in world coordinates
  57534. * @param csg The CSG to copy the transform attributes from
  57535. * @returns This CSG
  57536. */
  57537. copyTransformAttributes(csg: CSG): CSG;
  57538. /**
  57539. * Build Raw mesh from CSG
  57540. * Coordinates here are in world space
  57541. * @param name The name of the mesh geometry
  57542. * @param scene The Scene
  57543. * @param keepSubMeshes Specifies if the submeshes should be kept
  57544. * @returns A new Mesh
  57545. */
  57546. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  57547. /**
  57548. * Build Mesh from CSG taking material and transforms into account
  57549. * @param name The name of the Mesh
  57550. * @param material The material of the Mesh
  57551. * @param scene The Scene
  57552. * @param keepSubMeshes Specifies if submeshes should be kept
  57553. * @returns The new Mesh
  57554. */
  57555. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  57556. }
  57557. }
  57558. declare module "babylonjs/Meshes/trailMesh" {
  57559. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57560. import { Mesh } from "babylonjs/Meshes/mesh";
  57561. import { Scene } from "babylonjs/scene";
  57562. /**
  57563. * Class used to create a trail following a mesh
  57564. */
  57565. export class TrailMesh extends Mesh {
  57566. private _generator;
  57567. private _autoStart;
  57568. private _running;
  57569. private _diameter;
  57570. private _length;
  57571. private _sectionPolygonPointsCount;
  57572. private _sectionVectors;
  57573. private _sectionNormalVectors;
  57574. private _beforeRenderObserver;
  57575. /**
  57576. * @constructor
  57577. * @param name The value used by scene.getMeshByName() to do a lookup.
  57578. * @param generator The mesh to generate a trail.
  57579. * @param scene The scene to add this mesh to.
  57580. * @param diameter Diameter of trailing mesh. Default is 1.
  57581. * @param length Length of trailing mesh. Default is 60.
  57582. * @param autoStart Automatically start trailing mesh. Default true.
  57583. */
  57584. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  57585. /**
  57586. * "TrailMesh"
  57587. * @returns "TrailMesh"
  57588. */
  57589. getClassName(): string;
  57590. private _createMesh;
  57591. /**
  57592. * Start trailing mesh.
  57593. */
  57594. start(): void;
  57595. /**
  57596. * Stop trailing mesh.
  57597. */
  57598. stop(): void;
  57599. /**
  57600. * Update trailing mesh geometry.
  57601. */
  57602. update(): void;
  57603. /**
  57604. * Returns a new TrailMesh object.
  57605. * @param name is a string, the name given to the new mesh
  57606. * @param newGenerator use new generator object for cloned trail mesh
  57607. * @returns a new mesh
  57608. */
  57609. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  57610. /**
  57611. * Serializes this trail mesh
  57612. * @param serializationObject object to write serialization to
  57613. */
  57614. serialize(serializationObject: any): void;
  57615. /**
  57616. * Parses a serialized trail mesh
  57617. * @param parsedMesh the serialized mesh
  57618. * @param scene the scene to create the trail mesh in
  57619. * @returns the created trail mesh
  57620. */
  57621. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  57622. }
  57623. }
  57624. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  57625. import { Nullable } from "babylonjs/types";
  57626. import { Scene } from "babylonjs/scene";
  57627. import { Vector4 } from "babylonjs/Maths/math.vector";
  57628. import { Color4 } from "babylonjs/Maths/math.color";
  57629. import { Mesh } from "babylonjs/Meshes/mesh";
  57630. /**
  57631. * Class containing static functions to help procedurally build meshes
  57632. */
  57633. export class TiledBoxBuilder {
  57634. /**
  57635. * Creates a box mesh
  57636. * 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)
  57637. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  57638. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57639. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57641. * @param name defines the name of the mesh
  57642. * @param options defines the options used to create the mesh
  57643. * @param scene defines the hosting scene
  57644. * @returns the box mesh
  57645. */
  57646. static CreateTiledBox(name: string, options: {
  57647. pattern?: number;
  57648. width?: number;
  57649. height?: number;
  57650. depth?: number;
  57651. tileSize?: number;
  57652. tileWidth?: number;
  57653. tileHeight?: number;
  57654. alignHorizontal?: number;
  57655. alignVertical?: number;
  57656. faceUV?: Vector4[];
  57657. faceColors?: Color4[];
  57658. sideOrientation?: number;
  57659. updatable?: boolean;
  57660. }, scene?: Nullable<Scene>): Mesh;
  57661. }
  57662. }
  57663. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  57664. import { Vector4 } from "babylonjs/Maths/math.vector";
  57665. import { Mesh } from "babylonjs/Meshes/mesh";
  57666. /**
  57667. * Class containing static functions to help procedurally build meshes
  57668. */
  57669. export class TorusKnotBuilder {
  57670. /**
  57671. * Creates a torus knot mesh
  57672. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  57673. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  57674. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  57675. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  57676. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57677. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57678. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57679. * @param name defines the name of the mesh
  57680. * @param options defines the options used to create the mesh
  57681. * @param scene defines the hosting scene
  57682. * @returns the torus knot mesh
  57683. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  57684. */
  57685. static CreateTorusKnot(name: string, options: {
  57686. radius?: number;
  57687. tube?: number;
  57688. radialSegments?: number;
  57689. tubularSegments?: number;
  57690. p?: number;
  57691. q?: number;
  57692. updatable?: boolean;
  57693. sideOrientation?: number;
  57694. frontUVs?: Vector4;
  57695. backUVs?: Vector4;
  57696. }, scene: any): Mesh;
  57697. }
  57698. }
  57699. declare module "babylonjs/Meshes/polygonMesh" {
  57700. import { Scene } from "babylonjs/scene";
  57701. import { Vector2 } from "babylonjs/Maths/math.vector";
  57702. import { Mesh } from "babylonjs/Meshes/mesh";
  57703. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  57704. import { Path2 } from "babylonjs/Maths/math.path";
  57705. /**
  57706. * Polygon
  57707. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  57708. */
  57709. export class Polygon {
  57710. /**
  57711. * Creates a rectangle
  57712. * @param xmin bottom X coord
  57713. * @param ymin bottom Y coord
  57714. * @param xmax top X coord
  57715. * @param ymax top Y coord
  57716. * @returns points that make the resulting rectation
  57717. */
  57718. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  57719. /**
  57720. * Creates a circle
  57721. * @param radius radius of circle
  57722. * @param cx scale in x
  57723. * @param cy scale in y
  57724. * @param numberOfSides number of sides that make up the circle
  57725. * @returns points that make the resulting circle
  57726. */
  57727. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  57728. /**
  57729. * Creates a polygon from input string
  57730. * @param input Input polygon data
  57731. * @returns the parsed points
  57732. */
  57733. static Parse(input: string): Vector2[];
  57734. /**
  57735. * Starts building a polygon from x and y coordinates
  57736. * @param x x coordinate
  57737. * @param y y coordinate
  57738. * @returns the started path2
  57739. */
  57740. static StartingAt(x: number, y: number): Path2;
  57741. }
  57742. /**
  57743. * Builds a polygon
  57744. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  57745. */
  57746. export class PolygonMeshBuilder {
  57747. private _points;
  57748. private _outlinepoints;
  57749. private _holes;
  57750. private _name;
  57751. private _scene;
  57752. private _epoints;
  57753. private _eholes;
  57754. private _addToepoint;
  57755. /**
  57756. * Babylon reference to the earcut plugin.
  57757. */
  57758. bjsEarcut: any;
  57759. /**
  57760. * Creates a PolygonMeshBuilder
  57761. * @param name name of the builder
  57762. * @param contours Path of the polygon
  57763. * @param scene scene to add to when creating the mesh
  57764. * @param earcutInjection can be used to inject your own earcut reference
  57765. */
  57766. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  57767. /**
  57768. * Adds a whole within the polygon
  57769. * @param hole Array of points defining the hole
  57770. * @returns this
  57771. */
  57772. addHole(hole: Vector2[]): PolygonMeshBuilder;
  57773. /**
  57774. * Creates the polygon
  57775. * @param updatable If the mesh should be updatable
  57776. * @param depth The depth of the mesh created
  57777. * @returns the created mesh
  57778. */
  57779. build(updatable?: boolean, depth?: number): Mesh;
  57780. /**
  57781. * Creates the polygon
  57782. * @param depth The depth of the mesh created
  57783. * @returns the created VertexData
  57784. */
  57785. buildVertexData(depth?: number): VertexData;
  57786. /**
  57787. * Adds a side to the polygon
  57788. * @param positions points that make the polygon
  57789. * @param normals normals of the polygon
  57790. * @param uvs uvs of the polygon
  57791. * @param indices indices of the polygon
  57792. * @param bounds bounds of the polygon
  57793. * @param points points of the polygon
  57794. * @param depth depth of the polygon
  57795. * @param flip flip of the polygon
  57796. */
  57797. private addSide;
  57798. }
  57799. }
  57800. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  57801. import { Scene } from "babylonjs/scene";
  57802. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  57803. import { Color4 } from "babylonjs/Maths/math.color";
  57804. import { Mesh } from "babylonjs/Meshes/mesh";
  57805. import { Nullable } from "babylonjs/types";
  57806. /**
  57807. * Class containing static functions to help procedurally build meshes
  57808. */
  57809. export class PolygonBuilder {
  57810. /**
  57811. * Creates a polygon mesh
  57812. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  57813. * * 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
  57814. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  57815. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57816. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  57817. * * Remember you can only change the shape positions, not their number when updating a polygon
  57818. * @param name defines the name of the mesh
  57819. * @param options defines the options used to create the mesh
  57820. * @param scene defines the hosting scene
  57821. * @param earcutInjection can be used to inject your own earcut reference
  57822. * @returns the polygon mesh
  57823. */
  57824. static CreatePolygon(name: string, options: {
  57825. shape: Vector3[];
  57826. holes?: Vector3[][];
  57827. depth?: number;
  57828. faceUV?: Vector4[];
  57829. faceColors?: Color4[];
  57830. updatable?: boolean;
  57831. sideOrientation?: number;
  57832. frontUVs?: Vector4;
  57833. backUVs?: Vector4;
  57834. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  57835. /**
  57836. * Creates an extruded polygon mesh, with depth in the Y direction.
  57837. * * 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)
  57838. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  57839. * @param name defines the name of the mesh
  57840. * @param options defines the options used to create the mesh
  57841. * @param scene defines the hosting scene
  57842. * @param earcutInjection can be used to inject your own earcut reference
  57843. * @returns the polygon mesh
  57844. */
  57845. static ExtrudePolygon(name: string, options: {
  57846. shape: Vector3[];
  57847. holes?: Vector3[][];
  57848. depth?: number;
  57849. faceUV?: Vector4[];
  57850. faceColors?: Color4[];
  57851. updatable?: boolean;
  57852. sideOrientation?: number;
  57853. frontUVs?: Vector4;
  57854. backUVs?: Vector4;
  57855. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  57856. }
  57857. }
  57858. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  57859. import { Scene } from "babylonjs/scene";
  57860. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  57861. import { Mesh } from "babylonjs/Meshes/mesh";
  57862. import { Nullable } from "babylonjs/types";
  57863. /**
  57864. * Class containing static functions to help procedurally build meshes
  57865. */
  57866. export class LatheBuilder {
  57867. /**
  57868. * Creates lathe mesh.
  57869. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  57870. * * 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
  57871. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  57872. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  57873. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  57874. * * 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
  57875. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  57876. * * 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
  57877. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57878. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57879. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  57880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57881. * @param name defines the name of the mesh
  57882. * @param options defines the options used to create the mesh
  57883. * @param scene defines the hosting scene
  57884. * @returns the lathe mesh
  57885. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  57886. */
  57887. static CreateLathe(name: string, options: {
  57888. shape: Vector3[];
  57889. radius?: number;
  57890. tessellation?: number;
  57891. clip?: number;
  57892. arc?: number;
  57893. closed?: boolean;
  57894. updatable?: boolean;
  57895. sideOrientation?: number;
  57896. frontUVs?: Vector4;
  57897. backUVs?: Vector4;
  57898. cap?: number;
  57899. invertUV?: boolean;
  57900. }, scene?: Nullable<Scene>): Mesh;
  57901. }
  57902. }
  57903. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  57904. import { Nullable } from "babylonjs/types";
  57905. import { Scene } from "babylonjs/scene";
  57906. import { Vector4 } from "babylonjs/Maths/math.vector";
  57907. import { Mesh } from "babylonjs/Meshes/mesh";
  57908. /**
  57909. * Class containing static functions to help procedurally build meshes
  57910. */
  57911. export class TiledPlaneBuilder {
  57912. /**
  57913. * Creates a tiled plane mesh
  57914. * * The parameter `pattern` will, depending on value, do nothing or
  57915. * * * flip (reflect about central vertical) alternate tiles across and up
  57916. * * * flip every tile on alternate rows
  57917. * * * rotate (180 degs) alternate tiles across and up
  57918. * * * rotate every tile on alternate rows
  57919. * * * flip and rotate alternate tiles across and up
  57920. * * * flip and rotate every tile on alternate rows
  57921. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  57922. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  57923. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57924. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  57925. * * 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)
  57926. * * 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)
  57927. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  57928. * @param name defines the name of the mesh
  57929. * @param options defines the options used to create the mesh
  57930. * @param scene defines the hosting scene
  57931. * @returns the box mesh
  57932. */
  57933. static CreateTiledPlane(name: string, options: {
  57934. pattern?: number;
  57935. tileSize?: number;
  57936. tileWidth?: number;
  57937. tileHeight?: number;
  57938. size?: number;
  57939. width?: number;
  57940. height?: number;
  57941. alignHorizontal?: number;
  57942. alignVertical?: number;
  57943. sideOrientation?: number;
  57944. frontUVs?: Vector4;
  57945. backUVs?: Vector4;
  57946. updatable?: boolean;
  57947. }, scene?: Nullable<Scene>): Mesh;
  57948. }
  57949. }
  57950. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  57951. import { Nullable } from "babylonjs/types";
  57952. import { Scene } from "babylonjs/scene";
  57953. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  57954. import { Mesh } from "babylonjs/Meshes/mesh";
  57955. /**
  57956. * Class containing static functions to help procedurally build meshes
  57957. */
  57958. export class TubeBuilder {
  57959. /**
  57960. * Creates a tube mesh.
  57961. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  57962. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  57963. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  57964. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  57965. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  57966. * * 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)
  57967. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  57968. * * 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
  57969. * * 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
  57970. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57971. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57972. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  57973. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57974. * @param name defines the name of the mesh
  57975. * @param options defines the options used to create the mesh
  57976. * @param scene defines the hosting scene
  57977. * @returns the tube mesh
  57978. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  57979. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  57980. */
  57981. static CreateTube(name: string, options: {
  57982. path: Vector3[];
  57983. radius?: number;
  57984. tessellation?: number;
  57985. radiusFunction?: {
  57986. (i: number, distance: number): number;
  57987. };
  57988. cap?: number;
  57989. arc?: number;
  57990. updatable?: boolean;
  57991. sideOrientation?: number;
  57992. frontUVs?: Vector4;
  57993. backUVs?: Vector4;
  57994. instance?: Mesh;
  57995. invertUV?: boolean;
  57996. }, scene?: Nullable<Scene>): Mesh;
  57997. }
  57998. }
  57999. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  58000. import { Scene } from "babylonjs/scene";
  58001. import { Vector4 } from "babylonjs/Maths/math.vector";
  58002. import { Mesh } from "babylonjs/Meshes/mesh";
  58003. import { Nullable } from "babylonjs/types";
  58004. /**
  58005. * Class containing static functions to help procedurally build meshes
  58006. */
  58007. export class IcoSphereBuilder {
  58008. /**
  58009. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  58010. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  58011. * * 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`)
  58012. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  58013. * * 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
  58014. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58015. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58016. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58017. * @param name defines the name of the mesh
  58018. * @param options defines the options used to create the mesh
  58019. * @param scene defines the hosting scene
  58020. * @returns the icosahedron mesh
  58021. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  58022. */
  58023. static CreateIcoSphere(name: string, options: {
  58024. radius?: number;
  58025. radiusX?: number;
  58026. radiusY?: number;
  58027. radiusZ?: number;
  58028. flat?: boolean;
  58029. subdivisions?: number;
  58030. sideOrientation?: number;
  58031. frontUVs?: Vector4;
  58032. backUVs?: Vector4;
  58033. updatable?: boolean;
  58034. }, scene?: Nullable<Scene>): Mesh;
  58035. }
  58036. }
  58037. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  58038. import { Vector3 } from "babylonjs/Maths/math.vector";
  58039. import { Mesh } from "babylonjs/Meshes/mesh";
  58040. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58041. /**
  58042. * Class containing static functions to help procedurally build meshes
  58043. */
  58044. export class DecalBuilder {
  58045. /**
  58046. * Creates a decal mesh.
  58047. * 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
  58048. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  58049. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  58050. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  58051. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  58052. * @param name defines the name of the mesh
  58053. * @param sourceMesh defines the mesh where the decal must be applied
  58054. * @param options defines the options used to create the mesh
  58055. * @param scene defines the hosting scene
  58056. * @returns the decal mesh
  58057. * @see https://doc.babylonjs.com/how_to/decals
  58058. */
  58059. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  58060. position?: Vector3;
  58061. normal?: Vector3;
  58062. size?: Vector3;
  58063. angle?: number;
  58064. }): Mesh;
  58065. }
  58066. }
  58067. declare module "babylonjs/Meshes/meshBuilder" {
  58068. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  58069. import { Nullable } from "babylonjs/types";
  58070. import { Scene } from "babylonjs/scene";
  58071. import { Mesh } from "babylonjs/Meshes/mesh";
  58072. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  58073. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  58074. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58075. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  58076. import { Plane } from "babylonjs/Maths/math.plane";
  58077. /**
  58078. * Class containing static functions to help procedurally build meshes
  58079. */
  58080. export class MeshBuilder {
  58081. /**
  58082. * Creates a box mesh
  58083. * * The parameter `size` sets the size (float) of each box side (default 1)
  58084. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  58085. * * 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)
  58086. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  58087. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58088. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58089. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58090. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  58091. * @param name defines the name of the mesh
  58092. * @param options defines the options used to create the mesh
  58093. * @param scene defines the hosting scene
  58094. * @returns the box mesh
  58095. */
  58096. static CreateBox(name: string, options: {
  58097. size?: number;
  58098. width?: number;
  58099. height?: number;
  58100. depth?: number;
  58101. faceUV?: Vector4[];
  58102. faceColors?: Color4[];
  58103. sideOrientation?: number;
  58104. frontUVs?: Vector4;
  58105. backUVs?: Vector4;
  58106. updatable?: boolean;
  58107. }, scene?: Nullable<Scene>): Mesh;
  58108. /**
  58109. * Creates a tiled box mesh
  58110. * * faceTiles sets the pattern, tile size and number of tiles for a face
  58111. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58112. * @param name defines the name of the mesh
  58113. * @param options defines the options used to create the mesh
  58114. * @param scene defines the hosting scene
  58115. * @returns the tiled box mesh
  58116. */
  58117. static CreateTiledBox(name: string, options: {
  58118. pattern?: number;
  58119. size?: number;
  58120. width?: number;
  58121. height?: number;
  58122. depth: number;
  58123. tileSize?: number;
  58124. tileWidth?: number;
  58125. tileHeight?: number;
  58126. faceUV?: Vector4[];
  58127. faceColors?: Color4[];
  58128. alignHorizontal?: number;
  58129. alignVertical?: number;
  58130. sideOrientation?: number;
  58131. updatable?: boolean;
  58132. }, scene?: Nullable<Scene>): Mesh;
  58133. /**
  58134. * Creates a sphere mesh
  58135. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  58136. * * 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`)
  58137. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  58138. * * 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
  58139. * * 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)
  58140. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58141. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58142. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58143. * @param name defines the name of the mesh
  58144. * @param options defines the options used to create the mesh
  58145. * @param scene defines the hosting scene
  58146. * @returns the sphere mesh
  58147. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  58148. */
  58149. static CreateSphere(name: string, options: {
  58150. segments?: number;
  58151. diameter?: number;
  58152. diameterX?: number;
  58153. diameterY?: number;
  58154. diameterZ?: number;
  58155. arc?: number;
  58156. slice?: number;
  58157. sideOrientation?: number;
  58158. frontUVs?: Vector4;
  58159. backUVs?: Vector4;
  58160. updatable?: boolean;
  58161. }, scene?: Nullable<Scene>): Mesh;
  58162. /**
  58163. * Creates a plane polygonal mesh. By default, this is a disc
  58164. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  58165. * * 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
  58166. * * 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
  58167. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58168. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58169. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58170. * @param name defines the name of the mesh
  58171. * @param options defines the options used to create the mesh
  58172. * @param scene defines the hosting scene
  58173. * @returns the plane polygonal mesh
  58174. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  58175. */
  58176. static CreateDisc(name: string, options: {
  58177. radius?: number;
  58178. tessellation?: number;
  58179. arc?: number;
  58180. updatable?: boolean;
  58181. sideOrientation?: number;
  58182. frontUVs?: Vector4;
  58183. backUVs?: Vector4;
  58184. }, scene?: Nullable<Scene>): Mesh;
  58185. /**
  58186. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  58187. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  58188. * * 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`)
  58189. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  58190. * * 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
  58191. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58192. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58193. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58194. * @param name defines the name of the mesh
  58195. * @param options defines the options used to create the mesh
  58196. * @param scene defines the hosting scene
  58197. * @returns the icosahedron mesh
  58198. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  58199. */
  58200. static CreateIcoSphere(name: string, options: {
  58201. radius?: number;
  58202. radiusX?: number;
  58203. radiusY?: number;
  58204. radiusZ?: number;
  58205. flat?: boolean;
  58206. subdivisions?: number;
  58207. sideOrientation?: number;
  58208. frontUVs?: Vector4;
  58209. backUVs?: Vector4;
  58210. updatable?: boolean;
  58211. }, scene?: Nullable<Scene>): Mesh;
  58212. /**
  58213. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  58214. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  58215. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  58216. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  58217. * * 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
  58218. * * 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
  58219. * * 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
  58220. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58221. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58222. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  58223. * * 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
  58224. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  58225. * * 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
  58226. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  58227. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58228. * @param name defines the name of the mesh
  58229. * @param options defines the options used to create the mesh
  58230. * @param scene defines the hosting scene
  58231. * @returns the ribbon mesh
  58232. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  58233. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  58234. */
  58235. static CreateRibbon(name: string, options: {
  58236. pathArray: Vector3[][];
  58237. closeArray?: boolean;
  58238. closePath?: boolean;
  58239. offset?: number;
  58240. updatable?: boolean;
  58241. sideOrientation?: number;
  58242. frontUVs?: Vector4;
  58243. backUVs?: Vector4;
  58244. instance?: Mesh;
  58245. invertUV?: boolean;
  58246. uvs?: Vector2[];
  58247. colors?: Color4[];
  58248. }, scene?: Nullable<Scene>): Mesh;
  58249. /**
  58250. * Creates a cylinder or a cone mesh
  58251. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  58252. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  58253. * * 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.
  58254. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  58255. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  58256. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  58257. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  58258. * * 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).
  58259. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  58260. * * 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).
  58261. * * 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
  58262. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  58263. * * 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
  58264. * * 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.
  58265. * * If `enclose` is false, a ring surface is one element.
  58266. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  58267. * * 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
  58268. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58269. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58270. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58271. * @param name defines the name of the mesh
  58272. * @param options defines the options used to create the mesh
  58273. * @param scene defines the hosting scene
  58274. * @returns the cylinder mesh
  58275. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  58276. */
  58277. static CreateCylinder(name: string, options: {
  58278. height?: number;
  58279. diameterTop?: number;
  58280. diameterBottom?: number;
  58281. diameter?: number;
  58282. tessellation?: number;
  58283. subdivisions?: number;
  58284. arc?: number;
  58285. faceColors?: Color4[];
  58286. faceUV?: Vector4[];
  58287. updatable?: boolean;
  58288. hasRings?: boolean;
  58289. enclose?: boolean;
  58290. cap?: number;
  58291. sideOrientation?: number;
  58292. frontUVs?: Vector4;
  58293. backUVs?: Vector4;
  58294. }, scene?: Nullable<Scene>): Mesh;
  58295. /**
  58296. * Creates a torus mesh
  58297. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  58298. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  58299. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  58300. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58301. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58302. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58303. * @param name defines the name of the mesh
  58304. * @param options defines the options used to create the mesh
  58305. * @param scene defines the hosting scene
  58306. * @returns the torus mesh
  58307. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  58308. */
  58309. static CreateTorus(name: string, options: {
  58310. diameter?: number;
  58311. thickness?: number;
  58312. tessellation?: number;
  58313. updatable?: boolean;
  58314. sideOrientation?: number;
  58315. frontUVs?: Vector4;
  58316. backUVs?: Vector4;
  58317. }, scene?: Nullable<Scene>): Mesh;
  58318. /**
  58319. * Creates a torus knot mesh
  58320. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  58321. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  58322. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  58323. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  58324. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58325. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58326. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58327. * @param name defines the name of the mesh
  58328. * @param options defines the options used to create the mesh
  58329. * @param scene defines the hosting scene
  58330. * @returns the torus knot mesh
  58331. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  58332. */
  58333. static CreateTorusKnot(name: string, options: {
  58334. radius?: number;
  58335. tube?: number;
  58336. radialSegments?: number;
  58337. tubularSegments?: number;
  58338. p?: number;
  58339. q?: number;
  58340. updatable?: boolean;
  58341. sideOrientation?: number;
  58342. frontUVs?: Vector4;
  58343. backUVs?: Vector4;
  58344. }, scene?: Nullable<Scene>): Mesh;
  58345. /**
  58346. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  58347. * * 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
  58348. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  58349. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  58350. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  58351. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  58352. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  58353. * * 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
  58354. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  58355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58356. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  58357. * @param name defines the name of the new line system
  58358. * @param options defines the options used to create the line system
  58359. * @param scene defines the hosting scene
  58360. * @returns a new line system mesh
  58361. */
  58362. static CreateLineSystem(name: string, options: {
  58363. lines: Vector3[][];
  58364. updatable?: boolean;
  58365. instance?: Nullable<LinesMesh>;
  58366. colors?: Nullable<Color4[][]>;
  58367. useVertexAlpha?: boolean;
  58368. }, scene: Nullable<Scene>): LinesMesh;
  58369. /**
  58370. * Creates a line mesh
  58371. * 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
  58372. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  58373. * * The parameter `points` is an array successive Vector3
  58374. * * 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
  58375. * * The optional parameter `colors` is an array of successive Color4, one per line point
  58376. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  58377. * * When updating an instance, remember that only point positions can change, not the number of points
  58378. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58379. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  58380. * @param name defines the name of the new line system
  58381. * @param options defines the options used to create the line system
  58382. * @param scene defines the hosting scene
  58383. * @returns a new line mesh
  58384. */
  58385. static CreateLines(name: string, options: {
  58386. points: Vector3[];
  58387. updatable?: boolean;
  58388. instance?: Nullable<LinesMesh>;
  58389. colors?: Color4[];
  58390. useVertexAlpha?: boolean;
  58391. }, scene?: Nullable<Scene>): LinesMesh;
  58392. /**
  58393. * Creates a dashed line mesh
  58394. * * 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
  58395. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  58396. * * The parameter `points` is an array successive Vector3
  58397. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  58398. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  58399. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  58400. * * 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
  58401. * * When updating an instance, remember that only point positions can change, not the number of points
  58402. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58403. * @param name defines the name of the mesh
  58404. * @param options defines the options used to create the mesh
  58405. * @param scene defines the hosting scene
  58406. * @returns the dashed line mesh
  58407. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  58408. */
  58409. static CreateDashedLines(name: string, options: {
  58410. points: Vector3[];
  58411. dashSize?: number;
  58412. gapSize?: number;
  58413. dashNb?: number;
  58414. updatable?: boolean;
  58415. instance?: LinesMesh;
  58416. }, scene?: Nullable<Scene>): LinesMesh;
  58417. /**
  58418. * 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.
  58419. * * 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.
  58420. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  58421. * * 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.
  58422. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  58423. * * 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
  58424. * * 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
  58425. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  58426. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58427. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58428. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  58429. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58430. * @param name defines the name of the mesh
  58431. * @param options defines the options used to create the mesh
  58432. * @param scene defines the hosting scene
  58433. * @returns the extruded shape mesh
  58434. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  58435. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  58436. */
  58437. static ExtrudeShape(name: string, options: {
  58438. shape: Vector3[];
  58439. path: Vector3[];
  58440. scale?: number;
  58441. rotation?: number;
  58442. cap?: number;
  58443. updatable?: boolean;
  58444. sideOrientation?: number;
  58445. frontUVs?: Vector4;
  58446. backUVs?: Vector4;
  58447. instance?: Mesh;
  58448. invertUV?: boolean;
  58449. }, scene?: Nullable<Scene>): Mesh;
  58450. /**
  58451. * Creates an custom extruded shape mesh.
  58452. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  58453. * * 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.
  58454. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  58455. * * 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
  58456. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  58457. * * 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
  58458. * * It must returns a float value that will be the scale value applied to the shape on each path point
  58459. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  58460. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  58461. * * 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
  58462. * * 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
  58463. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  58464. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58465. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58466. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  58467. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58468. * @param name defines the name of the mesh
  58469. * @param options defines the options used to create the mesh
  58470. * @param scene defines the hosting scene
  58471. * @returns the custom extruded shape mesh
  58472. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  58473. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  58474. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  58475. */
  58476. static ExtrudeShapeCustom(name: string, options: {
  58477. shape: Vector3[];
  58478. path: Vector3[];
  58479. scaleFunction?: any;
  58480. rotationFunction?: any;
  58481. ribbonCloseArray?: boolean;
  58482. ribbonClosePath?: boolean;
  58483. cap?: number;
  58484. updatable?: boolean;
  58485. sideOrientation?: number;
  58486. frontUVs?: Vector4;
  58487. backUVs?: Vector4;
  58488. instance?: Mesh;
  58489. invertUV?: boolean;
  58490. }, scene?: Nullable<Scene>): Mesh;
  58491. /**
  58492. * Creates lathe mesh.
  58493. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  58494. * * 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
  58495. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  58496. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  58497. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  58498. * * 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
  58499. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  58500. * * 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
  58501. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58502. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58503. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  58504. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58505. * @param name defines the name of the mesh
  58506. * @param options defines the options used to create the mesh
  58507. * @param scene defines the hosting scene
  58508. * @returns the lathe mesh
  58509. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  58510. */
  58511. static CreateLathe(name: string, options: {
  58512. shape: Vector3[];
  58513. radius?: number;
  58514. tessellation?: number;
  58515. clip?: number;
  58516. arc?: number;
  58517. closed?: boolean;
  58518. updatable?: boolean;
  58519. sideOrientation?: number;
  58520. frontUVs?: Vector4;
  58521. backUVs?: Vector4;
  58522. cap?: number;
  58523. invertUV?: boolean;
  58524. }, scene?: Nullable<Scene>): Mesh;
  58525. /**
  58526. * Creates a tiled plane mesh
  58527. * * You can set a limited pattern arrangement with the tiles
  58528. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58529. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58530. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58531. * @param name defines the name of the mesh
  58532. * @param options defines the options used to create the mesh
  58533. * @param scene defines the hosting scene
  58534. * @returns the plane mesh
  58535. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  58536. */
  58537. static CreateTiledPlane(name: string, options: {
  58538. pattern?: number;
  58539. tileSize?: number;
  58540. tileWidth?: number;
  58541. tileHeight?: number;
  58542. size?: number;
  58543. width?: number;
  58544. height?: number;
  58545. alignHorizontal?: number;
  58546. alignVertical?: number;
  58547. sideOrientation?: number;
  58548. frontUVs?: Vector4;
  58549. backUVs?: Vector4;
  58550. updatable?: boolean;
  58551. }, scene?: Nullable<Scene>): Mesh;
  58552. /**
  58553. * Creates a plane mesh
  58554. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  58555. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  58556. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  58557. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58558. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58559. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58560. * @param name defines the name of the mesh
  58561. * @param options defines the options used to create the mesh
  58562. * @param scene defines the hosting scene
  58563. * @returns the plane mesh
  58564. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  58565. */
  58566. static CreatePlane(name: string, options: {
  58567. size?: number;
  58568. width?: number;
  58569. height?: number;
  58570. sideOrientation?: number;
  58571. frontUVs?: Vector4;
  58572. backUVs?: Vector4;
  58573. updatable?: boolean;
  58574. sourcePlane?: Plane;
  58575. }, scene?: Nullable<Scene>): Mesh;
  58576. /**
  58577. * Creates a ground mesh
  58578. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  58579. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  58580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58581. * @param name defines the name of the mesh
  58582. * @param options defines the options used to create the mesh
  58583. * @param scene defines the hosting scene
  58584. * @returns the ground mesh
  58585. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  58586. */
  58587. static CreateGround(name: string, options: {
  58588. width?: number;
  58589. height?: number;
  58590. subdivisions?: number;
  58591. subdivisionsX?: number;
  58592. subdivisionsY?: number;
  58593. updatable?: boolean;
  58594. }, scene?: Nullable<Scene>): Mesh;
  58595. /**
  58596. * Creates a tiled ground mesh
  58597. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  58598. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  58599. * * 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
  58600. * * 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
  58601. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58602. * @param name defines the name of the mesh
  58603. * @param options defines the options used to create the mesh
  58604. * @param scene defines the hosting scene
  58605. * @returns the tiled ground mesh
  58606. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  58607. */
  58608. static CreateTiledGround(name: string, options: {
  58609. xmin: number;
  58610. zmin: number;
  58611. xmax: number;
  58612. zmax: number;
  58613. subdivisions?: {
  58614. w: number;
  58615. h: number;
  58616. };
  58617. precision?: {
  58618. w: number;
  58619. h: number;
  58620. };
  58621. updatable?: boolean;
  58622. }, scene?: Nullable<Scene>): Mesh;
  58623. /**
  58624. * Creates a ground mesh from a height map
  58625. * * The parameter `url` sets the URL of the height map image resource.
  58626. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  58627. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  58628. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  58629. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  58630. * * 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.
  58631. * * 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).
  58632. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  58633. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  58634. * @param name defines the name of the mesh
  58635. * @param url defines the url to the height map
  58636. * @param options defines the options used to create the mesh
  58637. * @param scene defines the hosting scene
  58638. * @returns the ground mesh
  58639. * @see https://doc.babylonjs.com/babylon101/height_map
  58640. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  58641. */
  58642. static CreateGroundFromHeightMap(name: string, url: string, options: {
  58643. width?: number;
  58644. height?: number;
  58645. subdivisions?: number;
  58646. minHeight?: number;
  58647. maxHeight?: number;
  58648. colorFilter?: Color3;
  58649. alphaFilter?: number;
  58650. updatable?: boolean;
  58651. onReady?: (mesh: GroundMesh) => void;
  58652. }, scene?: Nullable<Scene>): GroundMesh;
  58653. /**
  58654. * Creates a polygon mesh
  58655. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  58656. * * 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
  58657. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  58658. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58659. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  58660. * * Remember you can only change the shape positions, not their number when updating a polygon
  58661. * @param name defines the name of the mesh
  58662. * @param options defines the options used to create the mesh
  58663. * @param scene defines the hosting scene
  58664. * @param earcutInjection can be used to inject your own earcut reference
  58665. * @returns the polygon mesh
  58666. */
  58667. static CreatePolygon(name: string, options: {
  58668. shape: Vector3[];
  58669. holes?: Vector3[][];
  58670. depth?: number;
  58671. faceUV?: Vector4[];
  58672. faceColors?: Color4[];
  58673. updatable?: boolean;
  58674. sideOrientation?: number;
  58675. frontUVs?: Vector4;
  58676. backUVs?: Vector4;
  58677. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  58678. /**
  58679. * Creates an extruded polygon mesh, with depth in the Y direction.
  58680. * * 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)
  58681. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  58682. * @param name defines the name of the mesh
  58683. * @param options defines the options used to create the mesh
  58684. * @param scene defines the hosting scene
  58685. * @param earcutInjection can be used to inject your own earcut reference
  58686. * @returns the polygon mesh
  58687. */
  58688. static ExtrudePolygon(name: string, options: {
  58689. shape: Vector3[];
  58690. holes?: Vector3[][];
  58691. depth?: number;
  58692. faceUV?: Vector4[];
  58693. faceColors?: Color4[];
  58694. updatable?: boolean;
  58695. sideOrientation?: number;
  58696. frontUVs?: Vector4;
  58697. backUVs?: Vector4;
  58698. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  58699. /**
  58700. * Creates a tube mesh.
  58701. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  58702. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  58703. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  58704. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  58705. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  58706. * * 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)
  58707. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  58708. * * 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
  58709. * * 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
  58710. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58711. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58712. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  58713. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58714. * @param name defines the name of the mesh
  58715. * @param options defines the options used to create the mesh
  58716. * @param scene defines the hosting scene
  58717. * @returns the tube mesh
  58718. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  58719. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  58720. */
  58721. static CreateTube(name: string, options: {
  58722. path: Vector3[];
  58723. radius?: number;
  58724. tessellation?: number;
  58725. radiusFunction?: {
  58726. (i: number, distance: number): number;
  58727. };
  58728. cap?: number;
  58729. arc?: number;
  58730. updatable?: boolean;
  58731. sideOrientation?: number;
  58732. frontUVs?: Vector4;
  58733. backUVs?: Vector4;
  58734. instance?: Mesh;
  58735. invertUV?: boolean;
  58736. }, scene?: Nullable<Scene>): Mesh;
  58737. /**
  58738. * Creates a polyhedron mesh
  58739. * * 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
  58740. * * The parameter `size` (positive float, default 1) sets the polygon size
  58741. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  58742. * * 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`
  58743. * * 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
  58744. * * 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)`)
  58745. * * 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
  58746. * * 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
  58747. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  58748. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  58749. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  58750. * @param name defines the name of the mesh
  58751. * @param options defines the options used to create the mesh
  58752. * @param scene defines the hosting scene
  58753. * @returns the polyhedron mesh
  58754. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  58755. */
  58756. static CreatePolyhedron(name: string, options: {
  58757. type?: number;
  58758. size?: number;
  58759. sizeX?: number;
  58760. sizeY?: number;
  58761. sizeZ?: number;
  58762. custom?: any;
  58763. faceUV?: Vector4[];
  58764. faceColors?: Color4[];
  58765. flat?: boolean;
  58766. updatable?: boolean;
  58767. sideOrientation?: number;
  58768. frontUVs?: Vector4;
  58769. backUVs?: Vector4;
  58770. }, scene?: Nullable<Scene>): Mesh;
  58771. /**
  58772. * Creates a decal mesh.
  58773. * 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
  58774. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  58775. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  58776. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  58777. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  58778. * @param name defines the name of the mesh
  58779. * @param sourceMesh defines the mesh where the decal must be applied
  58780. * @param options defines the options used to create the mesh
  58781. * @param scene defines the hosting scene
  58782. * @returns the decal mesh
  58783. * @see https://doc.babylonjs.com/how_to/decals
  58784. */
  58785. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  58786. position?: Vector3;
  58787. normal?: Vector3;
  58788. size?: Vector3;
  58789. angle?: number;
  58790. }): Mesh;
  58791. }
  58792. }
  58793. declare module "babylonjs/Meshes/meshSimplification" {
  58794. import { Mesh } from "babylonjs/Meshes/mesh";
  58795. /**
  58796. * A simplifier interface for future simplification implementations
  58797. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58798. */
  58799. export interface ISimplifier {
  58800. /**
  58801. * Simplification of a given mesh according to the given settings.
  58802. * Since this requires computation, it is assumed that the function runs async.
  58803. * @param settings The settings of the simplification, including quality and distance
  58804. * @param successCallback A callback that will be called after the mesh was simplified.
  58805. * @param errorCallback in case of an error, this callback will be called. optional.
  58806. */
  58807. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  58808. }
  58809. /**
  58810. * Expected simplification settings.
  58811. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  58812. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58813. */
  58814. export interface ISimplificationSettings {
  58815. /**
  58816. * Gets or sets the expected quality
  58817. */
  58818. quality: number;
  58819. /**
  58820. * Gets or sets the distance when this optimized version should be used
  58821. */
  58822. distance: number;
  58823. /**
  58824. * Gets an already optimized mesh
  58825. */
  58826. optimizeMesh?: boolean;
  58827. }
  58828. /**
  58829. * Class used to specify simplification options
  58830. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58831. */
  58832. export class SimplificationSettings implements ISimplificationSettings {
  58833. /** expected quality */
  58834. quality: number;
  58835. /** distance when this optimized version should be used */
  58836. distance: number;
  58837. /** already optimized mesh */
  58838. optimizeMesh?: boolean | undefined;
  58839. /**
  58840. * Creates a SimplificationSettings
  58841. * @param quality expected quality
  58842. * @param distance distance when this optimized version should be used
  58843. * @param optimizeMesh already optimized mesh
  58844. */
  58845. constructor(
  58846. /** expected quality */
  58847. quality: number,
  58848. /** distance when this optimized version should be used */
  58849. distance: number,
  58850. /** already optimized mesh */
  58851. optimizeMesh?: boolean | undefined);
  58852. }
  58853. /**
  58854. * Interface used to define a simplification task
  58855. */
  58856. export interface ISimplificationTask {
  58857. /**
  58858. * Array of settings
  58859. */
  58860. settings: Array<ISimplificationSettings>;
  58861. /**
  58862. * Simplification type
  58863. */
  58864. simplificationType: SimplificationType;
  58865. /**
  58866. * Mesh to simplify
  58867. */
  58868. mesh: Mesh;
  58869. /**
  58870. * Callback called on success
  58871. */
  58872. successCallback?: () => void;
  58873. /**
  58874. * Defines if parallel processing can be used
  58875. */
  58876. parallelProcessing: boolean;
  58877. }
  58878. /**
  58879. * Queue used to order the simplification tasks
  58880. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58881. */
  58882. export class SimplificationQueue {
  58883. private _simplificationArray;
  58884. /**
  58885. * Gets a boolean indicating that the process is still running
  58886. */
  58887. running: boolean;
  58888. /**
  58889. * Creates a new queue
  58890. */
  58891. constructor();
  58892. /**
  58893. * Adds a new simplification task
  58894. * @param task defines a task to add
  58895. */
  58896. addTask(task: ISimplificationTask): void;
  58897. /**
  58898. * Execute next task
  58899. */
  58900. executeNext(): void;
  58901. /**
  58902. * Execute a simplification task
  58903. * @param task defines the task to run
  58904. */
  58905. runSimplification(task: ISimplificationTask): void;
  58906. private getSimplifier;
  58907. }
  58908. /**
  58909. * The implemented types of simplification
  58910. * At the moment only Quadratic Error Decimation is implemented
  58911. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58912. */
  58913. export enum SimplificationType {
  58914. /** Quadratic error decimation */
  58915. QUADRATIC = 0
  58916. }
  58917. }
  58918. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  58919. import { Scene } from "babylonjs/scene";
  58920. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  58921. import { ISceneComponent } from "babylonjs/sceneComponent";
  58922. module "babylonjs/scene" {
  58923. interface Scene {
  58924. /** @hidden (Backing field) */
  58925. _simplificationQueue: SimplificationQueue;
  58926. /**
  58927. * Gets or sets the simplification queue attached to the scene
  58928. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  58929. */
  58930. simplificationQueue: SimplificationQueue;
  58931. }
  58932. }
  58933. module "babylonjs/Meshes/mesh" {
  58934. interface Mesh {
  58935. /**
  58936. * Simplify the mesh according to the given array of settings.
  58937. * Function will return immediately and will simplify async
  58938. * @param settings a collection of simplification settings
  58939. * @param parallelProcessing should all levels calculate parallel or one after the other
  58940. * @param simplificationType the type of simplification to run
  58941. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  58942. * @returns the current mesh
  58943. */
  58944. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  58945. }
  58946. }
  58947. /**
  58948. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  58949. * created in a scene
  58950. */
  58951. export class SimplicationQueueSceneComponent implements ISceneComponent {
  58952. /**
  58953. * The component name helpfull to identify the component in the list of scene components.
  58954. */
  58955. readonly name: string;
  58956. /**
  58957. * The scene the component belongs to.
  58958. */
  58959. scene: Scene;
  58960. /**
  58961. * Creates a new instance of the component for the given scene
  58962. * @param scene Defines the scene to register the component in
  58963. */
  58964. constructor(scene: Scene);
  58965. /**
  58966. * Registers the component in a given scene
  58967. */
  58968. register(): void;
  58969. /**
  58970. * Rebuilds the elements related to this component in case of
  58971. * context lost for instance.
  58972. */
  58973. rebuild(): void;
  58974. /**
  58975. * Disposes the component and the associated ressources
  58976. */
  58977. dispose(): void;
  58978. private _beforeCameraUpdate;
  58979. }
  58980. }
  58981. declare module "babylonjs/Meshes/Builders/index" {
  58982. export * from "babylonjs/Meshes/Builders/boxBuilder";
  58983. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  58984. export * from "babylonjs/Meshes/Builders/discBuilder";
  58985. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  58986. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  58987. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  58988. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  58989. export * from "babylonjs/Meshes/Builders/torusBuilder";
  58990. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  58991. export * from "babylonjs/Meshes/Builders/linesBuilder";
  58992. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  58993. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  58994. export * from "babylonjs/Meshes/Builders/latheBuilder";
  58995. export * from "babylonjs/Meshes/Builders/planeBuilder";
  58996. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  58997. export * from "babylonjs/Meshes/Builders/groundBuilder";
  58998. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  58999. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  59000. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  59001. export * from "babylonjs/Meshes/Builders/decalBuilder";
  59002. }
  59003. declare module "babylonjs/Meshes/index" {
  59004. export * from "babylonjs/Meshes/abstractMesh";
  59005. export * from "babylonjs/Meshes/buffer";
  59006. export * from "babylonjs/Meshes/Compression/index";
  59007. export * from "babylonjs/Meshes/csg";
  59008. export * from "babylonjs/Meshes/geometry";
  59009. export * from "babylonjs/Meshes/groundMesh";
  59010. export * from "babylonjs/Meshes/trailMesh";
  59011. export * from "babylonjs/Meshes/instancedMesh";
  59012. export * from "babylonjs/Meshes/linesMesh";
  59013. export * from "babylonjs/Meshes/mesh";
  59014. export * from "babylonjs/Meshes/mesh.vertexData";
  59015. export * from "babylonjs/Meshes/meshBuilder";
  59016. export * from "babylonjs/Meshes/meshSimplification";
  59017. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  59018. export * from "babylonjs/Meshes/polygonMesh";
  59019. export * from "babylonjs/Meshes/subMesh";
  59020. export * from "babylonjs/Meshes/meshLODLevel";
  59021. export * from "babylonjs/Meshes/transformNode";
  59022. export * from "babylonjs/Meshes/Builders/index";
  59023. export * from "babylonjs/Meshes/dataBuffer";
  59024. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  59025. }
  59026. declare module "babylonjs/Morph/index" {
  59027. export * from "babylonjs/Morph/morphTarget";
  59028. export * from "babylonjs/Morph/morphTargetManager";
  59029. }
  59030. declare module "babylonjs/Navigation/INavigationEngine" {
  59031. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59032. import { Vector3 } from "babylonjs/Maths/math";
  59033. import { Mesh } from "babylonjs/Meshes/mesh";
  59034. import { Scene } from "babylonjs/scene";
  59035. /**
  59036. * Navigation plugin interface to add navigation constrained by a navigation mesh
  59037. */
  59038. export interface INavigationEnginePlugin {
  59039. /**
  59040. * plugin name
  59041. */
  59042. name: string;
  59043. /**
  59044. * Creates a navigation mesh
  59045. * @param meshes array of all the geometry used to compute the navigatio mesh
  59046. * @param parameters bunch of parameters used to filter geometry
  59047. */
  59048. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  59049. /**
  59050. * Create a navigation mesh debug mesh
  59051. * @param scene is where the mesh will be added
  59052. * @returns debug display mesh
  59053. */
  59054. createDebugNavMesh(scene: Scene): Mesh;
  59055. /**
  59056. * Get a navigation mesh constrained position, closest to the parameter position
  59057. * @param position world position
  59058. * @returns the closest point to position constrained by the navigation mesh
  59059. */
  59060. getClosestPoint(position: Vector3): Vector3;
  59061. /**
  59062. * Get a navigation mesh constrained position, within a particular radius
  59063. * @param position world position
  59064. * @param maxRadius the maximum distance to the constrained world position
  59065. * @returns the closest point to position constrained by the navigation mesh
  59066. */
  59067. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  59068. /**
  59069. * Compute the final position from a segment made of destination-position
  59070. * @param position world position
  59071. * @param destination world position
  59072. * @returns the resulting point along the navmesh
  59073. */
  59074. moveAlong(position: Vector3, destination: Vector3): Vector3;
  59075. /**
  59076. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  59077. * @param start world position
  59078. * @param end world position
  59079. * @returns array containing world position composing the path
  59080. */
  59081. computePath(start: Vector3, end: Vector3): Vector3[];
  59082. /**
  59083. * If this plugin is supported
  59084. * @returns true if plugin is supported
  59085. */
  59086. isSupported(): boolean;
  59087. /**
  59088. * Create a new Crowd so you can add agents
  59089. * @param maxAgents the maximum agent count in the crowd
  59090. * @param maxAgentRadius the maximum radius an agent can have
  59091. * @param scene to attach the crowd to
  59092. * @returns the crowd you can add agents to
  59093. */
  59094. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  59095. /**
  59096. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  59097. * The queries will try to find a solution within those bounds
  59098. * default is (1,1,1)
  59099. * @param extent x,y,z value that define the extent around the queries point of reference
  59100. */
  59101. setDefaultQueryExtent(extent: Vector3): void;
  59102. /**
  59103. * Get the Bounding box extent specified by setDefaultQueryExtent
  59104. * @returns the box extent values
  59105. */
  59106. getDefaultQueryExtent(): Vector3;
  59107. /**
  59108. * Release all resources
  59109. */
  59110. dispose(): void;
  59111. }
  59112. /**
  59113. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  59114. */
  59115. export interface ICrowd {
  59116. /**
  59117. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  59118. * You can attach anything to that node. The node position is updated in the scene update tick.
  59119. * @param pos world position that will be constrained by the navigation mesh
  59120. * @param parameters agent parameters
  59121. * @param transform hooked to the agent that will be update by the scene
  59122. * @returns agent index
  59123. */
  59124. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  59125. /**
  59126. * Returns the agent position in world space
  59127. * @param index agent index returned by addAgent
  59128. * @returns world space position
  59129. */
  59130. getAgentPosition(index: number): Vector3;
  59131. /**
  59132. * Gets the agent velocity in world space
  59133. * @param index agent index returned by addAgent
  59134. * @returns world space velocity
  59135. */
  59136. getAgentVelocity(index: number): Vector3;
  59137. /**
  59138. * remove a particular agent previously created
  59139. * @param index agent index returned by addAgent
  59140. */
  59141. removeAgent(index: number): void;
  59142. /**
  59143. * get the list of all agents attached to this crowd
  59144. * @returns list of agent indices
  59145. */
  59146. getAgents(): number[];
  59147. /**
  59148. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  59149. * @param deltaTime in seconds
  59150. */
  59151. update(deltaTime: number): void;
  59152. /**
  59153. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  59154. * @param index agent index returned by addAgent
  59155. * @param destination targeted world position
  59156. */
  59157. agentGoto(index: number, destination: Vector3): void;
  59158. /**
  59159. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  59160. * The queries will try to find a solution within those bounds
  59161. * default is (1,1,1)
  59162. * @param extent x,y,z value that define the extent around the queries point of reference
  59163. */
  59164. setDefaultQueryExtent(extent: Vector3): void;
  59165. /**
  59166. * Get the Bounding box extent specified by setDefaultQueryExtent
  59167. * @returns the box extent values
  59168. */
  59169. getDefaultQueryExtent(): Vector3;
  59170. /**
  59171. * Release all resources
  59172. */
  59173. dispose(): void;
  59174. }
  59175. /**
  59176. * Configures an agent
  59177. */
  59178. export interface IAgentParameters {
  59179. /**
  59180. * Agent radius. [Limit: >= 0]
  59181. */
  59182. radius: number;
  59183. /**
  59184. * Agent height. [Limit: > 0]
  59185. */
  59186. height: number;
  59187. /**
  59188. * Maximum allowed acceleration. [Limit: >= 0]
  59189. */
  59190. maxAcceleration: number;
  59191. /**
  59192. * Maximum allowed speed. [Limit: >= 0]
  59193. */
  59194. maxSpeed: number;
  59195. /**
  59196. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  59197. */
  59198. collisionQueryRange: number;
  59199. /**
  59200. * The path visibility optimization range. [Limit: > 0]
  59201. */
  59202. pathOptimizationRange: number;
  59203. /**
  59204. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  59205. */
  59206. separationWeight: number;
  59207. }
  59208. /**
  59209. * Configures the navigation mesh creation
  59210. */
  59211. export interface INavMeshParameters {
  59212. /**
  59213. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  59214. */
  59215. cs: number;
  59216. /**
  59217. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  59218. */
  59219. ch: number;
  59220. /**
  59221. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  59222. */
  59223. walkableSlopeAngle: number;
  59224. /**
  59225. * Minimum floor to 'ceiling' height that will still allow the floor area to
  59226. * be considered walkable. [Limit: >= 3] [Units: vx]
  59227. */
  59228. walkableHeight: number;
  59229. /**
  59230. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  59231. */
  59232. walkableClimb: number;
  59233. /**
  59234. * The distance to erode/shrink the walkable area of the heightfield away from
  59235. * obstructions. [Limit: >=0] [Units: vx]
  59236. */
  59237. walkableRadius: number;
  59238. /**
  59239. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  59240. */
  59241. maxEdgeLen: number;
  59242. /**
  59243. * The maximum distance a simplfied contour's border edges should deviate
  59244. * the original raw contour. [Limit: >=0] [Units: vx]
  59245. */
  59246. maxSimplificationError: number;
  59247. /**
  59248. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  59249. */
  59250. minRegionArea: number;
  59251. /**
  59252. * Any regions with a span count smaller than this value will, if possible,
  59253. * be merged with larger regions. [Limit: >=0] [Units: vx]
  59254. */
  59255. mergeRegionArea: number;
  59256. /**
  59257. * The maximum number of vertices allowed for polygons generated during the
  59258. * contour to polygon conversion process. [Limit: >= 3]
  59259. */
  59260. maxVertsPerPoly: number;
  59261. /**
  59262. * Sets the sampling distance to use when generating the detail mesh.
  59263. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  59264. */
  59265. detailSampleDist: number;
  59266. /**
  59267. * The maximum distance the detail mesh surface should deviate from heightfield
  59268. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  59269. */
  59270. detailSampleMaxError: number;
  59271. }
  59272. }
  59273. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  59274. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  59275. import { Mesh } from "babylonjs/Meshes/mesh";
  59276. import { Scene } from "babylonjs/scene";
  59277. import { Vector3 } from "babylonjs/Maths/math";
  59278. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59279. /**
  59280. * RecastJS navigation plugin
  59281. */
  59282. export class RecastJSPlugin implements INavigationEnginePlugin {
  59283. /**
  59284. * Reference to the Recast library
  59285. */
  59286. bjsRECAST: any;
  59287. /**
  59288. * plugin name
  59289. */
  59290. name: string;
  59291. /**
  59292. * the first navmesh created. We might extend this to support multiple navmeshes
  59293. */
  59294. navMesh: any;
  59295. /**
  59296. * Initializes the recastJS plugin
  59297. * @param recastInjection can be used to inject your own recast reference
  59298. */
  59299. constructor(recastInjection?: any);
  59300. /**
  59301. * Creates a navigation mesh
  59302. * @param meshes array of all the geometry used to compute the navigatio mesh
  59303. * @param parameters bunch of parameters used to filter geometry
  59304. */
  59305. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  59306. /**
  59307. * Create a navigation mesh debug mesh
  59308. * @param scene is where the mesh will be added
  59309. * @returns debug display mesh
  59310. */
  59311. createDebugNavMesh(scene: Scene): Mesh;
  59312. /**
  59313. * Get a navigation mesh constrained position, closest to the parameter position
  59314. * @param position world position
  59315. * @returns the closest point to position constrained by the navigation mesh
  59316. */
  59317. getClosestPoint(position: Vector3): Vector3;
  59318. /**
  59319. * Get a navigation mesh constrained position, within a particular radius
  59320. * @param position world position
  59321. * @param maxRadius the maximum distance to the constrained world position
  59322. * @returns the closest point to position constrained by the navigation mesh
  59323. */
  59324. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  59325. /**
  59326. * Compute the final position from a segment made of destination-position
  59327. * @param position world position
  59328. * @param destination world position
  59329. * @returns the resulting point along the navmesh
  59330. */
  59331. moveAlong(position: Vector3, destination: Vector3): Vector3;
  59332. /**
  59333. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  59334. * @param start world position
  59335. * @param end world position
  59336. * @returns array containing world position composing the path
  59337. */
  59338. computePath(start: Vector3, end: Vector3): Vector3[];
  59339. /**
  59340. * Create a new Crowd so you can add agents
  59341. * @param maxAgents the maximum agent count in the crowd
  59342. * @param maxAgentRadius the maximum radius an agent can have
  59343. * @param scene to attach the crowd to
  59344. * @returns the crowd you can add agents to
  59345. */
  59346. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  59347. /**
  59348. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  59349. * The queries will try to find a solution within those bounds
  59350. * default is (1,1,1)
  59351. * @param extent x,y,z value that define the extent around the queries point of reference
  59352. */
  59353. setDefaultQueryExtent(extent: Vector3): void;
  59354. /**
  59355. * Get the Bounding box extent specified by setDefaultQueryExtent
  59356. * @returns the box extent values
  59357. */
  59358. getDefaultQueryExtent(): Vector3;
  59359. /**
  59360. * Disposes
  59361. */
  59362. dispose(): void;
  59363. /**
  59364. * If this plugin is supported
  59365. * @returns true if plugin is supported
  59366. */
  59367. isSupported(): boolean;
  59368. }
  59369. /**
  59370. * Recast detour crowd implementation
  59371. */
  59372. export class RecastJSCrowd implements ICrowd {
  59373. /**
  59374. * Recast/detour plugin
  59375. */
  59376. bjsRECASTPlugin: RecastJSPlugin;
  59377. /**
  59378. * Link to the detour crowd
  59379. */
  59380. recastCrowd: any;
  59381. /**
  59382. * One transform per agent
  59383. */
  59384. transforms: TransformNode[];
  59385. /**
  59386. * All agents created
  59387. */
  59388. agents: number[];
  59389. /**
  59390. * Link to the scene is kept to unregister the crowd from the scene
  59391. */
  59392. private _scene;
  59393. /**
  59394. * Observer for crowd updates
  59395. */
  59396. private _onBeforeAnimationsObserver;
  59397. /**
  59398. * Constructor
  59399. * @param plugin recastJS plugin
  59400. * @param maxAgents the maximum agent count in the crowd
  59401. * @param maxAgentRadius the maximum radius an agent can have
  59402. * @param scene to attach the crowd to
  59403. * @returns the crowd you can add agents to
  59404. */
  59405. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  59406. /**
  59407. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  59408. * You can attach anything to that node. The node position is updated in the scene update tick.
  59409. * @param pos world position that will be constrained by the navigation mesh
  59410. * @param parameters agent parameters
  59411. * @param transform hooked to the agent that will be update by the scene
  59412. * @returns agent index
  59413. */
  59414. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  59415. /**
  59416. * Returns the agent position in world space
  59417. * @param index agent index returned by addAgent
  59418. * @returns world space position
  59419. */
  59420. getAgentPosition(index: number): Vector3;
  59421. /**
  59422. * Returns the agent velocity in world space
  59423. * @param index agent index returned by addAgent
  59424. * @returns world space velocity
  59425. */
  59426. getAgentVelocity(index: number): Vector3;
  59427. /**
  59428. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  59429. * @param index agent index returned by addAgent
  59430. * @param destination targeted world position
  59431. */
  59432. agentGoto(index: number, destination: Vector3): void;
  59433. /**
  59434. * remove a particular agent previously created
  59435. * @param index agent index returned by addAgent
  59436. */
  59437. removeAgent(index: number): void;
  59438. /**
  59439. * get the list of all agents attached to this crowd
  59440. * @returns list of agent indices
  59441. */
  59442. getAgents(): number[];
  59443. /**
  59444. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  59445. * @param deltaTime in seconds
  59446. */
  59447. update(deltaTime: number): void;
  59448. /**
  59449. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  59450. * The queries will try to find a solution within those bounds
  59451. * default is (1,1,1)
  59452. * @param extent x,y,z value that define the extent around the queries point of reference
  59453. */
  59454. setDefaultQueryExtent(extent: Vector3): void;
  59455. /**
  59456. * Get the Bounding box extent specified by setDefaultQueryExtent
  59457. * @returns the box extent values
  59458. */
  59459. getDefaultQueryExtent(): Vector3;
  59460. /**
  59461. * Release all resources
  59462. */
  59463. dispose(): void;
  59464. }
  59465. }
  59466. declare module "babylonjs/Navigation/Plugins/index" {
  59467. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  59468. }
  59469. declare module "babylonjs/Navigation/index" {
  59470. export * from "babylonjs/Navigation/INavigationEngine";
  59471. export * from "babylonjs/Navigation/Plugins/index";
  59472. }
  59473. declare module "babylonjs/Offline/database" {
  59474. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  59475. /**
  59476. * Class used to enable access to IndexedDB
  59477. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  59478. */
  59479. export class Database implements IOfflineProvider {
  59480. private _callbackManifestChecked;
  59481. private _currentSceneUrl;
  59482. private _db;
  59483. private _enableSceneOffline;
  59484. private _enableTexturesOffline;
  59485. private _manifestVersionFound;
  59486. private _mustUpdateRessources;
  59487. private _hasReachedQuota;
  59488. private _isSupported;
  59489. private _idbFactory;
  59490. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  59491. private static IsUASupportingBlobStorage;
  59492. /**
  59493. * Gets a boolean indicating if Database storate is enabled (off by default)
  59494. */
  59495. static IDBStorageEnabled: boolean;
  59496. /**
  59497. * Gets a boolean indicating if scene must be saved in the database
  59498. */
  59499. readonly enableSceneOffline: boolean;
  59500. /**
  59501. * Gets a boolean indicating if textures must be saved in the database
  59502. */
  59503. readonly enableTexturesOffline: boolean;
  59504. /**
  59505. * Creates a new Database
  59506. * @param urlToScene defines the url to load the scene
  59507. * @param callbackManifestChecked defines the callback to use when manifest is checked
  59508. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  59509. */
  59510. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  59511. private static _ParseURL;
  59512. private static _ReturnFullUrlLocation;
  59513. private _checkManifestFile;
  59514. /**
  59515. * Open the database and make it available
  59516. * @param successCallback defines the callback to call on success
  59517. * @param errorCallback defines the callback to call on error
  59518. */
  59519. open(successCallback: () => void, errorCallback: () => void): void;
  59520. /**
  59521. * Loads an image from the database
  59522. * @param url defines the url to load from
  59523. * @param image defines the target DOM image
  59524. */
  59525. loadImage(url: string, image: HTMLImageElement): void;
  59526. private _loadImageFromDBAsync;
  59527. private _saveImageIntoDBAsync;
  59528. private _checkVersionFromDB;
  59529. private _loadVersionFromDBAsync;
  59530. private _saveVersionIntoDBAsync;
  59531. /**
  59532. * Loads a file from database
  59533. * @param url defines the URL to load from
  59534. * @param sceneLoaded defines a callback to call on success
  59535. * @param progressCallBack defines a callback to call when progress changed
  59536. * @param errorCallback defines a callback to call on error
  59537. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  59538. */
  59539. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  59540. private _loadFileAsync;
  59541. private _saveFileAsync;
  59542. /**
  59543. * Validates if xhr data is correct
  59544. * @param xhr defines the request to validate
  59545. * @param dataType defines the expected data type
  59546. * @returns true if data is correct
  59547. */
  59548. private static _ValidateXHRData;
  59549. }
  59550. }
  59551. declare module "babylonjs/Offline/index" {
  59552. export * from "babylonjs/Offline/database";
  59553. export * from "babylonjs/Offline/IOfflineProvider";
  59554. }
  59555. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  59556. /** @hidden */
  59557. export var gpuUpdateParticlesPixelShader: {
  59558. name: string;
  59559. shader: string;
  59560. };
  59561. }
  59562. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  59563. /** @hidden */
  59564. export var gpuUpdateParticlesVertexShader: {
  59565. name: string;
  59566. shader: string;
  59567. };
  59568. }
  59569. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  59570. /** @hidden */
  59571. export var clipPlaneFragmentDeclaration2: {
  59572. name: string;
  59573. shader: string;
  59574. };
  59575. }
  59576. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  59577. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  59578. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  59579. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  59580. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  59581. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  59582. /** @hidden */
  59583. export var gpuRenderParticlesPixelShader: {
  59584. name: string;
  59585. shader: string;
  59586. };
  59587. }
  59588. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  59589. /** @hidden */
  59590. export var clipPlaneVertexDeclaration2: {
  59591. name: string;
  59592. shader: string;
  59593. };
  59594. }
  59595. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  59596. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  59597. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  59598. /** @hidden */
  59599. export var gpuRenderParticlesVertexShader: {
  59600. name: string;
  59601. shader: string;
  59602. };
  59603. }
  59604. declare module "babylonjs/Particles/gpuParticleSystem" {
  59605. import { Nullable } from "babylonjs/types";
  59606. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  59607. import { Observable } from "babylonjs/Misc/observable";
  59608. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  59609. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  59610. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  59611. import { Scene, IDisposable } from "babylonjs/scene";
  59612. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  59613. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  59614. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  59615. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  59616. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  59617. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  59618. /**
  59619. * This represents a GPU particle system in Babylon
  59620. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  59621. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  59622. */
  59623. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  59624. /**
  59625. * The layer mask we are rendering the particles through.
  59626. */
  59627. layerMask: number;
  59628. private _capacity;
  59629. private _activeCount;
  59630. private _currentActiveCount;
  59631. private _accumulatedCount;
  59632. private _renderEffect;
  59633. private _updateEffect;
  59634. private _buffer0;
  59635. private _buffer1;
  59636. private _spriteBuffer;
  59637. private _updateVAO;
  59638. private _renderVAO;
  59639. private _targetIndex;
  59640. private _sourceBuffer;
  59641. private _targetBuffer;
  59642. private _engine;
  59643. private _currentRenderId;
  59644. private _started;
  59645. private _stopped;
  59646. private _timeDelta;
  59647. private _randomTexture;
  59648. private _randomTexture2;
  59649. private _attributesStrideSize;
  59650. private _updateEffectOptions;
  59651. private _randomTextureSize;
  59652. private _actualFrame;
  59653. private readonly _rawTextureWidth;
  59654. /**
  59655. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  59656. */
  59657. static readonly IsSupported: boolean;
  59658. /**
  59659. * An event triggered when the system is disposed.
  59660. */
  59661. onDisposeObservable: Observable<GPUParticleSystem>;
  59662. /**
  59663. * Gets the maximum number of particles active at the same time.
  59664. * @returns The max number of active particles.
  59665. */
  59666. getCapacity(): number;
  59667. /**
  59668. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  59669. * to override the particles.
  59670. */
  59671. forceDepthWrite: boolean;
  59672. /**
  59673. * Gets or set the number of active particles
  59674. */
  59675. activeParticleCount: number;
  59676. private _preWarmDone;
  59677. /**
  59678. * Is this system ready to be used/rendered
  59679. * @return true if the system is ready
  59680. */
  59681. isReady(): boolean;
  59682. /**
  59683. * Gets if the system has been started. (Note: this will still be true after stop is called)
  59684. * @returns True if it has been started, otherwise false.
  59685. */
  59686. isStarted(): boolean;
  59687. /**
  59688. * Starts the particle system and begins to emit
  59689. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  59690. */
  59691. start(delay?: number): void;
  59692. /**
  59693. * Stops the particle system.
  59694. */
  59695. stop(): void;
  59696. /**
  59697. * Remove all active particles
  59698. */
  59699. reset(): void;
  59700. /**
  59701. * Returns the string "GPUParticleSystem"
  59702. * @returns a string containing the class name
  59703. */
  59704. getClassName(): string;
  59705. private _colorGradientsTexture;
  59706. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  59707. /**
  59708. * Adds a new color gradient
  59709. * @param gradient defines the gradient to use (between 0 and 1)
  59710. * @param color1 defines the color to affect to the specified gradient
  59711. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  59712. * @returns the current particle system
  59713. */
  59714. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  59715. /**
  59716. * Remove a specific color gradient
  59717. * @param gradient defines the gradient to remove
  59718. * @returns the current particle system
  59719. */
  59720. removeColorGradient(gradient: number): GPUParticleSystem;
  59721. private _angularSpeedGradientsTexture;
  59722. private _sizeGradientsTexture;
  59723. private _velocityGradientsTexture;
  59724. private _limitVelocityGradientsTexture;
  59725. private _dragGradientsTexture;
  59726. private _addFactorGradient;
  59727. /**
  59728. * Adds a new size gradient
  59729. * @param gradient defines the gradient to use (between 0 and 1)
  59730. * @param factor defines the size factor to affect to the specified gradient
  59731. * @returns the current particle system
  59732. */
  59733. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  59734. /**
  59735. * Remove a specific size gradient
  59736. * @param gradient defines the gradient to remove
  59737. * @returns the current particle system
  59738. */
  59739. removeSizeGradient(gradient: number): GPUParticleSystem;
  59740. /**
  59741. * Adds a new angular speed gradient
  59742. * @param gradient defines the gradient to use (between 0 and 1)
  59743. * @param factor defines the angular speed to affect to the specified gradient
  59744. * @returns the current particle system
  59745. */
  59746. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  59747. /**
  59748. * Remove a specific angular speed gradient
  59749. * @param gradient defines the gradient to remove
  59750. * @returns the current particle system
  59751. */
  59752. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  59753. /**
  59754. * Adds a new velocity gradient
  59755. * @param gradient defines the gradient to use (between 0 and 1)
  59756. * @param factor defines the velocity to affect to the specified gradient
  59757. * @returns the current particle system
  59758. */
  59759. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  59760. /**
  59761. * Remove a specific velocity gradient
  59762. * @param gradient defines the gradient to remove
  59763. * @returns the current particle system
  59764. */
  59765. removeVelocityGradient(gradient: number): GPUParticleSystem;
  59766. /**
  59767. * Adds a new limit velocity gradient
  59768. * @param gradient defines the gradient to use (between 0 and 1)
  59769. * @param factor defines the limit velocity value to affect to the specified gradient
  59770. * @returns the current particle system
  59771. */
  59772. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  59773. /**
  59774. * Remove a specific limit velocity gradient
  59775. * @param gradient defines the gradient to remove
  59776. * @returns the current particle system
  59777. */
  59778. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  59779. /**
  59780. * Adds a new drag gradient
  59781. * @param gradient defines the gradient to use (between 0 and 1)
  59782. * @param factor defines the drag value to affect to the specified gradient
  59783. * @returns the current particle system
  59784. */
  59785. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  59786. /**
  59787. * Remove a specific drag gradient
  59788. * @param gradient defines the gradient to remove
  59789. * @returns the current particle system
  59790. */
  59791. removeDragGradient(gradient: number): GPUParticleSystem;
  59792. /**
  59793. * Not supported by GPUParticleSystem
  59794. * @param gradient defines the gradient to use (between 0 and 1)
  59795. * @param factor defines the emit rate value to affect to the specified gradient
  59796. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  59797. * @returns the current particle system
  59798. */
  59799. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  59800. /**
  59801. * Not supported by GPUParticleSystem
  59802. * @param gradient defines the gradient to remove
  59803. * @returns the current particle system
  59804. */
  59805. removeEmitRateGradient(gradient: number): IParticleSystem;
  59806. /**
  59807. * Not supported by GPUParticleSystem
  59808. * @param gradient defines the gradient to use (between 0 and 1)
  59809. * @param factor defines the start size value to affect to the specified gradient
  59810. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  59811. * @returns the current particle system
  59812. */
  59813. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  59814. /**
  59815. * Not supported by GPUParticleSystem
  59816. * @param gradient defines the gradient to remove
  59817. * @returns the current particle system
  59818. */
  59819. removeStartSizeGradient(gradient: number): IParticleSystem;
  59820. /**
  59821. * Not supported by GPUParticleSystem
  59822. * @param gradient defines the gradient to use (between 0 and 1)
  59823. * @param min defines the color remap minimal range
  59824. * @param max defines the color remap maximal range
  59825. * @returns the current particle system
  59826. */
  59827. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  59828. /**
  59829. * Not supported by GPUParticleSystem
  59830. * @param gradient defines the gradient to remove
  59831. * @returns the current particle system
  59832. */
  59833. removeColorRemapGradient(): IParticleSystem;
  59834. /**
  59835. * Not supported by GPUParticleSystem
  59836. * @param gradient defines the gradient to use (between 0 and 1)
  59837. * @param min defines the alpha remap minimal range
  59838. * @param max defines the alpha remap maximal range
  59839. * @returns the current particle system
  59840. */
  59841. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  59842. /**
  59843. * Not supported by GPUParticleSystem
  59844. * @param gradient defines the gradient to remove
  59845. * @returns the current particle system
  59846. */
  59847. removeAlphaRemapGradient(): IParticleSystem;
  59848. /**
  59849. * Not supported by GPUParticleSystem
  59850. * @param gradient defines the gradient to use (between 0 and 1)
  59851. * @param color defines the color to affect to the specified gradient
  59852. * @returns the current particle system
  59853. */
  59854. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  59855. /**
  59856. * Not supported by GPUParticleSystem
  59857. * @param gradient defines the gradient to remove
  59858. * @returns the current particle system
  59859. */
  59860. removeRampGradient(): IParticleSystem;
  59861. /**
  59862. * Not supported by GPUParticleSystem
  59863. * @returns the list of ramp gradients
  59864. */
  59865. getRampGradients(): Nullable<Array<Color3Gradient>>;
  59866. /**
  59867. * Not supported by GPUParticleSystem
  59868. * Gets or sets a boolean indicating that ramp gradients must be used
  59869. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  59870. */
  59871. useRampGradients: boolean;
  59872. /**
  59873. * Not supported by GPUParticleSystem
  59874. * @param gradient defines the gradient to use (between 0 and 1)
  59875. * @param factor defines the life time factor to affect to the specified gradient
  59876. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  59877. * @returns the current particle system
  59878. */
  59879. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  59880. /**
  59881. * Not supported by GPUParticleSystem
  59882. * @param gradient defines the gradient to remove
  59883. * @returns the current particle system
  59884. */
  59885. removeLifeTimeGradient(gradient: number): IParticleSystem;
  59886. /**
  59887. * Instantiates a GPU particle system.
  59888. * 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.
  59889. * @param name The name of the particle system
  59890. * @param options The options used to create the system
  59891. * @param scene The scene the particle system belongs to
  59892. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  59893. */
  59894. constructor(name: string, options: Partial<{
  59895. capacity: number;
  59896. randomTextureSize: number;
  59897. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  59898. protected _reset(): void;
  59899. private _createUpdateVAO;
  59900. private _createRenderVAO;
  59901. private _initialize;
  59902. /** @hidden */
  59903. _recreateUpdateEffect(): void;
  59904. /** @hidden */
  59905. _recreateRenderEffect(): void;
  59906. /**
  59907. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  59908. * @param preWarm defines if we are in the pre-warmimg phase
  59909. */
  59910. animate(preWarm?: boolean): void;
  59911. private _createFactorGradientTexture;
  59912. private _createSizeGradientTexture;
  59913. private _createAngularSpeedGradientTexture;
  59914. private _createVelocityGradientTexture;
  59915. private _createLimitVelocityGradientTexture;
  59916. private _createDragGradientTexture;
  59917. private _createColorGradientTexture;
  59918. /**
  59919. * Renders the particle system in its current state
  59920. * @param preWarm defines if the system should only update the particles but not render them
  59921. * @returns the current number of particles
  59922. */
  59923. render(preWarm?: boolean): number;
  59924. /**
  59925. * Rebuilds the particle system
  59926. */
  59927. rebuild(): void;
  59928. private _releaseBuffers;
  59929. private _releaseVAOs;
  59930. /**
  59931. * Disposes the particle system and free the associated resources
  59932. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  59933. */
  59934. dispose(disposeTexture?: boolean): void;
  59935. /**
  59936. * Clones the particle system.
  59937. * @param name The name of the cloned object
  59938. * @param newEmitter The new emitter to use
  59939. * @returns the cloned particle system
  59940. */
  59941. clone(name: string, newEmitter: any): GPUParticleSystem;
  59942. /**
  59943. * Serializes the particle system to a JSON object.
  59944. * @returns the JSON object
  59945. */
  59946. serialize(): any;
  59947. /**
  59948. * Parses a JSON object to create a GPU particle system.
  59949. * @param parsedParticleSystem The JSON object to parse
  59950. * @param scene The scene to create the particle system in
  59951. * @param rootUrl The root url to use to load external dependencies like texture
  59952. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  59953. * @returns the parsed GPU particle system
  59954. */
  59955. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  59956. }
  59957. }
  59958. declare module "babylonjs/Particles/particleSystemSet" {
  59959. import { Nullable } from "babylonjs/types";
  59960. import { Color3 } from "babylonjs/Maths/math.color";
  59961. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59962. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59963. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  59964. import { Scene, IDisposable } from "babylonjs/scene";
  59965. /**
  59966. * Represents a set of particle systems working together to create a specific effect
  59967. */
  59968. export class ParticleSystemSet implements IDisposable {
  59969. private _emitterCreationOptions;
  59970. private _emitterNode;
  59971. /**
  59972. * Gets the particle system list
  59973. */
  59974. systems: IParticleSystem[];
  59975. /**
  59976. * Gets the emitter node used with this set
  59977. */
  59978. readonly emitterNode: Nullable<TransformNode>;
  59979. /**
  59980. * Creates a new emitter mesh as a sphere
  59981. * @param options defines the options used to create the sphere
  59982. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  59983. * @param scene defines the hosting scene
  59984. */
  59985. setEmitterAsSphere(options: {
  59986. diameter: number;
  59987. segments: number;
  59988. color: Color3;
  59989. }, renderingGroupId: number, scene: Scene): void;
  59990. /**
  59991. * Starts all particle systems of the set
  59992. * @param emitter defines an optional mesh to use as emitter for the particle systems
  59993. */
  59994. start(emitter?: AbstractMesh): void;
  59995. /**
  59996. * Release all associated resources
  59997. */
  59998. dispose(): void;
  59999. /**
  60000. * Serialize the set into a JSON compatible object
  60001. * @returns a JSON compatible representation of the set
  60002. */
  60003. serialize(): any;
  60004. /**
  60005. * Parse a new ParticleSystemSet from a serialized source
  60006. * @param data defines a JSON compatible representation of the set
  60007. * @param scene defines the hosting scene
  60008. * @param gpu defines if we want GPU particles or CPU particles
  60009. * @returns a new ParticleSystemSet
  60010. */
  60011. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  60012. }
  60013. }
  60014. declare module "babylonjs/Particles/particleHelper" {
  60015. import { Nullable } from "babylonjs/types";
  60016. import { Scene } from "babylonjs/scene";
  60017. import { Vector3 } from "babylonjs/Maths/math.vector";
  60018. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60019. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  60020. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  60021. /**
  60022. * This class is made for on one-liner static method to help creating particle system set.
  60023. */
  60024. export class ParticleHelper {
  60025. /**
  60026. * Gets or sets base Assets URL
  60027. */
  60028. static BaseAssetsUrl: string;
  60029. /**
  60030. * Create a default particle system that you can tweak
  60031. * @param emitter defines the emitter to use
  60032. * @param capacity defines the system capacity (default is 500 particles)
  60033. * @param scene defines the hosting scene
  60034. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  60035. * @returns the new Particle system
  60036. */
  60037. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  60038. /**
  60039. * This is the main static method (one-liner) of this helper to create different particle systems
  60040. * @param type This string represents the type to the particle system to create
  60041. * @param scene The scene where the particle system should live
  60042. * @param gpu If the system will use gpu
  60043. * @returns the ParticleSystemSet created
  60044. */
  60045. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  60046. /**
  60047. * Static function used to export a particle system to a ParticleSystemSet variable.
  60048. * Please note that the emitter shape is not exported
  60049. * @param systems defines the particle systems to export
  60050. * @returns the created particle system set
  60051. */
  60052. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  60053. }
  60054. }
  60055. declare module "babylonjs/Particles/particleSystemComponent" {
  60056. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  60057. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  60058. import "babylonjs/Shaders/particles.vertex";
  60059. module "babylonjs/Engines/engine" {
  60060. interface Engine {
  60061. /**
  60062. * Create an effect to use with particle systems.
  60063. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  60064. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  60065. * @param uniformsNames defines a list of attribute names
  60066. * @param samplers defines an array of string used to represent textures
  60067. * @param defines defines the string containing the defines to use to compile the shaders
  60068. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  60069. * @param onCompiled defines a function to call when the effect creation is successful
  60070. * @param onError defines a function to call when the effect creation has failed
  60071. * @returns the new Effect
  60072. */
  60073. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  60074. }
  60075. }
  60076. module "babylonjs/Meshes/mesh" {
  60077. interface Mesh {
  60078. /**
  60079. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  60080. * @returns an array of IParticleSystem
  60081. */
  60082. getEmittedParticleSystems(): IParticleSystem[];
  60083. /**
  60084. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  60085. * @returns an array of IParticleSystem
  60086. */
  60087. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  60088. }
  60089. }
  60090. /**
  60091. * @hidden
  60092. */
  60093. export var _IDoNeedToBeInTheBuild: number;
  60094. }
  60095. declare module "babylonjs/Particles/index" {
  60096. export * from "babylonjs/Particles/baseParticleSystem";
  60097. export * from "babylonjs/Particles/EmitterTypes/index";
  60098. export * from "babylonjs/Particles/gpuParticleSystem";
  60099. export * from "babylonjs/Particles/IParticleSystem";
  60100. export * from "babylonjs/Particles/particle";
  60101. export * from "babylonjs/Particles/particleHelper";
  60102. export * from "babylonjs/Particles/particleSystem";
  60103. export * from "babylonjs/Particles/particleSystemComponent";
  60104. export * from "babylonjs/Particles/particleSystemSet";
  60105. export * from "babylonjs/Particles/solidParticle";
  60106. export * from "babylonjs/Particles/solidParticleSystem";
  60107. export * from "babylonjs/Particles/subEmitter";
  60108. }
  60109. declare module "babylonjs/Physics/physicsEngineComponent" {
  60110. import { Nullable } from "babylonjs/types";
  60111. import { Observable, Observer } from "babylonjs/Misc/observable";
  60112. import { Vector3 } from "babylonjs/Maths/math.vector";
  60113. import { Mesh } from "babylonjs/Meshes/mesh";
  60114. import { ISceneComponent } from "babylonjs/sceneComponent";
  60115. import { Scene } from "babylonjs/scene";
  60116. import { Node } from "babylonjs/node";
  60117. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  60118. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  60119. module "babylonjs/scene" {
  60120. interface Scene {
  60121. /** @hidden (Backing field) */
  60122. _physicsEngine: Nullable<IPhysicsEngine>;
  60123. /**
  60124. * Gets the current physics engine
  60125. * @returns a IPhysicsEngine or null if none attached
  60126. */
  60127. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  60128. /**
  60129. * Enables physics to the current scene
  60130. * @param gravity defines the scene's gravity for the physics engine
  60131. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  60132. * @return a boolean indicating if the physics engine was initialized
  60133. */
  60134. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  60135. /**
  60136. * Disables and disposes the physics engine associated with the scene
  60137. */
  60138. disablePhysicsEngine(): void;
  60139. /**
  60140. * Gets a boolean indicating if there is an active physics engine
  60141. * @returns a boolean indicating if there is an active physics engine
  60142. */
  60143. isPhysicsEnabled(): boolean;
  60144. /**
  60145. * Deletes a physics compound impostor
  60146. * @param compound defines the compound to delete
  60147. */
  60148. deleteCompoundImpostor(compound: any): void;
  60149. /**
  60150. * An event triggered when physic simulation is about to be run
  60151. */
  60152. onBeforePhysicsObservable: Observable<Scene>;
  60153. /**
  60154. * An event triggered when physic simulation has been done
  60155. */
  60156. onAfterPhysicsObservable: Observable<Scene>;
  60157. }
  60158. }
  60159. module "babylonjs/Meshes/abstractMesh" {
  60160. interface AbstractMesh {
  60161. /** @hidden */
  60162. _physicsImpostor: Nullable<PhysicsImpostor>;
  60163. /**
  60164. * Gets or sets impostor used for physic simulation
  60165. * @see http://doc.babylonjs.com/features/physics_engine
  60166. */
  60167. physicsImpostor: Nullable<PhysicsImpostor>;
  60168. /**
  60169. * Gets the current physics impostor
  60170. * @see http://doc.babylonjs.com/features/physics_engine
  60171. * @returns a physics impostor or null
  60172. */
  60173. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  60174. /** Apply a physic impulse to the mesh
  60175. * @param force defines the force to apply
  60176. * @param contactPoint defines where to apply the force
  60177. * @returns the current mesh
  60178. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  60179. */
  60180. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  60181. /**
  60182. * Creates a physic joint between two meshes
  60183. * @param otherMesh defines the other mesh to use
  60184. * @param pivot1 defines the pivot to use on this mesh
  60185. * @param pivot2 defines the pivot to use on the other mesh
  60186. * @param options defines additional options (can be plugin dependent)
  60187. * @returns the current mesh
  60188. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  60189. */
  60190. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  60191. /** @hidden */
  60192. _disposePhysicsObserver: Nullable<Observer<Node>>;
  60193. }
  60194. }
  60195. /**
  60196. * Defines the physics engine scene component responsible to manage a physics engine
  60197. */
  60198. export class PhysicsEngineSceneComponent implements ISceneComponent {
  60199. /**
  60200. * The component name helpful to identify the component in the list of scene components.
  60201. */
  60202. readonly name: string;
  60203. /**
  60204. * The scene the component belongs to.
  60205. */
  60206. scene: Scene;
  60207. /**
  60208. * Creates a new instance of the component for the given scene
  60209. * @param scene Defines the scene to register the component in
  60210. */
  60211. constructor(scene: Scene);
  60212. /**
  60213. * Registers the component in a given scene
  60214. */
  60215. register(): void;
  60216. /**
  60217. * Rebuilds the elements related to this component in case of
  60218. * context lost for instance.
  60219. */
  60220. rebuild(): void;
  60221. /**
  60222. * Disposes the component and the associated ressources
  60223. */
  60224. dispose(): void;
  60225. }
  60226. }
  60227. declare module "babylonjs/Physics/physicsHelper" {
  60228. import { Nullable } from "babylonjs/types";
  60229. import { Vector3 } from "babylonjs/Maths/math.vector";
  60230. import { Mesh } from "babylonjs/Meshes/mesh";
  60231. import { Scene } from "babylonjs/scene";
  60232. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  60233. /**
  60234. * A helper for physics simulations
  60235. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60236. */
  60237. export class PhysicsHelper {
  60238. private _scene;
  60239. private _physicsEngine;
  60240. /**
  60241. * Initializes the Physics helper
  60242. * @param scene Babylon.js scene
  60243. */
  60244. constructor(scene: Scene);
  60245. /**
  60246. * Applies a radial explosion impulse
  60247. * @param origin the origin of the explosion
  60248. * @param radiusOrEventOptions the radius or the options of radial explosion
  60249. * @param strength the explosion strength
  60250. * @param falloff possible options: Constant & Linear. Defaults to Constant
  60251. * @returns A physics radial explosion event, or null
  60252. */
  60253. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  60254. /**
  60255. * Applies a radial explosion force
  60256. * @param origin the origin of the explosion
  60257. * @param radiusOrEventOptions the radius or the options of radial explosion
  60258. * @param strength the explosion strength
  60259. * @param falloff possible options: Constant & Linear. Defaults to Constant
  60260. * @returns A physics radial explosion event, or null
  60261. */
  60262. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  60263. /**
  60264. * Creates a gravitational field
  60265. * @param origin the origin of the explosion
  60266. * @param radiusOrEventOptions the radius or the options of radial explosion
  60267. * @param strength the explosion strength
  60268. * @param falloff possible options: Constant & Linear. Defaults to Constant
  60269. * @returns A physics gravitational field event, or null
  60270. */
  60271. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  60272. /**
  60273. * Creates a physics updraft event
  60274. * @param origin the origin of the updraft
  60275. * @param radiusOrEventOptions the radius or the options of the updraft
  60276. * @param strength the strength of the updraft
  60277. * @param height the height of the updraft
  60278. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  60279. * @returns A physics updraft event, or null
  60280. */
  60281. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  60282. /**
  60283. * Creates a physics vortex event
  60284. * @param origin the of the vortex
  60285. * @param radiusOrEventOptions the radius or the options of the vortex
  60286. * @param strength the strength of the vortex
  60287. * @param height the height of the vortex
  60288. * @returns a Physics vortex event, or null
  60289. * A physics vortex event or null
  60290. */
  60291. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  60292. }
  60293. /**
  60294. * Represents a physics radial explosion event
  60295. */
  60296. class PhysicsRadialExplosionEvent {
  60297. private _scene;
  60298. private _options;
  60299. private _sphere;
  60300. private _dataFetched;
  60301. /**
  60302. * Initializes a radial explosioin event
  60303. * @param _scene BabylonJS scene
  60304. * @param _options The options for the vortex event
  60305. */
  60306. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  60307. /**
  60308. * Returns the data related to the radial explosion event (sphere).
  60309. * @returns The radial explosion event data
  60310. */
  60311. getData(): PhysicsRadialExplosionEventData;
  60312. /**
  60313. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  60314. * @param impostor A physics imposter
  60315. * @param origin the origin of the explosion
  60316. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  60317. */
  60318. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  60319. /**
  60320. * Triggers affecterd impostors callbacks
  60321. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  60322. */
  60323. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  60324. /**
  60325. * Disposes the sphere.
  60326. * @param force Specifies if the sphere should be disposed by force
  60327. */
  60328. dispose(force?: boolean): void;
  60329. /*** Helpers ***/
  60330. private _prepareSphere;
  60331. private _intersectsWithSphere;
  60332. }
  60333. /**
  60334. * Represents a gravitational field event
  60335. */
  60336. class PhysicsGravitationalFieldEvent {
  60337. private _physicsHelper;
  60338. private _scene;
  60339. private _origin;
  60340. private _options;
  60341. private _tickCallback;
  60342. private _sphere;
  60343. private _dataFetched;
  60344. /**
  60345. * Initializes the physics gravitational field event
  60346. * @param _physicsHelper A physics helper
  60347. * @param _scene BabylonJS scene
  60348. * @param _origin The origin position of the gravitational field event
  60349. * @param _options The options for the vortex event
  60350. */
  60351. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  60352. /**
  60353. * Returns the data related to the gravitational field event (sphere).
  60354. * @returns A gravitational field event
  60355. */
  60356. getData(): PhysicsGravitationalFieldEventData;
  60357. /**
  60358. * Enables the gravitational field.
  60359. */
  60360. enable(): void;
  60361. /**
  60362. * Disables the gravitational field.
  60363. */
  60364. disable(): void;
  60365. /**
  60366. * Disposes the sphere.
  60367. * @param force The force to dispose from the gravitational field event
  60368. */
  60369. dispose(force?: boolean): void;
  60370. private _tick;
  60371. }
  60372. /**
  60373. * Represents a physics updraft event
  60374. */
  60375. class PhysicsUpdraftEvent {
  60376. private _scene;
  60377. private _origin;
  60378. private _options;
  60379. private _physicsEngine;
  60380. private _originTop;
  60381. private _originDirection;
  60382. private _tickCallback;
  60383. private _cylinder;
  60384. private _cylinderPosition;
  60385. private _dataFetched;
  60386. /**
  60387. * Initializes the physics updraft event
  60388. * @param _scene BabylonJS scene
  60389. * @param _origin The origin position of the updraft
  60390. * @param _options The options for the updraft event
  60391. */
  60392. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  60393. /**
  60394. * Returns the data related to the updraft event (cylinder).
  60395. * @returns A physics updraft event
  60396. */
  60397. getData(): PhysicsUpdraftEventData;
  60398. /**
  60399. * Enables the updraft.
  60400. */
  60401. enable(): void;
  60402. /**
  60403. * Disables the updraft.
  60404. */
  60405. disable(): void;
  60406. /**
  60407. * Disposes the cylinder.
  60408. * @param force Specifies if the updraft should be disposed by force
  60409. */
  60410. dispose(force?: boolean): void;
  60411. private getImpostorHitData;
  60412. private _tick;
  60413. /*** Helpers ***/
  60414. private _prepareCylinder;
  60415. private _intersectsWithCylinder;
  60416. }
  60417. /**
  60418. * Represents a physics vortex event
  60419. */
  60420. class PhysicsVortexEvent {
  60421. private _scene;
  60422. private _origin;
  60423. private _options;
  60424. private _physicsEngine;
  60425. private _originTop;
  60426. private _tickCallback;
  60427. private _cylinder;
  60428. private _cylinderPosition;
  60429. private _dataFetched;
  60430. /**
  60431. * Initializes the physics vortex event
  60432. * @param _scene The BabylonJS scene
  60433. * @param _origin The origin position of the vortex
  60434. * @param _options The options for the vortex event
  60435. */
  60436. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  60437. /**
  60438. * Returns the data related to the vortex event (cylinder).
  60439. * @returns The physics vortex event data
  60440. */
  60441. getData(): PhysicsVortexEventData;
  60442. /**
  60443. * Enables the vortex.
  60444. */
  60445. enable(): void;
  60446. /**
  60447. * Disables the cortex.
  60448. */
  60449. disable(): void;
  60450. /**
  60451. * Disposes the sphere.
  60452. * @param force
  60453. */
  60454. dispose(force?: boolean): void;
  60455. private getImpostorHitData;
  60456. private _tick;
  60457. /*** Helpers ***/
  60458. private _prepareCylinder;
  60459. private _intersectsWithCylinder;
  60460. }
  60461. /**
  60462. * Options fot the radial explosion event
  60463. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60464. */
  60465. export class PhysicsRadialExplosionEventOptions {
  60466. /**
  60467. * The radius of the sphere for the radial explosion.
  60468. */
  60469. radius: number;
  60470. /**
  60471. * The strenth of the explosion.
  60472. */
  60473. strength: number;
  60474. /**
  60475. * The strenght of the force in correspondence to the distance of the affected object
  60476. */
  60477. falloff: PhysicsRadialImpulseFalloff;
  60478. /**
  60479. * Sphere options for the radial explosion.
  60480. */
  60481. sphere: {
  60482. segments: number;
  60483. diameter: number;
  60484. };
  60485. /**
  60486. * Sphere options for the radial explosion.
  60487. */
  60488. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  60489. }
  60490. /**
  60491. * Options fot the updraft event
  60492. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60493. */
  60494. export class PhysicsUpdraftEventOptions {
  60495. /**
  60496. * The radius of the cylinder for the vortex
  60497. */
  60498. radius: number;
  60499. /**
  60500. * The strenth of the updraft.
  60501. */
  60502. strength: number;
  60503. /**
  60504. * The height of the cylinder for the updraft.
  60505. */
  60506. height: number;
  60507. /**
  60508. * The mode for the the updraft.
  60509. */
  60510. updraftMode: PhysicsUpdraftMode;
  60511. }
  60512. /**
  60513. * Options fot the vortex event
  60514. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60515. */
  60516. export class PhysicsVortexEventOptions {
  60517. /**
  60518. * The radius of the cylinder for the vortex
  60519. */
  60520. radius: number;
  60521. /**
  60522. * The strenth of the vortex.
  60523. */
  60524. strength: number;
  60525. /**
  60526. * The height of the cylinder for the vortex.
  60527. */
  60528. height: number;
  60529. /**
  60530. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  60531. */
  60532. centripetalForceThreshold: number;
  60533. /**
  60534. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  60535. */
  60536. centripetalForceMultiplier: number;
  60537. /**
  60538. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  60539. */
  60540. centrifugalForceMultiplier: number;
  60541. /**
  60542. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  60543. */
  60544. updraftForceMultiplier: number;
  60545. }
  60546. /**
  60547. * The strenght of the force in correspondence to the distance of the affected object
  60548. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60549. */
  60550. export enum PhysicsRadialImpulseFalloff {
  60551. /** Defines that impulse is constant in strength across it's whole radius */
  60552. Constant = 0,
  60553. /** Defines that impulse gets weaker if it's further from the origin */
  60554. Linear = 1
  60555. }
  60556. /**
  60557. * The strength of the force in correspondence to the distance of the affected object
  60558. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60559. */
  60560. export enum PhysicsUpdraftMode {
  60561. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  60562. Center = 0,
  60563. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  60564. Perpendicular = 1
  60565. }
  60566. /**
  60567. * Interface for a physics hit data
  60568. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60569. */
  60570. export interface PhysicsHitData {
  60571. /**
  60572. * The force applied at the contact point
  60573. */
  60574. force: Vector3;
  60575. /**
  60576. * The contact point
  60577. */
  60578. contactPoint: Vector3;
  60579. /**
  60580. * The distance from the origin to the contact point
  60581. */
  60582. distanceFromOrigin: number;
  60583. }
  60584. /**
  60585. * Interface for radial explosion event data
  60586. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60587. */
  60588. export interface PhysicsRadialExplosionEventData {
  60589. /**
  60590. * A sphere used for the radial explosion event
  60591. */
  60592. sphere: Mesh;
  60593. }
  60594. /**
  60595. * Interface for gravitational field event data
  60596. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60597. */
  60598. export interface PhysicsGravitationalFieldEventData {
  60599. /**
  60600. * A sphere mesh used for the gravitational field event
  60601. */
  60602. sphere: Mesh;
  60603. }
  60604. /**
  60605. * Interface for updraft event data
  60606. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60607. */
  60608. export interface PhysicsUpdraftEventData {
  60609. /**
  60610. * A cylinder used for the updraft event
  60611. */
  60612. cylinder: Mesh;
  60613. }
  60614. /**
  60615. * Interface for vortex event data
  60616. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60617. */
  60618. export interface PhysicsVortexEventData {
  60619. /**
  60620. * A cylinder used for the vortex event
  60621. */
  60622. cylinder: Mesh;
  60623. }
  60624. /**
  60625. * Interface for an affected physics impostor
  60626. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  60627. */
  60628. export interface PhysicsAffectedImpostorWithData {
  60629. /**
  60630. * The impostor affected by the effect
  60631. */
  60632. impostor: PhysicsImpostor;
  60633. /**
  60634. * The data about the hit/horce from the explosion
  60635. */
  60636. hitData: PhysicsHitData;
  60637. }
  60638. }
  60639. declare module "babylonjs/Physics/Plugins/index" {
  60640. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  60641. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  60642. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  60643. }
  60644. declare module "babylonjs/Physics/index" {
  60645. export * from "babylonjs/Physics/IPhysicsEngine";
  60646. export * from "babylonjs/Physics/physicsEngine";
  60647. export * from "babylonjs/Physics/physicsEngineComponent";
  60648. export * from "babylonjs/Physics/physicsHelper";
  60649. export * from "babylonjs/Physics/physicsImpostor";
  60650. export * from "babylonjs/Physics/physicsJoint";
  60651. export * from "babylonjs/Physics/Plugins/index";
  60652. }
  60653. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  60654. /** @hidden */
  60655. export var blackAndWhitePixelShader: {
  60656. name: string;
  60657. shader: string;
  60658. };
  60659. }
  60660. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  60661. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60662. import { Camera } from "babylonjs/Cameras/camera";
  60663. import { Engine } from "babylonjs/Engines/engine";
  60664. import "babylonjs/Shaders/blackAndWhite.fragment";
  60665. /**
  60666. * Post process used to render in black and white
  60667. */
  60668. export class BlackAndWhitePostProcess extends PostProcess {
  60669. /**
  60670. * Linear about to convert he result to black and white (default: 1)
  60671. */
  60672. degree: number;
  60673. /**
  60674. * Creates a black and white post process
  60675. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  60676. * @param name The name of the effect.
  60677. * @param options The required width/height ratio to downsize to before computing the render pass.
  60678. * @param camera The camera to apply the render pass to.
  60679. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60680. * @param engine The engine which the post process will be applied. (default: current engine)
  60681. * @param reusable If the post process can be reused on the same frame. (default: false)
  60682. */
  60683. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  60684. }
  60685. }
  60686. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  60687. import { Nullable } from "babylonjs/types";
  60688. import { Camera } from "babylonjs/Cameras/camera";
  60689. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60690. import { Engine } from "babylonjs/Engines/engine";
  60691. /**
  60692. * This represents a set of one or more post processes in Babylon.
  60693. * A post process can be used to apply a shader to a texture after it is rendered.
  60694. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  60695. */
  60696. export class PostProcessRenderEffect {
  60697. private _postProcesses;
  60698. private _getPostProcesses;
  60699. private _singleInstance;
  60700. private _cameras;
  60701. private _indicesForCamera;
  60702. /**
  60703. * Name of the effect
  60704. * @hidden
  60705. */
  60706. _name: string;
  60707. /**
  60708. * Instantiates a post process render effect.
  60709. * A post process can be used to apply a shader to a texture after it is rendered.
  60710. * @param engine The engine the effect is tied to
  60711. * @param name The name of the effect
  60712. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  60713. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  60714. */
  60715. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  60716. /**
  60717. * Checks if all the post processes in the effect are supported.
  60718. */
  60719. readonly isSupported: boolean;
  60720. /**
  60721. * Updates the current state of the effect
  60722. * @hidden
  60723. */
  60724. _update(): void;
  60725. /**
  60726. * Attaches the effect on cameras
  60727. * @param cameras The camera to attach to.
  60728. * @hidden
  60729. */
  60730. _attachCameras(cameras: Camera): void;
  60731. /**
  60732. * Attaches the effect on cameras
  60733. * @param cameras The camera to attach to.
  60734. * @hidden
  60735. */
  60736. _attachCameras(cameras: Camera[]): void;
  60737. /**
  60738. * Detaches the effect on cameras
  60739. * @param cameras The camera to detatch from.
  60740. * @hidden
  60741. */
  60742. _detachCameras(cameras: Camera): void;
  60743. /**
  60744. * Detatches the effect on cameras
  60745. * @param cameras The camera to detatch from.
  60746. * @hidden
  60747. */
  60748. _detachCameras(cameras: Camera[]): void;
  60749. /**
  60750. * Enables the effect on given cameras
  60751. * @param cameras The camera to enable.
  60752. * @hidden
  60753. */
  60754. _enable(cameras: Camera): void;
  60755. /**
  60756. * Enables the effect on given cameras
  60757. * @param cameras The camera to enable.
  60758. * @hidden
  60759. */
  60760. _enable(cameras: Nullable<Camera[]>): void;
  60761. /**
  60762. * Disables the effect on the given cameras
  60763. * @param cameras The camera to disable.
  60764. * @hidden
  60765. */
  60766. _disable(cameras: Camera): void;
  60767. /**
  60768. * Disables the effect on the given cameras
  60769. * @param cameras The camera to disable.
  60770. * @hidden
  60771. */
  60772. _disable(cameras: Nullable<Camera[]>): void;
  60773. /**
  60774. * Gets a list of the post processes contained in the effect.
  60775. * @param camera The camera to get the post processes on.
  60776. * @returns The list of the post processes in the effect.
  60777. */
  60778. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  60779. }
  60780. }
  60781. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  60782. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  60783. /** @hidden */
  60784. export var extractHighlightsPixelShader: {
  60785. name: string;
  60786. shader: string;
  60787. };
  60788. }
  60789. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  60790. import { Nullable } from "babylonjs/types";
  60791. import { Camera } from "babylonjs/Cameras/camera";
  60792. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60793. import { Engine } from "babylonjs/Engines/engine";
  60794. import "babylonjs/Shaders/extractHighlights.fragment";
  60795. /**
  60796. * 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.
  60797. */
  60798. export class ExtractHighlightsPostProcess extends PostProcess {
  60799. /**
  60800. * The luminance threshold, pixels below this value will be set to black.
  60801. */
  60802. threshold: number;
  60803. /** @hidden */
  60804. _exposure: number;
  60805. /**
  60806. * Post process which has the input texture to be used when performing highlight extraction
  60807. * @hidden
  60808. */
  60809. _inputPostProcess: Nullable<PostProcess>;
  60810. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60811. }
  60812. }
  60813. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  60814. /** @hidden */
  60815. export var bloomMergePixelShader: {
  60816. name: string;
  60817. shader: string;
  60818. };
  60819. }
  60820. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  60821. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60822. import { Nullable } from "babylonjs/types";
  60823. import { Engine } from "babylonjs/Engines/engine";
  60824. import { Camera } from "babylonjs/Cameras/camera";
  60825. import "babylonjs/Shaders/bloomMerge.fragment";
  60826. /**
  60827. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  60828. */
  60829. export class BloomMergePostProcess extends PostProcess {
  60830. /** Weight of the bloom to be added to the original input. */
  60831. weight: number;
  60832. /**
  60833. * Creates a new instance of @see BloomMergePostProcess
  60834. * @param name The name of the effect.
  60835. * @param originalFromInput Post process which's input will be used for the merge.
  60836. * @param blurred Blurred highlights post process which's output will be used.
  60837. * @param weight Weight of the bloom to be added to the original input.
  60838. * @param options The required width/height ratio to downsize to before computing the render pass.
  60839. * @param camera The camera to apply the render pass to.
  60840. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60841. * @param engine The engine which the post process will be applied. (default: current engine)
  60842. * @param reusable If the post process can be reused on the same frame. (default: false)
  60843. * @param textureType Type of textures used when performing the post process. (default: 0)
  60844. * @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)
  60845. */
  60846. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  60847. /** Weight of the bloom to be added to the original input. */
  60848. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60849. }
  60850. }
  60851. declare module "babylonjs/PostProcesses/bloomEffect" {
  60852. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  60853. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60854. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  60855. import { Camera } from "babylonjs/Cameras/camera";
  60856. import { Scene } from "babylonjs/scene";
  60857. /**
  60858. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  60859. */
  60860. export class BloomEffect extends PostProcessRenderEffect {
  60861. private bloomScale;
  60862. /**
  60863. * @hidden Internal
  60864. */
  60865. _effects: Array<PostProcess>;
  60866. /**
  60867. * @hidden Internal
  60868. */
  60869. _downscale: ExtractHighlightsPostProcess;
  60870. private _blurX;
  60871. private _blurY;
  60872. private _merge;
  60873. /**
  60874. * The luminance threshold to find bright areas of the image to bloom.
  60875. */
  60876. threshold: number;
  60877. /**
  60878. * The strength of the bloom.
  60879. */
  60880. weight: number;
  60881. /**
  60882. * Specifies the size of the bloom blur kernel, relative to the final output size
  60883. */
  60884. kernel: number;
  60885. /**
  60886. * Creates a new instance of @see BloomEffect
  60887. * @param scene The scene the effect belongs to.
  60888. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  60889. * @param bloomKernel The size of the kernel to be used when applying the blur.
  60890. * @param bloomWeight The the strength of bloom.
  60891. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  60892. * @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)
  60893. */
  60894. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  60895. /**
  60896. * Disposes each of the internal effects for a given camera.
  60897. * @param camera The camera to dispose the effect on.
  60898. */
  60899. disposeEffects(camera: Camera): void;
  60900. /**
  60901. * @hidden Internal
  60902. */
  60903. _updateEffects(): void;
  60904. /**
  60905. * Internal
  60906. * @returns if all the contained post processes are ready.
  60907. * @hidden
  60908. */
  60909. _isReady(): boolean;
  60910. }
  60911. }
  60912. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  60913. /** @hidden */
  60914. export var chromaticAberrationPixelShader: {
  60915. name: string;
  60916. shader: string;
  60917. };
  60918. }
  60919. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  60920. import { Vector2 } from "babylonjs/Maths/math.vector";
  60921. import { Nullable } from "babylonjs/types";
  60922. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60923. import { Camera } from "babylonjs/Cameras/camera";
  60924. import { Engine } from "babylonjs/Engines/engine";
  60925. import "babylonjs/Shaders/chromaticAberration.fragment";
  60926. /**
  60927. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  60928. */
  60929. export class ChromaticAberrationPostProcess extends PostProcess {
  60930. /**
  60931. * The amount of seperation of rgb channels (default: 30)
  60932. */
  60933. aberrationAmount: number;
  60934. /**
  60935. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  60936. */
  60937. radialIntensity: number;
  60938. /**
  60939. * 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))
  60940. */
  60941. direction: Vector2;
  60942. /**
  60943. * 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))
  60944. */
  60945. centerPosition: Vector2;
  60946. /**
  60947. * Creates a new instance ChromaticAberrationPostProcess
  60948. * @param name The name of the effect.
  60949. * @param screenWidth The width of the screen to apply the effect on.
  60950. * @param screenHeight The height of the screen to apply the effect on.
  60951. * @param options The required width/height ratio to downsize to before computing the render pass.
  60952. * @param camera The camera to apply the render pass to.
  60953. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60954. * @param engine The engine which the post process will be applied. (default: current engine)
  60955. * @param reusable If the post process can be reused on the same frame. (default: false)
  60956. * @param textureType Type of textures used when performing the post process. (default: 0)
  60957. * @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)
  60958. */
  60959. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60960. }
  60961. }
  60962. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  60963. /** @hidden */
  60964. export var circleOfConfusionPixelShader: {
  60965. name: string;
  60966. shader: string;
  60967. };
  60968. }
  60969. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  60970. import { Nullable } from "babylonjs/types";
  60971. import { Engine } from "babylonjs/Engines/engine";
  60972. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60973. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60974. import { Camera } from "babylonjs/Cameras/camera";
  60975. import "babylonjs/Shaders/circleOfConfusion.fragment";
  60976. /**
  60977. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  60978. */
  60979. export class CircleOfConfusionPostProcess extends PostProcess {
  60980. /**
  60981. * 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.
  60982. */
  60983. lensSize: number;
  60984. /**
  60985. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  60986. */
  60987. fStop: number;
  60988. /**
  60989. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  60990. */
  60991. focusDistance: number;
  60992. /**
  60993. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  60994. */
  60995. focalLength: number;
  60996. private _depthTexture;
  60997. /**
  60998. * Creates a new instance CircleOfConfusionPostProcess
  60999. * @param name The name of the effect.
  61000. * @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.
  61001. * @param options The required width/height ratio to downsize to before computing the render pass.
  61002. * @param camera The camera to apply the render pass to.
  61003. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61004. * @param engine The engine which the post process will be applied. (default: current engine)
  61005. * @param reusable If the post process can be reused on the same frame. (default: false)
  61006. * @param textureType Type of textures used when performing the post process. (default: 0)
  61007. * @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)
  61008. */
  61009. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  61010. /**
  61011. * 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.
  61012. */
  61013. depthTexture: RenderTargetTexture;
  61014. }
  61015. }
  61016. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  61017. /** @hidden */
  61018. export var colorCorrectionPixelShader: {
  61019. name: string;
  61020. shader: string;
  61021. };
  61022. }
  61023. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  61024. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61025. import { Engine } from "babylonjs/Engines/engine";
  61026. import { Camera } from "babylonjs/Cameras/camera";
  61027. import "babylonjs/Shaders/colorCorrection.fragment";
  61028. /**
  61029. *
  61030. * This post-process allows the modification of rendered colors by using
  61031. * a 'look-up table' (LUT). This effect is also called Color Grading.
  61032. *
  61033. * The object needs to be provided an url to a texture containing the color
  61034. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  61035. * Use an image editing software to tweak the LUT to match your needs.
  61036. *
  61037. * For an example of a color LUT, see here:
  61038. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  61039. * For explanations on color grading, see here:
  61040. * @see http://udn.epicgames.com/Three/ColorGrading.html
  61041. *
  61042. */
  61043. export class ColorCorrectionPostProcess extends PostProcess {
  61044. private _colorTableTexture;
  61045. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  61046. }
  61047. }
  61048. declare module "babylonjs/Shaders/convolution.fragment" {
  61049. /** @hidden */
  61050. export var convolutionPixelShader: {
  61051. name: string;
  61052. shader: string;
  61053. };
  61054. }
  61055. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  61056. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61057. import { Nullable } from "babylonjs/types";
  61058. import { Camera } from "babylonjs/Cameras/camera";
  61059. import { Engine } from "babylonjs/Engines/engine";
  61060. import "babylonjs/Shaders/convolution.fragment";
  61061. /**
  61062. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  61063. * input texture to perform effects such as edge detection or sharpening
  61064. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  61065. */
  61066. export class ConvolutionPostProcess extends PostProcess {
  61067. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  61068. kernel: number[];
  61069. /**
  61070. * Creates a new instance ConvolutionPostProcess
  61071. * @param name The name of the effect.
  61072. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  61073. * @param options The required width/height ratio to downsize to before computing the render pass.
  61074. * @param camera The camera to apply the render pass to.
  61075. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61076. * @param engine The engine which the post process will be applied. (default: current engine)
  61077. * @param reusable If the post process can be reused on the same frame. (default: false)
  61078. * @param textureType Type of textures used when performing the post process. (default: 0)
  61079. */
  61080. constructor(name: string,
  61081. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  61082. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  61083. /**
  61084. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61085. */
  61086. static EdgeDetect0Kernel: number[];
  61087. /**
  61088. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61089. */
  61090. static EdgeDetect1Kernel: number[];
  61091. /**
  61092. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61093. */
  61094. static EdgeDetect2Kernel: number[];
  61095. /**
  61096. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61097. */
  61098. static SharpenKernel: number[];
  61099. /**
  61100. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61101. */
  61102. static EmbossKernel: number[];
  61103. /**
  61104. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  61105. */
  61106. static GaussianKernel: number[];
  61107. }
  61108. }
  61109. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  61110. import { Nullable } from "babylonjs/types";
  61111. import { Vector2 } from "babylonjs/Maths/math.vector";
  61112. import { Camera } from "babylonjs/Cameras/camera";
  61113. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61114. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  61115. import { Engine } from "babylonjs/Engines/engine";
  61116. import { Scene } from "babylonjs/scene";
  61117. /**
  61118. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  61119. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  61120. * based on samples that have a large difference in distance than the center pixel.
  61121. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  61122. */
  61123. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  61124. direction: Vector2;
  61125. /**
  61126. * Creates a new instance CircleOfConfusionPostProcess
  61127. * @param name The name of the effect.
  61128. * @param scene The scene the effect belongs to.
  61129. * @param direction The direction the blur should be applied.
  61130. * @param kernel The size of the kernel used to blur.
  61131. * @param options The required width/height ratio to downsize to before computing the render pass.
  61132. * @param camera The camera to apply the render pass to.
  61133. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  61134. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  61135. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61136. * @param engine The engine which the post process will be applied. (default: current engine)
  61137. * @param reusable If the post process can be reused on the same frame. (default: false)
  61138. * @param textureType Type of textures used when performing the post process. (default: 0)
  61139. * @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)
  61140. */
  61141. 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);
  61142. }
  61143. }
  61144. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  61145. /** @hidden */
  61146. export var depthOfFieldMergePixelShader: {
  61147. name: string;
  61148. shader: string;
  61149. };
  61150. }
  61151. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  61152. import { Nullable } from "babylonjs/types";
  61153. import { Camera } from "babylonjs/Cameras/camera";
  61154. import { Effect } from "babylonjs/Materials/effect";
  61155. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61156. import { Engine } from "babylonjs/Engines/engine";
  61157. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  61158. /**
  61159. * Options to be set when merging outputs from the default pipeline.
  61160. */
  61161. export class DepthOfFieldMergePostProcessOptions {
  61162. /**
  61163. * The original image to merge on top of
  61164. */
  61165. originalFromInput: PostProcess;
  61166. /**
  61167. * Parameters to perform the merge of the depth of field effect
  61168. */
  61169. depthOfField?: {
  61170. circleOfConfusion: PostProcess;
  61171. blurSteps: Array<PostProcess>;
  61172. };
  61173. /**
  61174. * Parameters to perform the merge of bloom effect
  61175. */
  61176. bloom?: {
  61177. blurred: PostProcess;
  61178. weight: number;
  61179. };
  61180. }
  61181. /**
  61182. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  61183. */
  61184. export class DepthOfFieldMergePostProcess extends PostProcess {
  61185. private blurSteps;
  61186. /**
  61187. * Creates a new instance of DepthOfFieldMergePostProcess
  61188. * @param name The name of the effect.
  61189. * @param originalFromInput Post process which's input will be used for the merge.
  61190. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  61191. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  61192. * @param options The required width/height ratio to downsize to before computing the render pass.
  61193. * @param camera The camera to apply the render pass to.
  61194. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61195. * @param engine The engine which the post process will be applied. (default: current engine)
  61196. * @param reusable If the post process can be reused on the same frame. (default: false)
  61197. * @param textureType Type of textures used when performing the post process. (default: 0)
  61198. * @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)
  61199. */
  61200. 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);
  61201. /**
  61202. * Updates the effect with the current post process compile time values and recompiles the shader.
  61203. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  61204. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  61205. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  61206. * @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
  61207. * @param onCompiled Called when the shader has been compiled.
  61208. * @param onError Called if there is an error when compiling a shader.
  61209. */
  61210. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  61211. }
  61212. }
  61213. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  61214. import { Nullable } from "babylonjs/types";
  61215. import { Camera } from "babylonjs/Cameras/camera";
  61216. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61217. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61218. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  61219. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  61220. import { Scene } from "babylonjs/scene";
  61221. /**
  61222. * Specifies the level of max blur that should be applied when using the depth of field effect
  61223. */
  61224. export enum DepthOfFieldEffectBlurLevel {
  61225. /**
  61226. * Subtle blur
  61227. */
  61228. Low = 0,
  61229. /**
  61230. * Medium blur
  61231. */
  61232. Medium = 1,
  61233. /**
  61234. * Large blur
  61235. */
  61236. High = 2
  61237. }
  61238. /**
  61239. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  61240. */
  61241. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  61242. private _circleOfConfusion;
  61243. /**
  61244. * @hidden Internal, blurs from high to low
  61245. */
  61246. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  61247. private _depthOfFieldBlurY;
  61248. private _dofMerge;
  61249. /**
  61250. * @hidden Internal post processes in depth of field effect
  61251. */
  61252. _effects: Array<PostProcess>;
  61253. /**
  61254. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  61255. */
  61256. focalLength: number;
  61257. /**
  61258. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  61259. */
  61260. fStop: number;
  61261. /**
  61262. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  61263. */
  61264. focusDistance: number;
  61265. /**
  61266. * 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.
  61267. */
  61268. lensSize: number;
  61269. /**
  61270. * Creates a new instance DepthOfFieldEffect
  61271. * @param scene The scene the effect belongs to.
  61272. * @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.
  61273. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  61274. * @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)
  61275. */
  61276. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  61277. /**
  61278. * Get the current class name of the current effet
  61279. * @returns "DepthOfFieldEffect"
  61280. */
  61281. getClassName(): string;
  61282. /**
  61283. * 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.
  61284. */
  61285. depthTexture: RenderTargetTexture;
  61286. /**
  61287. * Disposes each of the internal effects for a given camera.
  61288. * @param camera The camera to dispose the effect on.
  61289. */
  61290. disposeEffects(camera: Camera): void;
  61291. /**
  61292. * @hidden Internal
  61293. */
  61294. _updateEffects(): void;
  61295. /**
  61296. * Internal
  61297. * @returns if all the contained post processes are ready.
  61298. * @hidden
  61299. */
  61300. _isReady(): boolean;
  61301. }
  61302. }
  61303. declare module "babylonjs/Shaders/displayPass.fragment" {
  61304. /** @hidden */
  61305. export var displayPassPixelShader: {
  61306. name: string;
  61307. shader: string;
  61308. };
  61309. }
  61310. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  61311. import { Nullable } from "babylonjs/types";
  61312. import { Camera } from "babylonjs/Cameras/camera";
  61313. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61314. import { Engine } from "babylonjs/Engines/engine";
  61315. import "babylonjs/Shaders/displayPass.fragment";
  61316. /**
  61317. * DisplayPassPostProcess which produces an output the same as it's input
  61318. */
  61319. export class DisplayPassPostProcess extends PostProcess {
  61320. /**
  61321. * Creates the DisplayPassPostProcess
  61322. * @param name The name of the effect.
  61323. * @param options The required width/height ratio to downsize to before computing the render pass.
  61324. * @param camera The camera to apply the render pass to.
  61325. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61326. * @param engine The engine which the post process will be applied. (default: current engine)
  61327. * @param reusable If the post process can be reused on the same frame. (default: false)
  61328. */
  61329. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  61330. }
  61331. }
  61332. declare module "babylonjs/Shaders/filter.fragment" {
  61333. /** @hidden */
  61334. export var filterPixelShader: {
  61335. name: string;
  61336. shader: string;
  61337. };
  61338. }
  61339. declare module "babylonjs/PostProcesses/filterPostProcess" {
  61340. import { Nullable } from "babylonjs/types";
  61341. import { Matrix } from "babylonjs/Maths/math.vector";
  61342. import { Camera } from "babylonjs/Cameras/camera";
  61343. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61344. import { Engine } from "babylonjs/Engines/engine";
  61345. import "babylonjs/Shaders/filter.fragment";
  61346. /**
  61347. * Applies a kernel filter to the image
  61348. */
  61349. export class FilterPostProcess extends PostProcess {
  61350. /** The matrix to be applied to the image */
  61351. kernelMatrix: Matrix;
  61352. /**
  61353. *
  61354. * @param name The name of the effect.
  61355. * @param kernelMatrix The matrix to be applied to the image
  61356. * @param options The required width/height ratio to downsize to before computing the render pass.
  61357. * @param camera The camera to apply the render pass to.
  61358. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61359. * @param engine The engine which the post process will be applied. (default: current engine)
  61360. * @param reusable If the post process can be reused on the same frame. (default: false)
  61361. */
  61362. constructor(name: string,
  61363. /** The matrix to be applied to the image */
  61364. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  61365. }
  61366. }
  61367. declare module "babylonjs/Shaders/fxaa.fragment" {
  61368. /** @hidden */
  61369. export var fxaaPixelShader: {
  61370. name: string;
  61371. shader: string;
  61372. };
  61373. }
  61374. declare module "babylonjs/Shaders/fxaa.vertex" {
  61375. /** @hidden */
  61376. export var fxaaVertexShader: {
  61377. name: string;
  61378. shader: string;
  61379. };
  61380. }
  61381. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  61382. import { Nullable } from "babylonjs/types";
  61383. import { Camera } from "babylonjs/Cameras/camera";
  61384. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61385. import { Engine } from "babylonjs/Engines/engine";
  61386. import "babylonjs/Shaders/fxaa.fragment";
  61387. import "babylonjs/Shaders/fxaa.vertex";
  61388. /**
  61389. * Fxaa post process
  61390. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  61391. */
  61392. export class FxaaPostProcess extends PostProcess {
  61393. /** @hidden */
  61394. texelWidth: number;
  61395. /** @hidden */
  61396. texelHeight: number;
  61397. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  61398. private _getDefines;
  61399. }
  61400. }
  61401. declare module "babylonjs/Shaders/grain.fragment" {
  61402. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61403. /** @hidden */
  61404. export var grainPixelShader: {
  61405. name: string;
  61406. shader: string;
  61407. };
  61408. }
  61409. declare module "babylonjs/PostProcesses/grainPostProcess" {
  61410. import { Nullable } from "babylonjs/types";
  61411. import { Camera } from "babylonjs/Cameras/camera";
  61412. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61413. import { Engine } from "babylonjs/Engines/engine";
  61414. import "babylonjs/Shaders/grain.fragment";
  61415. /**
  61416. * The GrainPostProcess adds noise to the image at mid luminance levels
  61417. */
  61418. export class GrainPostProcess extends PostProcess {
  61419. /**
  61420. * The intensity of the grain added (default: 30)
  61421. */
  61422. intensity: number;
  61423. /**
  61424. * If the grain should be randomized on every frame
  61425. */
  61426. animated: boolean;
  61427. /**
  61428. * Creates a new instance of @see GrainPostProcess
  61429. * @param name The name of the effect.
  61430. * @param options The required width/height ratio to downsize to before computing the render pass.
  61431. * @param camera The camera to apply the render pass to.
  61432. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61433. * @param engine The engine which the post process will be applied. (default: current engine)
  61434. * @param reusable If the post process can be reused on the same frame. (default: false)
  61435. * @param textureType Type of textures used when performing the post process. (default: 0)
  61436. * @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)
  61437. */
  61438. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  61439. }
  61440. }
  61441. declare module "babylonjs/Shaders/highlights.fragment" {
  61442. /** @hidden */
  61443. export var highlightsPixelShader: {
  61444. name: string;
  61445. shader: string;
  61446. };
  61447. }
  61448. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  61449. import { Nullable } from "babylonjs/types";
  61450. import { Camera } from "babylonjs/Cameras/camera";
  61451. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61452. import { Engine } from "babylonjs/Engines/engine";
  61453. import "babylonjs/Shaders/highlights.fragment";
  61454. /**
  61455. * Extracts highlights from the image
  61456. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  61457. */
  61458. export class HighlightsPostProcess extends PostProcess {
  61459. /**
  61460. * Extracts highlights from the image
  61461. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  61462. * @param name The name of the effect.
  61463. * @param options The required width/height ratio to downsize to before computing the render pass.
  61464. * @param camera The camera to apply the render pass to.
  61465. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61466. * @param engine The engine which the post process will be applied. (default: current engine)
  61467. * @param reusable If the post process can be reused on the same frame. (default: false)
  61468. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  61469. */
  61470. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  61471. }
  61472. }
  61473. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  61474. /** @hidden */
  61475. export var mrtFragmentDeclaration: {
  61476. name: string;
  61477. shader: string;
  61478. };
  61479. }
  61480. declare module "babylonjs/Shaders/geometry.fragment" {
  61481. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  61482. /** @hidden */
  61483. export var geometryPixelShader: {
  61484. name: string;
  61485. shader: string;
  61486. };
  61487. }
  61488. declare module "babylonjs/Shaders/geometry.vertex" {
  61489. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61490. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61491. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61492. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61493. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61494. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61495. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61496. /** @hidden */
  61497. export var geometryVertexShader: {
  61498. name: string;
  61499. shader: string;
  61500. };
  61501. }
  61502. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  61503. import { Matrix } from "babylonjs/Maths/math.vector";
  61504. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61505. import { Mesh } from "babylonjs/Meshes/mesh";
  61506. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  61507. import { Effect } from "babylonjs/Materials/effect";
  61508. import { Scene } from "babylonjs/scene";
  61509. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61510. import "babylonjs/Shaders/geometry.fragment";
  61511. import "babylonjs/Shaders/geometry.vertex";
  61512. /** @hidden */
  61513. interface ISavedTransformationMatrix {
  61514. world: Matrix;
  61515. viewProjection: Matrix;
  61516. }
  61517. /**
  61518. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  61519. */
  61520. export class GeometryBufferRenderer {
  61521. /**
  61522. * Constant used to retrieve the position texture index in the G-Buffer textures array
  61523. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  61524. */
  61525. static readonly POSITION_TEXTURE_TYPE: number;
  61526. /**
  61527. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  61528. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  61529. */
  61530. static readonly VELOCITY_TEXTURE_TYPE: number;
  61531. /**
  61532. * Dictionary used to store the previous transformation matrices of each rendered mesh
  61533. * in order to compute objects velocities when enableVelocity is set to "true"
  61534. * @hidden
  61535. */
  61536. _previousTransformationMatrices: {
  61537. [index: number]: ISavedTransformationMatrix;
  61538. };
  61539. /**
  61540. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  61541. * in order to compute objects velocities when enableVelocity is set to "true"
  61542. * @hidden
  61543. */
  61544. _previousBonesTransformationMatrices: {
  61545. [index: number]: Float32Array;
  61546. };
  61547. /**
  61548. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  61549. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  61550. */
  61551. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  61552. private _scene;
  61553. private _multiRenderTarget;
  61554. private _ratio;
  61555. private _enablePosition;
  61556. private _enableVelocity;
  61557. private _positionIndex;
  61558. private _velocityIndex;
  61559. protected _effect: Effect;
  61560. protected _cachedDefines: string;
  61561. /**
  61562. * Set the render list (meshes to be rendered) used in the G buffer.
  61563. */
  61564. renderList: Mesh[];
  61565. /**
  61566. * Gets wether or not G buffer are supported by the running hardware.
  61567. * This requires draw buffer supports
  61568. */
  61569. readonly isSupported: boolean;
  61570. /**
  61571. * Returns the index of the given texture type in the G-Buffer textures array
  61572. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  61573. * @returns the index of the given texture type in the G-Buffer textures array
  61574. */
  61575. getTextureIndex(textureType: number): number;
  61576. /**
  61577. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  61578. */
  61579. /**
  61580. * Sets whether or not objects positions are enabled for the G buffer.
  61581. */
  61582. enablePosition: boolean;
  61583. /**
  61584. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  61585. */
  61586. /**
  61587. * Sets wether or not objects velocities are enabled for the G buffer.
  61588. */
  61589. enableVelocity: boolean;
  61590. /**
  61591. * Gets the scene associated with the buffer.
  61592. */
  61593. readonly scene: Scene;
  61594. /**
  61595. * Gets the ratio used by the buffer during its creation.
  61596. * How big is the buffer related to the main canvas.
  61597. */
  61598. readonly ratio: number;
  61599. /** @hidden */
  61600. static _SceneComponentInitialization: (scene: Scene) => void;
  61601. /**
  61602. * Creates a new G Buffer for the scene
  61603. * @param scene The scene the buffer belongs to
  61604. * @param ratio How big is the buffer related to the main canvas.
  61605. */
  61606. constructor(scene: Scene, ratio?: number);
  61607. /**
  61608. * Checks wether everything is ready to render a submesh to the G buffer.
  61609. * @param subMesh the submesh to check readiness for
  61610. * @param useInstances is the mesh drawn using instance or not
  61611. * @returns true if ready otherwise false
  61612. */
  61613. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61614. /**
  61615. * Gets the current underlying G Buffer.
  61616. * @returns the buffer
  61617. */
  61618. getGBuffer(): MultiRenderTarget;
  61619. /**
  61620. * Gets the number of samples used to render the buffer (anti aliasing).
  61621. */
  61622. /**
  61623. * Sets the number of samples used to render the buffer (anti aliasing).
  61624. */
  61625. samples: number;
  61626. /**
  61627. * Disposes the renderer and frees up associated resources.
  61628. */
  61629. dispose(): void;
  61630. protected _createRenderTargets(): void;
  61631. private _copyBonesTransformationMatrices;
  61632. }
  61633. }
  61634. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  61635. import { Nullable } from "babylonjs/types";
  61636. import { Scene } from "babylonjs/scene";
  61637. import { ISceneComponent } from "babylonjs/sceneComponent";
  61638. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  61639. module "babylonjs/scene" {
  61640. interface Scene {
  61641. /** @hidden (Backing field) */
  61642. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  61643. /**
  61644. * Gets or Sets the current geometry buffer associated to the scene.
  61645. */
  61646. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  61647. /**
  61648. * Enables a GeometryBufferRender and associates it with the scene
  61649. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  61650. * @returns the GeometryBufferRenderer
  61651. */
  61652. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  61653. /**
  61654. * Disables the GeometryBufferRender associated with the scene
  61655. */
  61656. disableGeometryBufferRenderer(): void;
  61657. }
  61658. }
  61659. /**
  61660. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  61661. * in several rendering techniques.
  61662. */
  61663. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  61664. /**
  61665. * The component name helpful to identify the component in the list of scene components.
  61666. */
  61667. readonly name: string;
  61668. /**
  61669. * The scene the component belongs to.
  61670. */
  61671. scene: Scene;
  61672. /**
  61673. * Creates a new instance of the component for the given scene
  61674. * @param scene Defines the scene to register the component in
  61675. */
  61676. constructor(scene: Scene);
  61677. /**
  61678. * Registers the component in a given scene
  61679. */
  61680. register(): void;
  61681. /**
  61682. * Rebuilds the elements related to this component in case of
  61683. * context lost for instance.
  61684. */
  61685. rebuild(): void;
  61686. /**
  61687. * Disposes the component and the associated ressources
  61688. */
  61689. dispose(): void;
  61690. private _gatherRenderTargets;
  61691. }
  61692. }
  61693. declare module "babylonjs/Shaders/motionBlur.fragment" {
  61694. /** @hidden */
  61695. export var motionBlurPixelShader: {
  61696. name: string;
  61697. shader: string;
  61698. };
  61699. }
  61700. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  61701. import { Nullable } from "babylonjs/types";
  61702. import { Camera } from "babylonjs/Cameras/camera";
  61703. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61704. import { Scene } from "babylonjs/scene";
  61705. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61706. import "babylonjs/Animations/animatable";
  61707. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  61708. import "babylonjs/Shaders/motionBlur.fragment";
  61709. import { Engine } from "babylonjs/Engines/engine";
  61710. /**
  61711. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  61712. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  61713. * As an example, all you have to do is to create the post-process:
  61714. * var mb = new BABYLON.MotionBlurPostProcess(
  61715. * 'mb', // The name of the effect.
  61716. * scene, // The scene containing the objects to blur according to their velocity.
  61717. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  61718. * camera // The camera to apply the render pass to.
  61719. * );
  61720. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  61721. */
  61722. export class MotionBlurPostProcess extends PostProcess {
  61723. /**
  61724. * Defines how much the image is blurred by the movement. Default value is equal to 1
  61725. */
  61726. motionStrength: number;
  61727. /**
  61728. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  61729. */
  61730. /**
  61731. * Sets the number of iterations to be used for motion blur quality
  61732. */
  61733. motionBlurSamples: number;
  61734. private _motionBlurSamples;
  61735. private _geometryBufferRenderer;
  61736. /**
  61737. * Creates a new instance MotionBlurPostProcess
  61738. * @param name The name of the effect.
  61739. * @param scene The scene containing the objects to blur according to their velocity.
  61740. * @param options The required width/height ratio to downsize to before computing the render pass.
  61741. * @param camera The camera to apply the render pass to.
  61742. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61743. * @param engine The engine which the post process will be applied. (default: current engine)
  61744. * @param reusable If the post process can be reused on the same frame. (default: false)
  61745. * @param textureType Type of textures used when performing the post process. (default: 0)
  61746. * @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)
  61747. */
  61748. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  61749. /**
  61750. * Excludes the given skinned mesh from computing bones velocities.
  61751. * 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.
  61752. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  61753. */
  61754. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  61755. /**
  61756. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  61757. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  61758. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  61759. */
  61760. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  61761. /**
  61762. * Disposes the post process.
  61763. * @param camera The camera to dispose the post process on.
  61764. */
  61765. dispose(camera?: Camera): void;
  61766. }
  61767. }
  61768. declare module "babylonjs/Shaders/refraction.fragment" {
  61769. /** @hidden */
  61770. export var refractionPixelShader: {
  61771. name: string;
  61772. shader: string;
  61773. };
  61774. }
  61775. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  61776. import { Color3 } from "babylonjs/Maths/math.color";
  61777. import { Camera } from "babylonjs/Cameras/camera";
  61778. import { Texture } from "babylonjs/Materials/Textures/texture";
  61779. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61780. import { Engine } from "babylonjs/Engines/engine";
  61781. import "babylonjs/Shaders/refraction.fragment";
  61782. /**
  61783. * Post process which applies a refractin texture
  61784. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  61785. */
  61786. export class RefractionPostProcess extends PostProcess {
  61787. /** the base color of the refraction (used to taint the rendering) */
  61788. color: Color3;
  61789. /** simulated refraction depth */
  61790. depth: number;
  61791. /** the coefficient of the base color (0 to remove base color tainting) */
  61792. colorLevel: number;
  61793. private _refTexture;
  61794. private _ownRefractionTexture;
  61795. /**
  61796. * Gets or sets the refraction texture
  61797. * Please note that you are responsible for disposing the texture if you set it manually
  61798. */
  61799. refractionTexture: Texture;
  61800. /**
  61801. * Initializes the RefractionPostProcess
  61802. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  61803. * @param name The name of the effect.
  61804. * @param refractionTextureUrl Url of the refraction texture to use
  61805. * @param color the base color of the refraction (used to taint the rendering)
  61806. * @param depth simulated refraction depth
  61807. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  61808. * @param camera The camera to apply the render pass to.
  61809. * @param options The required width/height ratio to downsize to before computing the render pass.
  61810. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61811. * @param engine The engine which the post process will be applied. (default: current engine)
  61812. * @param reusable If the post process can be reused on the same frame. (default: false)
  61813. */
  61814. constructor(name: string, refractionTextureUrl: string,
  61815. /** the base color of the refraction (used to taint the rendering) */
  61816. color: Color3,
  61817. /** simulated refraction depth */
  61818. depth: number,
  61819. /** the coefficient of the base color (0 to remove base color tainting) */
  61820. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  61821. /**
  61822. * Disposes of the post process
  61823. * @param camera Camera to dispose post process on
  61824. */
  61825. dispose(camera: Camera): void;
  61826. }
  61827. }
  61828. declare module "babylonjs/Shaders/sharpen.fragment" {
  61829. /** @hidden */
  61830. export var sharpenPixelShader: {
  61831. name: string;
  61832. shader: string;
  61833. };
  61834. }
  61835. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  61836. import { Nullable } from "babylonjs/types";
  61837. import { Camera } from "babylonjs/Cameras/camera";
  61838. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  61839. import "babylonjs/Shaders/sharpen.fragment";
  61840. import { Engine } from "babylonjs/Engines/engine";
  61841. /**
  61842. * The SharpenPostProcess applies a sharpen kernel to every pixel
  61843. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  61844. */
  61845. export class SharpenPostProcess extends PostProcess {
  61846. /**
  61847. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  61848. */
  61849. colorAmount: number;
  61850. /**
  61851. * How much sharpness should be applied (default: 0.3)
  61852. */
  61853. edgeAmount: number;
  61854. /**
  61855. * Creates a new instance ConvolutionPostProcess
  61856. * @param name The name of the effect.
  61857. * @param options The required width/height ratio to downsize to before computing the render pass.
  61858. * @param camera The camera to apply the render pass to.
  61859. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  61860. * @param engine The engine which the post process will be applied. (default: current engine)
  61861. * @param reusable If the post process can be reused on the same frame. (default: false)
  61862. * @param textureType Type of textures used when performing the post process. (default: 0)
  61863. * @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)
  61864. */
  61865. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  61866. }
  61867. }
  61868. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  61869. import { Nullable } from "babylonjs/types";
  61870. import { Camera } from "babylonjs/Cameras/camera";
  61871. import { Engine } from "babylonjs/Engines/engine";
  61872. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  61873. import { IInspectable } from "babylonjs/Misc/iInspectable";
  61874. /**
  61875. * PostProcessRenderPipeline
  61876. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  61877. */
  61878. export class PostProcessRenderPipeline {
  61879. private engine;
  61880. private _renderEffects;
  61881. private _renderEffectsForIsolatedPass;
  61882. /**
  61883. * List of inspectable custom properties (used by the Inspector)
  61884. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  61885. */
  61886. inspectableCustomProperties: IInspectable[];
  61887. /**
  61888. * @hidden
  61889. */
  61890. protected _cameras: Camera[];
  61891. /** @hidden */
  61892. _name: string;
  61893. /**
  61894. * Gets pipeline name
  61895. */
  61896. readonly name: string;
  61897. /**
  61898. * Initializes a PostProcessRenderPipeline
  61899. * @param engine engine to add the pipeline to
  61900. * @param name name of the pipeline
  61901. */
  61902. constructor(engine: Engine, name: string);
  61903. /**
  61904. * Gets the class name
  61905. * @returns "PostProcessRenderPipeline"
  61906. */
  61907. getClassName(): string;
  61908. /**
  61909. * If all the render effects in the pipeline are supported
  61910. */
  61911. readonly isSupported: boolean;
  61912. /**
  61913. * Adds an effect to the pipeline
  61914. * @param renderEffect the effect to add
  61915. */
  61916. addEffect(renderEffect: PostProcessRenderEffect): void;
  61917. /** @hidden */
  61918. _rebuild(): void;
  61919. /** @hidden */
  61920. _enableEffect(renderEffectName: string, cameras: Camera): void;
  61921. /** @hidden */
  61922. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  61923. /** @hidden */
  61924. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  61925. /** @hidden */
  61926. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  61927. /** @hidden */
  61928. _attachCameras(cameras: Camera, unique: boolean): void;
  61929. /** @hidden */
  61930. _attachCameras(cameras: Camera[], unique: boolean): void;
  61931. /** @hidden */
  61932. _detachCameras(cameras: Camera): void;
  61933. /** @hidden */
  61934. _detachCameras(cameras: Nullable<Camera[]>): void;
  61935. /** @hidden */
  61936. _update(): void;
  61937. /** @hidden */
  61938. _reset(): void;
  61939. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  61940. /**
  61941. * Disposes of the pipeline
  61942. */
  61943. dispose(): void;
  61944. }
  61945. }
  61946. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  61947. import { Camera } from "babylonjs/Cameras/camera";
  61948. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  61949. /**
  61950. * PostProcessRenderPipelineManager class
  61951. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  61952. */
  61953. export class PostProcessRenderPipelineManager {
  61954. private _renderPipelines;
  61955. /**
  61956. * Initializes a PostProcessRenderPipelineManager
  61957. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  61958. */
  61959. constructor();
  61960. /**
  61961. * Gets the list of supported render pipelines
  61962. */
  61963. readonly supportedPipelines: PostProcessRenderPipeline[];
  61964. /**
  61965. * Adds a pipeline to the manager
  61966. * @param renderPipeline The pipeline to add
  61967. */
  61968. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  61969. /**
  61970. * Attaches a camera to the pipeline
  61971. * @param renderPipelineName The name of the pipeline to attach to
  61972. * @param cameras the camera to attach
  61973. * @param unique if the camera can be attached multiple times to the pipeline
  61974. */
  61975. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  61976. /**
  61977. * Detaches a camera from the pipeline
  61978. * @param renderPipelineName The name of the pipeline to detach from
  61979. * @param cameras the camera to detach
  61980. */
  61981. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  61982. /**
  61983. * Enables an effect by name on a pipeline
  61984. * @param renderPipelineName the name of the pipeline to enable the effect in
  61985. * @param renderEffectName the name of the effect to enable
  61986. * @param cameras the cameras that the effect should be enabled on
  61987. */
  61988. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  61989. /**
  61990. * Disables an effect by name on a pipeline
  61991. * @param renderPipelineName the name of the pipeline to disable the effect in
  61992. * @param renderEffectName the name of the effect to disable
  61993. * @param cameras the cameras that the effect should be disabled on
  61994. */
  61995. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  61996. /**
  61997. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  61998. */
  61999. update(): void;
  62000. /** @hidden */
  62001. _rebuild(): void;
  62002. /**
  62003. * Disposes of the manager and pipelines
  62004. */
  62005. dispose(): void;
  62006. }
  62007. }
  62008. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  62009. import { ISceneComponent } from "babylonjs/sceneComponent";
  62010. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  62011. import { Scene } from "babylonjs/scene";
  62012. module "babylonjs/scene" {
  62013. interface Scene {
  62014. /** @hidden (Backing field) */
  62015. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  62016. /**
  62017. * Gets the postprocess render pipeline manager
  62018. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  62019. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  62020. */
  62021. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  62022. }
  62023. }
  62024. /**
  62025. * Defines the Render Pipeline scene component responsible to rendering pipelines
  62026. */
  62027. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  62028. /**
  62029. * The component name helpfull to identify the component in the list of scene components.
  62030. */
  62031. readonly name: string;
  62032. /**
  62033. * The scene the component belongs to.
  62034. */
  62035. scene: Scene;
  62036. /**
  62037. * Creates a new instance of the component for the given scene
  62038. * @param scene Defines the scene to register the component in
  62039. */
  62040. constructor(scene: Scene);
  62041. /**
  62042. * Registers the component in a given scene
  62043. */
  62044. register(): void;
  62045. /**
  62046. * Rebuilds the elements related to this component in case of
  62047. * context lost for instance.
  62048. */
  62049. rebuild(): void;
  62050. /**
  62051. * Disposes the component and the associated ressources
  62052. */
  62053. dispose(): void;
  62054. private _gatherRenderTargets;
  62055. }
  62056. }
  62057. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  62058. import { Nullable } from "babylonjs/types";
  62059. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  62060. import { Camera } from "babylonjs/Cameras/camera";
  62061. import { IDisposable } from "babylonjs/scene";
  62062. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  62063. import { Scene } from "babylonjs/scene";
  62064. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  62065. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  62066. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  62067. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  62068. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  62069. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  62070. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  62071. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  62072. import { Animation } from "babylonjs/Animations/animation";
  62073. /**
  62074. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  62075. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  62076. */
  62077. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  62078. private _scene;
  62079. private _camerasToBeAttached;
  62080. /**
  62081. * ID of the sharpen post process,
  62082. */
  62083. private readonly SharpenPostProcessId;
  62084. /**
  62085. * @ignore
  62086. * ID of the image processing post process;
  62087. */
  62088. readonly ImageProcessingPostProcessId: string;
  62089. /**
  62090. * @ignore
  62091. * ID of the Fast Approximate Anti-Aliasing post process;
  62092. */
  62093. readonly FxaaPostProcessId: string;
  62094. /**
  62095. * ID of the chromatic aberration post process,
  62096. */
  62097. private readonly ChromaticAberrationPostProcessId;
  62098. /**
  62099. * ID of the grain post process
  62100. */
  62101. private readonly GrainPostProcessId;
  62102. /**
  62103. * Sharpen post process which will apply a sharpen convolution to enhance edges
  62104. */
  62105. sharpen: SharpenPostProcess;
  62106. private _sharpenEffect;
  62107. private bloom;
  62108. /**
  62109. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  62110. */
  62111. depthOfField: DepthOfFieldEffect;
  62112. /**
  62113. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  62114. */
  62115. fxaa: FxaaPostProcess;
  62116. /**
  62117. * Image post processing pass used to perform operations such as tone mapping or color grading.
  62118. */
  62119. imageProcessing: ImageProcessingPostProcess;
  62120. /**
  62121. * Chromatic aberration post process which will shift rgb colors in the image
  62122. */
  62123. chromaticAberration: ChromaticAberrationPostProcess;
  62124. private _chromaticAberrationEffect;
  62125. /**
  62126. * Grain post process which add noise to the image
  62127. */
  62128. grain: GrainPostProcess;
  62129. private _grainEffect;
  62130. /**
  62131. * Glow post process which adds a glow to emissive areas of the image
  62132. */
  62133. private _glowLayer;
  62134. /**
  62135. * Animations which can be used to tweak settings over a period of time
  62136. */
  62137. animations: Animation[];
  62138. private _imageProcessingConfigurationObserver;
  62139. private _sharpenEnabled;
  62140. private _bloomEnabled;
  62141. private _depthOfFieldEnabled;
  62142. private _depthOfFieldBlurLevel;
  62143. private _fxaaEnabled;
  62144. private _imageProcessingEnabled;
  62145. private _defaultPipelineTextureType;
  62146. private _bloomScale;
  62147. private _chromaticAberrationEnabled;
  62148. private _grainEnabled;
  62149. private _buildAllowed;
  62150. /**
  62151. * Gets active scene
  62152. */
  62153. readonly scene: Scene;
  62154. /**
  62155. * Enable or disable the sharpen process from the pipeline
  62156. */
  62157. sharpenEnabled: boolean;
  62158. private _resizeObserver;
  62159. private _hardwareScaleLevel;
  62160. private _bloomKernel;
  62161. /**
  62162. * Specifies the size of the bloom blur kernel, relative to the final output size
  62163. */
  62164. bloomKernel: number;
  62165. /**
  62166. * Specifies the weight of the bloom in the final rendering
  62167. */
  62168. private _bloomWeight;
  62169. /**
  62170. * Specifies the luma threshold for the area that will be blurred by the bloom
  62171. */
  62172. private _bloomThreshold;
  62173. private _hdr;
  62174. /**
  62175. * The strength of the bloom.
  62176. */
  62177. bloomWeight: number;
  62178. /**
  62179. * The strength of the bloom.
  62180. */
  62181. bloomThreshold: number;
  62182. /**
  62183. * The scale of the bloom, lower value will provide better performance.
  62184. */
  62185. bloomScale: number;
  62186. /**
  62187. * Enable or disable the bloom from the pipeline
  62188. */
  62189. bloomEnabled: boolean;
  62190. private _rebuildBloom;
  62191. /**
  62192. * If the depth of field is enabled.
  62193. */
  62194. depthOfFieldEnabled: boolean;
  62195. /**
  62196. * Blur level of the depth of field effect. (Higher blur will effect performance)
  62197. */
  62198. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  62199. /**
  62200. * If the anti aliasing is enabled.
  62201. */
  62202. fxaaEnabled: boolean;
  62203. private _samples;
  62204. /**
  62205. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  62206. */
  62207. samples: number;
  62208. /**
  62209. * If image processing is enabled.
  62210. */
  62211. imageProcessingEnabled: boolean;
  62212. /**
  62213. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  62214. */
  62215. glowLayerEnabled: boolean;
  62216. /**
  62217. * Gets the glow layer (or null if not defined)
  62218. */
  62219. readonly glowLayer: Nullable<GlowLayer>;
  62220. /**
  62221. * Enable or disable the chromaticAberration process from the pipeline
  62222. */
  62223. chromaticAberrationEnabled: boolean;
  62224. /**
  62225. * Enable or disable the grain process from the pipeline
  62226. */
  62227. grainEnabled: boolean;
  62228. /**
  62229. * @constructor
  62230. * @param name - The rendering pipeline name (default: "")
  62231. * @param hdr - If high dynamic range textures should be used (default: true)
  62232. * @param scene - The scene linked to this pipeline (default: the last created scene)
  62233. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  62234. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  62235. */
  62236. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  62237. /**
  62238. * Get the class name
  62239. * @returns "DefaultRenderingPipeline"
  62240. */
  62241. getClassName(): string;
  62242. /**
  62243. * Force the compilation of the entire pipeline.
  62244. */
  62245. prepare(): void;
  62246. private _hasCleared;
  62247. private _prevPostProcess;
  62248. private _prevPrevPostProcess;
  62249. private _setAutoClearAndTextureSharing;
  62250. private _depthOfFieldSceneObserver;
  62251. private _buildPipeline;
  62252. private _disposePostProcesses;
  62253. /**
  62254. * Adds a camera to the pipeline
  62255. * @param camera the camera to be added
  62256. */
  62257. addCamera(camera: Camera): void;
  62258. /**
  62259. * Removes a camera from the pipeline
  62260. * @param camera the camera to remove
  62261. */
  62262. removeCamera(camera: Camera): void;
  62263. /**
  62264. * Dispose of the pipeline and stop all post processes
  62265. */
  62266. dispose(): void;
  62267. /**
  62268. * Serialize the rendering pipeline (Used when exporting)
  62269. * @returns the serialized object
  62270. */
  62271. serialize(): any;
  62272. /**
  62273. * Parse the serialized pipeline
  62274. * @param source Source pipeline.
  62275. * @param scene The scene to load the pipeline to.
  62276. * @param rootUrl The URL of the serialized pipeline.
  62277. * @returns An instantiated pipeline from the serialized object.
  62278. */
  62279. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  62280. }
  62281. }
  62282. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  62283. /** @hidden */
  62284. export var lensHighlightsPixelShader: {
  62285. name: string;
  62286. shader: string;
  62287. };
  62288. }
  62289. declare module "babylonjs/Shaders/depthOfField.fragment" {
  62290. /** @hidden */
  62291. export var depthOfFieldPixelShader: {
  62292. name: string;
  62293. shader: string;
  62294. };
  62295. }
  62296. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  62297. import { Camera } from "babylonjs/Cameras/camera";
  62298. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  62299. import { Scene } from "babylonjs/scene";
  62300. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  62301. import "babylonjs/Shaders/chromaticAberration.fragment";
  62302. import "babylonjs/Shaders/lensHighlights.fragment";
  62303. import "babylonjs/Shaders/depthOfField.fragment";
  62304. /**
  62305. * BABYLON.JS Chromatic Aberration GLSL Shader
  62306. * Author: Olivier Guyot
  62307. * Separates very slightly R, G and B colors on the edges of the screen
  62308. * Inspired by Francois Tarlier & Martins Upitis
  62309. */
  62310. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  62311. /**
  62312. * @ignore
  62313. * The chromatic aberration PostProcess id in the pipeline
  62314. */
  62315. LensChromaticAberrationEffect: string;
  62316. /**
  62317. * @ignore
  62318. * The highlights enhancing PostProcess id in the pipeline
  62319. */
  62320. HighlightsEnhancingEffect: string;
  62321. /**
  62322. * @ignore
  62323. * The depth-of-field PostProcess id in the pipeline
  62324. */
  62325. LensDepthOfFieldEffect: string;
  62326. private _scene;
  62327. private _depthTexture;
  62328. private _grainTexture;
  62329. private _chromaticAberrationPostProcess;
  62330. private _highlightsPostProcess;
  62331. private _depthOfFieldPostProcess;
  62332. private _edgeBlur;
  62333. private _grainAmount;
  62334. private _chromaticAberration;
  62335. private _distortion;
  62336. private _highlightsGain;
  62337. private _highlightsThreshold;
  62338. private _dofDistance;
  62339. private _dofAperture;
  62340. private _dofDarken;
  62341. private _dofPentagon;
  62342. private _blurNoise;
  62343. /**
  62344. * @constructor
  62345. *
  62346. * Effect parameters are as follow:
  62347. * {
  62348. * chromatic_aberration: number; // from 0 to x (1 for realism)
  62349. * edge_blur: number; // from 0 to x (1 for realism)
  62350. * distortion: number; // from 0 to x (1 for realism)
  62351. * grain_amount: number; // from 0 to 1
  62352. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  62353. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  62354. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  62355. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  62356. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  62357. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  62358. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  62359. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  62360. * }
  62361. * Note: if an effect parameter is unset, effect is disabled
  62362. *
  62363. * @param name The rendering pipeline name
  62364. * @param parameters - An object containing all parameters (see above)
  62365. * @param scene The scene linked to this pipeline
  62366. * @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)
  62367. * @param cameras The array of cameras that the rendering pipeline will be attached to
  62368. */
  62369. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  62370. /**
  62371. * Get the class name
  62372. * @returns "LensRenderingPipeline"
  62373. */
  62374. getClassName(): string;
  62375. /**
  62376. * Gets associated scene
  62377. */
  62378. readonly scene: Scene;
  62379. /**
  62380. * Gets or sets the edge blur
  62381. */
  62382. edgeBlur: number;
  62383. /**
  62384. * Gets or sets the grain amount
  62385. */
  62386. grainAmount: number;
  62387. /**
  62388. * Gets or sets the chromatic aberration amount
  62389. */
  62390. chromaticAberration: number;
  62391. /**
  62392. * Gets or sets the depth of field aperture
  62393. */
  62394. dofAperture: number;
  62395. /**
  62396. * Gets or sets the edge distortion
  62397. */
  62398. edgeDistortion: number;
  62399. /**
  62400. * Gets or sets the depth of field distortion
  62401. */
  62402. dofDistortion: number;
  62403. /**
  62404. * Gets or sets the darken out of focus amount
  62405. */
  62406. darkenOutOfFocus: number;
  62407. /**
  62408. * Gets or sets a boolean indicating if blur noise is enabled
  62409. */
  62410. blurNoise: boolean;
  62411. /**
  62412. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  62413. */
  62414. pentagonBokeh: boolean;
  62415. /**
  62416. * Gets or sets the highlight grain amount
  62417. */
  62418. highlightsGain: number;
  62419. /**
  62420. * Gets or sets the highlight threshold
  62421. */
  62422. highlightsThreshold: number;
  62423. /**
  62424. * Sets the amount of blur at the edges
  62425. * @param amount blur amount
  62426. */
  62427. setEdgeBlur(amount: number): void;
  62428. /**
  62429. * Sets edge blur to 0
  62430. */
  62431. disableEdgeBlur(): void;
  62432. /**
  62433. * Sets the amout of grain
  62434. * @param amount Amount of grain
  62435. */
  62436. setGrainAmount(amount: number): void;
  62437. /**
  62438. * Set grain amount to 0
  62439. */
  62440. disableGrain(): void;
  62441. /**
  62442. * Sets the chromatic aberration amount
  62443. * @param amount amount of chromatic aberration
  62444. */
  62445. setChromaticAberration(amount: number): void;
  62446. /**
  62447. * Sets chromatic aberration amount to 0
  62448. */
  62449. disableChromaticAberration(): void;
  62450. /**
  62451. * Sets the EdgeDistortion amount
  62452. * @param amount amount of EdgeDistortion
  62453. */
  62454. setEdgeDistortion(amount: number): void;
  62455. /**
  62456. * Sets edge distortion to 0
  62457. */
  62458. disableEdgeDistortion(): void;
  62459. /**
  62460. * Sets the FocusDistance amount
  62461. * @param amount amount of FocusDistance
  62462. */
  62463. setFocusDistance(amount: number): void;
  62464. /**
  62465. * Disables depth of field
  62466. */
  62467. disableDepthOfField(): void;
  62468. /**
  62469. * Sets the Aperture amount
  62470. * @param amount amount of Aperture
  62471. */
  62472. setAperture(amount: number): void;
  62473. /**
  62474. * Sets the DarkenOutOfFocus amount
  62475. * @param amount amount of DarkenOutOfFocus
  62476. */
  62477. setDarkenOutOfFocus(amount: number): void;
  62478. private _pentagonBokehIsEnabled;
  62479. /**
  62480. * Creates a pentagon bokeh effect
  62481. */
  62482. enablePentagonBokeh(): void;
  62483. /**
  62484. * Disables the pentagon bokeh effect
  62485. */
  62486. disablePentagonBokeh(): void;
  62487. /**
  62488. * Enables noise blur
  62489. */
  62490. enableNoiseBlur(): void;
  62491. /**
  62492. * Disables noise blur
  62493. */
  62494. disableNoiseBlur(): void;
  62495. /**
  62496. * Sets the HighlightsGain amount
  62497. * @param amount amount of HighlightsGain
  62498. */
  62499. setHighlightsGain(amount: number): void;
  62500. /**
  62501. * Sets the HighlightsThreshold amount
  62502. * @param amount amount of HighlightsThreshold
  62503. */
  62504. setHighlightsThreshold(amount: number): void;
  62505. /**
  62506. * Disables highlights
  62507. */
  62508. disableHighlights(): void;
  62509. /**
  62510. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  62511. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  62512. */
  62513. dispose(disableDepthRender?: boolean): void;
  62514. private _createChromaticAberrationPostProcess;
  62515. private _createHighlightsPostProcess;
  62516. private _createDepthOfFieldPostProcess;
  62517. private _createGrainTexture;
  62518. }
  62519. }
  62520. declare module "babylonjs/Shaders/ssao2.fragment" {
  62521. /** @hidden */
  62522. export var ssao2PixelShader: {
  62523. name: string;
  62524. shader: string;
  62525. };
  62526. }
  62527. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  62528. /** @hidden */
  62529. export var ssaoCombinePixelShader: {
  62530. name: string;
  62531. shader: string;
  62532. };
  62533. }
  62534. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  62535. import { Camera } from "babylonjs/Cameras/camera";
  62536. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  62537. import { Scene } from "babylonjs/scene";
  62538. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  62539. import "babylonjs/Shaders/ssao2.fragment";
  62540. import "babylonjs/Shaders/ssaoCombine.fragment";
  62541. /**
  62542. * Render pipeline to produce ssao effect
  62543. */
  62544. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  62545. /**
  62546. * @ignore
  62547. * The PassPostProcess id in the pipeline that contains the original scene color
  62548. */
  62549. SSAOOriginalSceneColorEffect: string;
  62550. /**
  62551. * @ignore
  62552. * The SSAO PostProcess id in the pipeline
  62553. */
  62554. SSAORenderEffect: string;
  62555. /**
  62556. * @ignore
  62557. * The horizontal blur PostProcess id in the pipeline
  62558. */
  62559. SSAOBlurHRenderEffect: string;
  62560. /**
  62561. * @ignore
  62562. * The vertical blur PostProcess id in the pipeline
  62563. */
  62564. SSAOBlurVRenderEffect: string;
  62565. /**
  62566. * @ignore
  62567. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  62568. */
  62569. SSAOCombineRenderEffect: string;
  62570. /**
  62571. * The output strength of the SSAO post-process. Default value is 1.0.
  62572. */
  62573. totalStrength: number;
  62574. /**
  62575. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  62576. */
  62577. maxZ: number;
  62578. /**
  62579. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  62580. */
  62581. minZAspect: number;
  62582. private _samples;
  62583. /**
  62584. * Number of samples used for the SSAO calculations. Default value is 8
  62585. */
  62586. samples: number;
  62587. private _textureSamples;
  62588. /**
  62589. * Number of samples to use for antialiasing
  62590. */
  62591. textureSamples: number;
  62592. /**
  62593. * Ratio object used for SSAO ratio and blur ratio
  62594. */
  62595. private _ratio;
  62596. /**
  62597. * Dynamically generated sphere sampler.
  62598. */
  62599. private _sampleSphere;
  62600. /**
  62601. * Blur filter offsets
  62602. */
  62603. private _samplerOffsets;
  62604. private _expensiveBlur;
  62605. /**
  62606. * If bilateral blur should be used
  62607. */
  62608. expensiveBlur: boolean;
  62609. /**
  62610. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  62611. */
  62612. radius: number;
  62613. /**
  62614. * The base color of the SSAO post-process
  62615. * The final result is "base + ssao" between [0, 1]
  62616. */
  62617. base: number;
  62618. /**
  62619. * Support test.
  62620. */
  62621. static readonly IsSupported: boolean;
  62622. private _scene;
  62623. private _depthTexture;
  62624. private _normalTexture;
  62625. private _randomTexture;
  62626. private _originalColorPostProcess;
  62627. private _ssaoPostProcess;
  62628. private _blurHPostProcess;
  62629. private _blurVPostProcess;
  62630. private _ssaoCombinePostProcess;
  62631. private _firstUpdate;
  62632. /**
  62633. * Gets active scene
  62634. */
  62635. readonly scene: Scene;
  62636. /**
  62637. * @constructor
  62638. * @param name The rendering pipeline name
  62639. * @param scene The scene linked to this pipeline
  62640. * @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 }
  62641. * @param cameras The array of cameras that the rendering pipeline will be attached to
  62642. */
  62643. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  62644. /**
  62645. * Get the class name
  62646. * @returns "SSAO2RenderingPipeline"
  62647. */
  62648. getClassName(): string;
  62649. /**
  62650. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  62651. */
  62652. dispose(disableGeometryBufferRenderer?: boolean): void;
  62653. private _createBlurPostProcess;
  62654. /** @hidden */
  62655. _rebuild(): void;
  62656. private _bits;
  62657. private _radicalInverse_VdC;
  62658. private _hammersley;
  62659. private _hemisphereSample_uniform;
  62660. private _generateHemisphere;
  62661. private _createSSAOPostProcess;
  62662. private _createSSAOCombinePostProcess;
  62663. private _createRandomTexture;
  62664. /**
  62665. * Serialize the rendering pipeline (Used when exporting)
  62666. * @returns the serialized object
  62667. */
  62668. serialize(): any;
  62669. /**
  62670. * Parse the serialized pipeline
  62671. * @param source Source pipeline.
  62672. * @param scene The scene to load the pipeline to.
  62673. * @param rootUrl The URL of the serialized pipeline.
  62674. * @returns An instantiated pipeline from the serialized object.
  62675. */
  62676. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  62677. }
  62678. }
  62679. declare module "babylonjs/Shaders/ssao.fragment" {
  62680. /** @hidden */
  62681. export var ssaoPixelShader: {
  62682. name: string;
  62683. shader: string;
  62684. };
  62685. }
  62686. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  62687. import { Camera } from "babylonjs/Cameras/camera";
  62688. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  62689. import { Scene } from "babylonjs/scene";
  62690. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  62691. import "babylonjs/Shaders/ssao.fragment";
  62692. import "babylonjs/Shaders/ssaoCombine.fragment";
  62693. /**
  62694. * Render pipeline to produce ssao effect
  62695. */
  62696. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  62697. /**
  62698. * @ignore
  62699. * The PassPostProcess id in the pipeline that contains the original scene color
  62700. */
  62701. SSAOOriginalSceneColorEffect: string;
  62702. /**
  62703. * @ignore
  62704. * The SSAO PostProcess id in the pipeline
  62705. */
  62706. SSAORenderEffect: string;
  62707. /**
  62708. * @ignore
  62709. * The horizontal blur PostProcess id in the pipeline
  62710. */
  62711. SSAOBlurHRenderEffect: string;
  62712. /**
  62713. * @ignore
  62714. * The vertical blur PostProcess id in the pipeline
  62715. */
  62716. SSAOBlurVRenderEffect: string;
  62717. /**
  62718. * @ignore
  62719. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  62720. */
  62721. SSAOCombineRenderEffect: string;
  62722. /**
  62723. * The output strength of the SSAO post-process. Default value is 1.0.
  62724. */
  62725. totalStrength: number;
  62726. /**
  62727. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  62728. */
  62729. radius: number;
  62730. /**
  62731. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  62732. * Must not be equal to fallOff and superior to fallOff.
  62733. * Default value is 0.0075
  62734. */
  62735. area: number;
  62736. /**
  62737. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  62738. * Must not be equal to area and inferior to area.
  62739. * Default value is 0.000001
  62740. */
  62741. fallOff: number;
  62742. /**
  62743. * The base color of the SSAO post-process
  62744. * The final result is "base + ssao" between [0, 1]
  62745. */
  62746. base: number;
  62747. private _scene;
  62748. private _depthTexture;
  62749. private _randomTexture;
  62750. private _originalColorPostProcess;
  62751. private _ssaoPostProcess;
  62752. private _blurHPostProcess;
  62753. private _blurVPostProcess;
  62754. private _ssaoCombinePostProcess;
  62755. private _firstUpdate;
  62756. /**
  62757. * Gets active scene
  62758. */
  62759. readonly scene: Scene;
  62760. /**
  62761. * @constructor
  62762. * @param name - The rendering pipeline name
  62763. * @param scene - The scene linked to this pipeline
  62764. * @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 }
  62765. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  62766. */
  62767. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  62768. /**
  62769. * Get the class name
  62770. * @returns "SSAORenderingPipeline"
  62771. */
  62772. getClassName(): string;
  62773. /**
  62774. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  62775. */
  62776. dispose(disableDepthRender?: boolean): void;
  62777. private _createBlurPostProcess;
  62778. /** @hidden */
  62779. _rebuild(): void;
  62780. private _createSSAOPostProcess;
  62781. private _createSSAOCombinePostProcess;
  62782. private _createRandomTexture;
  62783. }
  62784. }
  62785. declare module "babylonjs/Shaders/standard.fragment" {
  62786. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62787. /** @hidden */
  62788. export var standardPixelShader: {
  62789. name: string;
  62790. shader: string;
  62791. };
  62792. }
  62793. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  62794. import { Nullable } from "babylonjs/types";
  62795. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  62796. import { Camera } from "babylonjs/Cameras/camera";
  62797. import { Texture } from "babylonjs/Materials/Textures/texture";
  62798. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62799. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  62800. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  62801. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  62802. import { IDisposable } from "babylonjs/scene";
  62803. import { SpotLight } from "babylonjs/Lights/spotLight";
  62804. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62805. import { Scene } from "babylonjs/scene";
  62806. import { Animation } from "babylonjs/Animations/animation";
  62807. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  62808. import "babylonjs/Shaders/standard.fragment";
  62809. /**
  62810. * Standard rendering pipeline
  62811. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  62812. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  62813. */
  62814. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  62815. /**
  62816. * Public members
  62817. */
  62818. /**
  62819. * Post-process which contains the original scene color before the pipeline applies all the effects
  62820. */
  62821. originalPostProcess: Nullable<PostProcess>;
  62822. /**
  62823. * Post-process used to down scale an image x4
  62824. */
  62825. downSampleX4PostProcess: Nullable<PostProcess>;
  62826. /**
  62827. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  62828. */
  62829. brightPassPostProcess: Nullable<PostProcess>;
  62830. /**
  62831. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  62832. */
  62833. blurHPostProcesses: PostProcess[];
  62834. /**
  62835. * Post-process array storing all the vertical blur post-processes used by the pipeline
  62836. */
  62837. blurVPostProcesses: PostProcess[];
  62838. /**
  62839. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  62840. */
  62841. textureAdderPostProcess: Nullable<PostProcess>;
  62842. /**
  62843. * Post-process used to create volumetric lighting effect
  62844. */
  62845. volumetricLightPostProcess: Nullable<PostProcess>;
  62846. /**
  62847. * Post-process used to smooth the previous volumetric light post-process on the X axis
  62848. */
  62849. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  62850. /**
  62851. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  62852. */
  62853. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  62854. /**
  62855. * Post-process used to merge the volumetric light effect and the real scene color
  62856. */
  62857. volumetricLightMergePostProces: Nullable<PostProcess>;
  62858. /**
  62859. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  62860. */
  62861. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  62862. /**
  62863. * Base post-process used to calculate the average luminance of the final image for HDR
  62864. */
  62865. luminancePostProcess: Nullable<PostProcess>;
  62866. /**
  62867. * Post-processes used to create down sample post-processes in order to get
  62868. * the average luminance of the final image for HDR
  62869. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  62870. */
  62871. luminanceDownSamplePostProcesses: PostProcess[];
  62872. /**
  62873. * Post-process used to create a HDR effect (light adaptation)
  62874. */
  62875. hdrPostProcess: Nullable<PostProcess>;
  62876. /**
  62877. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  62878. */
  62879. textureAdderFinalPostProcess: Nullable<PostProcess>;
  62880. /**
  62881. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  62882. */
  62883. lensFlareFinalPostProcess: Nullable<PostProcess>;
  62884. /**
  62885. * Post-process used to merge the final HDR post-process and the real scene color
  62886. */
  62887. hdrFinalPostProcess: Nullable<PostProcess>;
  62888. /**
  62889. * Post-process used to create a lens flare effect
  62890. */
  62891. lensFlarePostProcess: Nullable<PostProcess>;
  62892. /**
  62893. * Post-process that merges the result of the lens flare post-process and the real scene color
  62894. */
  62895. lensFlareComposePostProcess: Nullable<PostProcess>;
  62896. /**
  62897. * Post-process used to create a motion blur effect
  62898. */
  62899. motionBlurPostProcess: Nullable<PostProcess>;
  62900. /**
  62901. * Post-process used to create a depth of field effect
  62902. */
  62903. depthOfFieldPostProcess: Nullable<PostProcess>;
  62904. /**
  62905. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  62906. */
  62907. fxaaPostProcess: Nullable<FxaaPostProcess>;
  62908. /**
  62909. * Represents the brightness threshold in order to configure the illuminated surfaces
  62910. */
  62911. brightThreshold: number;
  62912. /**
  62913. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  62914. */
  62915. blurWidth: number;
  62916. /**
  62917. * Sets if the blur for highlighted surfaces must be only horizontal
  62918. */
  62919. horizontalBlur: boolean;
  62920. /**
  62921. * Gets the overall exposure used by the pipeline
  62922. */
  62923. /**
  62924. * Sets the overall exposure used by the pipeline
  62925. */
  62926. exposure: number;
  62927. /**
  62928. * Texture used typically to simulate "dirty" on camera lens
  62929. */
  62930. lensTexture: Nullable<Texture>;
  62931. /**
  62932. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  62933. */
  62934. volumetricLightCoefficient: number;
  62935. /**
  62936. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  62937. */
  62938. volumetricLightPower: number;
  62939. /**
  62940. * Used the set the blur intensity to smooth the volumetric lights
  62941. */
  62942. volumetricLightBlurScale: number;
  62943. /**
  62944. * Light (spot or directional) used to generate the volumetric lights rays
  62945. * The source light must have a shadow generate so the pipeline can get its
  62946. * depth map
  62947. */
  62948. sourceLight: Nullable<SpotLight | DirectionalLight>;
  62949. /**
  62950. * For eye adaptation, represents the minimum luminance the eye can see
  62951. */
  62952. hdrMinimumLuminance: number;
  62953. /**
  62954. * For eye adaptation, represents the decrease luminance speed
  62955. */
  62956. hdrDecreaseRate: number;
  62957. /**
  62958. * For eye adaptation, represents the increase luminance speed
  62959. */
  62960. hdrIncreaseRate: number;
  62961. /**
  62962. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  62963. */
  62964. /**
  62965. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  62966. */
  62967. hdrAutoExposure: boolean;
  62968. /**
  62969. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  62970. */
  62971. lensColorTexture: Nullable<Texture>;
  62972. /**
  62973. * The overall strengh for the lens flare effect
  62974. */
  62975. lensFlareStrength: number;
  62976. /**
  62977. * Dispersion coefficient for lens flare ghosts
  62978. */
  62979. lensFlareGhostDispersal: number;
  62980. /**
  62981. * Main lens flare halo width
  62982. */
  62983. lensFlareHaloWidth: number;
  62984. /**
  62985. * Based on the lens distortion effect, defines how much the lens flare result
  62986. * is distorted
  62987. */
  62988. lensFlareDistortionStrength: number;
  62989. /**
  62990. * Configures the blur intensity used for for lens flare (halo)
  62991. */
  62992. lensFlareBlurWidth: number;
  62993. /**
  62994. * Lens star texture must be used to simulate rays on the flares and is available
  62995. * in the documentation
  62996. */
  62997. lensStarTexture: Nullable<Texture>;
  62998. /**
  62999. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  63000. * flare effect by taking account of the dirt texture
  63001. */
  63002. lensFlareDirtTexture: Nullable<Texture>;
  63003. /**
  63004. * Represents the focal length for the depth of field effect
  63005. */
  63006. depthOfFieldDistance: number;
  63007. /**
  63008. * Represents the blur intensity for the blurred part of the depth of field effect
  63009. */
  63010. depthOfFieldBlurWidth: number;
  63011. /**
  63012. * Gets how much the image is blurred by the movement while using the motion blur post-process
  63013. */
  63014. /**
  63015. * Sets how much the image is blurred by the movement while using the motion blur post-process
  63016. */
  63017. motionStrength: number;
  63018. /**
  63019. * Gets wether or not the motion blur post-process is object based or screen based.
  63020. */
  63021. /**
  63022. * Sets wether or not the motion blur post-process should be object based or screen based
  63023. */
  63024. objectBasedMotionBlur: boolean;
  63025. /**
  63026. * List of animations for the pipeline (IAnimatable implementation)
  63027. */
  63028. animations: Animation[];
  63029. /**
  63030. * Private members
  63031. */
  63032. private _scene;
  63033. private _currentDepthOfFieldSource;
  63034. private _basePostProcess;
  63035. private _fixedExposure;
  63036. private _currentExposure;
  63037. private _hdrAutoExposure;
  63038. private _hdrCurrentLuminance;
  63039. private _motionStrength;
  63040. private _isObjectBasedMotionBlur;
  63041. private _floatTextureType;
  63042. private _camerasToBeAttached;
  63043. private _ratio;
  63044. private _bloomEnabled;
  63045. private _depthOfFieldEnabled;
  63046. private _vlsEnabled;
  63047. private _lensFlareEnabled;
  63048. private _hdrEnabled;
  63049. private _motionBlurEnabled;
  63050. private _fxaaEnabled;
  63051. private _motionBlurSamples;
  63052. private _volumetricLightStepsCount;
  63053. private _samples;
  63054. /**
  63055. * @ignore
  63056. * Specifies if the bloom pipeline is enabled
  63057. */
  63058. BloomEnabled: boolean;
  63059. /**
  63060. * @ignore
  63061. * Specifies if the depth of field pipeline is enabed
  63062. */
  63063. DepthOfFieldEnabled: boolean;
  63064. /**
  63065. * @ignore
  63066. * Specifies if the lens flare pipeline is enabed
  63067. */
  63068. LensFlareEnabled: boolean;
  63069. /**
  63070. * @ignore
  63071. * Specifies if the HDR pipeline is enabled
  63072. */
  63073. HDREnabled: boolean;
  63074. /**
  63075. * @ignore
  63076. * Specifies if the volumetric lights scattering effect is enabled
  63077. */
  63078. VLSEnabled: boolean;
  63079. /**
  63080. * @ignore
  63081. * Specifies if the motion blur effect is enabled
  63082. */
  63083. MotionBlurEnabled: boolean;
  63084. /**
  63085. * Specifies if anti-aliasing is enabled
  63086. */
  63087. fxaaEnabled: boolean;
  63088. /**
  63089. * Specifies the number of steps used to calculate the volumetric lights
  63090. * Typically in interval [50, 200]
  63091. */
  63092. volumetricLightStepsCount: number;
  63093. /**
  63094. * Specifies the number of samples used for the motion blur effect
  63095. * Typically in interval [16, 64]
  63096. */
  63097. motionBlurSamples: number;
  63098. /**
  63099. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  63100. */
  63101. samples: number;
  63102. /**
  63103. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  63104. * @constructor
  63105. * @param name The rendering pipeline name
  63106. * @param scene The scene linked to this pipeline
  63107. * @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)
  63108. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  63109. * @param cameras The array of cameras that the rendering pipeline will be attached to
  63110. */
  63111. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  63112. private _buildPipeline;
  63113. private _createDownSampleX4PostProcess;
  63114. private _createBrightPassPostProcess;
  63115. private _createBlurPostProcesses;
  63116. private _createTextureAdderPostProcess;
  63117. private _createVolumetricLightPostProcess;
  63118. private _createLuminancePostProcesses;
  63119. private _createHdrPostProcess;
  63120. private _createLensFlarePostProcess;
  63121. private _createDepthOfFieldPostProcess;
  63122. private _createMotionBlurPostProcess;
  63123. private _getDepthTexture;
  63124. private _disposePostProcesses;
  63125. /**
  63126. * Dispose of the pipeline and stop all post processes
  63127. */
  63128. dispose(): void;
  63129. /**
  63130. * Serialize the rendering pipeline (Used when exporting)
  63131. * @returns the serialized object
  63132. */
  63133. serialize(): any;
  63134. /**
  63135. * Parse the serialized pipeline
  63136. * @param source Source pipeline.
  63137. * @param scene The scene to load the pipeline to.
  63138. * @param rootUrl The URL of the serialized pipeline.
  63139. * @returns An instantiated pipeline from the serialized object.
  63140. */
  63141. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  63142. /**
  63143. * Luminance steps
  63144. */
  63145. static LuminanceSteps: number;
  63146. }
  63147. }
  63148. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  63149. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  63150. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  63151. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  63152. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  63153. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  63154. }
  63155. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  63156. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  63157. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63158. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  63159. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  63160. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  63161. }
  63162. declare module "babylonjs/Shaders/tonemap.fragment" {
  63163. /** @hidden */
  63164. export var tonemapPixelShader: {
  63165. name: string;
  63166. shader: string;
  63167. };
  63168. }
  63169. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  63170. import { Camera } from "babylonjs/Cameras/camera";
  63171. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63172. import "babylonjs/Shaders/tonemap.fragment";
  63173. import { Engine } from "babylonjs/Engines/engine";
  63174. /** Defines operator used for tonemapping */
  63175. export enum TonemappingOperator {
  63176. /** Hable */
  63177. Hable = 0,
  63178. /** Reinhard */
  63179. Reinhard = 1,
  63180. /** HejiDawson */
  63181. HejiDawson = 2,
  63182. /** Photographic */
  63183. Photographic = 3
  63184. }
  63185. /**
  63186. * Defines a post process to apply tone mapping
  63187. */
  63188. export class TonemapPostProcess extends PostProcess {
  63189. private _operator;
  63190. /** Defines the required exposure adjustement */
  63191. exposureAdjustment: number;
  63192. /**
  63193. * Creates a new TonemapPostProcess
  63194. * @param name defines the name of the postprocess
  63195. * @param _operator defines the operator to use
  63196. * @param exposureAdjustment defines the required exposure adjustement
  63197. * @param camera defines the camera to use (can be null)
  63198. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  63199. * @param engine defines the hosting engine (can be ignore if camera is set)
  63200. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  63201. */
  63202. constructor(name: string, _operator: TonemappingOperator,
  63203. /** Defines the required exposure adjustement */
  63204. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  63205. }
  63206. }
  63207. declare module "babylonjs/Shaders/depth.vertex" {
  63208. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63209. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63210. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63211. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63212. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63213. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63214. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63215. /** @hidden */
  63216. export var depthVertexShader: {
  63217. name: string;
  63218. shader: string;
  63219. };
  63220. }
  63221. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  63222. /** @hidden */
  63223. export var volumetricLightScatteringPixelShader: {
  63224. name: string;
  63225. shader: string;
  63226. };
  63227. }
  63228. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  63229. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63230. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63231. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63232. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63233. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63234. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63235. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63236. /** @hidden */
  63237. export var volumetricLightScatteringPassVertexShader: {
  63238. name: string;
  63239. shader: string;
  63240. };
  63241. }
  63242. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  63243. /** @hidden */
  63244. export var volumetricLightScatteringPassPixelShader: {
  63245. name: string;
  63246. shader: string;
  63247. };
  63248. }
  63249. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  63250. import { Vector3 } from "babylonjs/Maths/math.vector";
  63251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63252. import { Mesh } from "babylonjs/Meshes/mesh";
  63253. import { Camera } from "babylonjs/Cameras/camera";
  63254. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63255. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63256. import { Scene } from "babylonjs/scene";
  63257. import "babylonjs/Meshes/Builders/planeBuilder";
  63258. import "babylonjs/Shaders/depth.vertex";
  63259. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  63260. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  63261. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  63262. import { Engine } from "babylonjs/Engines/engine";
  63263. /**
  63264. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  63265. */
  63266. export class VolumetricLightScatteringPostProcess extends PostProcess {
  63267. private _volumetricLightScatteringPass;
  63268. private _volumetricLightScatteringRTT;
  63269. private _viewPort;
  63270. private _screenCoordinates;
  63271. private _cachedDefines;
  63272. /**
  63273. * If not undefined, the mesh position is computed from the attached node position
  63274. */
  63275. attachedNode: {
  63276. position: Vector3;
  63277. };
  63278. /**
  63279. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  63280. */
  63281. customMeshPosition: Vector3;
  63282. /**
  63283. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  63284. */
  63285. useCustomMeshPosition: boolean;
  63286. /**
  63287. * If the post-process should inverse the light scattering direction
  63288. */
  63289. invert: boolean;
  63290. /**
  63291. * The internal mesh used by the post-process
  63292. */
  63293. mesh: Mesh;
  63294. /**
  63295. * @hidden
  63296. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  63297. */
  63298. useDiffuseColor: boolean;
  63299. /**
  63300. * Array containing the excluded meshes not rendered in the internal pass
  63301. */
  63302. excludedMeshes: AbstractMesh[];
  63303. /**
  63304. * Controls the overall intensity of the post-process
  63305. */
  63306. exposure: number;
  63307. /**
  63308. * Dissipates each sample's contribution in range [0, 1]
  63309. */
  63310. decay: number;
  63311. /**
  63312. * Controls the overall intensity of each sample
  63313. */
  63314. weight: number;
  63315. /**
  63316. * Controls the density of each sample
  63317. */
  63318. density: number;
  63319. /**
  63320. * @constructor
  63321. * @param name The post-process name
  63322. * @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)
  63323. * @param camera The camera that the post-process will be attached to
  63324. * @param mesh The mesh used to create the light scattering
  63325. * @param samples The post-process quality, default 100
  63326. * @param samplingModeThe post-process filtering mode
  63327. * @param engine The babylon engine
  63328. * @param reusable If the post-process is reusable
  63329. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  63330. */
  63331. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  63332. /**
  63333. * Returns the string "VolumetricLightScatteringPostProcess"
  63334. * @returns "VolumetricLightScatteringPostProcess"
  63335. */
  63336. getClassName(): string;
  63337. private _isReady;
  63338. /**
  63339. * Sets the new light position for light scattering effect
  63340. * @param position The new custom light position
  63341. */
  63342. setCustomMeshPosition(position: Vector3): void;
  63343. /**
  63344. * Returns the light position for light scattering effect
  63345. * @return Vector3 The custom light position
  63346. */
  63347. getCustomMeshPosition(): Vector3;
  63348. /**
  63349. * Disposes the internal assets and detaches the post-process from the camera
  63350. */
  63351. dispose(camera: Camera): void;
  63352. /**
  63353. * Returns the render target texture used by the post-process
  63354. * @return the render target texture used by the post-process
  63355. */
  63356. getPass(): RenderTargetTexture;
  63357. private _meshExcluded;
  63358. private _createPass;
  63359. private _updateMeshScreenCoordinates;
  63360. /**
  63361. * Creates a default mesh for the Volumeric Light Scattering post-process
  63362. * @param name The mesh name
  63363. * @param scene The scene where to create the mesh
  63364. * @return the default mesh
  63365. */
  63366. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  63367. }
  63368. }
  63369. declare module "babylonjs/PostProcesses/index" {
  63370. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  63371. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  63372. export * from "babylonjs/PostProcesses/bloomEffect";
  63373. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  63374. export * from "babylonjs/PostProcesses/blurPostProcess";
  63375. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  63376. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  63377. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  63378. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  63379. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63380. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  63381. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  63382. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  63383. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  63384. export * from "babylonjs/PostProcesses/filterPostProcess";
  63385. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  63386. export * from "babylonjs/PostProcesses/grainPostProcess";
  63387. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  63388. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  63389. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  63390. export * from "babylonjs/PostProcesses/passPostProcess";
  63391. export * from "babylonjs/PostProcesses/postProcess";
  63392. export * from "babylonjs/PostProcesses/postProcessManager";
  63393. export * from "babylonjs/PostProcesses/refractionPostProcess";
  63394. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  63395. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  63396. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  63397. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  63398. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  63399. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  63400. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  63401. }
  63402. declare module "babylonjs/Probes/index" {
  63403. export * from "babylonjs/Probes/reflectionProbe";
  63404. }
  63405. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  63406. import { Scene } from "babylonjs/scene";
  63407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63408. import { SmartArray } from "babylonjs/Misc/smartArray";
  63409. import { ISceneComponent } from "babylonjs/sceneComponent";
  63410. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  63411. import "babylonjs/Meshes/Builders/boxBuilder";
  63412. import "babylonjs/Shaders/color.fragment";
  63413. import "babylonjs/Shaders/color.vertex";
  63414. import { Color3 } from "babylonjs/Maths/math.color";
  63415. module "babylonjs/scene" {
  63416. interface Scene {
  63417. /** @hidden (Backing field) */
  63418. _boundingBoxRenderer: BoundingBoxRenderer;
  63419. /** @hidden (Backing field) */
  63420. _forceShowBoundingBoxes: boolean;
  63421. /**
  63422. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  63423. */
  63424. forceShowBoundingBoxes: boolean;
  63425. /**
  63426. * Gets the bounding box renderer associated with the scene
  63427. * @returns a BoundingBoxRenderer
  63428. */
  63429. getBoundingBoxRenderer(): BoundingBoxRenderer;
  63430. }
  63431. }
  63432. module "babylonjs/Meshes/abstractMesh" {
  63433. interface AbstractMesh {
  63434. /** @hidden (Backing field) */
  63435. _showBoundingBox: boolean;
  63436. /**
  63437. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  63438. */
  63439. showBoundingBox: boolean;
  63440. }
  63441. }
  63442. /**
  63443. * Component responsible of rendering the bounding box of the meshes in a scene.
  63444. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  63445. */
  63446. export class BoundingBoxRenderer implements ISceneComponent {
  63447. /**
  63448. * The component name helpfull to identify the component in the list of scene components.
  63449. */
  63450. readonly name: string;
  63451. /**
  63452. * The scene the component belongs to.
  63453. */
  63454. scene: Scene;
  63455. /**
  63456. * Color of the bounding box lines placed in front of an object
  63457. */
  63458. frontColor: Color3;
  63459. /**
  63460. * Color of the bounding box lines placed behind an object
  63461. */
  63462. backColor: Color3;
  63463. /**
  63464. * Defines if the renderer should show the back lines or not
  63465. */
  63466. showBackLines: boolean;
  63467. /**
  63468. * @hidden
  63469. */
  63470. renderList: SmartArray<BoundingBox>;
  63471. private _colorShader;
  63472. private _vertexBuffers;
  63473. private _indexBuffer;
  63474. private _fillIndexBuffer;
  63475. private _fillIndexData;
  63476. /**
  63477. * Instantiates a new bounding box renderer in a scene.
  63478. * @param scene the scene the renderer renders in
  63479. */
  63480. constructor(scene: Scene);
  63481. /**
  63482. * Registers the component in a given scene
  63483. */
  63484. register(): void;
  63485. private _evaluateSubMesh;
  63486. private _activeMesh;
  63487. private _prepareRessources;
  63488. private _createIndexBuffer;
  63489. /**
  63490. * Rebuilds the elements related to this component in case of
  63491. * context lost for instance.
  63492. */
  63493. rebuild(): void;
  63494. /**
  63495. * @hidden
  63496. */
  63497. reset(): void;
  63498. /**
  63499. * Render the bounding boxes of a specific rendering group
  63500. * @param renderingGroupId defines the rendering group to render
  63501. */
  63502. render(renderingGroupId: number): void;
  63503. /**
  63504. * In case of occlusion queries, we can render the occlusion bounding box through this method
  63505. * @param mesh Define the mesh to render the occlusion bounding box for
  63506. */
  63507. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  63508. /**
  63509. * Dispose and release the resources attached to this renderer.
  63510. */
  63511. dispose(): void;
  63512. }
  63513. }
  63514. declare module "babylonjs/Shaders/depth.fragment" {
  63515. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  63516. /** @hidden */
  63517. export var depthPixelShader: {
  63518. name: string;
  63519. shader: string;
  63520. };
  63521. }
  63522. declare module "babylonjs/Rendering/depthRenderer" {
  63523. import { Nullable } from "babylonjs/types";
  63524. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63525. import { Scene } from "babylonjs/scene";
  63526. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63527. import { Camera } from "babylonjs/Cameras/camera";
  63528. import "babylonjs/Shaders/depth.fragment";
  63529. import "babylonjs/Shaders/depth.vertex";
  63530. /**
  63531. * This represents a depth renderer in Babylon.
  63532. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  63533. */
  63534. export class DepthRenderer {
  63535. private _scene;
  63536. private _depthMap;
  63537. private _effect;
  63538. private readonly _storeNonLinearDepth;
  63539. private readonly _clearColor;
  63540. /** Get if the depth renderer is using packed depth or not */
  63541. readonly isPacked: boolean;
  63542. private _cachedDefines;
  63543. private _camera;
  63544. /**
  63545. * Specifiess that the depth renderer will only be used within
  63546. * the camera it is created for.
  63547. * This can help forcing its rendering during the camera processing.
  63548. */
  63549. useOnlyInActiveCamera: boolean;
  63550. /** @hidden */
  63551. static _SceneComponentInitialization: (scene: Scene) => void;
  63552. /**
  63553. * Instantiates a depth renderer
  63554. * @param scene The scene the renderer belongs to
  63555. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  63556. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  63557. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  63558. */
  63559. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  63560. /**
  63561. * Creates the depth rendering effect and checks if the effect is ready.
  63562. * @param subMesh The submesh to be used to render the depth map of
  63563. * @param useInstances If multiple world instances should be used
  63564. * @returns if the depth renderer is ready to render the depth map
  63565. */
  63566. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63567. /**
  63568. * Gets the texture which the depth map will be written to.
  63569. * @returns The depth map texture
  63570. */
  63571. getDepthMap(): RenderTargetTexture;
  63572. /**
  63573. * Disposes of the depth renderer.
  63574. */
  63575. dispose(): void;
  63576. }
  63577. }
  63578. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  63579. import { Nullable } from "babylonjs/types";
  63580. import { Scene } from "babylonjs/scene";
  63581. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  63582. import { Camera } from "babylonjs/Cameras/camera";
  63583. import { ISceneComponent } from "babylonjs/sceneComponent";
  63584. module "babylonjs/scene" {
  63585. interface Scene {
  63586. /** @hidden (Backing field) */
  63587. _depthRenderer: {
  63588. [id: string]: DepthRenderer;
  63589. };
  63590. /**
  63591. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  63592. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  63593. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  63594. * @returns the created depth renderer
  63595. */
  63596. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  63597. /**
  63598. * Disables a depth renderer for a given camera
  63599. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  63600. */
  63601. disableDepthRenderer(camera?: Nullable<Camera>): void;
  63602. }
  63603. }
  63604. /**
  63605. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  63606. * in several rendering techniques.
  63607. */
  63608. export class DepthRendererSceneComponent implements ISceneComponent {
  63609. /**
  63610. * The component name helpfull to identify the component in the list of scene components.
  63611. */
  63612. readonly name: string;
  63613. /**
  63614. * The scene the component belongs to.
  63615. */
  63616. scene: Scene;
  63617. /**
  63618. * Creates a new instance of the component for the given scene
  63619. * @param scene Defines the scene to register the component in
  63620. */
  63621. constructor(scene: Scene);
  63622. /**
  63623. * Registers the component in a given scene
  63624. */
  63625. register(): void;
  63626. /**
  63627. * Rebuilds the elements related to this component in case of
  63628. * context lost for instance.
  63629. */
  63630. rebuild(): void;
  63631. /**
  63632. * Disposes the component and the associated ressources
  63633. */
  63634. dispose(): void;
  63635. private _gatherRenderTargets;
  63636. private _gatherActiveCameraRenderTargets;
  63637. }
  63638. }
  63639. declare module "babylonjs/Shaders/outline.fragment" {
  63640. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  63641. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  63642. /** @hidden */
  63643. export var outlinePixelShader: {
  63644. name: string;
  63645. shader: string;
  63646. };
  63647. }
  63648. declare module "babylonjs/Shaders/outline.vertex" {
  63649. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63650. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63651. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63652. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63653. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  63654. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63655. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63656. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63657. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  63658. /** @hidden */
  63659. export var outlineVertexShader: {
  63660. name: string;
  63661. shader: string;
  63662. };
  63663. }
  63664. declare module "babylonjs/Rendering/outlineRenderer" {
  63665. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63666. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  63667. import { Scene } from "babylonjs/scene";
  63668. import { ISceneComponent } from "babylonjs/sceneComponent";
  63669. import "babylonjs/Shaders/outline.fragment";
  63670. import "babylonjs/Shaders/outline.vertex";
  63671. module "babylonjs/scene" {
  63672. interface Scene {
  63673. /** @hidden */
  63674. _outlineRenderer: OutlineRenderer;
  63675. /**
  63676. * Gets the outline renderer associated with the scene
  63677. * @returns a OutlineRenderer
  63678. */
  63679. getOutlineRenderer(): OutlineRenderer;
  63680. }
  63681. }
  63682. module "babylonjs/Meshes/abstractMesh" {
  63683. interface AbstractMesh {
  63684. /** @hidden (Backing field) */
  63685. _renderOutline: boolean;
  63686. /**
  63687. * Gets or sets a boolean indicating if the outline must be rendered as well
  63688. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  63689. */
  63690. renderOutline: boolean;
  63691. /** @hidden (Backing field) */
  63692. _renderOverlay: boolean;
  63693. /**
  63694. * Gets or sets a boolean indicating if the overlay must be rendered as well
  63695. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  63696. */
  63697. renderOverlay: boolean;
  63698. }
  63699. }
  63700. /**
  63701. * This class is responsible to draw bothe outline/overlay of meshes.
  63702. * It should not be used directly but through the available method on mesh.
  63703. */
  63704. export class OutlineRenderer implements ISceneComponent {
  63705. /**
  63706. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  63707. */
  63708. private static _StencilReference;
  63709. /**
  63710. * The name of the component. Each component must have a unique name.
  63711. */
  63712. name: string;
  63713. /**
  63714. * The scene the component belongs to.
  63715. */
  63716. scene: Scene;
  63717. /**
  63718. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  63719. */
  63720. zOffset: number;
  63721. private _engine;
  63722. private _effect;
  63723. private _cachedDefines;
  63724. private _savedDepthWrite;
  63725. /**
  63726. * Instantiates a new outline renderer. (There could be only one per scene).
  63727. * @param scene Defines the scene it belongs to
  63728. */
  63729. constructor(scene: Scene);
  63730. /**
  63731. * Register the component to one instance of a scene.
  63732. */
  63733. register(): void;
  63734. /**
  63735. * Rebuilds the elements related to this component in case of
  63736. * context lost for instance.
  63737. */
  63738. rebuild(): void;
  63739. /**
  63740. * Disposes the component and the associated ressources.
  63741. */
  63742. dispose(): void;
  63743. /**
  63744. * Renders the outline in the canvas.
  63745. * @param subMesh Defines the sumesh to render
  63746. * @param batch Defines the batch of meshes in case of instances
  63747. * @param useOverlay Defines if the rendering is for the overlay or the outline
  63748. */
  63749. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  63750. /**
  63751. * Returns whether or not the outline renderer is ready for a given submesh.
  63752. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  63753. * @param subMesh Defines the submesh to check readyness for
  63754. * @param useInstances Defines wheter wee are trying to render instances or not
  63755. * @returns true if ready otherwise false
  63756. */
  63757. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63758. private _beforeRenderingMesh;
  63759. private _afterRenderingMesh;
  63760. }
  63761. }
  63762. declare module "babylonjs/Rendering/index" {
  63763. export * from "babylonjs/Rendering/boundingBoxRenderer";
  63764. export * from "babylonjs/Rendering/depthRenderer";
  63765. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  63766. export * from "babylonjs/Rendering/edgesRenderer";
  63767. export * from "babylonjs/Rendering/geometryBufferRenderer";
  63768. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  63769. export * from "babylonjs/Rendering/outlineRenderer";
  63770. export * from "babylonjs/Rendering/renderingGroup";
  63771. export * from "babylonjs/Rendering/renderingManager";
  63772. export * from "babylonjs/Rendering/utilityLayerRenderer";
  63773. }
  63774. declare module "babylonjs/Sprites/spritePackedManager" {
  63775. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  63776. import { Scene } from "babylonjs/scene";
  63777. /**
  63778. * Class used to manage multiple sprites of different sizes on the same spritesheet
  63779. * @see http://doc.babylonjs.com/babylon101/sprites
  63780. */
  63781. export class SpritePackedManager extends SpriteManager {
  63782. /** defines the packed manager's name */
  63783. name: string;
  63784. /**
  63785. * Creates a new sprite manager from a packed sprite sheet
  63786. * @param name defines the manager's name
  63787. * @param imgUrl defines the sprite sheet url
  63788. * @param capacity defines the maximum allowed number of sprites
  63789. * @param scene defines the hosting scene
  63790. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  63791. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  63792. * @param samplingMode defines the smapling mode to use with spritesheet
  63793. * @param fromPacked set to true; do not alter
  63794. */
  63795. constructor(
  63796. /** defines the packed manager's name */
  63797. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  63798. }
  63799. }
  63800. declare module "babylonjs/Sprites/index" {
  63801. export * from "babylonjs/Sprites/sprite";
  63802. export * from "babylonjs/Sprites/spriteManager";
  63803. export * from "babylonjs/Sprites/spritePackedManager";
  63804. export * from "babylonjs/Sprites/spriteSceneComponent";
  63805. }
  63806. declare module "babylonjs/Misc/assetsManager" {
  63807. import { Scene } from "babylonjs/scene";
  63808. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63809. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  63810. import { Skeleton } from "babylonjs/Bones/skeleton";
  63811. import { Observable } from "babylonjs/Misc/observable";
  63812. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63813. import { Texture } from "babylonjs/Materials/Textures/texture";
  63814. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  63815. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  63816. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  63817. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  63818. /**
  63819. * Defines the list of states available for a task inside a AssetsManager
  63820. */
  63821. export enum AssetTaskState {
  63822. /**
  63823. * Initialization
  63824. */
  63825. INIT = 0,
  63826. /**
  63827. * Running
  63828. */
  63829. RUNNING = 1,
  63830. /**
  63831. * Done
  63832. */
  63833. DONE = 2,
  63834. /**
  63835. * Error
  63836. */
  63837. ERROR = 3
  63838. }
  63839. /**
  63840. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  63841. */
  63842. export abstract class AbstractAssetTask {
  63843. /**
  63844. * Task name
  63845. */ name: string;
  63846. /**
  63847. * Callback called when the task is successful
  63848. */
  63849. onSuccess: (task: any) => void;
  63850. /**
  63851. * Callback called when the task is not successful
  63852. */
  63853. onError: (task: any, message?: string, exception?: any) => void;
  63854. /**
  63855. * Creates a new AssetsManager
  63856. * @param name defines the name of the task
  63857. */
  63858. constructor(
  63859. /**
  63860. * Task name
  63861. */ name: string);
  63862. private _isCompleted;
  63863. private _taskState;
  63864. private _errorObject;
  63865. /**
  63866. * Get if the task is completed
  63867. */
  63868. readonly isCompleted: boolean;
  63869. /**
  63870. * Gets the current state of the task
  63871. */
  63872. readonly taskState: AssetTaskState;
  63873. /**
  63874. * Gets the current error object (if task is in error)
  63875. */
  63876. readonly errorObject: {
  63877. message?: string;
  63878. exception?: any;
  63879. };
  63880. /**
  63881. * Internal only
  63882. * @hidden
  63883. */
  63884. _setErrorObject(message?: string, exception?: any): void;
  63885. /**
  63886. * Execute the current task
  63887. * @param scene defines the scene where you want your assets to be loaded
  63888. * @param onSuccess is a callback called when the task is successfully executed
  63889. * @param onError is a callback called if an error occurs
  63890. */
  63891. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  63892. /**
  63893. * Execute the current task
  63894. * @param scene defines the scene where you want your assets to be loaded
  63895. * @param onSuccess is a callback called when the task is successfully executed
  63896. * @param onError is a callback called if an error occurs
  63897. */
  63898. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  63899. /**
  63900. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  63901. * This can be used with failed tasks that have the reason for failure fixed.
  63902. */
  63903. reset(): void;
  63904. private onErrorCallback;
  63905. private onDoneCallback;
  63906. }
  63907. /**
  63908. * Define the interface used by progress events raised during assets loading
  63909. */
  63910. export interface IAssetsProgressEvent {
  63911. /**
  63912. * Defines the number of remaining tasks to process
  63913. */
  63914. remainingCount: number;
  63915. /**
  63916. * Defines the total number of tasks
  63917. */
  63918. totalCount: number;
  63919. /**
  63920. * Defines the task that was just processed
  63921. */
  63922. task: AbstractAssetTask;
  63923. }
  63924. /**
  63925. * Class used to share progress information about assets loading
  63926. */
  63927. export class AssetsProgressEvent implements IAssetsProgressEvent {
  63928. /**
  63929. * Defines the number of remaining tasks to process
  63930. */
  63931. remainingCount: number;
  63932. /**
  63933. * Defines the total number of tasks
  63934. */
  63935. totalCount: number;
  63936. /**
  63937. * Defines the task that was just processed
  63938. */
  63939. task: AbstractAssetTask;
  63940. /**
  63941. * Creates a AssetsProgressEvent
  63942. * @param remainingCount defines the number of remaining tasks to process
  63943. * @param totalCount defines the total number of tasks
  63944. * @param task defines the task that was just processed
  63945. */
  63946. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  63947. }
  63948. /**
  63949. * Define a task used by AssetsManager to load meshes
  63950. */
  63951. export class MeshAssetTask extends AbstractAssetTask {
  63952. /**
  63953. * Defines the name of the task
  63954. */
  63955. name: string;
  63956. /**
  63957. * Defines the list of mesh's names you want to load
  63958. */
  63959. meshesNames: any;
  63960. /**
  63961. * Defines the root url to use as a base to load your meshes and associated resources
  63962. */
  63963. rootUrl: string;
  63964. /**
  63965. * Defines the filename of the scene to load from
  63966. */
  63967. sceneFilename: string;
  63968. /**
  63969. * Gets the list of loaded meshes
  63970. */
  63971. loadedMeshes: Array<AbstractMesh>;
  63972. /**
  63973. * Gets the list of loaded particle systems
  63974. */
  63975. loadedParticleSystems: Array<IParticleSystem>;
  63976. /**
  63977. * Gets the list of loaded skeletons
  63978. */
  63979. loadedSkeletons: Array<Skeleton>;
  63980. /**
  63981. * Gets the list of loaded animation groups
  63982. */
  63983. loadedAnimationGroups: Array<AnimationGroup>;
  63984. /**
  63985. * Callback called when the task is successful
  63986. */
  63987. onSuccess: (task: MeshAssetTask) => void;
  63988. /**
  63989. * Callback called when the task is successful
  63990. */
  63991. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  63992. /**
  63993. * Creates a new MeshAssetTask
  63994. * @param name defines the name of the task
  63995. * @param meshesNames defines the list of mesh's names you want to load
  63996. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  63997. * @param sceneFilename defines the filename of the scene to load from
  63998. */
  63999. constructor(
  64000. /**
  64001. * Defines the name of the task
  64002. */
  64003. name: string,
  64004. /**
  64005. * Defines the list of mesh's names you want to load
  64006. */
  64007. meshesNames: any,
  64008. /**
  64009. * Defines the root url to use as a base to load your meshes and associated resources
  64010. */
  64011. rootUrl: string,
  64012. /**
  64013. * Defines the filename of the scene to load from
  64014. */
  64015. sceneFilename: string);
  64016. /**
  64017. * Execute the current task
  64018. * @param scene defines the scene where you want your assets to be loaded
  64019. * @param onSuccess is a callback called when the task is successfully executed
  64020. * @param onError is a callback called if an error occurs
  64021. */
  64022. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64023. }
  64024. /**
  64025. * Define a task used by AssetsManager to load text content
  64026. */
  64027. export class TextFileAssetTask extends AbstractAssetTask {
  64028. /**
  64029. * Defines the name of the task
  64030. */
  64031. name: string;
  64032. /**
  64033. * Defines the location of the file to load
  64034. */
  64035. url: string;
  64036. /**
  64037. * Gets the loaded text string
  64038. */
  64039. text: string;
  64040. /**
  64041. * Callback called when the task is successful
  64042. */
  64043. onSuccess: (task: TextFileAssetTask) => void;
  64044. /**
  64045. * Callback called when the task is successful
  64046. */
  64047. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  64048. /**
  64049. * Creates a new TextFileAssetTask object
  64050. * @param name defines the name of the task
  64051. * @param url defines the location of the file to load
  64052. */
  64053. constructor(
  64054. /**
  64055. * Defines the name of the task
  64056. */
  64057. name: string,
  64058. /**
  64059. * Defines the location of the file to load
  64060. */
  64061. url: string);
  64062. /**
  64063. * Execute the current task
  64064. * @param scene defines the scene where you want your assets to be loaded
  64065. * @param onSuccess is a callback called when the task is successfully executed
  64066. * @param onError is a callback called if an error occurs
  64067. */
  64068. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64069. }
  64070. /**
  64071. * Define a task used by AssetsManager to load binary data
  64072. */
  64073. export class BinaryFileAssetTask extends AbstractAssetTask {
  64074. /**
  64075. * Defines the name of the task
  64076. */
  64077. name: string;
  64078. /**
  64079. * Defines the location of the file to load
  64080. */
  64081. url: string;
  64082. /**
  64083. * Gets the lodaded data (as an array buffer)
  64084. */
  64085. data: ArrayBuffer;
  64086. /**
  64087. * Callback called when the task is successful
  64088. */
  64089. onSuccess: (task: BinaryFileAssetTask) => void;
  64090. /**
  64091. * Callback called when the task is successful
  64092. */
  64093. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  64094. /**
  64095. * Creates a new BinaryFileAssetTask object
  64096. * @param name defines the name of the new task
  64097. * @param url defines the location of the file to load
  64098. */
  64099. constructor(
  64100. /**
  64101. * Defines the name of the task
  64102. */
  64103. name: string,
  64104. /**
  64105. * Defines the location of the file to load
  64106. */
  64107. url: string);
  64108. /**
  64109. * Execute the current task
  64110. * @param scene defines the scene where you want your assets to be loaded
  64111. * @param onSuccess is a callback called when the task is successfully executed
  64112. * @param onError is a callback called if an error occurs
  64113. */
  64114. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64115. }
  64116. /**
  64117. * Define a task used by AssetsManager to load images
  64118. */
  64119. export class ImageAssetTask extends AbstractAssetTask {
  64120. /**
  64121. * Defines the name of the task
  64122. */
  64123. name: string;
  64124. /**
  64125. * Defines the location of the image to load
  64126. */
  64127. url: string;
  64128. /**
  64129. * Gets the loaded images
  64130. */
  64131. image: HTMLImageElement;
  64132. /**
  64133. * Callback called when the task is successful
  64134. */
  64135. onSuccess: (task: ImageAssetTask) => void;
  64136. /**
  64137. * Callback called when the task is successful
  64138. */
  64139. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  64140. /**
  64141. * Creates a new ImageAssetTask
  64142. * @param name defines the name of the task
  64143. * @param url defines the location of the image to load
  64144. */
  64145. constructor(
  64146. /**
  64147. * Defines the name of the task
  64148. */
  64149. name: string,
  64150. /**
  64151. * Defines the location of the image to load
  64152. */
  64153. url: string);
  64154. /**
  64155. * Execute the current task
  64156. * @param scene defines the scene where you want your assets to be loaded
  64157. * @param onSuccess is a callback called when the task is successfully executed
  64158. * @param onError is a callback called if an error occurs
  64159. */
  64160. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64161. }
  64162. /**
  64163. * Defines the interface used by texture loading tasks
  64164. */
  64165. export interface ITextureAssetTask<TEX extends BaseTexture> {
  64166. /**
  64167. * Gets the loaded texture
  64168. */
  64169. texture: TEX;
  64170. }
  64171. /**
  64172. * Define a task used by AssetsManager to load 2D textures
  64173. */
  64174. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  64175. /**
  64176. * Defines the name of the task
  64177. */
  64178. name: string;
  64179. /**
  64180. * Defines the location of the file to load
  64181. */
  64182. url: string;
  64183. /**
  64184. * Defines if mipmap should not be generated (default is false)
  64185. */
  64186. noMipmap?: boolean | undefined;
  64187. /**
  64188. * Defines if texture must be inverted on Y axis (default is false)
  64189. */
  64190. invertY?: boolean | undefined;
  64191. /**
  64192. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  64193. */
  64194. samplingMode: number;
  64195. /**
  64196. * Gets the loaded texture
  64197. */
  64198. texture: Texture;
  64199. /**
  64200. * Callback called when the task is successful
  64201. */
  64202. onSuccess: (task: TextureAssetTask) => void;
  64203. /**
  64204. * Callback called when the task is successful
  64205. */
  64206. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  64207. /**
  64208. * Creates a new TextureAssetTask object
  64209. * @param name defines the name of the task
  64210. * @param url defines the location of the file to load
  64211. * @param noMipmap defines if mipmap should not be generated (default is false)
  64212. * @param invertY defines if texture must be inverted on Y axis (default is false)
  64213. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  64214. */
  64215. constructor(
  64216. /**
  64217. * Defines the name of the task
  64218. */
  64219. name: string,
  64220. /**
  64221. * Defines the location of the file to load
  64222. */
  64223. url: string,
  64224. /**
  64225. * Defines if mipmap should not be generated (default is false)
  64226. */
  64227. noMipmap?: boolean | undefined,
  64228. /**
  64229. * Defines if texture must be inverted on Y axis (default is false)
  64230. */
  64231. invertY?: boolean | undefined,
  64232. /**
  64233. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  64234. */
  64235. samplingMode?: number);
  64236. /**
  64237. * Execute the current task
  64238. * @param scene defines the scene where you want your assets to be loaded
  64239. * @param onSuccess is a callback called when the task is successfully executed
  64240. * @param onError is a callback called if an error occurs
  64241. */
  64242. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64243. }
  64244. /**
  64245. * Define a task used by AssetsManager to load cube textures
  64246. */
  64247. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  64248. /**
  64249. * Defines the name of the task
  64250. */
  64251. name: string;
  64252. /**
  64253. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  64254. */
  64255. url: string;
  64256. /**
  64257. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  64258. */
  64259. extensions?: string[] | undefined;
  64260. /**
  64261. * Defines if mipmaps should not be generated (default is false)
  64262. */
  64263. noMipmap?: boolean | undefined;
  64264. /**
  64265. * Defines the explicit list of files (undefined by default)
  64266. */
  64267. files?: string[] | undefined;
  64268. /**
  64269. * Gets the loaded texture
  64270. */
  64271. texture: CubeTexture;
  64272. /**
  64273. * Callback called when the task is successful
  64274. */
  64275. onSuccess: (task: CubeTextureAssetTask) => void;
  64276. /**
  64277. * Callback called when the task is successful
  64278. */
  64279. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  64280. /**
  64281. * Creates a new CubeTextureAssetTask
  64282. * @param name defines the name of the task
  64283. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  64284. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  64285. * @param noMipmap defines if mipmaps should not be generated (default is false)
  64286. * @param files defines the explicit list of files (undefined by default)
  64287. */
  64288. constructor(
  64289. /**
  64290. * Defines the name of the task
  64291. */
  64292. name: string,
  64293. /**
  64294. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  64295. */
  64296. url: string,
  64297. /**
  64298. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  64299. */
  64300. extensions?: string[] | undefined,
  64301. /**
  64302. * Defines if mipmaps should not be generated (default is false)
  64303. */
  64304. noMipmap?: boolean | undefined,
  64305. /**
  64306. * Defines the explicit list of files (undefined by default)
  64307. */
  64308. files?: string[] | undefined);
  64309. /**
  64310. * Execute the current task
  64311. * @param scene defines the scene where you want your assets to be loaded
  64312. * @param onSuccess is a callback called when the task is successfully executed
  64313. * @param onError is a callback called if an error occurs
  64314. */
  64315. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64316. }
  64317. /**
  64318. * Define a task used by AssetsManager to load HDR cube textures
  64319. */
  64320. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  64321. /**
  64322. * Defines the name of the task
  64323. */
  64324. name: string;
  64325. /**
  64326. * Defines the location of the file to load
  64327. */
  64328. url: string;
  64329. /**
  64330. * Defines the desired size (the more it increases the longer the generation will be)
  64331. */
  64332. size: number;
  64333. /**
  64334. * Defines if mipmaps should not be generated (default is false)
  64335. */
  64336. noMipmap: boolean;
  64337. /**
  64338. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  64339. */
  64340. generateHarmonics: boolean;
  64341. /**
  64342. * 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)
  64343. */
  64344. gammaSpace: boolean;
  64345. /**
  64346. * Internal Use Only
  64347. */
  64348. reserved: boolean;
  64349. /**
  64350. * Gets the loaded texture
  64351. */
  64352. texture: HDRCubeTexture;
  64353. /**
  64354. * Callback called when the task is successful
  64355. */
  64356. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  64357. /**
  64358. * Callback called when the task is successful
  64359. */
  64360. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  64361. /**
  64362. * Creates a new HDRCubeTextureAssetTask object
  64363. * @param name defines the name of the task
  64364. * @param url defines the location of the file to load
  64365. * @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.
  64366. * @param noMipmap defines if mipmaps should not be generated (default is false)
  64367. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  64368. * @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)
  64369. * @param reserved Internal use only
  64370. */
  64371. constructor(
  64372. /**
  64373. * Defines the name of the task
  64374. */
  64375. name: string,
  64376. /**
  64377. * Defines the location of the file to load
  64378. */
  64379. url: string,
  64380. /**
  64381. * Defines the desired size (the more it increases the longer the generation will be)
  64382. */
  64383. size: number,
  64384. /**
  64385. * Defines if mipmaps should not be generated (default is false)
  64386. */
  64387. noMipmap?: boolean,
  64388. /**
  64389. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  64390. */
  64391. generateHarmonics?: boolean,
  64392. /**
  64393. * 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)
  64394. */
  64395. gammaSpace?: boolean,
  64396. /**
  64397. * Internal Use Only
  64398. */
  64399. reserved?: boolean);
  64400. /**
  64401. * Execute the current task
  64402. * @param scene defines the scene where you want your assets to be loaded
  64403. * @param onSuccess is a callback called when the task is successfully executed
  64404. * @param onError is a callback called if an error occurs
  64405. */
  64406. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64407. }
  64408. /**
  64409. * Define a task used by AssetsManager to load Equirectangular cube textures
  64410. */
  64411. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  64412. /**
  64413. * Defines the name of the task
  64414. */
  64415. name: string;
  64416. /**
  64417. * Defines the location of the file to load
  64418. */
  64419. url: string;
  64420. /**
  64421. * Defines the desired size (the more it increases the longer the generation will be)
  64422. */
  64423. size: number;
  64424. /**
  64425. * Defines if mipmaps should not be generated (default is false)
  64426. */
  64427. noMipmap: boolean;
  64428. /**
  64429. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  64430. * but the standard material would require them in Gamma space) (default is true)
  64431. */
  64432. gammaSpace: boolean;
  64433. /**
  64434. * Gets the loaded texture
  64435. */
  64436. texture: EquiRectangularCubeTexture;
  64437. /**
  64438. * Callback called when the task is successful
  64439. */
  64440. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  64441. /**
  64442. * Callback called when the task is successful
  64443. */
  64444. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  64445. /**
  64446. * Creates a new EquiRectangularCubeTextureAssetTask object
  64447. * @param name defines the name of the task
  64448. * @param url defines the location of the file to load
  64449. * @param size defines the desired size (the more it increases the longer the generation will be)
  64450. * If the size is omitted this implies you are using a preprocessed cubemap.
  64451. * @param noMipmap defines if mipmaps should not be generated (default is false)
  64452. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  64453. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  64454. * (default is true)
  64455. */
  64456. constructor(
  64457. /**
  64458. * Defines the name of the task
  64459. */
  64460. name: string,
  64461. /**
  64462. * Defines the location of the file to load
  64463. */
  64464. url: string,
  64465. /**
  64466. * Defines the desired size (the more it increases the longer the generation will be)
  64467. */
  64468. size: number,
  64469. /**
  64470. * Defines if mipmaps should not be generated (default is false)
  64471. */
  64472. noMipmap?: boolean,
  64473. /**
  64474. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  64475. * but the standard material would require them in Gamma space) (default is true)
  64476. */
  64477. gammaSpace?: boolean);
  64478. /**
  64479. * Execute the current task
  64480. * @param scene defines the scene where you want your assets to be loaded
  64481. * @param onSuccess is a callback called when the task is successfully executed
  64482. * @param onError is a callback called if an error occurs
  64483. */
  64484. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  64485. }
  64486. /**
  64487. * This class can be used to easily import assets into a scene
  64488. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  64489. */
  64490. export class AssetsManager {
  64491. private _scene;
  64492. private _isLoading;
  64493. protected _tasks: AbstractAssetTask[];
  64494. protected _waitingTasksCount: number;
  64495. protected _totalTasksCount: number;
  64496. /**
  64497. * Callback called when all tasks are processed
  64498. */
  64499. onFinish: (tasks: AbstractAssetTask[]) => void;
  64500. /**
  64501. * Callback called when a task is successful
  64502. */
  64503. onTaskSuccess: (task: AbstractAssetTask) => void;
  64504. /**
  64505. * Callback called when a task had an error
  64506. */
  64507. onTaskError: (task: AbstractAssetTask) => void;
  64508. /**
  64509. * Callback called when a task is done (whatever the result is)
  64510. */
  64511. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  64512. /**
  64513. * Observable called when all tasks are processed
  64514. */
  64515. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  64516. /**
  64517. * Observable called when a task had an error
  64518. */
  64519. onTaskErrorObservable: Observable<AbstractAssetTask>;
  64520. /**
  64521. * Observable called when all tasks were executed
  64522. */
  64523. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  64524. /**
  64525. * Observable called when a task is done (whatever the result is)
  64526. */
  64527. onProgressObservable: Observable<IAssetsProgressEvent>;
  64528. /**
  64529. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  64530. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  64531. */
  64532. useDefaultLoadingScreen: boolean;
  64533. /**
  64534. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  64535. * when all assets have been downloaded.
  64536. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  64537. */
  64538. autoHideLoadingUI: boolean;
  64539. /**
  64540. * Creates a new AssetsManager
  64541. * @param scene defines the scene to work on
  64542. */
  64543. constructor(scene: Scene);
  64544. /**
  64545. * Add a MeshAssetTask to the list of active tasks
  64546. * @param taskName defines the name of the new task
  64547. * @param meshesNames defines the name of meshes to load
  64548. * @param rootUrl defines the root url to use to locate files
  64549. * @param sceneFilename defines the filename of the scene file
  64550. * @returns a new MeshAssetTask object
  64551. */
  64552. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  64553. /**
  64554. * Add a TextFileAssetTask to the list of active tasks
  64555. * @param taskName defines the name of the new task
  64556. * @param url defines the url of the file to load
  64557. * @returns a new TextFileAssetTask object
  64558. */
  64559. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  64560. /**
  64561. * Add a BinaryFileAssetTask to the list of active tasks
  64562. * @param taskName defines the name of the new task
  64563. * @param url defines the url of the file to load
  64564. * @returns a new BinaryFileAssetTask object
  64565. */
  64566. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  64567. /**
  64568. * Add a ImageAssetTask to the list of active tasks
  64569. * @param taskName defines the name of the new task
  64570. * @param url defines the url of the file to load
  64571. * @returns a new ImageAssetTask object
  64572. */
  64573. addImageTask(taskName: string, url: string): ImageAssetTask;
  64574. /**
  64575. * Add a TextureAssetTask to the list of active tasks
  64576. * @param taskName defines the name of the new task
  64577. * @param url defines the url of the file to load
  64578. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  64579. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  64580. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64581. * @returns a new TextureAssetTask object
  64582. */
  64583. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  64584. /**
  64585. * Add a CubeTextureAssetTask to the list of active tasks
  64586. * @param taskName defines the name of the new task
  64587. * @param url defines the url of the file to load
  64588. * @param extensions defines the extension to use to load the cube map (can be null)
  64589. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  64590. * @param files defines the list of files to load (can be null)
  64591. * @returns a new CubeTextureAssetTask object
  64592. */
  64593. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  64594. /**
  64595. *
  64596. * Add a HDRCubeTextureAssetTask to the list of active tasks
  64597. * @param taskName defines the name of the new task
  64598. * @param url defines the url of the file to load
  64599. * @param size defines the size you want for the cubemap (can be null)
  64600. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  64601. * @param generateHarmonics defines if you want to automatically generate (true by default)
  64602. * @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)
  64603. * @param reserved Internal use only
  64604. * @returns a new HDRCubeTextureAssetTask object
  64605. */
  64606. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  64607. /**
  64608. *
  64609. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  64610. * @param taskName defines the name of the new task
  64611. * @param url defines the url of the file to load
  64612. * @param size defines the size you want for the cubemap (can be null)
  64613. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  64614. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64615. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64616. * @returns a new EquiRectangularCubeTextureAssetTask object
  64617. */
  64618. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  64619. /**
  64620. * Remove a task from the assets manager.
  64621. * @param task the task to remove
  64622. */
  64623. removeTask(task: AbstractAssetTask): void;
  64624. private _decreaseWaitingTasksCount;
  64625. private _runTask;
  64626. /**
  64627. * Reset the AssetsManager and remove all tasks
  64628. * @return the current instance of the AssetsManager
  64629. */
  64630. reset(): AssetsManager;
  64631. /**
  64632. * Start the loading process
  64633. * @return the current instance of the AssetsManager
  64634. */
  64635. load(): AssetsManager;
  64636. /**
  64637. * Start the loading process as an async operation
  64638. * @return a promise returning the list of failed tasks
  64639. */
  64640. loadAsync(): Promise<void>;
  64641. }
  64642. }
  64643. declare module "babylonjs/Misc/deferred" {
  64644. /**
  64645. * Wrapper class for promise with external resolve and reject.
  64646. */
  64647. export class Deferred<T> {
  64648. /**
  64649. * The promise associated with this deferred object.
  64650. */
  64651. readonly promise: Promise<T>;
  64652. private _resolve;
  64653. private _reject;
  64654. /**
  64655. * The resolve method of the promise associated with this deferred object.
  64656. */
  64657. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  64658. /**
  64659. * The reject method of the promise associated with this deferred object.
  64660. */
  64661. readonly reject: (reason?: any) => void;
  64662. /**
  64663. * Constructor for this deferred object.
  64664. */
  64665. constructor();
  64666. }
  64667. }
  64668. declare module "babylonjs/Misc/meshExploder" {
  64669. import { Mesh } from "babylonjs/Meshes/mesh";
  64670. /**
  64671. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  64672. */
  64673. export class MeshExploder {
  64674. private _centerMesh;
  64675. private _meshes;
  64676. private _meshesOrigins;
  64677. private _toCenterVectors;
  64678. private _scaledDirection;
  64679. private _newPosition;
  64680. private _centerPosition;
  64681. /**
  64682. * Explodes meshes from a center mesh.
  64683. * @param meshes The meshes to explode.
  64684. * @param centerMesh The mesh to be center of explosion.
  64685. */
  64686. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  64687. private _setCenterMesh;
  64688. /**
  64689. * Get class name
  64690. * @returns "MeshExploder"
  64691. */
  64692. getClassName(): string;
  64693. /**
  64694. * "Exploded meshes"
  64695. * @returns Array of meshes with the centerMesh at index 0.
  64696. */
  64697. getMeshes(): Array<Mesh>;
  64698. /**
  64699. * Explodes meshes giving a specific direction
  64700. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  64701. */
  64702. explode(direction?: number): void;
  64703. }
  64704. }
  64705. declare module "babylonjs/Misc/filesInput" {
  64706. import { Engine } from "babylonjs/Engines/engine";
  64707. import { Scene } from "babylonjs/scene";
  64708. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  64709. /**
  64710. * Class used to help managing file picking and drag'n'drop
  64711. */
  64712. export class FilesInput {
  64713. /**
  64714. * List of files ready to be loaded
  64715. */
  64716. static readonly FilesToLoad: {
  64717. [key: string]: File;
  64718. };
  64719. /**
  64720. * Callback called when a file is processed
  64721. */
  64722. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  64723. private _engine;
  64724. private _currentScene;
  64725. private _sceneLoadedCallback;
  64726. private _progressCallback;
  64727. private _additionalRenderLoopLogicCallback;
  64728. private _textureLoadingCallback;
  64729. private _startingProcessingFilesCallback;
  64730. private _onReloadCallback;
  64731. private _errorCallback;
  64732. private _elementToMonitor;
  64733. private _sceneFileToLoad;
  64734. private _filesToLoad;
  64735. /**
  64736. * Creates a new FilesInput
  64737. * @param engine defines the rendering engine
  64738. * @param scene defines the hosting scene
  64739. * @param sceneLoadedCallback callback called when scene is loaded
  64740. * @param progressCallback callback called to track progress
  64741. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  64742. * @param textureLoadingCallback callback called when a texture is loading
  64743. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  64744. * @param onReloadCallback callback called when a reload is requested
  64745. * @param errorCallback callback call if an error occurs
  64746. */
  64747. 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);
  64748. private _dragEnterHandler;
  64749. private _dragOverHandler;
  64750. private _dropHandler;
  64751. /**
  64752. * Calls this function to listen to drag'n'drop events on a specific DOM element
  64753. * @param elementToMonitor defines the DOM element to track
  64754. */
  64755. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  64756. /**
  64757. * Release all associated resources
  64758. */
  64759. dispose(): void;
  64760. private renderFunction;
  64761. private drag;
  64762. private drop;
  64763. private _traverseFolder;
  64764. private _processFiles;
  64765. /**
  64766. * Load files from a drop event
  64767. * @param event defines the drop event to use as source
  64768. */
  64769. loadFiles(event: any): void;
  64770. private _processReload;
  64771. /**
  64772. * Reload the current scene from the loaded files
  64773. */
  64774. reload(): void;
  64775. }
  64776. }
  64777. declare module "babylonjs/Misc/HighDynamicRange/index" {
  64778. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  64779. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  64780. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  64781. }
  64782. declare module "babylonjs/Misc/sceneOptimizer" {
  64783. import { Scene, IDisposable } from "babylonjs/scene";
  64784. import { Observable } from "babylonjs/Misc/observable";
  64785. /**
  64786. * Defines the root class used to create scene optimization to use with SceneOptimizer
  64787. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64788. */
  64789. export class SceneOptimization {
  64790. /**
  64791. * Defines the priority of this optimization (0 by default which means first in the list)
  64792. */
  64793. priority: number;
  64794. /**
  64795. * Gets a string describing the action executed by the current optimization
  64796. * @returns description string
  64797. */
  64798. getDescription(): string;
  64799. /**
  64800. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64801. * @param scene defines the current scene where to apply this optimization
  64802. * @param optimizer defines the current optimizer
  64803. * @returns true if everything that can be done was applied
  64804. */
  64805. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64806. /**
  64807. * Creates the SceneOptimization object
  64808. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  64809. * @param desc defines the description associated with the optimization
  64810. */
  64811. constructor(
  64812. /**
  64813. * Defines the priority of this optimization (0 by default which means first in the list)
  64814. */
  64815. priority?: number);
  64816. }
  64817. /**
  64818. * Defines an optimization used to reduce the size of render target textures
  64819. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64820. */
  64821. export class TextureOptimization extends SceneOptimization {
  64822. /**
  64823. * Defines the priority of this optimization (0 by default which means first in the list)
  64824. */
  64825. priority: number;
  64826. /**
  64827. * 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
  64828. */
  64829. maximumSize: number;
  64830. /**
  64831. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  64832. */
  64833. step: number;
  64834. /**
  64835. * Gets a string describing the action executed by the current optimization
  64836. * @returns description string
  64837. */
  64838. getDescription(): string;
  64839. /**
  64840. * Creates the TextureOptimization object
  64841. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  64842. * @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
  64843. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  64844. */
  64845. constructor(
  64846. /**
  64847. * Defines the priority of this optimization (0 by default which means first in the list)
  64848. */
  64849. priority?: number,
  64850. /**
  64851. * 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
  64852. */
  64853. maximumSize?: number,
  64854. /**
  64855. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  64856. */
  64857. step?: number);
  64858. /**
  64859. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64860. * @param scene defines the current scene where to apply this optimization
  64861. * @param optimizer defines the current optimizer
  64862. * @returns true if everything that can be done was applied
  64863. */
  64864. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64865. }
  64866. /**
  64867. * Defines an optimization used to increase or decrease the rendering resolution
  64868. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64869. */
  64870. export class HardwareScalingOptimization extends SceneOptimization {
  64871. /**
  64872. * Defines the priority of this optimization (0 by default which means first in the list)
  64873. */
  64874. priority: number;
  64875. /**
  64876. * Defines the maximum scale to use (2 by default)
  64877. */
  64878. maximumScale: number;
  64879. /**
  64880. * Defines the step to use between two passes (0.5 by default)
  64881. */
  64882. step: number;
  64883. private _currentScale;
  64884. private _directionOffset;
  64885. /**
  64886. * Gets a string describing the action executed by the current optimization
  64887. * @return description string
  64888. */
  64889. getDescription(): string;
  64890. /**
  64891. * Creates the HardwareScalingOptimization object
  64892. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  64893. * @param maximumScale defines the maximum scale to use (2 by default)
  64894. * @param step defines the step to use between two passes (0.5 by default)
  64895. */
  64896. constructor(
  64897. /**
  64898. * Defines the priority of this optimization (0 by default which means first in the list)
  64899. */
  64900. priority?: number,
  64901. /**
  64902. * Defines the maximum scale to use (2 by default)
  64903. */
  64904. maximumScale?: number,
  64905. /**
  64906. * Defines the step to use between two passes (0.5 by default)
  64907. */
  64908. step?: number);
  64909. /**
  64910. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64911. * @param scene defines the current scene where to apply this optimization
  64912. * @param optimizer defines the current optimizer
  64913. * @returns true if everything that can be done was applied
  64914. */
  64915. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64916. }
  64917. /**
  64918. * Defines an optimization used to remove shadows
  64919. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64920. */
  64921. export class ShadowsOptimization extends SceneOptimization {
  64922. /**
  64923. * Gets a string describing the action executed by the current optimization
  64924. * @return description string
  64925. */
  64926. getDescription(): string;
  64927. /**
  64928. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64929. * @param scene defines the current scene where to apply this optimization
  64930. * @param optimizer defines the current optimizer
  64931. * @returns true if everything that can be done was applied
  64932. */
  64933. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64934. }
  64935. /**
  64936. * Defines an optimization used to turn post-processes off
  64937. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64938. */
  64939. export class PostProcessesOptimization extends SceneOptimization {
  64940. /**
  64941. * Gets a string describing the action executed by the current optimization
  64942. * @return description string
  64943. */
  64944. getDescription(): string;
  64945. /**
  64946. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64947. * @param scene defines the current scene where to apply this optimization
  64948. * @param optimizer defines the current optimizer
  64949. * @returns true if everything that can be done was applied
  64950. */
  64951. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64952. }
  64953. /**
  64954. * Defines an optimization used to turn lens flares off
  64955. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64956. */
  64957. export class LensFlaresOptimization extends SceneOptimization {
  64958. /**
  64959. * Gets a string describing the action executed by the current optimization
  64960. * @return description string
  64961. */
  64962. getDescription(): string;
  64963. /**
  64964. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64965. * @param scene defines the current scene where to apply this optimization
  64966. * @param optimizer defines the current optimizer
  64967. * @returns true if everything that can be done was applied
  64968. */
  64969. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64970. }
  64971. /**
  64972. * Defines an optimization based on user defined callback.
  64973. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  64974. */
  64975. export class CustomOptimization extends SceneOptimization {
  64976. /**
  64977. * Callback called to apply the custom optimization.
  64978. */
  64979. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  64980. /**
  64981. * Callback called to get custom description
  64982. */
  64983. onGetDescription: () => string;
  64984. /**
  64985. * Gets a string describing the action executed by the current optimization
  64986. * @returns description string
  64987. */
  64988. getDescription(): string;
  64989. /**
  64990. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  64991. * @param scene defines the current scene where to apply this optimization
  64992. * @param optimizer defines the current optimizer
  64993. * @returns true if everything that can be done was applied
  64994. */
  64995. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  64996. }
  64997. /**
  64998. * Defines an optimization used to turn particles off
  64999. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  65000. */
  65001. export class ParticlesOptimization extends SceneOptimization {
  65002. /**
  65003. * Gets a string describing the action executed by the current optimization
  65004. * @return description string
  65005. */
  65006. getDescription(): string;
  65007. /**
  65008. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  65009. * @param scene defines the current scene where to apply this optimization
  65010. * @param optimizer defines the current optimizer
  65011. * @returns true if everything that can be done was applied
  65012. */
  65013. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  65014. }
  65015. /**
  65016. * Defines an optimization used to turn render targets off
  65017. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  65018. */
  65019. export class RenderTargetsOptimization extends SceneOptimization {
  65020. /**
  65021. * Gets a string describing the action executed by the current optimization
  65022. * @return description string
  65023. */
  65024. getDescription(): string;
  65025. /**
  65026. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  65027. * @param scene defines the current scene where to apply this optimization
  65028. * @param optimizer defines the current optimizer
  65029. * @returns true if everything that can be done was applied
  65030. */
  65031. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  65032. }
  65033. /**
  65034. * Defines an optimization used to merge meshes with compatible materials
  65035. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  65036. */
  65037. export class MergeMeshesOptimization extends SceneOptimization {
  65038. private static _UpdateSelectionTree;
  65039. /**
  65040. * Gets or sets a boolean which defines if optimization octree has to be updated
  65041. */
  65042. /**
  65043. * Gets or sets a boolean which defines if optimization octree has to be updated
  65044. */
  65045. static UpdateSelectionTree: boolean;
  65046. /**
  65047. * Gets a string describing the action executed by the current optimization
  65048. * @return description string
  65049. */
  65050. getDescription(): string;
  65051. private _canBeMerged;
  65052. /**
  65053. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  65054. * @param scene defines the current scene where to apply this optimization
  65055. * @param optimizer defines the current optimizer
  65056. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  65057. * @returns true if everything that can be done was applied
  65058. */
  65059. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  65060. }
  65061. /**
  65062. * Defines a list of options used by SceneOptimizer
  65063. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  65064. */
  65065. export class SceneOptimizerOptions {
  65066. /**
  65067. * Defines the target frame rate to reach (60 by default)
  65068. */
  65069. targetFrameRate: number;
  65070. /**
  65071. * Defines the interval between two checkes (2000ms by default)
  65072. */
  65073. trackerDuration: number;
  65074. /**
  65075. * Gets the list of optimizations to apply
  65076. */
  65077. optimizations: SceneOptimization[];
  65078. /**
  65079. * Creates a new list of options used by SceneOptimizer
  65080. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  65081. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  65082. */
  65083. constructor(
  65084. /**
  65085. * Defines the target frame rate to reach (60 by default)
  65086. */
  65087. targetFrameRate?: number,
  65088. /**
  65089. * Defines the interval between two checkes (2000ms by default)
  65090. */
  65091. trackerDuration?: number);
  65092. /**
  65093. * Add a new optimization
  65094. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  65095. * @returns the current SceneOptimizerOptions
  65096. */
  65097. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  65098. /**
  65099. * Add a new custom optimization
  65100. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  65101. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  65102. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  65103. * @returns the current SceneOptimizerOptions
  65104. */
  65105. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  65106. /**
  65107. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  65108. * @param targetFrameRate defines the target frame rate (60 by default)
  65109. * @returns a SceneOptimizerOptions object
  65110. */
  65111. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  65112. /**
  65113. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  65114. * @param targetFrameRate defines the target frame rate (60 by default)
  65115. * @returns a SceneOptimizerOptions object
  65116. */
  65117. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  65118. /**
  65119. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  65120. * @param targetFrameRate defines the target frame rate (60 by default)
  65121. * @returns a SceneOptimizerOptions object
  65122. */
  65123. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  65124. }
  65125. /**
  65126. * Class used to run optimizations in order to reach a target frame rate
  65127. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  65128. */
  65129. export class SceneOptimizer implements IDisposable {
  65130. private _isRunning;
  65131. private _options;
  65132. private _scene;
  65133. private _currentPriorityLevel;
  65134. private _targetFrameRate;
  65135. private _trackerDuration;
  65136. private _currentFrameRate;
  65137. private _sceneDisposeObserver;
  65138. private _improvementMode;
  65139. /**
  65140. * Defines an observable called when the optimizer reaches the target frame rate
  65141. */
  65142. onSuccessObservable: Observable<SceneOptimizer>;
  65143. /**
  65144. * Defines an observable called when the optimizer enables an optimization
  65145. */
  65146. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  65147. /**
  65148. * Defines an observable called when the optimizer is not able to reach the target frame rate
  65149. */
  65150. onFailureObservable: Observable<SceneOptimizer>;
  65151. /**
  65152. * Gets a boolean indicating if the optimizer is in improvement mode
  65153. */
  65154. readonly isInImprovementMode: boolean;
  65155. /**
  65156. * Gets the current priority level (0 at start)
  65157. */
  65158. readonly currentPriorityLevel: number;
  65159. /**
  65160. * Gets the current frame rate checked by the SceneOptimizer
  65161. */
  65162. readonly currentFrameRate: number;
  65163. /**
  65164. * Gets or sets the current target frame rate (60 by default)
  65165. */
  65166. /**
  65167. * Gets or sets the current target frame rate (60 by default)
  65168. */
  65169. targetFrameRate: number;
  65170. /**
  65171. * Gets or sets the current interval between two checks (every 2000ms by default)
  65172. */
  65173. /**
  65174. * Gets or sets the current interval between two checks (every 2000ms by default)
  65175. */
  65176. trackerDuration: number;
  65177. /**
  65178. * Gets the list of active optimizations
  65179. */
  65180. readonly optimizations: SceneOptimization[];
  65181. /**
  65182. * Creates a new SceneOptimizer
  65183. * @param scene defines the scene to work on
  65184. * @param options defines the options to use with the SceneOptimizer
  65185. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  65186. * @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)
  65187. */
  65188. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  65189. /**
  65190. * Stops the current optimizer
  65191. */
  65192. stop(): void;
  65193. /**
  65194. * Reset the optimizer to initial step (current priority level = 0)
  65195. */
  65196. reset(): void;
  65197. /**
  65198. * Start the optimizer. By default it will try to reach a specific framerate
  65199. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  65200. */
  65201. start(): void;
  65202. private _checkCurrentState;
  65203. /**
  65204. * Release all resources
  65205. */
  65206. dispose(): void;
  65207. /**
  65208. * Helper function to create a SceneOptimizer with one single line of code
  65209. * @param scene defines the scene to work on
  65210. * @param options defines the options to use with the SceneOptimizer
  65211. * @param onSuccess defines a callback to call on success
  65212. * @param onFailure defines a callback to call on failure
  65213. * @returns the new SceneOptimizer object
  65214. */
  65215. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  65216. }
  65217. }
  65218. declare module "babylonjs/Misc/sceneSerializer" {
  65219. import { Scene } from "babylonjs/scene";
  65220. /**
  65221. * Class used to serialize a scene into a string
  65222. */
  65223. export class SceneSerializer {
  65224. /**
  65225. * Clear cache used by a previous serialization
  65226. */
  65227. static ClearCache(): void;
  65228. /**
  65229. * Serialize a scene into a JSON compatible object
  65230. * @param scene defines the scene to serialize
  65231. * @returns a JSON compatible object
  65232. */
  65233. static Serialize(scene: Scene): any;
  65234. /**
  65235. * Serialize a mesh into a JSON compatible object
  65236. * @param toSerialize defines the mesh to serialize
  65237. * @param withParents defines if parents must be serialized as well
  65238. * @param withChildren defines if children must be serialized as well
  65239. * @returns a JSON compatible object
  65240. */
  65241. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  65242. }
  65243. }
  65244. declare module "babylonjs/Misc/textureTools" {
  65245. import { Texture } from "babylonjs/Materials/Textures/texture";
  65246. /**
  65247. * Class used to host texture specific utilities
  65248. */
  65249. export class TextureTools {
  65250. /**
  65251. * Uses the GPU to create a copy texture rescaled at a given size
  65252. * @param texture Texture to copy from
  65253. * @param width defines the desired width
  65254. * @param height defines the desired height
  65255. * @param useBilinearMode defines if bilinear mode has to be used
  65256. * @return the generated texture
  65257. */
  65258. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  65259. }
  65260. }
  65261. declare module "babylonjs/Misc/videoRecorder" {
  65262. import { Nullable } from "babylonjs/types";
  65263. import { Engine } from "babylonjs/Engines/engine";
  65264. /**
  65265. * This represents the different options available for the video capture.
  65266. */
  65267. export interface VideoRecorderOptions {
  65268. /** Defines the mime type of the video. */
  65269. mimeType: string;
  65270. /** Defines the FPS the video should be recorded at. */
  65271. fps: number;
  65272. /** Defines the chunk size for the recording data. */
  65273. recordChunckSize: number;
  65274. /** The audio tracks to attach to the recording. */
  65275. audioTracks?: MediaStreamTrack[];
  65276. }
  65277. /**
  65278. * This can help with recording videos from BabylonJS.
  65279. * This is based on the available WebRTC functionalities of the browser.
  65280. *
  65281. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  65282. */
  65283. export class VideoRecorder {
  65284. private static readonly _defaultOptions;
  65285. /**
  65286. * Returns whether or not the VideoRecorder is available in your browser.
  65287. * @param engine Defines the Babylon Engine.
  65288. * @returns true if supported otherwise false.
  65289. */
  65290. static IsSupported(engine: Engine): boolean;
  65291. private readonly _options;
  65292. private _canvas;
  65293. private _mediaRecorder;
  65294. private _recordedChunks;
  65295. private _fileName;
  65296. private _resolve;
  65297. private _reject;
  65298. /**
  65299. * True when a recording is already in progress.
  65300. */
  65301. readonly isRecording: boolean;
  65302. /**
  65303. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  65304. * @param engine Defines the BabylonJS Engine you wish to record.
  65305. * @param options Defines options that can be used to customize the capture.
  65306. */
  65307. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  65308. /**
  65309. * Stops the current recording before the default capture timeout passed in the startRecording function.
  65310. */
  65311. stopRecording(): void;
  65312. /**
  65313. * Starts recording the canvas for a max duration specified in parameters.
  65314. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  65315. * If null no automatic download will start and you can rely on the promise to get the data back.
  65316. * @param maxDuration Defines the maximum recording time in seconds.
  65317. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  65318. * @return A promise callback at the end of the recording with the video data in Blob.
  65319. */
  65320. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  65321. /**
  65322. * Releases internal resources used during the recording.
  65323. */
  65324. dispose(): void;
  65325. private _handleDataAvailable;
  65326. private _handleError;
  65327. private _handleStop;
  65328. }
  65329. }
  65330. declare module "babylonjs/Misc/screenshotTools" {
  65331. import { Camera } from "babylonjs/Cameras/camera";
  65332. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  65333. import { Engine } from "babylonjs/Engines/engine";
  65334. /**
  65335. * Class containing a set of static utilities functions for screenshots
  65336. */
  65337. export class ScreenshotTools {
  65338. /**
  65339. * Captures a screenshot of the current rendering
  65340. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  65341. * @param engine defines the rendering engine
  65342. * @param camera defines the source camera
  65343. * @param size This parameter can be set to a single number or to an object with the
  65344. * following (optional) properties: precision, width, height. If a single number is passed,
  65345. * it will be used for both width and height. If an object is passed, the screenshot size
  65346. * will be derived from the parameters. The precision property is a multiplier allowing
  65347. * rendering at a higher or lower resolution
  65348. * @param successCallback defines the callback receives a single parameter which contains the
  65349. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  65350. * src parameter of an <img> to display it
  65351. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  65352. * Check your browser for supported MIME types
  65353. */
  65354. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  65355. /**
  65356. * Captures a screenshot of the current rendering
  65357. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  65358. * @param engine defines the rendering engine
  65359. * @param camera defines the source camera
  65360. * @param size This parameter can be set to a single number or to an object with the
  65361. * following (optional) properties: precision, width, height. If a single number is passed,
  65362. * it will be used for both width and height. If an object is passed, the screenshot size
  65363. * will be derived from the parameters. The precision property is a multiplier allowing
  65364. * rendering at a higher or lower resolution
  65365. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  65366. * Check your browser for supported MIME types
  65367. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  65368. * to the src parameter of an <img> to display it
  65369. */
  65370. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  65371. /**
  65372. * Generates an image screenshot from the specified camera.
  65373. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  65374. * @param engine The engine to use for rendering
  65375. * @param camera The camera to use for rendering
  65376. * @param size This parameter can be set to a single number or to an object with the
  65377. * following (optional) properties: precision, width, height. If a single number is passed,
  65378. * it will be used for both width and height. If an object is passed, the screenshot size
  65379. * will be derived from the parameters. The precision property is a multiplier allowing
  65380. * rendering at a higher or lower resolution
  65381. * @param successCallback The callback receives a single parameter which contains the
  65382. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  65383. * src parameter of an <img> to display it
  65384. * @param mimeType The MIME type of the screenshot image (default: image/png).
  65385. * Check your browser for supported MIME types
  65386. * @param samples Texture samples (default: 1)
  65387. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  65388. * @param fileName A name for for the downloaded file.
  65389. */
  65390. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  65391. /**
  65392. * Generates an image screenshot from the specified camera.
  65393. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  65394. * @param engine The engine to use for rendering
  65395. * @param camera The camera to use for rendering
  65396. * @param size This parameter can be set to a single number or to an object with the
  65397. * following (optional) properties: precision, width, height. If a single number is passed,
  65398. * it will be used for both width and height. If an object is passed, the screenshot size
  65399. * will be derived from the parameters. The precision property is a multiplier allowing
  65400. * rendering at a higher or lower resolution
  65401. * @param mimeType The MIME type of the screenshot image (default: image/png).
  65402. * Check your browser for supported MIME types
  65403. * @param samples Texture samples (default: 1)
  65404. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  65405. * @param fileName A name for for the downloaded file.
  65406. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  65407. * to the src parameter of an <img> to display it
  65408. */
  65409. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  65410. /**
  65411. * Gets height and width for screenshot size
  65412. * @private
  65413. */
  65414. private static _getScreenshotSize;
  65415. }
  65416. }
  65417. declare module "babylonjs/Misc/index" {
  65418. export * from "babylonjs/Misc/andOrNotEvaluator";
  65419. export * from "babylonjs/Misc/assetsManager";
  65420. export * from "babylonjs/Misc/dds";
  65421. export * from "babylonjs/Misc/decorators";
  65422. export * from "babylonjs/Misc/deferred";
  65423. export * from "babylonjs/Misc/environmentTextureTools";
  65424. export * from "babylonjs/Misc/meshExploder";
  65425. export * from "babylonjs/Misc/filesInput";
  65426. export * from "babylonjs/Misc/HighDynamicRange/index";
  65427. export * from "babylonjs/Misc/khronosTextureContainer";
  65428. export * from "babylonjs/Misc/observable";
  65429. export * from "babylonjs/Misc/performanceMonitor";
  65430. export * from "babylonjs/Misc/promise";
  65431. export * from "babylonjs/Misc/sceneOptimizer";
  65432. export * from "babylonjs/Misc/sceneSerializer";
  65433. export * from "babylonjs/Misc/smartArray";
  65434. export * from "babylonjs/Misc/stringDictionary";
  65435. export * from "babylonjs/Misc/tags";
  65436. export * from "babylonjs/Misc/textureTools";
  65437. export * from "babylonjs/Misc/tga";
  65438. export * from "babylonjs/Misc/tools";
  65439. export * from "babylonjs/Misc/videoRecorder";
  65440. export * from "babylonjs/Misc/virtualJoystick";
  65441. export * from "babylonjs/Misc/workerPool";
  65442. export * from "babylonjs/Misc/logger";
  65443. export * from "babylonjs/Misc/typeStore";
  65444. export * from "babylonjs/Misc/filesInputStore";
  65445. export * from "babylonjs/Misc/deepCopier";
  65446. export * from "babylonjs/Misc/pivotTools";
  65447. export * from "babylonjs/Misc/precisionDate";
  65448. export * from "babylonjs/Misc/screenshotTools";
  65449. export * from "babylonjs/Misc/typeStore";
  65450. export * from "babylonjs/Misc/webRequest";
  65451. export * from "babylonjs/Misc/iInspectable";
  65452. export * from "babylonjs/Misc/brdfTextureTools";
  65453. export * from "babylonjs/Misc/rgbdTextureTools";
  65454. export * from "babylonjs/Misc/gradients";
  65455. export * from "babylonjs/Misc/perfCounter";
  65456. export * from "babylonjs/Misc/fileRequest";
  65457. export * from "babylonjs/Misc/customAnimationFrameRequester";
  65458. export * from "babylonjs/Misc/retryStrategy";
  65459. export * from "babylonjs/Misc/loadFileError";
  65460. }
  65461. declare module "babylonjs/index" {
  65462. export * from "babylonjs/abstractScene";
  65463. export * from "babylonjs/Actions/index";
  65464. export * from "babylonjs/Animations/index";
  65465. export * from "babylonjs/assetContainer";
  65466. export * from "babylonjs/Audio/index";
  65467. export * from "babylonjs/Behaviors/index";
  65468. export * from "babylonjs/Bones/index";
  65469. export * from "babylonjs/Cameras/index";
  65470. export * from "babylonjs/Collisions/index";
  65471. export * from "babylonjs/Culling/index";
  65472. export * from "babylonjs/Debug/index";
  65473. export * from "babylonjs/Engines/index";
  65474. export * from "babylonjs/Events/index";
  65475. export * from "babylonjs/Gamepads/index";
  65476. export * from "babylonjs/Gizmos/index";
  65477. export * from "babylonjs/Helpers/index";
  65478. export * from "babylonjs/Instrumentation/index";
  65479. export * from "babylonjs/Layers/index";
  65480. export * from "babylonjs/LensFlares/index";
  65481. export * from "babylonjs/Lights/index";
  65482. export * from "babylonjs/Loading/index";
  65483. export * from "babylonjs/Materials/index";
  65484. export * from "babylonjs/Maths/index";
  65485. export * from "babylonjs/Meshes/index";
  65486. export * from "babylonjs/Morph/index";
  65487. export * from "babylonjs/Navigation/index";
  65488. export * from "babylonjs/node";
  65489. export * from "babylonjs/Offline/index";
  65490. export * from "babylonjs/Particles/index";
  65491. export * from "babylonjs/Physics/index";
  65492. export * from "babylonjs/PostProcesses/index";
  65493. export * from "babylonjs/Probes/index";
  65494. export * from "babylonjs/Rendering/index";
  65495. export * from "babylonjs/scene";
  65496. export * from "babylonjs/sceneComponent";
  65497. export * from "babylonjs/Sprites/index";
  65498. export * from "babylonjs/States/index";
  65499. export * from "babylonjs/Misc/index";
  65500. export * from "babylonjs/types";
  65501. }
  65502. declare module "babylonjs/Animations/pathCursor" {
  65503. import { Vector3 } from "babylonjs/Maths/math.vector";
  65504. import { Path2 } from "babylonjs/Maths/math.path";
  65505. /**
  65506. * A cursor which tracks a point on a path
  65507. */
  65508. export class PathCursor {
  65509. private path;
  65510. /**
  65511. * Stores path cursor callbacks for when an onchange event is triggered
  65512. */
  65513. private _onchange;
  65514. /**
  65515. * The value of the path cursor
  65516. */
  65517. value: number;
  65518. /**
  65519. * The animation array of the path cursor
  65520. */
  65521. animations: Animation[];
  65522. /**
  65523. * Initializes the path cursor
  65524. * @param path The path to track
  65525. */
  65526. constructor(path: Path2);
  65527. /**
  65528. * Gets the cursor point on the path
  65529. * @returns A point on the path cursor at the cursor location
  65530. */
  65531. getPoint(): Vector3;
  65532. /**
  65533. * Moves the cursor ahead by the step amount
  65534. * @param step The amount to move the cursor forward
  65535. * @returns This path cursor
  65536. */
  65537. moveAhead(step?: number): PathCursor;
  65538. /**
  65539. * Moves the cursor behind by the step amount
  65540. * @param step The amount to move the cursor back
  65541. * @returns This path cursor
  65542. */
  65543. moveBack(step?: number): PathCursor;
  65544. /**
  65545. * Moves the cursor by the step amount
  65546. * If the step amount is greater than one, an exception is thrown
  65547. * @param step The amount to move the cursor
  65548. * @returns This path cursor
  65549. */
  65550. move(step: number): PathCursor;
  65551. /**
  65552. * Ensures that the value is limited between zero and one
  65553. * @returns This path cursor
  65554. */
  65555. private ensureLimits;
  65556. /**
  65557. * Runs onchange callbacks on change (used by the animation engine)
  65558. * @returns This path cursor
  65559. */
  65560. private raiseOnChange;
  65561. /**
  65562. * Executes a function on change
  65563. * @param f A path cursor onchange callback
  65564. * @returns This path cursor
  65565. */
  65566. onchange(f: (cursor: PathCursor) => void): PathCursor;
  65567. }
  65568. }
  65569. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  65570. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  65571. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  65572. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  65573. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  65574. }
  65575. declare module "babylonjs/Engines/Processors/Expressions/index" {
  65576. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  65577. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  65578. }
  65579. declare module "babylonjs/Engines/Processors/index" {
  65580. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  65581. export * from "babylonjs/Engines/Processors/Expressions/index";
  65582. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  65583. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  65584. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  65585. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  65586. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  65587. export * from "babylonjs/Engines/Processors/shaderProcessor";
  65588. }
  65589. declare module "babylonjs/Legacy/legacy" {
  65590. import * as Babylon from "babylonjs/index";
  65591. export * from "babylonjs/index";
  65592. }
  65593. declare module "babylonjs/Shaders/blur.fragment" {
  65594. /** @hidden */
  65595. export var blurPixelShader: {
  65596. name: string;
  65597. shader: string;
  65598. };
  65599. }
  65600. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  65601. /** @hidden */
  65602. export var pointCloudVertexDeclaration: {
  65603. name: string;
  65604. shader: string;
  65605. };
  65606. }
  65607. declare module "babylonjs" {
  65608. export * from "babylonjs/Legacy/legacy";
  65609. }
  65610. declare module BABYLON {
  65611. /** Alias type for value that can be null */
  65612. export type Nullable<T> = T | null;
  65613. /**
  65614. * Alias type for number that are floats
  65615. * @ignorenaming
  65616. */
  65617. export type float = number;
  65618. /**
  65619. * Alias type for number that are doubles.
  65620. * @ignorenaming
  65621. */
  65622. export type double = number;
  65623. /**
  65624. * Alias type for number that are integer
  65625. * @ignorenaming
  65626. */
  65627. export type int = number;
  65628. /** Alias type for number array or Float32Array */
  65629. export type FloatArray = number[] | Float32Array;
  65630. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  65631. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  65632. /**
  65633. * Alias for types that can be used by a Buffer or VertexBuffer.
  65634. */
  65635. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  65636. /**
  65637. * Alias type for primitive types
  65638. * @ignorenaming
  65639. */
  65640. type Primitive = undefined | null | boolean | string | number | Function;
  65641. /**
  65642. * Type modifier to make all the properties of an object Readonly
  65643. */
  65644. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  65645. /**
  65646. * Type modifier to make all the properties of an object Readonly recursively
  65647. */
  65648. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  65649. /** @hidden */
  65650. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  65651. }
  65652. /** @hidden */
  65653. /** @hidden */
  65654. type DeepImmutableObject<T> = {
  65655. readonly [K in keyof T]: DeepImmutable<T[K]>;
  65656. };
  65657. }
  65658. declare module BABYLON {
  65659. /**
  65660. * A class serves as a medium between the observable and its observers
  65661. */
  65662. export class EventState {
  65663. /**
  65664. * Create a new EventState
  65665. * @param mask defines the mask associated with this state
  65666. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  65667. * @param target defines the original target of the state
  65668. * @param currentTarget defines the current target of the state
  65669. */
  65670. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  65671. /**
  65672. * Initialize the current event state
  65673. * @param mask defines the mask associated with this state
  65674. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  65675. * @param target defines the original target of the state
  65676. * @param currentTarget defines the current target of the state
  65677. * @returns the current event state
  65678. */
  65679. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  65680. /**
  65681. * An Observer can set this property to true to prevent subsequent observers of being notified
  65682. */
  65683. skipNextObservers: boolean;
  65684. /**
  65685. * Get the mask value that were used to trigger the event corresponding to this EventState object
  65686. */
  65687. mask: number;
  65688. /**
  65689. * The object that originally notified the event
  65690. */
  65691. target?: any;
  65692. /**
  65693. * The current object in the bubbling phase
  65694. */
  65695. currentTarget?: any;
  65696. /**
  65697. * This will be populated with the return value of the last function that was executed.
  65698. * If it is the first function in the callback chain it will be the event data.
  65699. */
  65700. lastReturnValue?: any;
  65701. }
  65702. /**
  65703. * Represent an Observer registered to a given Observable object.
  65704. */
  65705. export class Observer<T> {
  65706. /**
  65707. * Defines the callback to call when the observer is notified
  65708. */
  65709. callback: (eventData: T, eventState: EventState) => void;
  65710. /**
  65711. * Defines the mask of the observer (used to filter notifications)
  65712. */
  65713. mask: number;
  65714. /**
  65715. * Defines the current scope used to restore the JS context
  65716. */
  65717. scope: any;
  65718. /** @hidden */
  65719. _willBeUnregistered: boolean;
  65720. /**
  65721. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  65722. */
  65723. unregisterOnNextCall: boolean;
  65724. /**
  65725. * Creates a new observer
  65726. * @param callback defines the callback to call when the observer is notified
  65727. * @param mask defines the mask of the observer (used to filter notifications)
  65728. * @param scope defines the current scope used to restore the JS context
  65729. */
  65730. constructor(
  65731. /**
  65732. * Defines the callback to call when the observer is notified
  65733. */
  65734. callback: (eventData: T, eventState: EventState) => void,
  65735. /**
  65736. * Defines the mask of the observer (used to filter notifications)
  65737. */
  65738. mask: number,
  65739. /**
  65740. * Defines the current scope used to restore the JS context
  65741. */
  65742. scope?: any);
  65743. }
  65744. /**
  65745. * Represent a list of observers registered to multiple Observables object.
  65746. */
  65747. export class MultiObserver<T> {
  65748. private _observers;
  65749. private _observables;
  65750. /**
  65751. * Release associated resources
  65752. */
  65753. dispose(): void;
  65754. /**
  65755. * Raise a callback when one of the observable will notify
  65756. * @param observables defines a list of observables to watch
  65757. * @param callback defines the callback to call on notification
  65758. * @param mask defines the mask used to filter notifications
  65759. * @param scope defines the current scope used to restore the JS context
  65760. * @returns the new MultiObserver
  65761. */
  65762. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  65763. }
  65764. /**
  65765. * The Observable class is a simple implementation of the Observable pattern.
  65766. *
  65767. * 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.
  65768. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  65769. * 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).
  65770. * 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.
  65771. */
  65772. export class Observable<T> {
  65773. private _observers;
  65774. private _eventState;
  65775. private _onObserverAdded;
  65776. /**
  65777. * Gets the list of observers
  65778. */
  65779. readonly observers: Array<Observer<T>>;
  65780. /**
  65781. * Creates a new observable
  65782. * @param onObserverAdded defines a callback to call when a new observer is added
  65783. */
  65784. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  65785. /**
  65786. * Create a new Observer with the specified callback
  65787. * @param callback the callback that will be executed for that Observer
  65788. * @param mask the mask used to filter observers
  65789. * @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.
  65790. * @param scope optional scope for the callback to be called from
  65791. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  65792. * @returns the new observer created for the callback
  65793. */
  65794. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  65795. /**
  65796. * Create a new Observer with the specified callback and unregisters after the next notification
  65797. * @param callback the callback that will be executed for that Observer
  65798. * @returns the new observer created for the callback
  65799. */
  65800. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  65801. /**
  65802. * Remove an Observer from the Observable object
  65803. * @param observer the instance of the Observer to remove
  65804. * @returns false if it doesn't belong to this Observable
  65805. */
  65806. remove(observer: Nullable<Observer<T>>): boolean;
  65807. /**
  65808. * Remove a callback from the Observable object
  65809. * @param callback the callback to remove
  65810. * @param scope optional scope. If used only the callbacks with this scope will be removed
  65811. * @returns false if it doesn't belong to this Observable
  65812. */
  65813. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  65814. private _deferUnregister;
  65815. private _remove;
  65816. /**
  65817. * Moves the observable to the top of the observer list making it get called first when notified
  65818. * @param observer the observer to move
  65819. */
  65820. makeObserverTopPriority(observer: Observer<T>): void;
  65821. /**
  65822. * Moves the observable to the bottom of the observer list making it get called last when notified
  65823. * @param observer the observer to move
  65824. */
  65825. makeObserverBottomPriority(observer: Observer<T>): void;
  65826. /**
  65827. * Notify all Observers by calling their respective callback with the given data
  65828. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  65829. * @param eventData defines the data to send to all observers
  65830. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  65831. * @param target defines the original target of the state
  65832. * @param currentTarget defines the current target of the state
  65833. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  65834. */
  65835. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  65836. /**
  65837. * Calling this will execute each callback, expecting it to be a promise or return a value.
  65838. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  65839. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  65840. * and it is crucial that all callbacks will be executed.
  65841. * The order of the callbacks is kept, callbacks are not executed parallel.
  65842. *
  65843. * @param eventData The data to be sent to each callback
  65844. * @param mask is used to filter observers defaults to -1
  65845. * @param target defines the callback target (see EventState)
  65846. * @param currentTarget defines he current object in the bubbling phase
  65847. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  65848. */
  65849. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  65850. /**
  65851. * Notify a specific observer
  65852. * @param observer defines the observer to notify
  65853. * @param eventData defines the data to be sent to each callback
  65854. * @param mask is used to filter observers defaults to -1
  65855. */
  65856. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  65857. /**
  65858. * Gets a boolean indicating if the observable has at least one observer
  65859. * @returns true is the Observable has at least one Observer registered
  65860. */
  65861. hasObservers(): boolean;
  65862. /**
  65863. * Clear the list of observers
  65864. */
  65865. clear(): void;
  65866. /**
  65867. * Clone the current observable
  65868. * @returns a new observable
  65869. */
  65870. clone(): Observable<T>;
  65871. /**
  65872. * Does this observable handles observer registered with a given mask
  65873. * @param mask defines the mask to be tested
  65874. * @return whether or not one observer registered with the given mask is handeled
  65875. **/
  65876. hasSpecificMask(mask?: number): boolean;
  65877. }
  65878. }
  65879. declare module BABYLON {
  65880. /**
  65881. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  65882. * Babylon.js
  65883. */
  65884. export class DomManagement {
  65885. /**
  65886. * Checks if the window object exists
  65887. * @returns true if the window object exists
  65888. */
  65889. static IsWindowObjectExist(): boolean;
  65890. /**
  65891. * Checks if the navigator object exists
  65892. * @returns true if the navigator object exists
  65893. */
  65894. static IsNavigatorAvailable(): boolean;
  65895. /**
  65896. * Extracts text content from a DOM element hierarchy
  65897. * @param element defines the root element
  65898. * @returns a string
  65899. */
  65900. static GetDOMTextContent(element: HTMLElement): string;
  65901. }
  65902. }
  65903. declare module BABYLON {
  65904. /**
  65905. * Logger used througouht the application to allow configuration of
  65906. * the log level required for the messages.
  65907. */
  65908. export class Logger {
  65909. /**
  65910. * No log
  65911. */
  65912. static readonly NoneLogLevel: number;
  65913. /**
  65914. * Only message logs
  65915. */
  65916. static readonly MessageLogLevel: number;
  65917. /**
  65918. * Only warning logs
  65919. */
  65920. static readonly WarningLogLevel: number;
  65921. /**
  65922. * Only error logs
  65923. */
  65924. static readonly ErrorLogLevel: number;
  65925. /**
  65926. * All logs
  65927. */
  65928. static readonly AllLogLevel: number;
  65929. private static _LogCache;
  65930. /**
  65931. * Gets a value indicating the number of loading errors
  65932. * @ignorenaming
  65933. */
  65934. static errorsCount: number;
  65935. /**
  65936. * Callback called when a new log is added
  65937. */
  65938. static OnNewCacheEntry: (entry: string) => void;
  65939. private static _AddLogEntry;
  65940. private static _FormatMessage;
  65941. private static _LogDisabled;
  65942. private static _LogEnabled;
  65943. private static _WarnDisabled;
  65944. private static _WarnEnabled;
  65945. private static _ErrorDisabled;
  65946. private static _ErrorEnabled;
  65947. /**
  65948. * Log a message to the console
  65949. */
  65950. static Log: (message: string) => void;
  65951. /**
  65952. * Write a warning message to the console
  65953. */
  65954. static Warn: (message: string) => void;
  65955. /**
  65956. * Write an error message to the console
  65957. */
  65958. static Error: (message: string) => void;
  65959. /**
  65960. * Gets current log cache (list of logs)
  65961. */
  65962. static readonly LogCache: string;
  65963. /**
  65964. * Clears the log cache
  65965. */
  65966. static ClearLogCache(): void;
  65967. /**
  65968. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  65969. */
  65970. static LogLevels: number;
  65971. }
  65972. }
  65973. declare module BABYLON {
  65974. /** @hidden */
  65975. export class _TypeStore {
  65976. /** @hidden */
  65977. static RegisteredTypes: {
  65978. [key: string]: Object;
  65979. };
  65980. /** @hidden */
  65981. static GetClass(fqdn: string): any;
  65982. }
  65983. }
  65984. declare module BABYLON {
  65985. /**
  65986. * Class containing a set of static utilities functions for deep copy.
  65987. */
  65988. export class DeepCopier {
  65989. /**
  65990. * Tries to copy an object by duplicating every property
  65991. * @param source defines the source object
  65992. * @param destination defines the target object
  65993. * @param doNotCopyList defines a list of properties to avoid
  65994. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  65995. */
  65996. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  65997. }
  65998. }
  65999. declare module BABYLON {
  66000. /**
  66001. * Class containing a set of static utilities functions for precision date
  66002. */
  66003. export class PrecisionDate {
  66004. /**
  66005. * Gets either window.performance.now() if supported or Date.now() else
  66006. */
  66007. static readonly Now: number;
  66008. }
  66009. }
  66010. declare module BABYLON {
  66011. /** @hidden */
  66012. export class _DevTools {
  66013. static WarnImport(name: string): string;
  66014. }
  66015. }
  66016. declare module BABYLON {
  66017. /**
  66018. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  66019. */
  66020. export class WebRequest {
  66021. private _xhr;
  66022. /**
  66023. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  66024. * i.e. when loading files, where the server/service expects an Authorization header
  66025. */
  66026. static CustomRequestHeaders: {
  66027. [key: string]: string;
  66028. };
  66029. /**
  66030. * Add callback functions in this array to update all the requests before they get sent to the network
  66031. */
  66032. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  66033. private _injectCustomRequestHeaders;
  66034. /**
  66035. * Gets or sets a function to be called when loading progress changes
  66036. */
  66037. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  66038. /**
  66039. * Returns client's state
  66040. */
  66041. readonly readyState: number;
  66042. /**
  66043. * Returns client's status
  66044. */
  66045. readonly status: number;
  66046. /**
  66047. * Returns client's status as a text
  66048. */
  66049. readonly statusText: string;
  66050. /**
  66051. * Returns client's response
  66052. */
  66053. readonly response: any;
  66054. /**
  66055. * Returns client's response url
  66056. */
  66057. readonly responseURL: string;
  66058. /**
  66059. * Returns client's response as text
  66060. */
  66061. readonly responseText: string;
  66062. /**
  66063. * Gets or sets the expected response type
  66064. */
  66065. responseType: XMLHttpRequestResponseType;
  66066. /** @hidden */
  66067. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  66068. /** @hidden */
  66069. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  66070. /**
  66071. * Cancels any network activity
  66072. */
  66073. abort(): void;
  66074. /**
  66075. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  66076. * @param body defines an optional request body
  66077. */
  66078. send(body?: Document | BodyInit | null): void;
  66079. /**
  66080. * Sets the request method, request URL
  66081. * @param method defines the method to use (GET, POST, etc..)
  66082. * @param url defines the url to connect with
  66083. */
  66084. open(method: string, url: string): void;
  66085. }
  66086. }
  66087. declare module BABYLON {
  66088. /**
  66089. * File request interface
  66090. */
  66091. export interface IFileRequest {
  66092. /**
  66093. * Raised when the request is complete (success or error).
  66094. */
  66095. onCompleteObservable: Observable<IFileRequest>;
  66096. /**
  66097. * Aborts the request for a file.
  66098. */
  66099. abort: () => void;
  66100. }
  66101. }
  66102. declare module BABYLON {
  66103. /**
  66104. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  66105. */
  66106. export class PerformanceMonitor {
  66107. private _enabled;
  66108. private _rollingFrameTime;
  66109. private _lastFrameTimeMs;
  66110. /**
  66111. * constructor
  66112. * @param frameSampleSize The number of samples required to saturate the sliding window
  66113. */
  66114. constructor(frameSampleSize?: number);
  66115. /**
  66116. * Samples current frame
  66117. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  66118. */
  66119. sampleFrame(timeMs?: number): void;
  66120. /**
  66121. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  66122. */
  66123. readonly averageFrameTime: number;
  66124. /**
  66125. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  66126. */
  66127. readonly averageFrameTimeVariance: number;
  66128. /**
  66129. * Returns the frame time of the most recent frame
  66130. */
  66131. readonly instantaneousFrameTime: number;
  66132. /**
  66133. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  66134. */
  66135. readonly averageFPS: number;
  66136. /**
  66137. * Returns the average framerate in frames per second using the most recent frame time
  66138. */
  66139. readonly instantaneousFPS: number;
  66140. /**
  66141. * Returns true if enough samples have been taken to completely fill the sliding window
  66142. */
  66143. readonly isSaturated: boolean;
  66144. /**
  66145. * Enables contributions to the sliding window sample set
  66146. */
  66147. enable(): void;
  66148. /**
  66149. * Disables contributions to the sliding window sample set
  66150. * Samples will not be interpolated over the disabled period
  66151. */
  66152. disable(): void;
  66153. /**
  66154. * Returns true if sampling is enabled
  66155. */
  66156. readonly isEnabled: boolean;
  66157. /**
  66158. * Resets performance monitor
  66159. */
  66160. reset(): void;
  66161. }
  66162. /**
  66163. * RollingAverage
  66164. *
  66165. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  66166. */
  66167. export class RollingAverage {
  66168. /**
  66169. * Current average
  66170. */
  66171. average: number;
  66172. /**
  66173. * Current variance
  66174. */
  66175. variance: number;
  66176. protected _samples: Array<number>;
  66177. protected _sampleCount: number;
  66178. protected _pos: number;
  66179. protected _m2: number;
  66180. /**
  66181. * constructor
  66182. * @param length The number of samples required to saturate the sliding window
  66183. */
  66184. constructor(length: number);
  66185. /**
  66186. * Adds a sample to the sample set
  66187. * @param v The sample value
  66188. */
  66189. add(v: number): void;
  66190. /**
  66191. * Returns previously added values or null if outside of history or outside the sliding window domain
  66192. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  66193. * @return Value previously recorded with add() or null if outside of range
  66194. */
  66195. history(i: number): number;
  66196. /**
  66197. * Returns true if enough samples have been taken to completely fill the sliding window
  66198. * @return true if sample-set saturated
  66199. */
  66200. isSaturated(): boolean;
  66201. /**
  66202. * Resets the rolling average (equivalent to 0 samples taken so far)
  66203. */
  66204. reset(): void;
  66205. /**
  66206. * Wraps a value around the sample range boundaries
  66207. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  66208. * @return Wrapped position in sample range
  66209. */
  66210. protected _wrapPosition(i: number): number;
  66211. }
  66212. }
  66213. declare module BABYLON {
  66214. /**
  66215. * This class implement a typical dictionary using a string as key and the generic type T as value.
  66216. * The underlying implementation relies on an associative array to ensure the best performances.
  66217. * The value can be anything including 'null' but except 'undefined'
  66218. */
  66219. export class StringDictionary<T> {
  66220. /**
  66221. * This will clear this dictionary and copy the content from the 'source' one.
  66222. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  66223. * @param source the dictionary to take the content from and copy to this dictionary
  66224. */
  66225. copyFrom(source: StringDictionary<T>): void;
  66226. /**
  66227. * Get a value based from its key
  66228. * @param key the given key to get the matching value from
  66229. * @return the value if found, otherwise undefined is returned
  66230. */
  66231. get(key: string): T | undefined;
  66232. /**
  66233. * Get a value from its key or add it if it doesn't exist.
  66234. * This method will ensure you that a given key/data will be present in the dictionary.
  66235. * @param key the given key to get the matching value from
  66236. * @param factory the factory that will create the value if the key is not present in the dictionary.
  66237. * The factory will only be invoked if there's no data for the given key.
  66238. * @return the value corresponding to the key.
  66239. */
  66240. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  66241. /**
  66242. * Get a value from its key if present in the dictionary otherwise add it
  66243. * @param key the key to get the value from
  66244. * @param val if there's no such key/value pair in the dictionary add it with this value
  66245. * @return the value corresponding to the key
  66246. */
  66247. getOrAdd(key: string, val: T): T;
  66248. /**
  66249. * Check if there's a given key in the dictionary
  66250. * @param key the key to check for
  66251. * @return true if the key is present, false otherwise
  66252. */
  66253. contains(key: string): boolean;
  66254. /**
  66255. * Add a new key and its corresponding value
  66256. * @param key the key to add
  66257. * @param value the value corresponding to the key
  66258. * @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
  66259. */
  66260. add(key: string, value: T): boolean;
  66261. /**
  66262. * Update a specific value associated to a key
  66263. * @param key defines the key to use
  66264. * @param value defines the value to store
  66265. * @returns true if the value was updated (or false if the key was not found)
  66266. */
  66267. set(key: string, value: T): boolean;
  66268. /**
  66269. * Get the element of the given key and remove it from the dictionary
  66270. * @param key defines the key to search
  66271. * @returns the value associated with the key or null if not found
  66272. */
  66273. getAndRemove(key: string): Nullable<T>;
  66274. /**
  66275. * Remove a key/value from the dictionary.
  66276. * @param key the key to remove
  66277. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  66278. */
  66279. remove(key: string): boolean;
  66280. /**
  66281. * Clear the whole content of the dictionary
  66282. */
  66283. clear(): void;
  66284. /**
  66285. * Gets the current count
  66286. */
  66287. readonly count: number;
  66288. /**
  66289. * Execute a callback on each key/val of the dictionary.
  66290. * Note that you can remove any element in this dictionary in the callback implementation
  66291. * @param callback the callback to execute on a given key/value pair
  66292. */
  66293. forEach(callback: (key: string, val: T) => void): void;
  66294. /**
  66295. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  66296. * If the callback returns null or undefined the method will iterate to the next key/value pair
  66297. * Note that you can remove any element in this dictionary in the callback implementation
  66298. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  66299. * @returns the first item
  66300. */
  66301. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  66302. private _count;
  66303. private _data;
  66304. }
  66305. }
  66306. declare module BABYLON {
  66307. /**
  66308. * Class used to store gfx data (like WebGLBuffer)
  66309. */
  66310. export class DataBuffer {
  66311. /**
  66312. * Gets or sets the number of objects referencing this buffer
  66313. */
  66314. references: number;
  66315. /** Gets or sets the size of the underlying buffer */
  66316. capacity: number;
  66317. /**
  66318. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  66319. */
  66320. is32Bits: boolean;
  66321. /**
  66322. * Gets the underlying buffer
  66323. */
  66324. readonly underlyingResource: any;
  66325. }
  66326. }
  66327. declare module BABYLON {
  66328. /**
  66329. * Class used to store data that will be store in GPU memory
  66330. */
  66331. export class Buffer {
  66332. private _engine;
  66333. private _buffer;
  66334. /** @hidden */
  66335. _data: Nullable<DataArray>;
  66336. private _updatable;
  66337. private _instanced;
  66338. /**
  66339. * Gets the byte stride.
  66340. */
  66341. readonly byteStride: number;
  66342. /**
  66343. * Constructor
  66344. * @param engine the engine
  66345. * @param data the data to use for this buffer
  66346. * @param updatable whether the data is updatable
  66347. * @param stride the stride (optional)
  66348. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  66349. * @param instanced whether the buffer is instanced (optional)
  66350. * @param useBytes set to true if the stride in in bytes (optional)
  66351. */
  66352. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean);
  66353. /**
  66354. * Create a new VertexBuffer based on the current buffer
  66355. * @param kind defines the vertex buffer kind (position, normal, etc.)
  66356. * @param offset defines offset in the buffer (0 by default)
  66357. * @param size defines the size in floats of attributes (position is 3 for instance)
  66358. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  66359. * @param instanced defines if the vertex buffer contains indexed data
  66360. * @param useBytes defines if the offset and stride are in bytes
  66361. * @returns the new vertex buffer
  66362. */
  66363. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean): VertexBuffer;
  66364. /**
  66365. * Gets a boolean indicating if the Buffer is updatable?
  66366. * @returns true if the buffer is updatable
  66367. */
  66368. isUpdatable(): boolean;
  66369. /**
  66370. * Gets current buffer's data
  66371. * @returns a DataArray or null
  66372. */
  66373. getData(): Nullable<DataArray>;
  66374. /**
  66375. * Gets underlying native buffer
  66376. * @returns underlying native buffer
  66377. */
  66378. getBuffer(): Nullable<DataBuffer>;
  66379. /**
  66380. * Gets the stride in float32 units (i.e. byte stride / 4).
  66381. * May not be an integer if the byte stride is not divisible by 4.
  66382. * DEPRECATED. Use byteStride instead.
  66383. * @returns the stride in float32 units
  66384. */
  66385. getStrideSize(): number;
  66386. /**
  66387. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  66388. * @param data defines the data to store
  66389. */
  66390. create(data?: Nullable<DataArray>): void;
  66391. /** @hidden */
  66392. _rebuild(): void;
  66393. /**
  66394. * Update current buffer data
  66395. * @param data defines the data to store
  66396. */
  66397. update(data: DataArray): void;
  66398. /**
  66399. * Updates the data directly.
  66400. * @param data the new data
  66401. * @param offset the new offset
  66402. * @param vertexCount the vertex count (optional)
  66403. * @param useBytes set to true if the offset is in bytes
  66404. */
  66405. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  66406. /**
  66407. * Release all resources
  66408. */
  66409. dispose(): void;
  66410. }
  66411. /**
  66412. * Specialized buffer used to store vertex data
  66413. */
  66414. export class VertexBuffer {
  66415. /** @hidden */
  66416. _buffer: Buffer;
  66417. private _kind;
  66418. private _size;
  66419. private _ownsBuffer;
  66420. private _instanced;
  66421. private _instanceDivisor;
  66422. /**
  66423. * The byte type.
  66424. */
  66425. static readonly BYTE: number;
  66426. /**
  66427. * The unsigned byte type.
  66428. */
  66429. static readonly UNSIGNED_BYTE: number;
  66430. /**
  66431. * The short type.
  66432. */
  66433. static readonly SHORT: number;
  66434. /**
  66435. * The unsigned short type.
  66436. */
  66437. static readonly UNSIGNED_SHORT: number;
  66438. /**
  66439. * The integer type.
  66440. */
  66441. static readonly INT: number;
  66442. /**
  66443. * The unsigned integer type.
  66444. */
  66445. static readonly UNSIGNED_INT: number;
  66446. /**
  66447. * The float type.
  66448. */
  66449. static readonly FLOAT: number;
  66450. /**
  66451. * Gets or sets the instance divisor when in instanced mode
  66452. */
  66453. instanceDivisor: number;
  66454. /**
  66455. * Gets the byte stride.
  66456. */
  66457. readonly byteStride: number;
  66458. /**
  66459. * Gets the byte offset.
  66460. */
  66461. readonly byteOffset: number;
  66462. /**
  66463. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  66464. */
  66465. readonly normalized: boolean;
  66466. /**
  66467. * Gets the data type of each component in the array.
  66468. */
  66469. readonly type: number;
  66470. /**
  66471. * Constructor
  66472. * @param engine the engine
  66473. * @param data the data to use for this vertex buffer
  66474. * @param kind the vertex buffer kind
  66475. * @param updatable whether the data is updatable
  66476. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  66477. * @param stride the stride (optional)
  66478. * @param instanced whether the buffer is instanced (optional)
  66479. * @param offset the offset of the data (optional)
  66480. * @param size the number of components (optional)
  66481. * @param type the type of the component (optional)
  66482. * @param normalized whether the data contains normalized data (optional)
  66483. * @param useBytes set to true if stride and offset are in bytes (optional)
  66484. */
  66485. 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);
  66486. /** @hidden */
  66487. _rebuild(): void;
  66488. /**
  66489. * Returns the kind of the VertexBuffer (string)
  66490. * @returns a string
  66491. */
  66492. getKind(): string;
  66493. /**
  66494. * Gets a boolean indicating if the VertexBuffer is updatable?
  66495. * @returns true if the buffer is updatable
  66496. */
  66497. isUpdatable(): boolean;
  66498. /**
  66499. * Gets current buffer's data
  66500. * @returns a DataArray or null
  66501. */
  66502. getData(): Nullable<DataArray>;
  66503. /**
  66504. * Gets underlying native buffer
  66505. * @returns underlying native buffer
  66506. */
  66507. getBuffer(): Nullable<DataBuffer>;
  66508. /**
  66509. * Gets the stride in float32 units (i.e. byte stride / 4).
  66510. * May not be an integer if the byte stride is not divisible by 4.
  66511. * DEPRECATED. Use byteStride instead.
  66512. * @returns the stride in float32 units
  66513. */
  66514. getStrideSize(): number;
  66515. /**
  66516. * Returns the offset as a multiple of the type byte length.
  66517. * DEPRECATED. Use byteOffset instead.
  66518. * @returns the offset in bytes
  66519. */
  66520. getOffset(): number;
  66521. /**
  66522. * Returns the number of components per vertex attribute (integer)
  66523. * @returns the size in float
  66524. */
  66525. getSize(): number;
  66526. /**
  66527. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  66528. * @returns true if this buffer is instanced
  66529. */
  66530. getIsInstanced(): boolean;
  66531. /**
  66532. * Returns the instancing divisor, zero for non-instanced (integer).
  66533. * @returns a number
  66534. */
  66535. getInstanceDivisor(): number;
  66536. /**
  66537. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  66538. * @param data defines the data to store
  66539. */
  66540. create(data?: DataArray): void;
  66541. /**
  66542. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  66543. * This function will create a new buffer if the current one is not updatable
  66544. * @param data defines the data to store
  66545. */
  66546. update(data: DataArray): void;
  66547. /**
  66548. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  66549. * Returns the directly updated WebGLBuffer.
  66550. * @param data the new data
  66551. * @param offset the new offset
  66552. * @param useBytes set to true if the offset is in bytes
  66553. */
  66554. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  66555. /**
  66556. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  66557. */
  66558. dispose(): void;
  66559. /**
  66560. * Enumerates each value of this vertex buffer as numbers.
  66561. * @param count the number of values to enumerate
  66562. * @param callback the callback function called for each value
  66563. */
  66564. forEach(count: number, callback: (value: number, index: number) => void): void;
  66565. /**
  66566. * Positions
  66567. */
  66568. static readonly PositionKind: string;
  66569. /**
  66570. * Normals
  66571. */
  66572. static readonly NormalKind: string;
  66573. /**
  66574. * Tangents
  66575. */
  66576. static readonly TangentKind: string;
  66577. /**
  66578. * Texture coordinates
  66579. */
  66580. static readonly UVKind: string;
  66581. /**
  66582. * Texture coordinates 2
  66583. */
  66584. static readonly UV2Kind: string;
  66585. /**
  66586. * Texture coordinates 3
  66587. */
  66588. static readonly UV3Kind: string;
  66589. /**
  66590. * Texture coordinates 4
  66591. */
  66592. static readonly UV4Kind: string;
  66593. /**
  66594. * Texture coordinates 5
  66595. */
  66596. static readonly UV5Kind: string;
  66597. /**
  66598. * Texture coordinates 6
  66599. */
  66600. static readonly UV6Kind: string;
  66601. /**
  66602. * Colors
  66603. */
  66604. static readonly ColorKind: string;
  66605. /**
  66606. * Matrix indices (for bones)
  66607. */
  66608. static readonly MatricesIndicesKind: string;
  66609. /**
  66610. * Matrix weights (for bones)
  66611. */
  66612. static readonly MatricesWeightsKind: string;
  66613. /**
  66614. * Additional matrix indices (for bones)
  66615. */
  66616. static readonly MatricesIndicesExtraKind: string;
  66617. /**
  66618. * Additional matrix weights (for bones)
  66619. */
  66620. static readonly MatricesWeightsExtraKind: string;
  66621. /**
  66622. * Deduces the stride given a kind.
  66623. * @param kind The kind string to deduce
  66624. * @returns The deduced stride
  66625. */
  66626. static DeduceStride(kind: string): number;
  66627. /**
  66628. * Gets the byte length of the given type.
  66629. * @param type the type
  66630. * @returns the number of bytes
  66631. */
  66632. static GetTypeByteLength(type: number): number;
  66633. /**
  66634. * Enumerates each value of the given parameters as numbers.
  66635. * @param data the data to enumerate
  66636. * @param byteOffset the byte offset of the data
  66637. * @param byteStride the byte stride of the data
  66638. * @param componentCount the number of components per element
  66639. * @param componentType the type of the component
  66640. * @param count the number of values to enumerate
  66641. * @param normalized whether the data is normalized
  66642. * @param callback the callback function called for each value
  66643. */
  66644. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  66645. private static _GetFloatValue;
  66646. }
  66647. }
  66648. declare module BABYLON {
  66649. /**
  66650. * Scalar computation library
  66651. */
  66652. export class Scalar {
  66653. /**
  66654. * Two pi constants convenient for computation.
  66655. */
  66656. static TwoPi: number;
  66657. /**
  66658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  66659. * @param a number
  66660. * @param b number
  66661. * @param epsilon (default = 1.401298E-45)
  66662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  66663. */
  66664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  66665. /**
  66666. * Returns a string : the upper case translation of the number i to hexadecimal.
  66667. * @param i number
  66668. * @returns the upper case translation of the number i to hexadecimal.
  66669. */
  66670. static ToHex(i: number): string;
  66671. /**
  66672. * Returns -1 if value is negative and +1 is value is positive.
  66673. * @param value the value
  66674. * @returns the value itself if it's equal to zero.
  66675. */
  66676. static Sign(value: number): number;
  66677. /**
  66678. * Returns the value itself if it's between min and max.
  66679. * Returns min if the value is lower than min.
  66680. * Returns max if the value is greater than max.
  66681. * @param value the value to clmap
  66682. * @param min the min value to clamp to (default: 0)
  66683. * @param max the max value to clamp to (default: 1)
  66684. * @returns the clamped value
  66685. */
  66686. static Clamp(value: number, min?: number, max?: number): number;
  66687. /**
  66688. * the log2 of value.
  66689. * @param value the value to compute log2 of
  66690. * @returns the log2 of value.
  66691. */
  66692. static Log2(value: number): number;
  66693. /**
  66694. * Loops the value, so that it is never larger than length and never smaller than 0.
  66695. *
  66696. * This is similar to the modulo operator but it works with floating point numbers.
  66697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  66698. * With t = 5 and length = 2.5, the result would be 0.0.
  66699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  66700. * @param value the value
  66701. * @param length the length
  66702. * @returns the looped value
  66703. */
  66704. static Repeat(value: number, length: number): number;
  66705. /**
  66706. * Normalize the value between 0.0 and 1.0 using min and max values
  66707. * @param value value to normalize
  66708. * @param min max to normalize between
  66709. * @param max min to normalize between
  66710. * @returns the normalized value
  66711. */
  66712. static Normalize(value: number, min: number, max: number): number;
  66713. /**
  66714. * Denormalize the value from 0.0 and 1.0 using min and max values
  66715. * @param normalized value to denormalize
  66716. * @param min max to denormalize between
  66717. * @param max min to denormalize between
  66718. * @returns the denormalized value
  66719. */
  66720. static Denormalize(normalized: number, min: number, max: number): number;
  66721. /**
  66722. * Calculates the shortest difference between two given angles given in degrees.
  66723. * @param current current angle in degrees
  66724. * @param target target angle in degrees
  66725. * @returns the delta
  66726. */
  66727. static DeltaAngle(current: number, target: number): number;
  66728. /**
  66729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  66730. * @param tx value
  66731. * @param length length
  66732. * @returns The returned value will move back and forth between 0 and length
  66733. */
  66734. static PingPong(tx: number, length: number): number;
  66735. /**
  66736. * Interpolates between min and max with smoothing at the limits.
  66737. *
  66738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  66739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  66740. * @param from from
  66741. * @param to to
  66742. * @param tx value
  66743. * @returns the smooth stepped value
  66744. */
  66745. static SmoothStep(from: number, to: number, tx: number): number;
  66746. /**
  66747. * Moves a value current towards target.
  66748. *
  66749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  66750. * Negative values of maxDelta pushes the value away from target.
  66751. * @param current current value
  66752. * @param target target value
  66753. * @param maxDelta max distance to move
  66754. * @returns resulting value
  66755. */
  66756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  66757. /**
  66758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  66759. *
  66760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  66761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  66762. * @param current current value
  66763. * @param target target value
  66764. * @param maxDelta max distance to move
  66765. * @returns resulting angle
  66766. */
  66767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  66768. /**
  66769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  66770. * @param start start value
  66771. * @param end target value
  66772. * @param amount amount to lerp between
  66773. * @returns the lerped value
  66774. */
  66775. static Lerp(start: number, end: number, amount: number): number;
  66776. /**
  66777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  66778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  66779. * @param start start value
  66780. * @param end target value
  66781. * @param amount amount to lerp between
  66782. * @returns the lerped value
  66783. */
  66784. static LerpAngle(start: number, end: number, amount: number): number;
  66785. /**
  66786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  66787. * @param a start value
  66788. * @param b target value
  66789. * @param value value between a and b
  66790. * @returns the inverseLerp value
  66791. */
  66792. static InverseLerp(a: number, b: number, value: number): number;
  66793. /**
  66794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  66795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  66796. * @param value1 spline value
  66797. * @param tangent1 spline value
  66798. * @param value2 spline value
  66799. * @param tangent2 spline value
  66800. * @param amount input value
  66801. * @returns hermite result
  66802. */
  66803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  66804. /**
  66805. * Returns a random float number between and min and max values
  66806. * @param min min value of random
  66807. * @param max max value of random
  66808. * @returns random value
  66809. */
  66810. static RandomRange(min: number, max: number): number;
  66811. /**
  66812. * This function returns percentage of a number in a given range.
  66813. *
  66814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  66815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  66816. * @param number to convert to percentage
  66817. * @param min min range
  66818. * @param max max range
  66819. * @returns the percentage
  66820. */
  66821. static RangeToPercent(number: number, min: number, max: number): number;
  66822. /**
  66823. * This function returns number that corresponds to the percentage in a given range.
  66824. *
  66825. * PercentToRange(0.34,0,100) will return 34.
  66826. * @param percent to convert to number
  66827. * @param min min range
  66828. * @param max max range
  66829. * @returns the number
  66830. */
  66831. static PercentToRange(percent: number, min: number, max: number): number;
  66832. /**
  66833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  66834. * @param angle The angle to normalize in radian.
  66835. * @return The converted angle.
  66836. */
  66837. static NormalizeRadians(angle: number): number;
  66838. }
  66839. }
  66840. declare module BABYLON {
  66841. /**
  66842. * Constant used to convert a value to gamma space
  66843. * @ignorenaming
  66844. */
  66845. export const ToGammaSpace: number;
  66846. /**
  66847. * Constant used to convert a value to linear space
  66848. * @ignorenaming
  66849. */
  66850. export const ToLinearSpace = 2.2;
  66851. /**
  66852. * Constant used to define the minimal number value in Babylon.js
  66853. * @ignorenaming
  66854. */
  66855. let Epsilon: number;
  66856. }
  66857. declare module BABYLON {
  66858. /**
  66859. * Class used to represent a viewport on screen
  66860. */
  66861. export class Viewport {
  66862. /** viewport left coordinate */
  66863. x: number;
  66864. /** viewport top coordinate */
  66865. y: number;
  66866. /**viewport width */
  66867. width: number;
  66868. /** viewport height */
  66869. height: number;
  66870. /**
  66871. * Creates a Viewport object located at (x, y) and sized (width, height)
  66872. * @param x defines viewport left coordinate
  66873. * @param y defines viewport top coordinate
  66874. * @param width defines the viewport width
  66875. * @param height defines the viewport height
  66876. */
  66877. constructor(
  66878. /** viewport left coordinate */
  66879. x: number,
  66880. /** viewport top coordinate */
  66881. y: number,
  66882. /**viewport width */
  66883. width: number,
  66884. /** viewport height */
  66885. height: number);
  66886. /**
  66887. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  66888. * @param renderWidth defines the rendering width
  66889. * @param renderHeight defines the rendering height
  66890. * @returns a new Viewport
  66891. */
  66892. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  66893. /**
  66894. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  66895. * @param renderWidth defines the rendering width
  66896. * @param renderHeight defines the rendering height
  66897. * @param ref defines the target viewport
  66898. * @returns the current viewport
  66899. */
  66900. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  66901. /**
  66902. * Returns a new Viewport copied from the current one
  66903. * @returns a new Viewport
  66904. */
  66905. clone(): Viewport;
  66906. }
  66907. }
  66908. declare module BABYLON {
  66909. /**
  66910. * Class containing a set of static utilities functions for arrays.
  66911. */
  66912. export class ArrayTools {
  66913. /**
  66914. * Returns an array of the given size filled with element built from the given constructor and the paramters
  66915. * @param size the number of element to construct and put in the array
  66916. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  66917. * @returns a new array filled with new objects
  66918. */
  66919. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  66920. }
  66921. }
  66922. declare module BABYLON {
  66923. /**
  66924. * @hidden
  66925. */
  66926. export interface IColor4Like {
  66927. r: float;
  66928. g: float;
  66929. b: float;
  66930. a: float;
  66931. }
  66932. /**
  66933. * @hidden
  66934. */
  66935. export interface IColor3Like {
  66936. r: float;
  66937. g: float;
  66938. b: float;
  66939. }
  66940. /**
  66941. * @hidden
  66942. */
  66943. export interface IVector4Like {
  66944. x: float;
  66945. y: float;
  66946. z: float;
  66947. w: float;
  66948. }
  66949. /**
  66950. * @hidden
  66951. */
  66952. export interface IVector3Like {
  66953. x: float;
  66954. y: float;
  66955. z: float;
  66956. }
  66957. /**
  66958. * @hidden
  66959. */
  66960. export interface IVector2Like {
  66961. x: float;
  66962. y: float;
  66963. }
  66964. /**
  66965. * @hidden
  66966. */
  66967. export interface IMatrixLike {
  66968. toArray(): DeepImmutable<Float32Array>;
  66969. updateFlag: int;
  66970. }
  66971. /**
  66972. * @hidden
  66973. */
  66974. export interface IViewportLike {
  66975. x: float;
  66976. y: float;
  66977. width: float;
  66978. height: float;
  66979. }
  66980. /**
  66981. * @hidden
  66982. */
  66983. export interface IPlaneLike {
  66984. normal: IVector3Like;
  66985. d: float;
  66986. normalize(): void;
  66987. }
  66988. }
  66989. declare module BABYLON {
  66990. /**
  66991. * Class representing a vector containing 2 coordinates
  66992. */
  66993. export class Vector2 {
  66994. /** defines the first coordinate */
  66995. x: number;
  66996. /** defines the second coordinate */
  66997. y: number;
  66998. /**
  66999. * Creates a new Vector2 from the given x and y coordinates
  67000. * @param x defines the first coordinate
  67001. * @param y defines the second coordinate
  67002. */
  67003. constructor(
  67004. /** defines the first coordinate */
  67005. x?: number,
  67006. /** defines the second coordinate */
  67007. y?: number);
  67008. /**
  67009. * Gets a string with the Vector2 coordinates
  67010. * @returns a string with the Vector2 coordinates
  67011. */
  67012. toString(): string;
  67013. /**
  67014. * Gets class name
  67015. * @returns the string "Vector2"
  67016. */
  67017. getClassName(): string;
  67018. /**
  67019. * Gets current vector hash code
  67020. * @returns the Vector2 hash code as a number
  67021. */
  67022. getHashCode(): number;
  67023. /**
  67024. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  67025. * @param array defines the source array
  67026. * @param index defines the offset in source array
  67027. * @returns the current Vector2
  67028. */
  67029. toArray(array: FloatArray, index?: number): Vector2;
  67030. /**
  67031. * Copy the current vector to an array
  67032. * @returns a new array with 2 elements: the Vector2 coordinates.
  67033. */
  67034. asArray(): number[];
  67035. /**
  67036. * Sets the Vector2 coordinates with the given Vector2 coordinates
  67037. * @param source defines the source Vector2
  67038. * @returns the current updated Vector2
  67039. */
  67040. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  67041. /**
  67042. * Sets the Vector2 coordinates with the given floats
  67043. * @param x defines the first coordinate
  67044. * @param y defines the second coordinate
  67045. * @returns the current updated Vector2
  67046. */
  67047. copyFromFloats(x: number, y: number): Vector2;
  67048. /**
  67049. * Sets the Vector2 coordinates with the given floats
  67050. * @param x defines the first coordinate
  67051. * @param y defines the second coordinate
  67052. * @returns the current updated Vector2
  67053. */
  67054. set(x: number, y: number): Vector2;
  67055. /**
  67056. * Add another vector with the current one
  67057. * @param otherVector defines the other vector
  67058. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  67059. */
  67060. add(otherVector: DeepImmutable<Vector2>): Vector2;
  67061. /**
  67062. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  67063. * @param otherVector defines the other vector
  67064. * @param result defines the target vector
  67065. * @returns the unmodified current Vector2
  67066. */
  67067. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  67068. /**
  67069. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  67070. * @param otherVector defines the other vector
  67071. * @returns the current updated Vector2
  67072. */
  67073. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  67074. /**
  67075. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  67076. * @param otherVector defines the other vector
  67077. * @returns a new Vector2
  67078. */
  67079. addVector3(otherVector: Vector3): Vector2;
  67080. /**
  67081. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  67082. * @param otherVector defines the other vector
  67083. * @returns a new Vector2
  67084. */
  67085. subtract(otherVector: Vector2): Vector2;
  67086. /**
  67087. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  67088. * @param otherVector defines the other vector
  67089. * @param result defines the target vector
  67090. * @returns the unmodified current Vector2
  67091. */
  67092. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  67093. /**
  67094. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  67095. * @param otherVector defines the other vector
  67096. * @returns the current updated Vector2
  67097. */
  67098. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  67099. /**
  67100. * Multiplies in place the current Vector2 coordinates by the given ones
  67101. * @param otherVector defines the other vector
  67102. * @returns the current updated Vector2
  67103. */
  67104. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  67105. /**
  67106. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  67107. * @param otherVector defines the other vector
  67108. * @returns a new Vector2
  67109. */
  67110. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  67111. /**
  67112. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  67113. * @param otherVector defines the other vector
  67114. * @param result defines the target vector
  67115. * @returns the unmodified current Vector2
  67116. */
  67117. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  67118. /**
  67119. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  67120. * @param x defines the first coordinate
  67121. * @param y defines the second coordinate
  67122. * @returns a new Vector2
  67123. */
  67124. multiplyByFloats(x: number, y: number): Vector2;
  67125. /**
  67126. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  67127. * @param otherVector defines the other vector
  67128. * @returns a new Vector2
  67129. */
  67130. divide(otherVector: Vector2): Vector2;
  67131. /**
  67132. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  67133. * @param otherVector defines the other vector
  67134. * @param result defines the target vector
  67135. * @returns the unmodified current Vector2
  67136. */
  67137. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  67138. /**
  67139. * Divides the current Vector2 coordinates by the given ones
  67140. * @param otherVector defines the other vector
  67141. * @returns the current updated Vector2
  67142. */
  67143. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  67144. /**
  67145. * Gets a new Vector2 with current Vector2 negated coordinates
  67146. * @returns a new Vector2
  67147. */
  67148. negate(): Vector2;
  67149. /**
  67150. * Multiply the Vector2 coordinates by scale
  67151. * @param scale defines the scaling factor
  67152. * @returns the current updated Vector2
  67153. */
  67154. scaleInPlace(scale: number): Vector2;
  67155. /**
  67156. * Returns a new Vector2 scaled by "scale" from the current Vector2
  67157. * @param scale defines the scaling factor
  67158. * @returns a new Vector2
  67159. */
  67160. scale(scale: number): Vector2;
  67161. /**
  67162. * Scale the current Vector2 values by a factor to a given Vector2
  67163. * @param scale defines the scale factor
  67164. * @param result defines the Vector2 object where to store the result
  67165. * @returns the unmodified current Vector2
  67166. */
  67167. scaleToRef(scale: number, result: Vector2): Vector2;
  67168. /**
  67169. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  67170. * @param scale defines the scale factor
  67171. * @param result defines the Vector2 object where to store the result
  67172. * @returns the unmodified current Vector2
  67173. */
  67174. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  67175. /**
  67176. * Gets a boolean if two vectors are equals
  67177. * @param otherVector defines the other vector
  67178. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  67179. */
  67180. equals(otherVector: DeepImmutable<Vector2>): boolean;
  67181. /**
  67182. * Gets a boolean if two vectors are equals (using an epsilon value)
  67183. * @param otherVector defines the other vector
  67184. * @param epsilon defines the minimal distance to consider equality
  67185. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  67186. */
  67187. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  67188. /**
  67189. * Gets a new Vector2 from current Vector2 floored values
  67190. * @returns a new Vector2
  67191. */
  67192. floor(): Vector2;
  67193. /**
  67194. * Gets a new Vector2 from current Vector2 floored values
  67195. * @returns a new Vector2
  67196. */
  67197. fract(): Vector2;
  67198. /**
  67199. * Gets the length of the vector
  67200. * @returns the vector length (float)
  67201. */
  67202. length(): number;
  67203. /**
  67204. * Gets the vector squared length
  67205. * @returns the vector squared length (float)
  67206. */
  67207. lengthSquared(): number;
  67208. /**
  67209. * Normalize the vector
  67210. * @returns the current updated Vector2
  67211. */
  67212. normalize(): Vector2;
  67213. /**
  67214. * Gets a new Vector2 copied from the Vector2
  67215. * @returns a new Vector2
  67216. */
  67217. clone(): Vector2;
  67218. /**
  67219. * Gets a new Vector2(0, 0)
  67220. * @returns a new Vector2
  67221. */
  67222. static Zero(): Vector2;
  67223. /**
  67224. * Gets a new Vector2(1, 1)
  67225. * @returns a new Vector2
  67226. */
  67227. static One(): Vector2;
  67228. /**
  67229. * Gets a new Vector2 set from the given index element of the given array
  67230. * @param array defines the data source
  67231. * @param offset defines the offset in the data source
  67232. * @returns a new Vector2
  67233. */
  67234. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  67235. /**
  67236. * Sets "result" from the given index element of the given array
  67237. * @param array defines the data source
  67238. * @param offset defines the offset in the data source
  67239. * @param result defines the target vector
  67240. */
  67241. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  67242. /**
  67243. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  67244. * @param value1 defines 1st point of control
  67245. * @param value2 defines 2nd point of control
  67246. * @param value3 defines 3rd point of control
  67247. * @param value4 defines 4th point of control
  67248. * @param amount defines the interpolation factor
  67249. * @returns a new Vector2
  67250. */
  67251. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  67252. /**
  67253. * 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".
  67254. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  67255. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  67256. * @param value defines the value to clamp
  67257. * @param min defines the lower limit
  67258. * @param max defines the upper limit
  67259. * @returns a new Vector2
  67260. */
  67261. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  67262. /**
  67263. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  67264. * @param value1 defines the 1st control point
  67265. * @param tangent1 defines the outgoing tangent
  67266. * @param value2 defines the 2nd control point
  67267. * @param tangent2 defines the incoming tangent
  67268. * @param amount defines the interpolation factor
  67269. * @returns a new Vector2
  67270. */
  67271. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  67272. /**
  67273. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  67274. * @param start defines the start vector
  67275. * @param end defines the end vector
  67276. * @param amount defines the interpolation factor
  67277. * @returns a new Vector2
  67278. */
  67279. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  67280. /**
  67281. * Gets the dot product of the vector "left" and the vector "right"
  67282. * @param left defines first vector
  67283. * @param right defines second vector
  67284. * @returns the dot product (float)
  67285. */
  67286. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  67287. /**
  67288. * Returns a new Vector2 equal to the normalized given vector
  67289. * @param vector defines the vector to normalize
  67290. * @returns a new Vector2
  67291. */
  67292. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  67293. /**
  67294. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  67295. * @param left defines 1st vector
  67296. * @param right defines 2nd vector
  67297. * @returns a new Vector2
  67298. */
  67299. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  67300. /**
  67301. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  67302. * @param left defines 1st vector
  67303. * @param right defines 2nd vector
  67304. * @returns a new Vector2
  67305. */
  67306. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  67307. /**
  67308. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  67309. * @param vector defines the vector to transform
  67310. * @param transformation defines the matrix to apply
  67311. * @returns a new Vector2
  67312. */
  67313. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  67314. /**
  67315. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  67316. * @param vector defines the vector to transform
  67317. * @param transformation defines the matrix to apply
  67318. * @param result defines the target vector
  67319. */
  67320. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  67321. /**
  67322. * Determines if a given vector is included in a triangle
  67323. * @param p defines the vector to test
  67324. * @param p0 defines 1st triangle point
  67325. * @param p1 defines 2nd triangle point
  67326. * @param p2 defines 3rd triangle point
  67327. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  67328. */
  67329. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  67330. /**
  67331. * Gets the distance between the vectors "value1" and "value2"
  67332. * @param value1 defines first vector
  67333. * @param value2 defines second vector
  67334. * @returns the distance between vectors
  67335. */
  67336. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  67337. /**
  67338. * Returns the squared distance between the vectors "value1" and "value2"
  67339. * @param value1 defines first vector
  67340. * @param value2 defines second vector
  67341. * @returns the squared distance between vectors
  67342. */
  67343. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  67344. /**
  67345. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  67346. * @param value1 defines first vector
  67347. * @param value2 defines second vector
  67348. * @returns a new Vector2
  67349. */
  67350. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  67351. /**
  67352. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  67353. * @param p defines the middle point
  67354. * @param segA defines one point of the segment
  67355. * @param segB defines the other point of the segment
  67356. * @returns the shortest distance
  67357. */
  67358. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  67359. }
  67360. /**
  67361. * Classed used to store (x,y,z) vector representation
  67362. * A Vector3 is the main object used in 3D geometry
  67363. * It can represent etiher the coordinates of a point the space, either a direction
  67364. * Reminder: js uses a left handed forward facing system
  67365. */
  67366. export class Vector3 {
  67367. /**
  67368. * Defines the first coordinates (on X axis)
  67369. */
  67370. x: number;
  67371. /**
  67372. * Defines the second coordinates (on Y axis)
  67373. */
  67374. y: number;
  67375. /**
  67376. * Defines the third coordinates (on Z axis)
  67377. */
  67378. z: number;
  67379. private static _UpReadOnly;
  67380. private static _ZeroReadOnly;
  67381. /**
  67382. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  67383. * @param x defines the first coordinates (on X axis)
  67384. * @param y defines the second coordinates (on Y axis)
  67385. * @param z defines the third coordinates (on Z axis)
  67386. */
  67387. constructor(
  67388. /**
  67389. * Defines the first coordinates (on X axis)
  67390. */
  67391. x?: number,
  67392. /**
  67393. * Defines the second coordinates (on Y axis)
  67394. */
  67395. y?: number,
  67396. /**
  67397. * Defines the third coordinates (on Z axis)
  67398. */
  67399. z?: number);
  67400. /**
  67401. * Creates a string representation of the Vector3
  67402. * @returns a string with the Vector3 coordinates.
  67403. */
  67404. toString(): string;
  67405. /**
  67406. * Gets the class name
  67407. * @returns the string "Vector3"
  67408. */
  67409. getClassName(): string;
  67410. /**
  67411. * Creates the Vector3 hash code
  67412. * @returns a number which tends to be unique between Vector3 instances
  67413. */
  67414. getHashCode(): number;
  67415. /**
  67416. * Creates an array containing three elements : the coordinates of the Vector3
  67417. * @returns a new array of numbers
  67418. */
  67419. asArray(): number[];
  67420. /**
  67421. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  67422. * @param array defines the destination array
  67423. * @param index defines the offset in the destination array
  67424. * @returns the current Vector3
  67425. */
  67426. toArray(array: FloatArray, index?: number): Vector3;
  67427. /**
  67428. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  67429. * @returns a new Quaternion object, computed from the Vector3 coordinates
  67430. */
  67431. toQuaternion(): Quaternion;
  67432. /**
  67433. * Adds the given vector to the current Vector3
  67434. * @param otherVector defines the second operand
  67435. * @returns the current updated Vector3
  67436. */
  67437. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  67438. /**
  67439. * Adds the given coordinates to the current Vector3
  67440. * @param x defines the x coordinate of the operand
  67441. * @param y defines the y coordinate of the operand
  67442. * @param z defines the z coordinate of the operand
  67443. * @returns the current updated Vector3
  67444. */
  67445. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  67446. /**
  67447. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  67448. * @param otherVector defines the second operand
  67449. * @returns the resulting Vector3
  67450. */
  67451. add(otherVector: DeepImmutable<Vector3>): Vector3;
  67452. /**
  67453. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  67454. * @param otherVector defines the second operand
  67455. * @param result defines the Vector3 object where to store the result
  67456. * @returns the current Vector3
  67457. */
  67458. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  67459. /**
  67460. * Subtract the given vector from the current Vector3
  67461. * @param otherVector defines the second operand
  67462. * @returns the current updated Vector3
  67463. */
  67464. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  67465. /**
  67466. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  67467. * @param otherVector defines the second operand
  67468. * @returns the resulting Vector3
  67469. */
  67470. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  67471. /**
  67472. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  67473. * @param otherVector defines the second operand
  67474. * @param result defines the Vector3 object where to store the result
  67475. * @returns the current Vector3
  67476. */
  67477. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  67478. /**
  67479. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  67480. * @param x defines the x coordinate of the operand
  67481. * @param y defines the y coordinate of the operand
  67482. * @param z defines the z coordinate of the operand
  67483. * @returns the resulting Vector3
  67484. */
  67485. subtractFromFloats(x: number, y: number, z: number): Vector3;
  67486. /**
  67487. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  67488. * @param x defines the x coordinate of the operand
  67489. * @param y defines the y coordinate of the operand
  67490. * @param z defines the z coordinate of the operand
  67491. * @param result defines the Vector3 object where to store the result
  67492. * @returns the current Vector3
  67493. */
  67494. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  67495. /**
  67496. * Gets a new Vector3 set with the current Vector3 negated coordinates
  67497. * @returns a new Vector3
  67498. */
  67499. negate(): Vector3;
  67500. /**
  67501. * Multiplies the Vector3 coordinates by the float "scale"
  67502. * @param scale defines the multiplier factor
  67503. * @returns the current updated Vector3
  67504. */
  67505. scaleInPlace(scale: number): Vector3;
  67506. /**
  67507. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  67508. * @param scale defines the multiplier factor
  67509. * @returns a new Vector3
  67510. */
  67511. scale(scale: number): Vector3;
  67512. /**
  67513. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  67514. * @param scale defines the multiplier factor
  67515. * @param result defines the Vector3 object where to store the result
  67516. * @returns the current Vector3
  67517. */
  67518. scaleToRef(scale: number, result: Vector3): Vector3;
  67519. /**
  67520. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  67521. * @param scale defines the scale factor
  67522. * @param result defines the Vector3 object where to store the result
  67523. * @returns the unmodified current Vector3
  67524. */
  67525. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  67526. /**
  67527. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  67528. * @param otherVector defines the second operand
  67529. * @returns true if both vectors are equals
  67530. */
  67531. equals(otherVector: DeepImmutable<Vector3>): boolean;
  67532. /**
  67533. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  67534. * @param otherVector defines the second operand
  67535. * @param epsilon defines the minimal distance to define values as equals
  67536. * @returns true if both vectors are distant less than epsilon
  67537. */
  67538. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  67539. /**
  67540. * Returns true if the current Vector3 coordinates equals the given floats
  67541. * @param x defines the x coordinate of the operand
  67542. * @param y defines the y coordinate of the operand
  67543. * @param z defines the z coordinate of the operand
  67544. * @returns true if both vectors are equals
  67545. */
  67546. equalsToFloats(x: number, y: number, z: number): boolean;
  67547. /**
  67548. * Multiplies the current Vector3 coordinates by the given ones
  67549. * @param otherVector defines the second operand
  67550. * @returns the current updated Vector3
  67551. */
  67552. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  67553. /**
  67554. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  67555. * @param otherVector defines the second operand
  67556. * @returns the new Vector3
  67557. */
  67558. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  67559. /**
  67560. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  67561. * @param otherVector defines the second operand
  67562. * @param result defines the Vector3 object where to store the result
  67563. * @returns the current Vector3
  67564. */
  67565. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  67566. /**
  67567. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  67568. * @param x defines the x coordinate of the operand
  67569. * @param y defines the y coordinate of the operand
  67570. * @param z defines the z coordinate of the operand
  67571. * @returns the new Vector3
  67572. */
  67573. multiplyByFloats(x: number, y: number, z: number): Vector3;
  67574. /**
  67575. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  67576. * @param otherVector defines the second operand
  67577. * @returns the new Vector3
  67578. */
  67579. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  67580. /**
  67581. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  67582. * @param otherVector defines the second operand
  67583. * @param result defines the Vector3 object where to store the result
  67584. * @returns the current Vector3
  67585. */
  67586. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  67587. /**
  67588. * Divides the current Vector3 coordinates by the given ones.
  67589. * @param otherVector defines the second operand
  67590. * @returns the current updated Vector3
  67591. */
  67592. divideInPlace(otherVector: Vector3): Vector3;
  67593. /**
  67594. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  67595. * @param other defines the second operand
  67596. * @returns the current updated Vector3
  67597. */
  67598. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  67599. /**
  67600. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  67601. * @param other defines the second operand
  67602. * @returns the current updated Vector3
  67603. */
  67604. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  67605. /**
  67606. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  67607. * @param x defines the x coordinate of the operand
  67608. * @param y defines the y coordinate of the operand
  67609. * @param z defines the z coordinate of the operand
  67610. * @returns the current updated Vector3
  67611. */
  67612. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  67613. /**
  67614. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  67615. * @param x defines the x coordinate of the operand
  67616. * @param y defines the y coordinate of the operand
  67617. * @param z defines the z coordinate of the operand
  67618. * @returns the current updated Vector3
  67619. */
  67620. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  67621. /**
  67622. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  67623. * Check if is non uniform within a certain amount of decimal places to account for this
  67624. * @param epsilon the amount the values can differ
  67625. * @returns if the the vector is non uniform to a certain number of decimal places
  67626. */
  67627. isNonUniformWithinEpsilon(epsilon: number): boolean;
  67628. /**
  67629. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  67630. */
  67631. readonly isNonUniform: boolean;
  67632. /**
  67633. * Gets a new Vector3 from current Vector3 floored values
  67634. * @returns a new Vector3
  67635. */
  67636. floor(): Vector3;
  67637. /**
  67638. * Gets a new Vector3 from current Vector3 floored values
  67639. * @returns a new Vector3
  67640. */
  67641. fract(): Vector3;
  67642. /**
  67643. * Gets the length of the Vector3
  67644. * @returns the length of the Vector3
  67645. */
  67646. length(): number;
  67647. /**
  67648. * Gets the squared length of the Vector3
  67649. * @returns squared length of the Vector3
  67650. */
  67651. lengthSquared(): number;
  67652. /**
  67653. * Normalize the current Vector3.
  67654. * Please note that this is an in place operation.
  67655. * @returns the current updated Vector3
  67656. */
  67657. normalize(): Vector3;
  67658. /**
  67659. * Reorders the x y z properties of the vector in place
  67660. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  67661. * @returns the current updated vector
  67662. */
  67663. reorderInPlace(order: string): this;
  67664. /**
  67665. * Rotates the vector around 0,0,0 by a quaternion
  67666. * @param quaternion the rotation quaternion
  67667. * @param result vector to store the result
  67668. * @returns the resulting vector
  67669. */
  67670. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  67671. /**
  67672. * Rotates a vector around a given point
  67673. * @param quaternion the rotation quaternion
  67674. * @param point the point to rotate around
  67675. * @param result vector to store the result
  67676. * @returns the resulting vector
  67677. */
  67678. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  67679. /**
  67680. * Normalize the current Vector3 with the given input length.
  67681. * Please note that this is an in place operation.
  67682. * @param len the length of the vector
  67683. * @returns the current updated Vector3
  67684. */
  67685. normalizeFromLength(len: number): Vector3;
  67686. /**
  67687. * Normalize the current Vector3 to a new vector
  67688. * @returns the new Vector3
  67689. */
  67690. normalizeToNew(): Vector3;
  67691. /**
  67692. * Normalize the current Vector3 to the reference
  67693. * @param reference define the Vector3 to update
  67694. * @returns the updated Vector3
  67695. */
  67696. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  67697. /**
  67698. * Creates a new Vector3 copied from the current Vector3
  67699. * @returns the new Vector3
  67700. */
  67701. clone(): Vector3;
  67702. /**
  67703. * Copies the given vector coordinates to the current Vector3 ones
  67704. * @param source defines the source Vector3
  67705. * @returns the current updated Vector3
  67706. */
  67707. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  67708. /**
  67709. * Copies the given floats to the current Vector3 coordinates
  67710. * @param x defines the x coordinate of the operand
  67711. * @param y defines the y coordinate of the operand
  67712. * @param z defines the z coordinate of the operand
  67713. * @returns the current updated Vector3
  67714. */
  67715. copyFromFloats(x: number, y: number, z: number): Vector3;
  67716. /**
  67717. * Copies the given floats to the current Vector3 coordinates
  67718. * @param x defines the x coordinate of the operand
  67719. * @param y defines the y coordinate of the operand
  67720. * @param z defines the z coordinate of the operand
  67721. * @returns the current updated Vector3
  67722. */
  67723. set(x: number, y: number, z: number): Vector3;
  67724. /**
  67725. * Copies the given float to the current Vector3 coordinates
  67726. * @param v defines the x, y and z coordinates of the operand
  67727. * @returns the current updated Vector3
  67728. */
  67729. setAll(v: number): Vector3;
  67730. /**
  67731. * Get the clip factor between two vectors
  67732. * @param vector0 defines the first operand
  67733. * @param vector1 defines the second operand
  67734. * @param axis defines the axis to use
  67735. * @param size defines the size along the axis
  67736. * @returns the clip factor
  67737. */
  67738. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  67739. /**
  67740. * Get angle between two vectors
  67741. * @param vector0 angle between vector0 and vector1
  67742. * @param vector1 angle between vector0 and vector1
  67743. * @param normal direction of the normal
  67744. * @return the angle between vector0 and vector1
  67745. */
  67746. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  67747. /**
  67748. * Returns a new Vector3 set from the index "offset" of the given array
  67749. * @param array defines the source array
  67750. * @param offset defines the offset in the source array
  67751. * @returns the new Vector3
  67752. */
  67753. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  67754. /**
  67755. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  67756. * This function is deprecated. Use FromArray instead
  67757. * @param array defines the source array
  67758. * @param offset defines the offset in the source array
  67759. * @returns the new Vector3
  67760. */
  67761. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  67762. /**
  67763. * Sets the given vector "result" with the element values from the index "offset" of the given array
  67764. * @param array defines the source array
  67765. * @param offset defines the offset in the source array
  67766. * @param result defines the Vector3 where to store the result
  67767. */
  67768. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  67769. /**
  67770. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  67771. * This function is deprecated. Use FromArrayToRef instead.
  67772. * @param array defines the source array
  67773. * @param offset defines the offset in the source array
  67774. * @param result defines the Vector3 where to store the result
  67775. */
  67776. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  67777. /**
  67778. * Sets the given vector "result" with the given floats.
  67779. * @param x defines the x coordinate of the source
  67780. * @param y defines the y coordinate of the source
  67781. * @param z defines the z coordinate of the source
  67782. * @param result defines the Vector3 where to store the result
  67783. */
  67784. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  67785. /**
  67786. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  67787. * @returns a new empty Vector3
  67788. */
  67789. static Zero(): Vector3;
  67790. /**
  67791. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  67792. * @returns a new unit Vector3
  67793. */
  67794. static One(): Vector3;
  67795. /**
  67796. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  67797. * @returns a new up Vector3
  67798. */
  67799. static Up(): Vector3;
  67800. /**
  67801. * Gets a up Vector3 that must not be updated
  67802. */
  67803. static readonly UpReadOnly: DeepImmutable<Vector3>;
  67804. /**
  67805. * Gets a zero Vector3 that must not be updated
  67806. */
  67807. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  67808. /**
  67809. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  67810. * @returns a new down Vector3
  67811. */
  67812. static Down(): Vector3;
  67813. /**
  67814. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  67815. * @returns a new forward Vector3
  67816. */
  67817. static Forward(): Vector3;
  67818. /**
  67819. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  67820. * @returns a new forward Vector3
  67821. */
  67822. static Backward(): Vector3;
  67823. /**
  67824. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  67825. * @returns a new right Vector3
  67826. */
  67827. static Right(): Vector3;
  67828. /**
  67829. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  67830. * @returns a new left Vector3
  67831. */
  67832. static Left(): Vector3;
  67833. /**
  67834. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  67835. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  67836. * @param vector defines the Vector3 to transform
  67837. * @param transformation defines the transformation matrix
  67838. * @returns the transformed Vector3
  67839. */
  67840. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  67841. /**
  67842. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  67843. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  67844. * @param vector defines the Vector3 to transform
  67845. * @param transformation defines the transformation matrix
  67846. * @param result defines the Vector3 where to store the result
  67847. */
  67848. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  67849. /**
  67850. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  67851. * This method computes tranformed coordinates only, not transformed direction vectors
  67852. * @param x define the x coordinate of the source vector
  67853. * @param y define the y coordinate of the source vector
  67854. * @param z define the z coordinate of the source vector
  67855. * @param transformation defines the transformation matrix
  67856. * @param result defines the Vector3 where to store the result
  67857. */
  67858. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  67859. /**
  67860. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  67861. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  67862. * @param vector defines the Vector3 to transform
  67863. * @param transformation defines the transformation matrix
  67864. * @returns the new Vector3
  67865. */
  67866. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  67867. /**
  67868. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  67869. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  67870. * @param vector defines the Vector3 to transform
  67871. * @param transformation defines the transformation matrix
  67872. * @param result defines the Vector3 where to store the result
  67873. */
  67874. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  67875. /**
  67876. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  67877. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  67878. * @param x define the x coordinate of the source vector
  67879. * @param y define the y coordinate of the source vector
  67880. * @param z define the z coordinate of the source vector
  67881. * @param transformation defines the transformation matrix
  67882. * @param result defines the Vector3 where to store the result
  67883. */
  67884. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  67885. /**
  67886. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  67887. * @param value1 defines the first control point
  67888. * @param value2 defines the second control point
  67889. * @param value3 defines the third control point
  67890. * @param value4 defines the fourth control point
  67891. * @param amount defines the amount on the spline to use
  67892. * @returns the new Vector3
  67893. */
  67894. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  67895. /**
  67896. * 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"
  67897. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  67898. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  67899. * @param value defines the current value
  67900. * @param min defines the lower range value
  67901. * @param max defines the upper range value
  67902. * @returns the new Vector3
  67903. */
  67904. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  67905. /**
  67906. * 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"
  67907. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  67908. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  67909. * @param value defines the current value
  67910. * @param min defines the lower range value
  67911. * @param max defines the upper range value
  67912. * @param result defines the Vector3 where to store the result
  67913. */
  67914. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  67915. /**
  67916. * Checks if a given vector is inside a specific range
  67917. * @param v defines the vector to test
  67918. * @param min defines the minimum range
  67919. * @param max defines the maximum range
  67920. */
  67921. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  67922. /**
  67923. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  67924. * @param value1 defines the first control point
  67925. * @param tangent1 defines the first tangent vector
  67926. * @param value2 defines the second control point
  67927. * @param tangent2 defines the second tangent vector
  67928. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  67929. * @returns the new Vector3
  67930. */
  67931. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  67932. /**
  67933. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  67934. * @param start defines the start value
  67935. * @param end defines the end value
  67936. * @param amount max defines amount between both (between 0 and 1)
  67937. * @returns the new Vector3
  67938. */
  67939. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  67940. /**
  67941. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  67942. * @param start defines the start value
  67943. * @param end defines the end value
  67944. * @param amount max defines amount between both (between 0 and 1)
  67945. * @param result defines the Vector3 where to store the result
  67946. */
  67947. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  67948. /**
  67949. * Returns the dot product (float) between the vectors "left" and "right"
  67950. * @param left defines the left operand
  67951. * @param right defines the right operand
  67952. * @returns the dot product
  67953. */
  67954. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  67955. /**
  67956. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  67957. * The cross product is then orthogonal to both "left" and "right"
  67958. * @param left defines the left operand
  67959. * @param right defines the right operand
  67960. * @returns the cross product
  67961. */
  67962. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  67963. /**
  67964. * Sets the given vector "result" with the cross product of "left" and "right"
  67965. * The cross product is then orthogonal to both "left" and "right"
  67966. * @param left defines the left operand
  67967. * @param right defines the right operand
  67968. * @param result defines the Vector3 where to store the result
  67969. */
  67970. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  67971. /**
  67972. * Returns a new Vector3 as the normalization of the given vector
  67973. * @param vector defines the Vector3 to normalize
  67974. * @returns the new Vector3
  67975. */
  67976. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  67977. /**
  67978. * Sets the given vector "result" with the normalization of the given first vector
  67979. * @param vector defines the Vector3 to normalize
  67980. * @param result defines the Vector3 where to store the result
  67981. */
  67982. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  67983. /**
  67984. * Project a Vector3 onto screen space
  67985. * @param vector defines the Vector3 to project
  67986. * @param world defines the world matrix to use
  67987. * @param transform defines the transform (view x projection) matrix to use
  67988. * @param viewport defines the screen viewport to use
  67989. * @returns the new Vector3
  67990. */
  67991. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  67992. /** @hidden */
  67993. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  67994. /**
  67995. * Unproject from screen space to object space
  67996. * @param source defines the screen space Vector3 to use
  67997. * @param viewportWidth defines the current width of the viewport
  67998. * @param viewportHeight defines the current height of the viewport
  67999. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  68000. * @param transform defines the transform (view x projection) matrix to use
  68001. * @returns the new Vector3
  68002. */
  68003. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  68004. /**
  68005. * Unproject from screen space to object space
  68006. * @param source defines the screen space Vector3 to use
  68007. * @param viewportWidth defines the current width of the viewport
  68008. * @param viewportHeight defines the current height of the viewport
  68009. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  68010. * @param view defines the view matrix to use
  68011. * @param projection defines the projection matrix to use
  68012. * @returns the new Vector3
  68013. */
  68014. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  68015. /**
  68016. * Unproject from screen space to object space
  68017. * @param source defines the screen space Vector3 to use
  68018. * @param viewportWidth defines the current width of the viewport
  68019. * @param viewportHeight defines the current height of the viewport
  68020. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  68021. * @param view defines the view matrix to use
  68022. * @param projection defines the projection matrix to use
  68023. * @param result defines the Vector3 where to store the result
  68024. */
  68025. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  68026. /**
  68027. * Unproject from screen space to object space
  68028. * @param sourceX defines the screen space x coordinate to use
  68029. * @param sourceY defines the screen space y coordinate to use
  68030. * @param sourceZ defines the screen space z coordinate to use
  68031. * @param viewportWidth defines the current width of the viewport
  68032. * @param viewportHeight defines the current height of the viewport
  68033. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  68034. * @param view defines the view matrix to use
  68035. * @param projection defines the projection matrix to use
  68036. * @param result defines the Vector3 where to store the result
  68037. */
  68038. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  68039. /**
  68040. * Gets the minimal coordinate values between two Vector3
  68041. * @param left defines the first operand
  68042. * @param right defines the second operand
  68043. * @returns the new Vector3
  68044. */
  68045. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  68046. /**
  68047. * Gets the maximal coordinate values between two Vector3
  68048. * @param left defines the first operand
  68049. * @param right defines the second operand
  68050. * @returns the new Vector3
  68051. */
  68052. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  68053. /**
  68054. * Returns the distance between the vectors "value1" and "value2"
  68055. * @param value1 defines the first operand
  68056. * @param value2 defines the second operand
  68057. * @returns the distance
  68058. */
  68059. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  68060. /**
  68061. * Returns the squared distance between the vectors "value1" and "value2"
  68062. * @param value1 defines the first operand
  68063. * @param value2 defines the second operand
  68064. * @returns the squared distance
  68065. */
  68066. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  68067. /**
  68068. * Returns a new Vector3 located at the center between "value1" and "value2"
  68069. * @param value1 defines the first operand
  68070. * @param value2 defines the second operand
  68071. * @returns the new Vector3
  68072. */
  68073. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  68074. /**
  68075. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  68076. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  68077. * to something in order to rotate it from its local system to the given target system
  68078. * Note: axis1, axis2 and axis3 are normalized during this operation
  68079. * @param axis1 defines the first axis
  68080. * @param axis2 defines the second axis
  68081. * @param axis3 defines the third axis
  68082. * @returns a new Vector3
  68083. */
  68084. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  68085. /**
  68086. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  68087. * @param axis1 defines the first axis
  68088. * @param axis2 defines the second axis
  68089. * @param axis3 defines the third axis
  68090. * @param ref defines the Vector3 where to store the result
  68091. */
  68092. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  68093. }
  68094. /**
  68095. * Vector4 class created for EulerAngle class conversion to Quaternion
  68096. */
  68097. export class Vector4 {
  68098. /** x value of the vector */
  68099. x: number;
  68100. /** y value of the vector */
  68101. y: number;
  68102. /** z value of the vector */
  68103. z: number;
  68104. /** w value of the vector */
  68105. w: number;
  68106. /**
  68107. * Creates a Vector4 object from the given floats.
  68108. * @param x x value of the vector
  68109. * @param y y value of the vector
  68110. * @param z z value of the vector
  68111. * @param w w value of the vector
  68112. */
  68113. constructor(
  68114. /** x value of the vector */
  68115. x: number,
  68116. /** y value of the vector */
  68117. y: number,
  68118. /** z value of the vector */
  68119. z: number,
  68120. /** w value of the vector */
  68121. w: number);
  68122. /**
  68123. * Returns the string with the Vector4 coordinates.
  68124. * @returns a string containing all the vector values
  68125. */
  68126. toString(): string;
  68127. /**
  68128. * Returns the string "Vector4".
  68129. * @returns "Vector4"
  68130. */
  68131. getClassName(): string;
  68132. /**
  68133. * Returns the Vector4 hash code.
  68134. * @returns a unique hash code
  68135. */
  68136. getHashCode(): number;
  68137. /**
  68138. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  68139. * @returns the resulting array
  68140. */
  68141. asArray(): number[];
  68142. /**
  68143. * Populates the given array from the given index with the Vector4 coordinates.
  68144. * @param array array to populate
  68145. * @param index index of the array to start at (default: 0)
  68146. * @returns the Vector4.
  68147. */
  68148. toArray(array: FloatArray, index?: number): Vector4;
  68149. /**
  68150. * Adds the given vector to the current Vector4.
  68151. * @param otherVector the vector to add
  68152. * @returns the updated Vector4.
  68153. */
  68154. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  68155. /**
  68156. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  68157. * @param otherVector the vector to add
  68158. * @returns the resulting vector
  68159. */
  68160. add(otherVector: DeepImmutable<Vector4>): Vector4;
  68161. /**
  68162. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  68163. * @param otherVector the vector to add
  68164. * @param result the vector to store the result
  68165. * @returns the current Vector4.
  68166. */
  68167. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  68168. /**
  68169. * Subtract in place the given vector from the current Vector4.
  68170. * @param otherVector the vector to subtract
  68171. * @returns the updated Vector4.
  68172. */
  68173. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  68174. /**
  68175. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  68176. * @param otherVector the vector to add
  68177. * @returns the new vector with the result
  68178. */
  68179. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  68180. /**
  68181. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  68182. * @param otherVector the vector to subtract
  68183. * @param result the vector to store the result
  68184. * @returns the current Vector4.
  68185. */
  68186. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  68187. /**
  68188. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  68189. */
  68190. /**
  68191. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  68192. * @param x value to subtract
  68193. * @param y value to subtract
  68194. * @param z value to subtract
  68195. * @param w value to subtract
  68196. * @returns new vector containing the result
  68197. */
  68198. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  68199. /**
  68200. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  68201. * @param x value to subtract
  68202. * @param y value to subtract
  68203. * @param z value to subtract
  68204. * @param w value to subtract
  68205. * @param result the vector to store the result in
  68206. * @returns the current Vector4.
  68207. */
  68208. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  68209. /**
  68210. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  68211. * @returns a new vector with the negated values
  68212. */
  68213. negate(): Vector4;
  68214. /**
  68215. * Multiplies the current Vector4 coordinates by scale (float).
  68216. * @param scale the number to scale with
  68217. * @returns the updated Vector4.
  68218. */
  68219. scaleInPlace(scale: number): Vector4;
  68220. /**
  68221. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  68222. * @param scale the number to scale with
  68223. * @returns a new vector with the result
  68224. */
  68225. scale(scale: number): Vector4;
  68226. /**
  68227. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  68228. * @param scale the number to scale with
  68229. * @param result a vector to store the result in
  68230. * @returns the current Vector4.
  68231. */
  68232. scaleToRef(scale: number, result: Vector4): Vector4;
  68233. /**
  68234. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  68235. * @param scale defines the scale factor
  68236. * @param result defines the Vector4 object where to store the result
  68237. * @returns the unmodified current Vector4
  68238. */
  68239. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  68240. /**
  68241. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  68242. * @param otherVector the vector to compare against
  68243. * @returns true if they are equal
  68244. */
  68245. equals(otherVector: DeepImmutable<Vector4>): boolean;
  68246. /**
  68247. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  68248. * @param otherVector vector to compare against
  68249. * @param epsilon (Default: very small number)
  68250. * @returns true if they are equal
  68251. */
  68252. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  68253. /**
  68254. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  68255. * @param x x value to compare against
  68256. * @param y y value to compare against
  68257. * @param z z value to compare against
  68258. * @param w w value to compare against
  68259. * @returns true if equal
  68260. */
  68261. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  68262. /**
  68263. * Multiplies in place the current Vector4 by the given one.
  68264. * @param otherVector vector to multiple with
  68265. * @returns the updated Vector4.
  68266. */
  68267. multiplyInPlace(otherVector: Vector4): Vector4;
  68268. /**
  68269. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  68270. * @param otherVector vector to multiple with
  68271. * @returns resulting new vector
  68272. */
  68273. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  68274. /**
  68275. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  68276. * @param otherVector vector to multiple with
  68277. * @param result vector to store the result
  68278. * @returns the current Vector4.
  68279. */
  68280. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  68281. /**
  68282. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  68283. * @param x x value multiply with
  68284. * @param y y value multiply with
  68285. * @param z z value multiply with
  68286. * @param w w value multiply with
  68287. * @returns resulting new vector
  68288. */
  68289. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  68290. /**
  68291. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  68292. * @param otherVector vector to devide with
  68293. * @returns resulting new vector
  68294. */
  68295. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  68296. /**
  68297. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  68298. * @param otherVector vector to devide with
  68299. * @param result vector to store the result
  68300. * @returns the current Vector4.
  68301. */
  68302. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  68303. /**
  68304. * Divides the current Vector3 coordinates by the given ones.
  68305. * @param otherVector vector to devide with
  68306. * @returns the updated Vector3.
  68307. */
  68308. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  68309. /**
  68310. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  68311. * @param other defines the second operand
  68312. * @returns the current updated Vector4
  68313. */
  68314. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  68315. /**
  68316. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  68317. * @param other defines the second operand
  68318. * @returns the current updated Vector4
  68319. */
  68320. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  68321. /**
  68322. * Gets a new Vector4 from current Vector4 floored values
  68323. * @returns a new Vector4
  68324. */
  68325. floor(): Vector4;
  68326. /**
  68327. * Gets a new Vector4 from current Vector3 floored values
  68328. * @returns a new Vector4
  68329. */
  68330. fract(): Vector4;
  68331. /**
  68332. * Returns the Vector4 length (float).
  68333. * @returns the length
  68334. */
  68335. length(): number;
  68336. /**
  68337. * Returns the Vector4 squared length (float).
  68338. * @returns the length squared
  68339. */
  68340. lengthSquared(): number;
  68341. /**
  68342. * Normalizes in place the Vector4.
  68343. * @returns the updated Vector4.
  68344. */
  68345. normalize(): Vector4;
  68346. /**
  68347. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  68348. * @returns this converted to a new vector3
  68349. */
  68350. toVector3(): Vector3;
  68351. /**
  68352. * Returns a new Vector4 copied from the current one.
  68353. * @returns the new cloned vector
  68354. */
  68355. clone(): Vector4;
  68356. /**
  68357. * Updates the current Vector4 with the given one coordinates.
  68358. * @param source the source vector to copy from
  68359. * @returns the updated Vector4.
  68360. */
  68361. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  68362. /**
  68363. * Updates the current Vector4 coordinates with the given floats.
  68364. * @param x float to copy from
  68365. * @param y float to copy from
  68366. * @param z float to copy from
  68367. * @param w float to copy from
  68368. * @returns the updated Vector4.
  68369. */
  68370. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  68371. /**
  68372. * Updates the current Vector4 coordinates with the given floats.
  68373. * @param x float to set from
  68374. * @param y float to set from
  68375. * @param z float to set from
  68376. * @param w float to set from
  68377. * @returns the updated Vector4.
  68378. */
  68379. set(x: number, y: number, z: number, w: number): Vector4;
  68380. /**
  68381. * Copies the given float to the current Vector3 coordinates
  68382. * @param v defines the x, y, z and w coordinates of the operand
  68383. * @returns the current updated Vector3
  68384. */
  68385. setAll(v: number): Vector4;
  68386. /**
  68387. * Returns a new Vector4 set from the starting index of the given array.
  68388. * @param array the array to pull values from
  68389. * @param offset the offset into the array to start at
  68390. * @returns the new vector
  68391. */
  68392. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  68393. /**
  68394. * Updates the given vector "result" from the starting index of the given array.
  68395. * @param array the array to pull values from
  68396. * @param offset the offset into the array to start at
  68397. * @param result the vector to store the result in
  68398. */
  68399. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  68400. /**
  68401. * Updates the given vector "result" from the starting index of the given Float32Array.
  68402. * @param array the array to pull values from
  68403. * @param offset the offset into the array to start at
  68404. * @param result the vector to store the result in
  68405. */
  68406. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  68407. /**
  68408. * Updates the given vector "result" coordinates from the given floats.
  68409. * @param x float to set from
  68410. * @param y float to set from
  68411. * @param z float to set from
  68412. * @param w float to set from
  68413. * @param result the vector to the floats in
  68414. */
  68415. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  68416. /**
  68417. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  68418. * @returns the new vector
  68419. */
  68420. static Zero(): Vector4;
  68421. /**
  68422. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  68423. * @returns the new vector
  68424. */
  68425. static One(): Vector4;
  68426. /**
  68427. * Returns a new normalized Vector4 from the given one.
  68428. * @param vector the vector to normalize
  68429. * @returns the vector
  68430. */
  68431. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  68432. /**
  68433. * Updates the given vector "result" from the normalization of the given one.
  68434. * @param vector the vector to normalize
  68435. * @param result the vector to store the result in
  68436. */
  68437. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  68438. /**
  68439. * Returns a vector with the minimum values from the left and right vectors
  68440. * @param left left vector to minimize
  68441. * @param right right vector to minimize
  68442. * @returns a new vector with the minimum of the left and right vector values
  68443. */
  68444. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  68445. /**
  68446. * Returns a vector with the maximum values from the left and right vectors
  68447. * @param left left vector to maximize
  68448. * @param right right vector to maximize
  68449. * @returns a new vector with the maximum of the left and right vector values
  68450. */
  68451. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  68452. /**
  68453. * Returns the distance (float) between the vectors "value1" and "value2".
  68454. * @param value1 value to calulate the distance between
  68455. * @param value2 value to calulate the distance between
  68456. * @return the distance between the two vectors
  68457. */
  68458. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  68459. /**
  68460. * Returns the squared distance (float) between the vectors "value1" and "value2".
  68461. * @param value1 value to calulate the distance between
  68462. * @param value2 value to calulate the distance between
  68463. * @return the distance between the two vectors squared
  68464. */
  68465. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  68466. /**
  68467. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  68468. * @param value1 value to calulate the center between
  68469. * @param value2 value to calulate the center between
  68470. * @return the center between the two vectors
  68471. */
  68472. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  68473. /**
  68474. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  68475. * This methods computes transformed normalized direction vectors only.
  68476. * @param vector the vector to transform
  68477. * @param transformation the transformation matrix to apply
  68478. * @returns the new vector
  68479. */
  68480. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  68481. /**
  68482. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  68483. * This methods computes transformed normalized direction vectors only.
  68484. * @param vector the vector to transform
  68485. * @param transformation the transformation matrix to apply
  68486. * @param result the vector to store the result in
  68487. */
  68488. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  68489. /**
  68490. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  68491. * This methods computes transformed normalized direction vectors only.
  68492. * @param x value to transform
  68493. * @param y value to transform
  68494. * @param z value to transform
  68495. * @param w value to transform
  68496. * @param transformation the transformation matrix to apply
  68497. * @param result the vector to store the results in
  68498. */
  68499. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  68500. /**
  68501. * Creates a new Vector4 from a Vector3
  68502. * @param source defines the source data
  68503. * @param w defines the 4th component (default is 0)
  68504. * @returns a new Vector4
  68505. */
  68506. static FromVector3(source: Vector3, w?: number): Vector4;
  68507. }
  68508. /**
  68509. * Class used to store quaternion data
  68510. * @see https://en.wikipedia.org/wiki/Quaternion
  68511. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  68512. */
  68513. export class Quaternion {
  68514. /** defines the first component (0 by default) */
  68515. x: number;
  68516. /** defines the second component (0 by default) */
  68517. y: number;
  68518. /** defines the third component (0 by default) */
  68519. z: number;
  68520. /** defines the fourth component (1.0 by default) */
  68521. w: number;
  68522. /**
  68523. * Creates a new Quaternion from the given floats
  68524. * @param x defines the first component (0 by default)
  68525. * @param y defines the second component (0 by default)
  68526. * @param z defines the third component (0 by default)
  68527. * @param w defines the fourth component (1.0 by default)
  68528. */
  68529. constructor(
  68530. /** defines the first component (0 by default) */
  68531. x?: number,
  68532. /** defines the second component (0 by default) */
  68533. y?: number,
  68534. /** defines the third component (0 by default) */
  68535. z?: number,
  68536. /** defines the fourth component (1.0 by default) */
  68537. w?: number);
  68538. /**
  68539. * Gets a string representation for the current quaternion
  68540. * @returns a string with the Quaternion coordinates
  68541. */
  68542. toString(): string;
  68543. /**
  68544. * Gets the class name of the quaternion
  68545. * @returns the string "Quaternion"
  68546. */
  68547. getClassName(): string;
  68548. /**
  68549. * Gets a hash code for this quaternion
  68550. * @returns the quaternion hash code
  68551. */
  68552. getHashCode(): number;
  68553. /**
  68554. * Copy the quaternion to an array
  68555. * @returns a new array populated with 4 elements from the quaternion coordinates
  68556. */
  68557. asArray(): number[];
  68558. /**
  68559. * Check if two quaternions are equals
  68560. * @param otherQuaternion defines the second operand
  68561. * @return true if the current quaternion and the given one coordinates are strictly equals
  68562. */
  68563. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  68564. /**
  68565. * Clone the current quaternion
  68566. * @returns a new quaternion copied from the current one
  68567. */
  68568. clone(): Quaternion;
  68569. /**
  68570. * Copy a quaternion to the current one
  68571. * @param other defines the other quaternion
  68572. * @returns the updated current quaternion
  68573. */
  68574. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  68575. /**
  68576. * Updates the current quaternion with the given float coordinates
  68577. * @param x defines the x coordinate
  68578. * @param y defines the y coordinate
  68579. * @param z defines the z coordinate
  68580. * @param w defines the w coordinate
  68581. * @returns the updated current quaternion
  68582. */
  68583. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  68584. /**
  68585. * Updates the current quaternion from the given float coordinates
  68586. * @param x defines the x coordinate
  68587. * @param y defines the y coordinate
  68588. * @param z defines the z coordinate
  68589. * @param w defines the w coordinate
  68590. * @returns the updated current quaternion
  68591. */
  68592. set(x: number, y: number, z: number, w: number): Quaternion;
  68593. /**
  68594. * Adds two quaternions
  68595. * @param other defines the second operand
  68596. * @returns a new quaternion as the addition result of the given one and the current quaternion
  68597. */
  68598. add(other: DeepImmutable<Quaternion>): Quaternion;
  68599. /**
  68600. * Add a quaternion to the current one
  68601. * @param other defines the quaternion to add
  68602. * @returns the current quaternion
  68603. */
  68604. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  68605. /**
  68606. * Subtract two quaternions
  68607. * @param other defines the second operand
  68608. * @returns a new quaternion as the subtraction result of the given one from the current one
  68609. */
  68610. subtract(other: Quaternion): Quaternion;
  68611. /**
  68612. * Multiplies the current quaternion by a scale factor
  68613. * @param value defines the scale factor
  68614. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  68615. */
  68616. scale(value: number): Quaternion;
  68617. /**
  68618. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  68619. * @param scale defines the scale factor
  68620. * @param result defines the Quaternion object where to store the result
  68621. * @returns the unmodified current quaternion
  68622. */
  68623. scaleToRef(scale: number, result: Quaternion): Quaternion;
  68624. /**
  68625. * Multiplies in place the current quaternion by a scale factor
  68626. * @param value defines the scale factor
  68627. * @returns the current modified quaternion
  68628. */
  68629. scaleInPlace(value: number): Quaternion;
  68630. /**
  68631. * Scale the current quaternion values by a factor and add the result to a given quaternion
  68632. * @param scale defines the scale factor
  68633. * @param result defines the Quaternion object where to store the result
  68634. * @returns the unmodified current quaternion
  68635. */
  68636. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  68637. /**
  68638. * Multiplies two quaternions
  68639. * @param q1 defines the second operand
  68640. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  68641. */
  68642. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  68643. /**
  68644. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  68645. * @param q1 defines the second operand
  68646. * @param result defines the target quaternion
  68647. * @returns the current quaternion
  68648. */
  68649. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  68650. /**
  68651. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  68652. * @param q1 defines the second operand
  68653. * @returns the currentupdated quaternion
  68654. */
  68655. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  68656. /**
  68657. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  68658. * @param ref defines the target quaternion
  68659. * @returns the current quaternion
  68660. */
  68661. conjugateToRef(ref: Quaternion): Quaternion;
  68662. /**
  68663. * Conjugates in place (1-q) the current quaternion
  68664. * @returns the current updated quaternion
  68665. */
  68666. conjugateInPlace(): Quaternion;
  68667. /**
  68668. * Conjugates in place (1-q) the current quaternion
  68669. * @returns a new quaternion
  68670. */
  68671. conjugate(): Quaternion;
  68672. /**
  68673. * Gets length of current quaternion
  68674. * @returns the quaternion length (float)
  68675. */
  68676. length(): number;
  68677. /**
  68678. * Normalize in place the current quaternion
  68679. * @returns the current updated quaternion
  68680. */
  68681. normalize(): Quaternion;
  68682. /**
  68683. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  68684. * @param order is a reserved parameter and is ignore for now
  68685. * @returns a new Vector3 containing the Euler angles
  68686. */
  68687. toEulerAngles(order?: string): Vector3;
  68688. /**
  68689. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  68690. * @param result defines the vector which will be filled with the Euler angles
  68691. * @param order is a reserved parameter and is ignore for now
  68692. * @returns the current unchanged quaternion
  68693. */
  68694. toEulerAnglesToRef(result: Vector3): Quaternion;
  68695. /**
  68696. * Updates the given rotation matrix with the current quaternion values
  68697. * @param result defines the target matrix
  68698. * @returns the current unchanged quaternion
  68699. */
  68700. toRotationMatrix(result: Matrix): Quaternion;
  68701. /**
  68702. * Updates the current quaternion from the given rotation matrix values
  68703. * @param matrix defines the source matrix
  68704. * @returns the current updated quaternion
  68705. */
  68706. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  68707. /**
  68708. * Creates a new quaternion from a rotation matrix
  68709. * @param matrix defines the source matrix
  68710. * @returns a new quaternion created from the given rotation matrix values
  68711. */
  68712. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  68713. /**
  68714. * Updates the given quaternion with the given rotation matrix values
  68715. * @param matrix defines the source matrix
  68716. * @param result defines the target quaternion
  68717. */
  68718. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  68719. /**
  68720. * Returns the dot product (float) between the quaternions "left" and "right"
  68721. * @param left defines the left operand
  68722. * @param right defines the right operand
  68723. * @returns the dot product
  68724. */
  68725. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  68726. /**
  68727. * Checks if the two quaternions are close to each other
  68728. * @param quat0 defines the first quaternion to check
  68729. * @param quat1 defines the second quaternion to check
  68730. * @returns true if the two quaternions are close to each other
  68731. */
  68732. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  68733. /**
  68734. * Creates an empty quaternion
  68735. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  68736. */
  68737. static Zero(): Quaternion;
  68738. /**
  68739. * Inverse a given quaternion
  68740. * @param q defines the source quaternion
  68741. * @returns a new quaternion as the inverted current quaternion
  68742. */
  68743. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  68744. /**
  68745. * Inverse a given quaternion
  68746. * @param q defines the source quaternion
  68747. * @param result the quaternion the result will be stored in
  68748. * @returns the result quaternion
  68749. */
  68750. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  68751. /**
  68752. * Creates an identity quaternion
  68753. * @returns the identity quaternion
  68754. */
  68755. static Identity(): Quaternion;
  68756. /**
  68757. * Gets a boolean indicating if the given quaternion is identity
  68758. * @param quaternion defines the quaternion to check
  68759. * @returns true if the quaternion is identity
  68760. */
  68761. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  68762. /**
  68763. * Creates a quaternion from a rotation around an axis
  68764. * @param axis defines the axis to use
  68765. * @param angle defines the angle to use
  68766. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  68767. */
  68768. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  68769. /**
  68770. * Creates a rotation around an axis and stores it into the given quaternion
  68771. * @param axis defines the axis to use
  68772. * @param angle defines the angle to use
  68773. * @param result defines the target quaternion
  68774. * @returns the target quaternion
  68775. */
  68776. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  68777. /**
  68778. * Creates a new quaternion from data stored into an array
  68779. * @param array defines the data source
  68780. * @param offset defines the offset in the source array where the data starts
  68781. * @returns a new quaternion
  68782. */
  68783. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  68784. /**
  68785. * Create a quaternion from Euler rotation angles
  68786. * @param x Pitch
  68787. * @param y Yaw
  68788. * @param z Roll
  68789. * @returns the new Quaternion
  68790. */
  68791. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  68792. /**
  68793. * Updates a quaternion from Euler rotation angles
  68794. * @param x Pitch
  68795. * @param y Yaw
  68796. * @param z Roll
  68797. * @param result the quaternion to store the result
  68798. * @returns the updated quaternion
  68799. */
  68800. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  68801. /**
  68802. * Create a quaternion from Euler rotation vector
  68803. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  68804. * @returns the new Quaternion
  68805. */
  68806. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  68807. /**
  68808. * Updates a quaternion from Euler rotation vector
  68809. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  68810. * @param result the quaternion to store the result
  68811. * @returns the updated quaternion
  68812. */
  68813. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  68814. /**
  68815. * Creates a new quaternion from the given Euler float angles (y, x, z)
  68816. * @param yaw defines the rotation around Y axis
  68817. * @param pitch defines the rotation around X axis
  68818. * @param roll defines the rotation around Z axis
  68819. * @returns the new quaternion
  68820. */
  68821. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  68822. /**
  68823. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  68824. * @param yaw defines the rotation around Y axis
  68825. * @param pitch defines the rotation around X axis
  68826. * @param roll defines the rotation around Z axis
  68827. * @param result defines the target quaternion
  68828. */
  68829. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  68830. /**
  68831. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  68832. * @param alpha defines the rotation around first axis
  68833. * @param beta defines the rotation around second axis
  68834. * @param gamma defines the rotation around third axis
  68835. * @returns the new quaternion
  68836. */
  68837. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  68838. /**
  68839. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  68840. * @param alpha defines the rotation around first axis
  68841. * @param beta defines the rotation around second axis
  68842. * @param gamma defines the rotation around third axis
  68843. * @param result defines the target quaternion
  68844. */
  68845. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  68846. /**
  68847. * 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)
  68848. * @param axis1 defines the first axis
  68849. * @param axis2 defines the second axis
  68850. * @param axis3 defines the third axis
  68851. * @returns the new quaternion
  68852. */
  68853. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  68854. /**
  68855. * 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
  68856. * @param axis1 defines the first axis
  68857. * @param axis2 defines the second axis
  68858. * @param axis3 defines the third axis
  68859. * @param ref defines the target quaternion
  68860. */
  68861. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  68862. /**
  68863. * Interpolates between two quaternions
  68864. * @param left defines first quaternion
  68865. * @param right defines second quaternion
  68866. * @param amount defines the gradient to use
  68867. * @returns the new interpolated quaternion
  68868. */
  68869. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  68870. /**
  68871. * Interpolates between two quaternions and stores it into a target quaternion
  68872. * @param left defines first quaternion
  68873. * @param right defines second quaternion
  68874. * @param amount defines the gradient to use
  68875. * @param result defines the target quaternion
  68876. */
  68877. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  68878. /**
  68879. * Interpolate between two quaternions using Hermite interpolation
  68880. * @param value1 defines first quaternion
  68881. * @param tangent1 defines the incoming tangent
  68882. * @param value2 defines second quaternion
  68883. * @param tangent2 defines the outgoing tangent
  68884. * @param amount defines the target quaternion
  68885. * @returns the new interpolated quaternion
  68886. */
  68887. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  68888. }
  68889. /**
  68890. * Class used to store matrix data (4x4)
  68891. */
  68892. export class Matrix {
  68893. private static _updateFlagSeed;
  68894. private static _identityReadOnly;
  68895. private _isIdentity;
  68896. private _isIdentityDirty;
  68897. private _isIdentity3x2;
  68898. private _isIdentity3x2Dirty;
  68899. /**
  68900. * Gets the update flag of the matrix which is an unique number for the matrix.
  68901. * It will be incremented every time the matrix data change.
  68902. * You can use it to speed the comparison between two versions of the same matrix.
  68903. */
  68904. updateFlag: number;
  68905. private readonly _m;
  68906. /**
  68907. * Gets the internal data of the matrix
  68908. */
  68909. readonly m: DeepImmutable<Float32Array>;
  68910. /** @hidden */
  68911. _markAsUpdated(): void;
  68912. /** @hidden */
  68913. private _updateIdentityStatus;
  68914. /**
  68915. * Creates an empty matrix (filled with zeros)
  68916. */
  68917. constructor();
  68918. /**
  68919. * Check if the current matrix is identity
  68920. * @returns true is the matrix is the identity matrix
  68921. */
  68922. isIdentity(): boolean;
  68923. /**
  68924. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  68925. * @returns true is the matrix is the identity matrix
  68926. */
  68927. isIdentityAs3x2(): boolean;
  68928. /**
  68929. * Gets the determinant of the matrix
  68930. * @returns the matrix determinant
  68931. */
  68932. determinant(): number;
  68933. /**
  68934. * Returns the matrix as a Float32Array
  68935. * @returns the matrix underlying array
  68936. */
  68937. toArray(): DeepImmutable<Float32Array>;
  68938. /**
  68939. * Returns the matrix as a Float32Array
  68940. * @returns the matrix underlying array.
  68941. */
  68942. asArray(): DeepImmutable<Float32Array>;
  68943. /**
  68944. * Inverts the current matrix in place
  68945. * @returns the current inverted matrix
  68946. */
  68947. invert(): Matrix;
  68948. /**
  68949. * Sets all the matrix elements to zero
  68950. * @returns the current matrix
  68951. */
  68952. reset(): Matrix;
  68953. /**
  68954. * Adds the current matrix with a second one
  68955. * @param other defines the matrix to add
  68956. * @returns a new matrix as the addition of the current matrix and the given one
  68957. */
  68958. add(other: DeepImmutable<Matrix>): Matrix;
  68959. /**
  68960. * Sets the given matrix "result" to the addition of the current matrix and the given one
  68961. * @param other defines the matrix to add
  68962. * @param result defines the target matrix
  68963. * @returns the current matrix
  68964. */
  68965. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  68966. /**
  68967. * Adds in place the given matrix to the current matrix
  68968. * @param other defines the second operand
  68969. * @returns the current updated matrix
  68970. */
  68971. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  68972. /**
  68973. * Sets the given matrix to the current inverted Matrix
  68974. * @param other defines the target matrix
  68975. * @returns the unmodified current matrix
  68976. */
  68977. invertToRef(other: Matrix): Matrix;
  68978. /**
  68979. * add a value at the specified position in the current Matrix
  68980. * @param index the index of the value within the matrix. between 0 and 15.
  68981. * @param value the value to be added
  68982. * @returns the current updated matrix
  68983. */
  68984. addAtIndex(index: number, value: number): Matrix;
  68985. /**
  68986. * mutiply the specified position in the current Matrix by a value
  68987. * @param index the index of the value within the matrix. between 0 and 15.
  68988. * @param value the value to be added
  68989. * @returns the current updated matrix
  68990. */
  68991. multiplyAtIndex(index: number, value: number): Matrix;
  68992. /**
  68993. * Inserts the translation vector (using 3 floats) in the current matrix
  68994. * @param x defines the 1st component of the translation
  68995. * @param y defines the 2nd component of the translation
  68996. * @param z defines the 3rd component of the translation
  68997. * @returns the current updated matrix
  68998. */
  68999. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  69000. /**
  69001. * Adds the translation vector (using 3 floats) in the current matrix
  69002. * @param x defines the 1st component of the translation
  69003. * @param y defines the 2nd component of the translation
  69004. * @param z defines the 3rd component of the translation
  69005. * @returns the current updated matrix
  69006. */
  69007. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  69008. /**
  69009. * Inserts the translation vector in the current matrix
  69010. * @param vector3 defines the translation to insert
  69011. * @returns the current updated matrix
  69012. */
  69013. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  69014. /**
  69015. * Gets the translation value of the current matrix
  69016. * @returns a new Vector3 as the extracted translation from the matrix
  69017. */
  69018. getTranslation(): Vector3;
  69019. /**
  69020. * Fill a Vector3 with the extracted translation from the matrix
  69021. * @param result defines the Vector3 where to store the translation
  69022. * @returns the current matrix
  69023. */
  69024. getTranslationToRef(result: Vector3): Matrix;
  69025. /**
  69026. * Remove rotation and scaling part from the matrix
  69027. * @returns the updated matrix
  69028. */
  69029. removeRotationAndScaling(): Matrix;
  69030. /**
  69031. * Multiply two matrices
  69032. * @param other defines the second operand
  69033. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  69034. */
  69035. multiply(other: DeepImmutable<Matrix>): Matrix;
  69036. /**
  69037. * Copy the current matrix from the given one
  69038. * @param other defines the source matrix
  69039. * @returns the current updated matrix
  69040. */
  69041. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  69042. /**
  69043. * Populates the given array from the starting index with the current matrix values
  69044. * @param array defines the target array
  69045. * @param offset defines the offset in the target array where to start storing values
  69046. * @returns the current matrix
  69047. */
  69048. copyToArray(array: Float32Array, offset?: number): Matrix;
  69049. /**
  69050. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  69051. * @param other defines the second operand
  69052. * @param result defines the matrix where to store the multiplication
  69053. * @returns the current matrix
  69054. */
  69055. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  69056. /**
  69057. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  69058. * @param other defines the second operand
  69059. * @param result defines the array where to store the multiplication
  69060. * @param offset defines the offset in the target array where to start storing values
  69061. * @returns the current matrix
  69062. */
  69063. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  69064. /**
  69065. * Check equality between this matrix and a second one
  69066. * @param value defines the second matrix to compare
  69067. * @returns true is the current matrix and the given one values are strictly equal
  69068. */
  69069. equals(value: DeepImmutable<Matrix>): boolean;
  69070. /**
  69071. * Clone the current matrix
  69072. * @returns a new matrix from the current matrix
  69073. */
  69074. clone(): Matrix;
  69075. /**
  69076. * Returns the name of the current matrix class
  69077. * @returns the string "Matrix"
  69078. */
  69079. getClassName(): string;
  69080. /**
  69081. * Gets the hash code of the current matrix
  69082. * @returns the hash code
  69083. */
  69084. getHashCode(): number;
  69085. /**
  69086. * Decomposes the current Matrix into a translation, rotation and scaling components
  69087. * @param scale defines the scale vector3 given as a reference to update
  69088. * @param rotation defines the rotation quaternion given as a reference to update
  69089. * @param translation defines the translation vector3 given as a reference to update
  69090. * @returns true if operation was successful
  69091. */
  69092. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  69093. /**
  69094. * Gets specific row of the matrix
  69095. * @param index defines the number of the row to get
  69096. * @returns the index-th row of the current matrix as a new Vector4
  69097. */
  69098. getRow(index: number): Nullable<Vector4>;
  69099. /**
  69100. * Sets the index-th row of the current matrix to the vector4 values
  69101. * @param index defines the number of the row to set
  69102. * @param row defines the target vector4
  69103. * @returns the updated current matrix
  69104. */
  69105. setRow(index: number, row: Vector4): Matrix;
  69106. /**
  69107. * Compute the transpose of the matrix
  69108. * @returns the new transposed matrix
  69109. */
  69110. transpose(): Matrix;
  69111. /**
  69112. * Compute the transpose of the matrix and store it in a given matrix
  69113. * @param result defines the target matrix
  69114. * @returns the current matrix
  69115. */
  69116. transposeToRef(result: Matrix): Matrix;
  69117. /**
  69118. * Sets the index-th row of the current matrix with the given 4 x float values
  69119. * @param index defines the row index
  69120. * @param x defines the x component to set
  69121. * @param y defines the y component to set
  69122. * @param z defines the z component to set
  69123. * @param w defines the w component to set
  69124. * @returns the updated current matrix
  69125. */
  69126. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  69127. /**
  69128. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  69129. * @param scale defines the scale factor
  69130. * @returns a new matrix
  69131. */
  69132. scale(scale: number): Matrix;
  69133. /**
  69134. * Scale the current matrix values by a factor to a given result matrix
  69135. * @param scale defines the scale factor
  69136. * @param result defines the matrix to store the result
  69137. * @returns the current matrix
  69138. */
  69139. scaleToRef(scale: number, result: Matrix): Matrix;
  69140. /**
  69141. * Scale the current matrix values by a factor and add the result to a given matrix
  69142. * @param scale defines the scale factor
  69143. * @param result defines the Matrix to store the result
  69144. * @returns the current matrix
  69145. */
  69146. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  69147. /**
  69148. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  69149. * @param ref matrix to store the result
  69150. */
  69151. toNormalMatrix(ref: Matrix): void;
  69152. /**
  69153. * Gets only rotation part of the current matrix
  69154. * @returns a new matrix sets to the extracted rotation matrix from the current one
  69155. */
  69156. getRotationMatrix(): Matrix;
  69157. /**
  69158. * Extracts the rotation matrix from the current one and sets it as the given "result"
  69159. * @param result defines the target matrix to store data to
  69160. * @returns the current matrix
  69161. */
  69162. getRotationMatrixToRef(result: Matrix): Matrix;
  69163. /**
  69164. * Toggles model matrix from being right handed to left handed in place and vice versa
  69165. */
  69166. toggleModelMatrixHandInPlace(): void;
  69167. /**
  69168. * Toggles projection matrix from being right handed to left handed in place and vice versa
  69169. */
  69170. toggleProjectionMatrixHandInPlace(): void;
  69171. /**
  69172. * Creates a matrix from an array
  69173. * @param array defines the source array
  69174. * @param offset defines an offset in the source array
  69175. * @returns a new Matrix set from the starting index of the given array
  69176. */
  69177. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  69178. /**
  69179. * Copy the content of an array into a given matrix
  69180. * @param array defines the source array
  69181. * @param offset defines an offset in the source array
  69182. * @param result defines the target matrix
  69183. */
  69184. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  69185. /**
  69186. * Stores an array into a matrix after having multiplied each component by a given factor
  69187. * @param array defines the source array
  69188. * @param offset defines the offset in the source array
  69189. * @param scale defines the scaling factor
  69190. * @param result defines the target matrix
  69191. */
  69192. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  69193. /**
  69194. * Gets an identity matrix that must not be updated
  69195. */
  69196. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  69197. /**
  69198. * Stores a list of values (16) inside a given matrix
  69199. * @param initialM11 defines 1st value of 1st row
  69200. * @param initialM12 defines 2nd value of 1st row
  69201. * @param initialM13 defines 3rd value of 1st row
  69202. * @param initialM14 defines 4th value of 1st row
  69203. * @param initialM21 defines 1st value of 2nd row
  69204. * @param initialM22 defines 2nd value of 2nd row
  69205. * @param initialM23 defines 3rd value of 2nd row
  69206. * @param initialM24 defines 4th value of 2nd row
  69207. * @param initialM31 defines 1st value of 3rd row
  69208. * @param initialM32 defines 2nd value of 3rd row
  69209. * @param initialM33 defines 3rd value of 3rd row
  69210. * @param initialM34 defines 4th value of 3rd row
  69211. * @param initialM41 defines 1st value of 4th row
  69212. * @param initialM42 defines 2nd value of 4th row
  69213. * @param initialM43 defines 3rd value of 4th row
  69214. * @param initialM44 defines 4th value of 4th row
  69215. * @param result defines the target matrix
  69216. */
  69217. 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;
  69218. /**
  69219. * Creates new matrix from a list of values (16)
  69220. * @param initialM11 defines 1st value of 1st row
  69221. * @param initialM12 defines 2nd value of 1st row
  69222. * @param initialM13 defines 3rd value of 1st row
  69223. * @param initialM14 defines 4th value of 1st row
  69224. * @param initialM21 defines 1st value of 2nd row
  69225. * @param initialM22 defines 2nd value of 2nd row
  69226. * @param initialM23 defines 3rd value of 2nd row
  69227. * @param initialM24 defines 4th value of 2nd row
  69228. * @param initialM31 defines 1st value of 3rd row
  69229. * @param initialM32 defines 2nd value of 3rd row
  69230. * @param initialM33 defines 3rd value of 3rd row
  69231. * @param initialM34 defines 4th value of 3rd row
  69232. * @param initialM41 defines 1st value of 4th row
  69233. * @param initialM42 defines 2nd value of 4th row
  69234. * @param initialM43 defines 3rd value of 4th row
  69235. * @param initialM44 defines 4th value of 4th row
  69236. * @returns the new matrix
  69237. */
  69238. 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;
  69239. /**
  69240. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  69241. * @param scale defines the scale vector3
  69242. * @param rotation defines the rotation quaternion
  69243. * @param translation defines the translation vector3
  69244. * @returns a new matrix
  69245. */
  69246. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  69247. /**
  69248. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  69249. * @param scale defines the scale vector3
  69250. * @param rotation defines the rotation quaternion
  69251. * @param translation defines the translation vector3
  69252. * @param result defines the target matrix
  69253. */
  69254. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  69255. /**
  69256. * Creates a new identity matrix
  69257. * @returns a new identity matrix
  69258. */
  69259. static Identity(): Matrix;
  69260. /**
  69261. * Creates a new identity matrix and stores the result in a given matrix
  69262. * @param result defines the target matrix
  69263. */
  69264. static IdentityToRef(result: Matrix): void;
  69265. /**
  69266. * Creates a new zero matrix
  69267. * @returns a new zero matrix
  69268. */
  69269. static Zero(): Matrix;
  69270. /**
  69271. * Creates a new rotation matrix for "angle" radians around the X axis
  69272. * @param angle defines the angle (in radians) to use
  69273. * @return the new matrix
  69274. */
  69275. static RotationX(angle: number): Matrix;
  69276. /**
  69277. * Creates a new matrix as the invert of a given matrix
  69278. * @param source defines the source matrix
  69279. * @returns the new matrix
  69280. */
  69281. static Invert(source: DeepImmutable<Matrix>): Matrix;
  69282. /**
  69283. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  69284. * @param angle defines the angle (in radians) to use
  69285. * @param result defines the target matrix
  69286. */
  69287. static RotationXToRef(angle: number, result: Matrix): void;
  69288. /**
  69289. * Creates a new rotation matrix for "angle" radians around the Y axis
  69290. * @param angle defines the angle (in radians) to use
  69291. * @return the new matrix
  69292. */
  69293. static RotationY(angle: number): Matrix;
  69294. /**
  69295. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  69296. * @param angle defines the angle (in radians) to use
  69297. * @param result defines the target matrix
  69298. */
  69299. static RotationYToRef(angle: number, result: Matrix): void;
  69300. /**
  69301. * Creates a new rotation matrix for "angle" radians around the Z axis
  69302. * @param angle defines the angle (in radians) to use
  69303. * @return the new matrix
  69304. */
  69305. static RotationZ(angle: number): Matrix;
  69306. /**
  69307. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  69308. * @param angle defines the angle (in radians) to use
  69309. * @param result defines the target matrix
  69310. */
  69311. static RotationZToRef(angle: number, result: Matrix): void;
  69312. /**
  69313. * Creates a new rotation matrix for "angle" radians around the given axis
  69314. * @param axis defines the axis to use
  69315. * @param angle defines the angle (in radians) to use
  69316. * @return the new matrix
  69317. */
  69318. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  69319. /**
  69320. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  69321. * @param axis defines the axis to use
  69322. * @param angle defines the angle (in radians) to use
  69323. * @param result defines the target matrix
  69324. */
  69325. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  69326. /**
  69327. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  69328. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  69329. * @param from defines the vector to align
  69330. * @param to defines the vector to align to
  69331. * @param result defines the target matrix
  69332. */
  69333. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  69334. /**
  69335. * Creates a rotation matrix
  69336. * @param yaw defines the yaw angle in radians (Y axis)
  69337. * @param pitch defines the pitch angle in radians (X axis)
  69338. * @param roll defines the roll angle in radians (X axis)
  69339. * @returns the new rotation matrix
  69340. */
  69341. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  69342. /**
  69343. * Creates a rotation matrix and stores it in a given matrix
  69344. * @param yaw defines the yaw angle in radians (Y axis)
  69345. * @param pitch defines the pitch angle in radians (X axis)
  69346. * @param roll defines the roll angle in radians (X axis)
  69347. * @param result defines the target matrix
  69348. */
  69349. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  69350. /**
  69351. * Creates a scaling matrix
  69352. * @param x defines the scale factor on X axis
  69353. * @param y defines the scale factor on Y axis
  69354. * @param z defines the scale factor on Z axis
  69355. * @returns the new matrix
  69356. */
  69357. static Scaling(x: number, y: number, z: number): Matrix;
  69358. /**
  69359. * Creates a scaling matrix and stores it in a given matrix
  69360. * @param x defines the scale factor on X axis
  69361. * @param y defines the scale factor on Y axis
  69362. * @param z defines the scale factor on Z axis
  69363. * @param result defines the target matrix
  69364. */
  69365. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  69366. /**
  69367. * Creates a translation matrix
  69368. * @param x defines the translation on X axis
  69369. * @param y defines the translation on Y axis
  69370. * @param z defines the translationon Z axis
  69371. * @returns the new matrix
  69372. */
  69373. static Translation(x: number, y: number, z: number): Matrix;
  69374. /**
  69375. * Creates a translation matrix and stores it in a given matrix
  69376. * @param x defines the translation on X axis
  69377. * @param y defines the translation on Y axis
  69378. * @param z defines the translationon Z axis
  69379. * @param result defines the target matrix
  69380. */
  69381. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  69382. /**
  69383. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  69384. * @param startValue defines the start value
  69385. * @param endValue defines the end value
  69386. * @param gradient defines the gradient factor
  69387. * @returns the new matrix
  69388. */
  69389. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  69390. /**
  69391. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  69392. * @param startValue defines the start value
  69393. * @param endValue defines the end value
  69394. * @param gradient defines the gradient factor
  69395. * @param result defines the Matrix object where to store data
  69396. */
  69397. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  69398. /**
  69399. * Builds a new matrix whose values are computed by:
  69400. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  69401. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  69402. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  69403. * @param startValue defines the first matrix
  69404. * @param endValue defines the second matrix
  69405. * @param gradient defines the gradient between the two matrices
  69406. * @returns the new matrix
  69407. */
  69408. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  69409. /**
  69410. * Update a matrix to values which are computed by:
  69411. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  69412. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  69413. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  69414. * @param startValue defines the first matrix
  69415. * @param endValue defines the second matrix
  69416. * @param gradient defines the gradient between the two matrices
  69417. * @param result defines the target matrix
  69418. */
  69419. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  69420. /**
  69421. * 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"
  69422. * This function works in left handed mode
  69423. * @param eye defines the final position of the entity
  69424. * @param target defines where the entity should look at
  69425. * @param up defines the up vector for the entity
  69426. * @returns the new matrix
  69427. */
  69428. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  69429. /**
  69430. * 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".
  69431. * This function works in left handed mode
  69432. * @param eye defines the final position of the entity
  69433. * @param target defines where the entity should look at
  69434. * @param up defines the up vector for the entity
  69435. * @param result defines the target matrix
  69436. */
  69437. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  69438. /**
  69439. * 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"
  69440. * This function works in right handed mode
  69441. * @param eye defines the final position of the entity
  69442. * @param target defines where the entity should look at
  69443. * @param up defines the up vector for the entity
  69444. * @returns the new matrix
  69445. */
  69446. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  69447. /**
  69448. * 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".
  69449. * This function works in right handed mode
  69450. * @param eye defines the final position of the entity
  69451. * @param target defines where the entity should look at
  69452. * @param up defines the up vector for the entity
  69453. * @param result defines the target matrix
  69454. */
  69455. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  69456. /**
  69457. * Create a left-handed orthographic projection matrix
  69458. * @param width defines the viewport width
  69459. * @param height defines the viewport height
  69460. * @param znear defines the near clip plane
  69461. * @param zfar defines the far clip plane
  69462. * @returns a new matrix as a left-handed orthographic projection matrix
  69463. */
  69464. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  69465. /**
  69466. * Store a left-handed orthographic projection to a given matrix
  69467. * @param width defines the viewport width
  69468. * @param height defines the viewport height
  69469. * @param znear defines the near clip plane
  69470. * @param zfar defines the far clip plane
  69471. * @param result defines the target matrix
  69472. */
  69473. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  69474. /**
  69475. * Create a left-handed orthographic projection matrix
  69476. * @param left defines the viewport left coordinate
  69477. * @param right defines the viewport right coordinate
  69478. * @param bottom defines the viewport bottom coordinate
  69479. * @param top defines the viewport top coordinate
  69480. * @param znear defines the near clip plane
  69481. * @param zfar defines the far clip plane
  69482. * @returns a new matrix as a left-handed orthographic projection matrix
  69483. */
  69484. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  69485. /**
  69486. * Stores a left-handed orthographic projection into a given matrix
  69487. * @param left defines the viewport left coordinate
  69488. * @param right defines the viewport right coordinate
  69489. * @param bottom defines the viewport bottom coordinate
  69490. * @param top defines the viewport top coordinate
  69491. * @param znear defines the near clip plane
  69492. * @param zfar defines the far clip plane
  69493. * @param result defines the target matrix
  69494. */
  69495. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  69496. /**
  69497. * Creates a right-handed orthographic projection matrix
  69498. * @param left defines the viewport left coordinate
  69499. * @param right defines the viewport right coordinate
  69500. * @param bottom defines the viewport bottom coordinate
  69501. * @param top defines the viewport top coordinate
  69502. * @param znear defines the near clip plane
  69503. * @param zfar defines the far clip plane
  69504. * @returns a new matrix as a right-handed orthographic projection matrix
  69505. */
  69506. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  69507. /**
  69508. * Stores a right-handed orthographic projection into a given matrix
  69509. * @param left defines the viewport left coordinate
  69510. * @param right defines the viewport right coordinate
  69511. * @param bottom defines the viewport bottom coordinate
  69512. * @param top defines the viewport top coordinate
  69513. * @param znear defines the near clip plane
  69514. * @param zfar defines the far clip plane
  69515. * @param result defines the target matrix
  69516. */
  69517. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  69518. /**
  69519. * Creates a left-handed perspective projection matrix
  69520. * @param width defines the viewport width
  69521. * @param height defines the viewport height
  69522. * @param znear defines the near clip plane
  69523. * @param zfar defines the far clip plane
  69524. * @returns a new matrix as a left-handed perspective projection matrix
  69525. */
  69526. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  69527. /**
  69528. * Creates a left-handed perspective projection matrix
  69529. * @param fov defines the horizontal field of view
  69530. * @param aspect defines the aspect ratio
  69531. * @param znear defines the near clip plane
  69532. * @param zfar defines the far clip plane
  69533. * @returns a new matrix as a left-handed perspective projection matrix
  69534. */
  69535. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  69536. /**
  69537. * Stores a left-handed perspective projection into a given matrix
  69538. * @param fov defines the horizontal field of view
  69539. * @param aspect defines the aspect ratio
  69540. * @param znear defines the near clip plane
  69541. * @param zfar defines the far clip plane
  69542. * @param result defines the target matrix
  69543. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  69544. */
  69545. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  69546. /**
  69547. * Creates a right-handed perspective projection matrix
  69548. * @param fov defines the horizontal field of view
  69549. * @param aspect defines the aspect ratio
  69550. * @param znear defines the near clip plane
  69551. * @param zfar defines the far clip plane
  69552. * @returns a new matrix as a right-handed perspective projection matrix
  69553. */
  69554. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  69555. /**
  69556. * Stores a right-handed perspective projection into a given matrix
  69557. * @param fov defines the horizontal field of view
  69558. * @param aspect defines the aspect ratio
  69559. * @param znear defines the near clip plane
  69560. * @param zfar defines the far clip plane
  69561. * @param result defines the target matrix
  69562. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  69563. */
  69564. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  69565. /**
  69566. * Stores a perspective projection for WebVR info a given matrix
  69567. * @param fov defines the field of view
  69568. * @param znear defines the near clip plane
  69569. * @param zfar defines the far clip plane
  69570. * @param result defines the target matrix
  69571. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  69572. */
  69573. static PerspectiveFovWebVRToRef(fov: {
  69574. upDegrees: number;
  69575. downDegrees: number;
  69576. leftDegrees: number;
  69577. rightDegrees: number;
  69578. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  69579. /**
  69580. * Computes a complete transformation matrix
  69581. * @param viewport defines the viewport to use
  69582. * @param world defines the world matrix
  69583. * @param view defines the view matrix
  69584. * @param projection defines the projection matrix
  69585. * @param zmin defines the near clip plane
  69586. * @param zmax defines the far clip plane
  69587. * @returns the transformation matrix
  69588. */
  69589. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  69590. /**
  69591. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  69592. * @param matrix defines the matrix to use
  69593. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  69594. */
  69595. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  69596. /**
  69597. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  69598. * @param matrix defines the matrix to use
  69599. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  69600. */
  69601. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  69602. /**
  69603. * Compute the transpose of a given matrix
  69604. * @param matrix defines the matrix to transpose
  69605. * @returns the new matrix
  69606. */
  69607. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  69608. /**
  69609. * Compute the transpose of a matrix and store it in a target matrix
  69610. * @param matrix defines the matrix to transpose
  69611. * @param result defines the target matrix
  69612. */
  69613. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  69614. /**
  69615. * Computes a reflection matrix from a plane
  69616. * @param plane defines the reflection plane
  69617. * @returns a new matrix
  69618. */
  69619. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  69620. /**
  69621. * Computes a reflection matrix from a plane
  69622. * @param plane defines the reflection plane
  69623. * @param result defines the target matrix
  69624. */
  69625. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  69626. /**
  69627. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  69628. * @param xaxis defines the value of the 1st axis
  69629. * @param yaxis defines the value of the 2nd axis
  69630. * @param zaxis defines the value of the 3rd axis
  69631. * @param result defines the target matrix
  69632. */
  69633. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  69634. /**
  69635. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  69636. * @param quat defines the quaternion to use
  69637. * @param result defines the target matrix
  69638. */
  69639. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  69640. }
  69641. /**
  69642. * @hidden
  69643. */
  69644. export class TmpVectors {
  69645. static Vector2: Vector2[];
  69646. static Vector3: Vector3[];
  69647. static Vector4: Vector4[];
  69648. static Quaternion: Quaternion[];
  69649. static Matrix: Matrix[];
  69650. }
  69651. }
  69652. declare module BABYLON {
  69653. /** Defines the cross module used constants to avoid circular dependncies */
  69654. export class Constants {
  69655. /** Defines that alpha blending is disabled */
  69656. static readonly ALPHA_DISABLE: number;
  69657. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  69658. static readonly ALPHA_ADD: number;
  69659. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  69660. static readonly ALPHA_COMBINE: number;
  69661. /** Defines that alpha blending to DEST - SRC * DEST */
  69662. static readonly ALPHA_SUBTRACT: number;
  69663. /** Defines that alpha blending to SRC * DEST */
  69664. static readonly ALPHA_MULTIPLY: number;
  69665. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  69666. static readonly ALPHA_MAXIMIZED: number;
  69667. /** Defines that alpha blending to SRC + DEST */
  69668. static readonly ALPHA_ONEONE: number;
  69669. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  69670. static readonly ALPHA_PREMULTIPLIED: number;
  69671. /**
  69672. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  69673. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  69674. */
  69675. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  69676. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  69677. static readonly ALPHA_INTERPOLATE: number;
  69678. /**
  69679. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  69680. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  69681. */
  69682. static readonly ALPHA_SCREENMODE: number;
  69683. /** Defines that the ressource is not delayed*/
  69684. static readonly DELAYLOADSTATE_NONE: number;
  69685. /** Defines that the ressource was successfully delay loaded */
  69686. static readonly DELAYLOADSTATE_LOADED: number;
  69687. /** Defines that the ressource is currently delay loading */
  69688. static readonly DELAYLOADSTATE_LOADING: number;
  69689. /** Defines that the ressource is delayed and has not started loading */
  69690. static readonly DELAYLOADSTATE_NOTLOADED: number;
  69691. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  69692. static readonly NEVER: number;
  69693. /** 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 */
  69694. static readonly ALWAYS: number;
  69695. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  69696. static readonly LESS: number;
  69697. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  69698. static readonly EQUAL: number;
  69699. /** 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 */
  69700. static readonly LEQUAL: number;
  69701. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  69702. static readonly GREATER: number;
  69703. /** 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 */
  69704. static readonly GEQUAL: number;
  69705. /** 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 */
  69706. static readonly NOTEQUAL: number;
  69707. /** Passed to stencilOperation to specify that stencil value must be kept */
  69708. static readonly KEEP: number;
  69709. /** Passed to stencilOperation to specify that stencil value must be replaced */
  69710. static readonly REPLACE: number;
  69711. /** Passed to stencilOperation to specify that stencil value must be incremented */
  69712. static readonly INCR: number;
  69713. /** Passed to stencilOperation to specify that stencil value must be decremented */
  69714. static readonly DECR: number;
  69715. /** Passed to stencilOperation to specify that stencil value must be inverted */
  69716. static readonly INVERT: number;
  69717. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  69718. static readonly INCR_WRAP: number;
  69719. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  69720. static readonly DECR_WRAP: number;
  69721. /** Texture is not repeating outside of 0..1 UVs */
  69722. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  69723. /** Texture is repeating outside of 0..1 UVs */
  69724. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  69725. /** Texture is repeating and mirrored */
  69726. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  69727. /** ALPHA */
  69728. static readonly TEXTUREFORMAT_ALPHA: number;
  69729. /** LUMINANCE */
  69730. static readonly TEXTUREFORMAT_LUMINANCE: number;
  69731. /** LUMINANCE_ALPHA */
  69732. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  69733. /** RGB */
  69734. static readonly TEXTUREFORMAT_RGB: number;
  69735. /** RGBA */
  69736. static readonly TEXTUREFORMAT_RGBA: number;
  69737. /** RED */
  69738. static readonly TEXTUREFORMAT_RED: number;
  69739. /** RED (2nd reference) */
  69740. static readonly TEXTUREFORMAT_R: number;
  69741. /** RG */
  69742. static readonly TEXTUREFORMAT_RG: number;
  69743. /** RED_INTEGER */
  69744. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  69745. /** RED_INTEGER (2nd reference) */
  69746. static readonly TEXTUREFORMAT_R_INTEGER: number;
  69747. /** RG_INTEGER */
  69748. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  69749. /** RGB_INTEGER */
  69750. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  69751. /** RGBA_INTEGER */
  69752. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  69753. /** UNSIGNED_BYTE */
  69754. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  69755. /** UNSIGNED_BYTE (2nd reference) */
  69756. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  69757. /** FLOAT */
  69758. static readonly TEXTURETYPE_FLOAT: number;
  69759. /** HALF_FLOAT */
  69760. static readonly TEXTURETYPE_HALF_FLOAT: number;
  69761. /** BYTE */
  69762. static readonly TEXTURETYPE_BYTE: number;
  69763. /** SHORT */
  69764. static readonly TEXTURETYPE_SHORT: number;
  69765. /** UNSIGNED_SHORT */
  69766. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  69767. /** INT */
  69768. static readonly TEXTURETYPE_INT: number;
  69769. /** UNSIGNED_INT */
  69770. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  69771. /** UNSIGNED_SHORT_4_4_4_4 */
  69772. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  69773. /** UNSIGNED_SHORT_5_5_5_1 */
  69774. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  69775. /** UNSIGNED_SHORT_5_6_5 */
  69776. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  69777. /** UNSIGNED_INT_2_10_10_10_REV */
  69778. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  69779. /** UNSIGNED_INT_24_8 */
  69780. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  69781. /** UNSIGNED_INT_10F_11F_11F_REV */
  69782. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  69783. /** UNSIGNED_INT_5_9_9_9_REV */
  69784. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  69785. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  69786. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  69787. /** nearest is mag = nearest and min = nearest and mip = linear */
  69788. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  69789. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69790. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  69791. /** Trilinear is mag = linear and min = linear and mip = linear */
  69792. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  69793. /** nearest is mag = nearest and min = nearest and mip = linear */
  69794. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  69795. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69796. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  69797. /** Trilinear is mag = linear and min = linear and mip = linear */
  69798. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  69799. /** mag = nearest and min = nearest and mip = nearest */
  69800. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  69801. /** mag = nearest and min = linear and mip = nearest */
  69802. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  69803. /** mag = nearest and min = linear and mip = linear */
  69804. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  69805. /** mag = nearest and min = linear and mip = none */
  69806. static readonly TEXTURE_NEAREST_LINEAR: number;
  69807. /** mag = nearest and min = nearest and mip = none */
  69808. static readonly TEXTURE_NEAREST_NEAREST: number;
  69809. /** mag = linear and min = nearest and mip = nearest */
  69810. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  69811. /** mag = linear and min = nearest and mip = linear */
  69812. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  69813. /** mag = linear and min = linear and mip = none */
  69814. static readonly TEXTURE_LINEAR_LINEAR: number;
  69815. /** mag = linear and min = nearest and mip = none */
  69816. static readonly TEXTURE_LINEAR_NEAREST: number;
  69817. /** Explicit coordinates mode */
  69818. static readonly TEXTURE_EXPLICIT_MODE: number;
  69819. /** Spherical coordinates mode */
  69820. static readonly TEXTURE_SPHERICAL_MODE: number;
  69821. /** Planar coordinates mode */
  69822. static readonly TEXTURE_PLANAR_MODE: number;
  69823. /** Cubic coordinates mode */
  69824. static readonly TEXTURE_CUBIC_MODE: number;
  69825. /** Projection coordinates mode */
  69826. static readonly TEXTURE_PROJECTION_MODE: number;
  69827. /** Skybox coordinates mode */
  69828. static readonly TEXTURE_SKYBOX_MODE: number;
  69829. /** Inverse Cubic coordinates mode */
  69830. static readonly TEXTURE_INVCUBIC_MODE: number;
  69831. /** Equirectangular coordinates mode */
  69832. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  69833. /** Equirectangular Fixed coordinates mode */
  69834. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  69835. /** Equirectangular Fixed Mirrored coordinates mode */
  69836. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  69837. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  69838. static readonly SCALEMODE_FLOOR: number;
  69839. /** Defines that texture rescaling will look for the nearest power of 2 size */
  69840. static readonly SCALEMODE_NEAREST: number;
  69841. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  69842. static readonly SCALEMODE_CEILING: number;
  69843. /**
  69844. * The dirty texture flag value
  69845. */
  69846. static readonly MATERIAL_TextureDirtyFlag: number;
  69847. /**
  69848. * The dirty light flag value
  69849. */
  69850. static readonly MATERIAL_LightDirtyFlag: number;
  69851. /**
  69852. * The dirty fresnel flag value
  69853. */
  69854. static readonly MATERIAL_FresnelDirtyFlag: number;
  69855. /**
  69856. * The dirty attribute flag value
  69857. */
  69858. static readonly MATERIAL_AttributesDirtyFlag: number;
  69859. /**
  69860. * The dirty misc flag value
  69861. */
  69862. static readonly MATERIAL_MiscDirtyFlag: number;
  69863. /**
  69864. * The all dirty flag value
  69865. */
  69866. static readonly MATERIAL_AllDirtyFlag: number;
  69867. /**
  69868. * Returns the triangle fill mode
  69869. */
  69870. static readonly MATERIAL_TriangleFillMode: number;
  69871. /**
  69872. * Returns the wireframe mode
  69873. */
  69874. static readonly MATERIAL_WireFrameFillMode: number;
  69875. /**
  69876. * Returns the point fill mode
  69877. */
  69878. static readonly MATERIAL_PointFillMode: number;
  69879. /**
  69880. * Returns the point list draw mode
  69881. */
  69882. static readonly MATERIAL_PointListDrawMode: number;
  69883. /**
  69884. * Returns the line list draw mode
  69885. */
  69886. static readonly MATERIAL_LineListDrawMode: number;
  69887. /**
  69888. * Returns the line loop draw mode
  69889. */
  69890. static readonly MATERIAL_LineLoopDrawMode: number;
  69891. /**
  69892. * Returns the line strip draw mode
  69893. */
  69894. static readonly MATERIAL_LineStripDrawMode: number;
  69895. /**
  69896. * Returns the triangle strip draw mode
  69897. */
  69898. static readonly MATERIAL_TriangleStripDrawMode: number;
  69899. /**
  69900. * Returns the triangle fan draw mode
  69901. */
  69902. static readonly MATERIAL_TriangleFanDrawMode: number;
  69903. /**
  69904. * Stores the clock-wise side orientation
  69905. */
  69906. static readonly MATERIAL_ClockWiseSideOrientation: number;
  69907. /**
  69908. * Stores the counter clock-wise side orientation
  69909. */
  69910. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  69911. /**
  69912. * Nothing
  69913. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69914. */
  69915. static readonly ACTION_NothingTrigger: number;
  69916. /**
  69917. * On pick
  69918. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69919. */
  69920. static readonly ACTION_OnPickTrigger: number;
  69921. /**
  69922. * On left pick
  69923. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69924. */
  69925. static readonly ACTION_OnLeftPickTrigger: number;
  69926. /**
  69927. * On right pick
  69928. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69929. */
  69930. static readonly ACTION_OnRightPickTrigger: number;
  69931. /**
  69932. * On center pick
  69933. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69934. */
  69935. static readonly ACTION_OnCenterPickTrigger: number;
  69936. /**
  69937. * On pick down
  69938. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69939. */
  69940. static readonly ACTION_OnPickDownTrigger: number;
  69941. /**
  69942. * On double pick
  69943. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69944. */
  69945. static readonly ACTION_OnDoublePickTrigger: number;
  69946. /**
  69947. * On pick up
  69948. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69949. */
  69950. static readonly ACTION_OnPickUpTrigger: number;
  69951. /**
  69952. * On pick out.
  69953. * This trigger will only be raised if you also declared a OnPickDown
  69954. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69955. */
  69956. static readonly ACTION_OnPickOutTrigger: number;
  69957. /**
  69958. * On long press
  69959. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69960. */
  69961. static readonly ACTION_OnLongPressTrigger: number;
  69962. /**
  69963. * On pointer over
  69964. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69965. */
  69966. static readonly ACTION_OnPointerOverTrigger: number;
  69967. /**
  69968. * On pointer out
  69969. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69970. */
  69971. static readonly ACTION_OnPointerOutTrigger: number;
  69972. /**
  69973. * On every frame
  69974. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69975. */
  69976. static readonly ACTION_OnEveryFrameTrigger: number;
  69977. /**
  69978. * On intersection enter
  69979. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69980. */
  69981. static readonly ACTION_OnIntersectionEnterTrigger: number;
  69982. /**
  69983. * On intersection exit
  69984. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69985. */
  69986. static readonly ACTION_OnIntersectionExitTrigger: number;
  69987. /**
  69988. * On key down
  69989. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69990. */
  69991. static readonly ACTION_OnKeyDownTrigger: number;
  69992. /**
  69993. * On key up
  69994. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69995. */
  69996. static readonly ACTION_OnKeyUpTrigger: number;
  69997. /**
  69998. * Billboard mode will only apply to Y axis
  69999. */
  70000. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  70001. /**
  70002. * Billboard mode will apply to all axes
  70003. */
  70004. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  70005. /**
  70006. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  70007. */
  70008. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  70009. /**
  70010. * Gets or sets base Assets URL
  70011. */
  70012. static PARTICLES_BaseAssetsUrl: string;
  70013. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  70014. * Test order :
  70015. * Is the bounding sphere outside the frustum ?
  70016. * If not, are the bounding box vertices outside the frustum ?
  70017. * It not, then the cullable object is in the frustum.
  70018. */
  70019. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  70020. /** Culling strategy : Bounding Sphere Only.
  70021. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  70022. * It's also less accurate than the standard because some not visible objects can still be selected.
  70023. * Test : is the bounding sphere outside the frustum ?
  70024. * If not, then the cullable object is in the frustum.
  70025. */
  70026. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  70027. /** Culling strategy : Optimistic Inclusion.
  70028. * This in an inclusion test first, then the standard exclusion test.
  70029. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  70030. * 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.
  70031. * Anyway, it's as accurate as the standard strategy.
  70032. * Test :
  70033. * Is the cullable object bounding sphere center in the frustum ?
  70034. * If not, apply the default culling strategy.
  70035. */
  70036. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  70037. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  70038. * This in an inclusion test first, then the bounding sphere only exclusion test.
  70039. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  70040. * 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.
  70041. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  70042. * Test :
  70043. * Is the cullable object bounding sphere center in the frustum ?
  70044. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  70045. */
  70046. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  70047. /**
  70048. * No logging while loading
  70049. */
  70050. static readonly SCENELOADER_NO_LOGGING: number;
  70051. /**
  70052. * Minimal logging while loading
  70053. */
  70054. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  70055. /**
  70056. * Summary logging while loading
  70057. */
  70058. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  70059. /**
  70060. * Detailled logging while loading
  70061. */
  70062. static readonly SCENELOADER_DETAILED_LOGGING: number;
  70063. }
  70064. }
  70065. declare module BABYLON {
  70066. /**
  70067. * Class used to store and describe the pipeline context associated with an effect
  70068. */
  70069. export interface IPipelineContext {
  70070. /**
  70071. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  70072. */
  70073. isAsync: boolean;
  70074. /**
  70075. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  70076. */
  70077. isReady: boolean;
  70078. /** @hidden */
  70079. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  70080. }
  70081. }
  70082. declare module BABYLON {
  70083. /** @hidden */
  70084. export interface IShaderProcessor {
  70085. attributeProcessor?: (attribute: string) => string;
  70086. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  70087. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  70088. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  70089. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  70090. lineProcessor?: (line: string, isFragment: boolean) => string;
  70091. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  70092. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  70093. }
  70094. }
  70095. declare module BABYLON {
  70096. /** @hidden */
  70097. export interface ProcessingOptions {
  70098. defines: string[];
  70099. indexParameters: any;
  70100. isFragment: boolean;
  70101. shouldUseHighPrecisionShader: boolean;
  70102. supportsUniformBuffers: boolean;
  70103. shadersRepository: string;
  70104. includesShadersStore: {
  70105. [key: string]: string;
  70106. };
  70107. processor?: IShaderProcessor;
  70108. version: string;
  70109. platformName: string;
  70110. lookForClosingBracketForUniformBuffer?: boolean;
  70111. }
  70112. }
  70113. declare module BABYLON {
  70114. /**
  70115. * Helper to manipulate strings
  70116. */
  70117. export class StringTools {
  70118. /**
  70119. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  70120. * @param str Source string
  70121. * @param suffix Suffix to search for in the source string
  70122. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  70123. */
  70124. static EndsWith(str: string, suffix: string): boolean;
  70125. /**
  70126. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  70127. * @param str Source string
  70128. * @param suffix Suffix to search for in the source string
  70129. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  70130. */
  70131. static StartsWith(str: string, suffix: string): boolean;
  70132. }
  70133. }
  70134. declare module BABYLON {
  70135. /** @hidden */
  70136. export class ShaderCodeNode {
  70137. line: string;
  70138. children: ShaderCodeNode[];
  70139. additionalDefineKey?: string;
  70140. additionalDefineValue?: string;
  70141. isValid(preprocessors: {
  70142. [key: string]: string;
  70143. }): boolean;
  70144. process(preprocessors: {
  70145. [key: string]: string;
  70146. }, options: ProcessingOptions): string;
  70147. }
  70148. }
  70149. declare module BABYLON {
  70150. /** @hidden */
  70151. export class ShaderCodeCursor {
  70152. private _lines;
  70153. lineIndex: number;
  70154. readonly currentLine: string;
  70155. readonly canRead: boolean;
  70156. lines: string[];
  70157. }
  70158. }
  70159. declare module BABYLON {
  70160. /** @hidden */
  70161. export class ShaderCodeConditionNode extends ShaderCodeNode {
  70162. process(preprocessors: {
  70163. [key: string]: string;
  70164. }, options: ProcessingOptions): string;
  70165. }
  70166. }
  70167. declare module BABYLON {
  70168. /** @hidden */
  70169. export class ShaderDefineExpression {
  70170. isTrue(preprocessors: {
  70171. [key: string]: string;
  70172. }): boolean;
  70173. }
  70174. }
  70175. declare module BABYLON {
  70176. /** @hidden */
  70177. export class ShaderCodeTestNode extends ShaderCodeNode {
  70178. testExpression: ShaderDefineExpression;
  70179. isValid(preprocessors: {
  70180. [key: string]: string;
  70181. }): boolean;
  70182. }
  70183. }
  70184. declare module BABYLON {
  70185. /** @hidden */
  70186. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  70187. define: string;
  70188. not: boolean;
  70189. constructor(define: string, not?: boolean);
  70190. isTrue(preprocessors: {
  70191. [key: string]: string;
  70192. }): boolean;
  70193. }
  70194. }
  70195. declare module BABYLON {
  70196. /** @hidden */
  70197. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  70198. leftOperand: ShaderDefineExpression;
  70199. rightOperand: ShaderDefineExpression;
  70200. isTrue(preprocessors: {
  70201. [key: string]: string;
  70202. }): boolean;
  70203. }
  70204. }
  70205. declare module BABYLON {
  70206. /** @hidden */
  70207. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  70208. leftOperand: ShaderDefineExpression;
  70209. rightOperand: ShaderDefineExpression;
  70210. isTrue(preprocessors: {
  70211. [key: string]: string;
  70212. }): boolean;
  70213. }
  70214. }
  70215. declare module BABYLON {
  70216. /** @hidden */
  70217. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  70218. define: string;
  70219. operand: string;
  70220. testValue: string;
  70221. constructor(define: string, operand: string, testValue: string);
  70222. isTrue(preprocessors: {
  70223. [key: string]: string;
  70224. }): boolean;
  70225. }
  70226. }
  70227. declare module BABYLON {
  70228. /**
  70229. * @ignore
  70230. * Application error to support additional information when loading a file
  70231. */
  70232. export class LoadFileError extends Error {
  70233. /** defines the optional web request */
  70234. request?: WebRequest | undefined;
  70235. private static _setPrototypeOf;
  70236. /**
  70237. * Creates a new LoadFileError
  70238. * @param message defines the message of the error
  70239. * @param request defines the optional web request
  70240. */
  70241. constructor(message: string,
  70242. /** defines the optional web request */
  70243. request?: WebRequest | undefined);
  70244. }
  70245. }
  70246. declare module BABYLON {
  70247. /**
  70248. * Class used to enable access to offline support
  70249. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70250. */
  70251. export interface IOfflineProvider {
  70252. /**
  70253. * Gets a boolean indicating if scene must be saved in the database
  70254. */
  70255. enableSceneOffline: boolean;
  70256. /**
  70257. * Gets a boolean indicating if textures must be saved in the database
  70258. */
  70259. enableTexturesOffline: boolean;
  70260. /**
  70261. * Open the offline support and make it available
  70262. * @param successCallback defines the callback to call on success
  70263. * @param errorCallback defines the callback to call on error
  70264. */
  70265. open(successCallback: () => void, errorCallback: () => void): void;
  70266. /**
  70267. * Loads an image from the offline support
  70268. * @param url defines the url to load from
  70269. * @param image defines the target DOM image
  70270. */
  70271. loadImage(url: string, image: HTMLImageElement): void;
  70272. /**
  70273. * Loads a file from offline support
  70274. * @param url defines the URL to load from
  70275. * @param sceneLoaded defines a callback to call on success
  70276. * @param progressCallBack defines a callback to call when progress changed
  70277. * @param errorCallback defines a callback to call on error
  70278. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70279. */
  70280. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70281. }
  70282. }
  70283. declare module BABYLON {
  70284. /**
  70285. * Class used to help managing file picking and drag'n'drop
  70286. * File Storage
  70287. */
  70288. export class FilesInputStore {
  70289. /**
  70290. * List of files ready to be loaded
  70291. */
  70292. static FilesToLoad: {
  70293. [key: string]: File;
  70294. };
  70295. }
  70296. }
  70297. declare module BABYLON {
  70298. /**
  70299. * Class used to define a retry strategy when error happens while loading assets
  70300. */
  70301. export class RetryStrategy {
  70302. /**
  70303. * Function used to defines an exponential back off strategy
  70304. * @param maxRetries defines the maximum number of retries (3 by default)
  70305. * @param baseInterval defines the interval between retries
  70306. * @returns the strategy function to use
  70307. */
  70308. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  70309. }
  70310. }
  70311. declare module BABYLON {
  70312. /**
  70313. * @hidden
  70314. */
  70315. export class FileTools {
  70316. /**
  70317. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  70318. */
  70319. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  70320. /**
  70321. * Gets or sets the base URL to use to load assets
  70322. */
  70323. static BaseUrl: string;
  70324. /**
  70325. * Default behaviour for cors in the application.
  70326. * It can be a string if the expected behavior is identical in the entire app.
  70327. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  70328. */
  70329. static CorsBehavior: string | ((url: string | string[]) => string);
  70330. /**
  70331. * Gets or sets a function used to pre-process url before using them to load assets
  70332. */
  70333. static PreprocessUrl: (url: string) => string;
  70334. /**
  70335. * Removes unwanted characters from an url
  70336. * @param url defines the url to clean
  70337. * @returns the cleaned url
  70338. */
  70339. private static _CleanUrl;
  70340. /**
  70341. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  70342. * @param url define the url we are trying
  70343. * @param element define the dom element where to configure the cors policy
  70344. */
  70345. static SetCorsBehavior(url: string | string[], element: {
  70346. crossOrigin: string | null;
  70347. }): void;
  70348. /**
  70349. * Loads an image as an HTMLImageElement.
  70350. * @param input url string, ArrayBuffer, or Blob to load
  70351. * @param onLoad callback called when the image successfully loads
  70352. * @param onError callback called when the image fails to load
  70353. * @param offlineProvider offline provider for caching
  70354. * @returns the HTMLImageElement of the loaded image
  70355. */
  70356. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  70357. /**
  70358. * Loads a file
  70359. * @param fileToLoad defines the file to load
  70360. * @param callback defines the callback to call when data is loaded
  70361. * @param progressCallBack defines the callback to call during loading process
  70362. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  70363. * @returns a file request object
  70364. */
  70365. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  70366. /**
  70367. * Loads a file
  70368. * @param url url string, ArrayBuffer, or Blob to load
  70369. * @param onSuccess callback called when the file successfully loads
  70370. * @param onProgress callback called while file is loading (if the server supports this mode)
  70371. * @param offlineProvider defines the offline provider for caching
  70372. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  70373. * @param onError callback called when the file fails to load
  70374. * @returns a file request object
  70375. */
  70376. 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;
  70377. /**
  70378. * Checks if the loaded document was accessed via `file:`-Protocol.
  70379. * @returns boolean
  70380. */
  70381. static IsFileURL(): boolean;
  70382. }
  70383. }
  70384. declare module BABYLON {
  70385. /** @hidden */
  70386. export class ShaderProcessor {
  70387. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  70388. private static _ProcessPrecision;
  70389. private static _ExtractOperation;
  70390. private static _BuildSubExpression;
  70391. private static _BuildExpression;
  70392. private static _MoveCursorWithinIf;
  70393. private static _MoveCursor;
  70394. private static _EvaluatePreProcessors;
  70395. private static _PreparePreProcessors;
  70396. private static _ProcessShaderConversion;
  70397. private static _ProcessIncludes;
  70398. }
  70399. }
  70400. declare module BABYLON {
  70401. /**
  70402. * Class used to hold a RBG color
  70403. */
  70404. export class Color3 {
  70405. /**
  70406. * Defines the red component (between 0 and 1, default is 0)
  70407. */
  70408. r: number;
  70409. /**
  70410. * Defines the green component (between 0 and 1, default is 0)
  70411. */
  70412. g: number;
  70413. /**
  70414. * Defines the blue component (between 0 and 1, default is 0)
  70415. */
  70416. b: number;
  70417. /**
  70418. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  70419. * @param r defines the red component (between 0 and 1, default is 0)
  70420. * @param g defines the green component (between 0 and 1, default is 0)
  70421. * @param b defines the blue component (between 0 and 1, default is 0)
  70422. */
  70423. constructor(
  70424. /**
  70425. * Defines the red component (between 0 and 1, default is 0)
  70426. */
  70427. r?: number,
  70428. /**
  70429. * Defines the green component (between 0 and 1, default is 0)
  70430. */
  70431. g?: number,
  70432. /**
  70433. * Defines the blue component (between 0 and 1, default is 0)
  70434. */
  70435. b?: number);
  70436. /**
  70437. * Creates a string with the Color3 current values
  70438. * @returns the string representation of the Color3 object
  70439. */
  70440. toString(): string;
  70441. /**
  70442. * Returns the string "Color3"
  70443. * @returns "Color3"
  70444. */
  70445. getClassName(): string;
  70446. /**
  70447. * Compute the Color3 hash code
  70448. * @returns an unique number that can be used to hash Color3 objects
  70449. */
  70450. getHashCode(): number;
  70451. /**
  70452. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  70453. * @param array defines the array where to store the r,g,b components
  70454. * @param index defines an optional index in the target array to define where to start storing values
  70455. * @returns the current Color3 object
  70456. */
  70457. toArray(array: FloatArray, index?: number): Color3;
  70458. /**
  70459. * Returns a new Color4 object from the current Color3 and the given alpha
  70460. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  70461. * @returns a new Color4 object
  70462. */
  70463. toColor4(alpha?: number): Color4;
  70464. /**
  70465. * Returns a new array populated with 3 numeric elements : red, green and blue values
  70466. * @returns the new array
  70467. */
  70468. asArray(): number[];
  70469. /**
  70470. * Returns the luminance value
  70471. * @returns a float value
  70472. */
  70473. toLuminance(): number;
  70474. /**
  70475. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  70476. * @param otherColor defines the second operand
  70477. * @returns the new Color3 object
  70478. */
  70479. multiply(otherColor: DeepImmutable<Color3>): Color3;
  70480. /**
  70481. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  70482. * @param otherColor defines the second operand
  70483. * @param result defines the Color3 object where to store the result
  70484. * @returns the current Color3
  70485. */
  70486. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  70487. /**
  70488. * Determines equality between Color3 objects
  70489. * @param otherColor defines the second operand
  70490. * @returns true if the rgb values are equal to the given ones
  70491. */
  70492. equals(otherColor: DeepImmutable<Color3>): boolean;
  70493. /**
  70494. * Determines equality between the current Color3 object and a set of r,b,g values
  70495. * @param r defines the red component to check
  70496. * @param g defines the green component to check
  70497. * @param b defines the blue component to check
  70498. * @returns true if the rgb values are equal to the given ones
  70499. */
  70500. equalsFloats(r: number, g: number, b: number): boolean;
  70501. /**
  70502. * Multiplies in place each rgb value by scale
  70503. * @param scale defines the scaling factor
  70504. * @returns the updated Color3
  70505. */
  70506. scale(scale: number): Color3;
  70507. /**
  70508. * Multiplies the rgb values by scale and stores the result into "result"
  70509. * @param scale defines the scaling factor
  70510. * @param result defines the Color3 object where to store the result
  70511. * @returns the unmodified current Color3
  70512. */
  70513. scaleToRef(scale: number, result: Color3): Color3;
  70514. /**
  70515. * Scale the current Color3 values by a factor and add the result to a given Color3
  70516. * @param scale defines the scale factor
  70517. * @param result defines color to store the result into
  70518. * @returns the unmodified current Color3
  70519. */
  70520. scaleAndAddToRef(scale: number, result: Color3): Color3;
  70521. /**
  70522. * Clamps the rgb values by the min and max values and stores the result into "result"
  70523. * @param min defines minimum clamping value (default is 0)
  70524. * @param max defines maximum clamping value (default is 1)
  70525. * @param result defines color to store the result into
  70526. * @returns the original Color3
  70527. */
  70528. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  70529. /**
  70530. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  70531. * @param otherColor defines the second operand
  70532. * @returns the new Color3
  70533. */
  70534. add(otherColor: DeepImmutable<Color3>): Color3;
  70535. /**
  70536. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  70537. * @param otherColor defines the second operand
  70538. * @param result defines Color3 object to store the result into
  70539. * @returns the unmodified current Color3
  70540. */
  70541. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  70542. /**
  70543. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  70544. * @param otherColor defines the second operand
  70545. * @returns the new Color3
  70546. */
  70547. subtract(otherColor: DeepImmutable<Color3>): Color3;
  70548. /**
  70549. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  70550. * @param otherColor defines the second operand
  70551. * @param result defines Color3 object to store the result into
  70552. * @returns the unmodified current Color3
  70553. */
  70554. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  70555. /**
  70556. * Copy the current object
  70557. * @returns a new Color3 copied the current one
  70558. */
  70559. clone(): Color3;
  70560. /**
  70561. * Copies the rgb values from the source in the current Color3
  70562. * @param source defines the source Color3 object
  70563. * @returns the updated Color3 object
  70564. */
  70565. copyFrom(source: DeepImmutable<Color3>): Color3;
  70566. /**
  70567. * Updates the Color3 rgb values from the given floats
  70568. * @param r defines the red component to read from
  70569. * @param g defines the green component to read from
  70570. * @param b defines the blue component to read from
  70571. * @returns the current Color3 object
  70572. */
  70573. copyFromFloats(r: number, g: number, b: number): Color3;
  70574. /**
  70575. * Updates the Color3 rgb values from the given floats
  70576. * @param r defines the red component to read from
  70577. * @param g defines the green component to read from
  70578. * @param b defines the blue component to read from
  70579. * @returns the current Color3 object
  70580. */
  70581. set(r: number, g: number, b: number): Color3;
  70582. /**
  70583. * Compute the Color3 hexadecimal code as a string
  70584. * @returns a string containing the hexadecimal representation of the Color3 object
  70585. */
  70586. toHexString(): string;
  70587. /**
  70588. * Computes a new Color3 converted from the current one to linear space
  70589. * @returns a new Color3 object
  70590. */
  70591. toLinearSpace(): Color3;
  70592. /**
  70593. * Converts current color in rgb space to HSV values
  70594. * @returns a new color3 representing the HSV values
  70595. */
  70596. toHSV(): Color3;
  70597. /**
  70598. * Converts current color in rgb space to HSV values
  70599. * @param result defines the Color3 where to store the HSV values
  70600. */
  70601. toHSVToRef(result: Color3): void;
  70602. /**
  70603. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  70604. * @param convertedColor defines the Color3 object where to store the linear space version
  70605. * @returns the unmodified Color3
  70606. */
  70607. toLinearSpaceToRef(convertedColor: Color3): Color3;
  70608. /**
  70609. * Computes a new Color3 converted from the current one to gamma space
  70610. * @returns a new Color3 object
  70611. */
  70612. toGammaSpace(): Color3;
  70613. /**
  70614. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  70615. * @param convertedColor defines the Color3 object where to store the gamma space version
  70616. * @returns the unmodified Color3
  70617. */
  70618. toGammaSpaceToRef(convertedColor: Color3): Color3;
  70619. private static _BlackReadOnly;
  70620. /**
  70621. * Convert Hue, saturation and value to a Color3 (RGB)
  70622. * @param hue defines the hue
  70623. * @param saturation defines the saturation
  70624. * @param value defines the value
  70625. * @param result defines the Color3 where to store the RGB values
  70626. */
  70627. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  70628. /**
  70629. * Creates a new Color3 from the string containing valid hexadecimal values
  70630. * @param hex defines a string containing valid hexadecimal values
  70631. * @returns a new Color3 object
  70632. */
  70633. static FromHexString(hex: string): Color3;
  70634. /**
  70635. * Creates a new Color3 from the starting index of the given array
  70636. * @param array defines the source array
  70637. * @param offset defines an offset in the source array
  70638. * @returns a new Color3 object
  70639. */
  70640. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  70641. /**
  70642. * Creates a new Color3 from integer values (< 256)
  70643. * @param r defines the red component to read from (value between 0 and 255)
  70644. * @param g defines the green component to read from (value between 0 and 255)
  70645. * @param b defines the blue component to read from (value between 0 and 255)
  70646. * @returns a new Color3 object
  70647. */
  70648. static FromInts(r: number, g: number, b: number): Color3;
  70649. /**
  70650. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  70651. * @param start defines the start Color3 value
  70652. * @param end defines the end Color3 value
  70653. * @param amount defines the gradient value between start and end
  70654. * @returns a new Color3 object
  70655. */
  70656. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  70657. /**
  70658. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  70659. * @param left defines the start value
  70660. * @param right defines the end value
  70661. * @param amount defines the gradient factor
  70662. * @param result defines the Color3 object where to store the result
  70663. */
  70664. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  70665. /**
  70666. * Returns a Color3 value containing a red color
  70667. * @returns a new Color3 object
  70668. */
  70669. static Red(): Color3;
  70670. /**
  70671. * Returns a Color3 value containing a green color
  70672. * @returns a new Color3 object
  70673. */
  70674. static Green(): Color3;
  70675. /**
  70676. * Returns a Color3 value containing a blue color
  70677. * @returns a new Color3 object
  70678. */
  70679. static Blue(): Color3;
  70680. /**
  70681. * Returns a Color3 value containing a black color
  70682. * @returns a new Color3 object
  70683. */
  70684. static Black(): Color3;
  70685. /**
  70686. * Gets a Color3 value containing a black color that must not be updated
  70687. */
  70688. static readonly BlackReadOnly: DeepImmutable<Color3>;
  70689. /**
  70690. * Returns a Color3 value containing a white color
  70691. * @returns a new Color3 object
  70692. */
  70693. static White(): Color3;
  70694. /**
  70695. * Returns a Color3 value containing a purple color
  70696. * @returns a new Color3 object
  70697. */
  70698. static Purple(): Color3;
  70699. /**
  70700. * Returns a Color3 value containing a magenta color
  70701. * @returns a new Color3 object
  70702. */
  70703. static Magenta(): Color3;
  70704. /**
  70705. * Returns a Color3 value containing a yellow color
  70706. * @returns a new Color3 object
  70707. */
  70708. static Yellow(): Color3;
  70709. /**
  70710. * Returns a Color3 value containing a gray color
  70711. * @returns a new Color3 object
  70712. */
  70713. static Gray(): Color3;
  70714. /**
  70715. * Returns a Color3 value containing a teal color
  70716. * @returns a new Color3 object
  70717. */
  70718. static Teal(): Color3;
  70719. /**
  70720. * Returns a Color3 value containing a random color
  70721. * @returns a new Color3 object
  70722. */
  70723. static Random(): Color3;
  70724. }
  70725. /**
  70726. * Class used to hold a RBGA color
  70727. */
  70728. export class Color4 {
  70729. /**
  70730. * Defines the red component (between 0 and 1, default is 0)
  70731. */
  70732. r: number;
  70733. /**
  70734. * Defines the green component (between 0 and 1, default is 0)
  70735. */
  70736. g: number;
  70737. /**
  70738. * Defines the blue component (between 0 and 1, default is 0)
  70739. */
  70740. b: number;
  70741. /**
  70742. * Defines the alpha component (between 0 and 1, default is 1)
  70743. */
  70744. a: number;
  70745. /**
  70746. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  70747. * @param r defines the red component (between 0 and 1, default is 0)
  70748. * @param g defines the green component (between 0 and 1, default is 0)
  70749. * @param b defines the blue component (between 0 and 1, default is 0)
  70750. * @param a defines the alpha component (between 0 and 1, default is 1)
  70751. */
  70752. constructor(
  70753. /**
  70754. * Defines the red component (between 0 and 1, default is 0)
  70755. */
  70756. r?: number,
  70757. /**
  70758. * Defines the green component (between 0 and 1, default is 0)
  70759. */
  70760. g?: number,
  70761. /**
  70762. * Defines the blue component (between 0 and 1, default is 0)
  70763. */
  70764. b?: number,
  70765. /**
  70766. * Defines the alpha component (between 0 and 1, default is 1)
  70767. */
  70768. a?: number);
  70769. /**
  70770. * Adds in place the given Color4 values to the current Color4 object
  70771. * @param right defines the second operand
  70772. * @returns the current updated Color4 object
  70773. */
  70774. addInPlace(right: DeepImmutable<Color4>): Color4;
  70775. /**
  70776. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  70777. * @returns the new array
  70778. */
  70779. asArray(): number[];
  70780. /**
  70781. * Stores from the starting index in the given array the Color4 successive values
  70782. * @param array defines the array where to store the r,g,b components
  70783. * @param index defines an optional index in the target array to define where to start storing values
  70784. * @returns the current Color4 object
  70785. */
  70786. toArray(array: number[], index?: number): Color4;
  70787. /**
  70788. * Determines equality between Color4 objects
  70789. * @param otherColor defines the second operand
  70790. * @returns true if the rgba values are equal to the given ones
  70791. */
  70792. equals(otherColor: DeepImmutable<Color4>): boolean;
  70793. /**
  70794. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  70795. * @param right defines the second operand
  70796. * @returns a new Color4 object
  70797. */
  70798. add(right: DeepImmutable<Color4>): Color4;
  70799. /**
  70800. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  70801. * @param right defines the second operand
  70802. * @returns a new Color4 object
  70803. */
  70804. subtract(right: DeepImmutable<Color4>): Color4;
  70805. /**
  70806. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  70807. * @param right defines the second operand
  70808. * @param result defines the Color4 object where to store the result
  70809. * @returns the current Color4 object
  70810. */
  70811. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  70812. /**
  70813. * Creates a new Color4 with the current Color4 values multiplied by scale
  70814. * @param scale defines the scaling factor to apply
  70815. * @returns a new Color4 object
  70816. */
  70817. scale(scale: number): Color4;
  70818. /**
  70819. * Multiplies the current Color4 values by scale and stores the result in "result"
  70820. * @param scale defines the scaling factor to apply
  70821. * @param result defines the Color4 object where to store the result
  70822. * @returns the current unmodified Color4
  70823. */
  70824. scaleToRef(scale: number, result: Color4): Color4;
  70825. /**
  70826. * Scale the current Color4 values by a factor and add the result to a given Color4
  70827. * @param scale defines the scale factor
  70828. * @param result defines the Color4 object where to store the result
  70829. * @returns the unmodified current Color4
  70830. */
  70831. scaleAndAddToRef(scale: number, result: Color4): Color4;
  70832. /**
  70833. * Clamps the rgb values by the min and max values and stores the result into "result"
  70834. * @param min defines minimum clamping value (default is 0)
  70835. * @param max defines maximum clamping value (default is 1)
  70836. * @param result defines color to store the result into.
  70837. * @returns the cuurent Color4
  70838. */
  70839. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  70840. /**
  70841. * Multipy an Color4 value by another and return a new Color4 object
  70842. * @param color defines the Color4 value to multiply by
  70843. * @returns a new Color4 object
  70844. */
  70845. multiply(color: Color4): Color4;
  70846. /**
  70847. * Multipy a Color4 value by another and push the result in a reference value
  70848. * @param color defines the Color4 value to multiply by
  70849. * @param result defines the Color4 to fill the result in
  70850. * @returns the result Color4
  70851. */
  70852. multiplyToRef(color: Color4, result: Color4): Color4;
  70853. /**
  70854. * Creates a string with the Color4 current values
  70855. * @returns the string representation of the Color4 object
  70856. */
  70857. toString(): string;
  70858. /**
  70859. * Returns the string "Color4"
  70860. * @returns "Color4"
  70861. */
  70862. getClassName(): string;
  70863. /**
  70864. * Compute the Color4 hash code
  70865. * @returns an unique number that can be used to hash Color4 objects
  70866. */
  70867. getHashCode(): number;
  70868. /**
  70869. * Creates a new Color4 copied from the current one
  70870. * @returns a new Color4 object
  70871. */
  70872. clone(): Color4;
  70873. /**
  70874. * Copies the given Color4 values into the current one
  70875. * @param source defines the source Color4 object
  70876. * @returns the current updated Color4 object
  70877. */
  70878. copyFrom(source: Color4): Color4;
  70879. /**
  70880. * Copies the given float values into the current one
  70881. * @param r defines the red component to read from
  70882. * @param g defines the green component to read from
  70883. * @param b defines the blue component to read from
  70884. * @param a defines the alpha component to read from
  70885. * @returns the current updated Color4 object
  70886. */
  70887. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  70888. /**
  70889. * Copies the given float values into the current one
  70890. * @param r defines the red component to read from
  70891. * @param g defines the green component to read from
  70892. * @param b defines the blue component to read from
  70893. * @param a defines the alpha component to read from
  70894. * @returns the current updated Color4 object
  70895. */
  70896. set(r: number, g: number, b: number, a: number): Color4;
  70897. /**
  70898. * Compute the Color4 hexadecimal code as a string
  70899. * @returns a string containing the hexadecimal representation of the Color4 object
  70900. */
  70901. toHexString(): string;
  70902. /**
  70903. * Computes a new Color4 converted from the current one to linear space
  70904. * @returns a new Color4 object
  70905. */
  70906. toLinearSpace(): Color4;
  70907. /**
  70908. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  70909. * @param convertedColor defines the Color4 object where to store the linear space version
  70910. * @returns the unmodified Color4
  70911. */
  70912. toLinearSpaceToRef(convertedColor: Color4): Color4;
  70913. /**
  70914. * Computes a new Color4 converted from the current one to gamma space
  70915. * @returns a new Color4 object
  70916. */
  70917. toGammaSpace(): Color4;
  70918. /**
  70919. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  70920. * @param convertedColor defines the Color4 object where to store the gamma space version
  70921. * @returns the unmodified Color4
  70922. */
  70923. toGammaSpaceToRef(convertedColor: Color4): Color4;
  70924. /**
  70925. * Creates a new Color4 from the string containing valid hexadecimal values
  70926. * @param hex defines a string containing valid hexadecimal values
  70927. * @returns a new Color4 object
  70928. */
  70929. static FromHexString(hex: string): Color4;
  70930. /**
  70931. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  70932. * @param left defines the start value
  70933. * @param right defines the end value
  70934. * @param amount defines the gradient factor
  70935. * @returns a new Color4 object
  70936. */
  70937. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  70938. /**
  70939. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  70940. * @param left defines the start value
  70941. * @param right defines the end value
  70942. * @param amount defines the gradient factor
  70943. * @param result defines the Color4 object where to store data
  70944. */
  70945. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  70946. /**
  70947. * Creates a new Color4 from a Color3 and an alpha value
  70948. * @param color3 defines the source Color3 to read from
  70949. * @param alpha defines the alpha component (1.0 by default)
  70950. * @returns a new Color4 object
  70951. */
  70952. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  70953. /**
  70954. * Creates a new Color4 from the starting index element of the given array
  70955. * @param array defines the source array to read from
  70956. * @param offset defines the offset in the source array
  70957. * @returns a new Color4 object
  70958. */
  70959. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  70960. /**
  70961. * Creates a new Color3 from integer values (< 256)
  70962. * @param r defines the red component to read from (value between 0 and 255)
  70963. * @param g defines the green component to read from (value between 0 and 255)
  70964. * @param b defines the blue component to read from (value between 0 and 255)
  70965. * @param a defines the alpha component to read from (value between 0 and 255)
  70966. * @returns a new Color3 object
  70967. */
  70968. static FromInts(r: number, g: number, b: number, a: number): Color4;
  70969. /**
  70970. * Check the content of a given array and convert it to an array containing RGBA data
  70971. * If the original array was already containing count * 4 values then it is returned directly
  70972. * @param colors defines the array to check
  70973. * @param count defines the number of RGBA data to expect
  70974. * @returns an array containing count * 4 values (RGBA)
  70975. */
  70976. static CheckColors4(colors: number[], count: number): number[];
  70977. }
  70978. /**
  70979. * @hidden
  70980. */
  70981. export class TmpColors {
  70982. static Color3: Color3[];
  70983. static Color4: Color4[];
  70984. }
  70985. }
  70986. declare module BABYLON {
  70987. /**
  70988. * Class representing spherical harmonics coefficients to the 3rd degree
  70989. */
  70990. export class SphericalHarmonics {
  70991. /**
  70992. * Defines whether or not the harmonics have been prescaled for rendering.
  70993. */
  70994. preScaled: boolean;
  70995. /**
  70996. * The l0,0 coefficients of the spherical harmonics
  70997. */
  70998. l00: Vector3;
  70999. /**
  71000. * The l1,-1 coefficients of the spherical harmonics
  71001. */
  71002. l1_1: Vector3;
  71003. /**
  71004. * The l1,0 coefficients of the spherical harmonics
  71005. */
  71006. l10: Vector3;
  71007. /**
  71008. * The l1,1 coefficients of the spherical harmonics
  71009. */
  71010. l11: Vector3;
  71011. /**
  71012. * The l2,-2 coefficients of the spherical harmonics
  71013. */
  71014. l2_2: Vector3;
  71015. /**
  71016. * The l2,-1 coefficients of the spherical harmonics
  71017. */
  71018. l2_1: Vector3;
  71019. /**
  71020. * The l2,0 coefficients of the spherical harmonics
  71021. */
  71022. l20: Vector3;
  71023. /**
  71024. * The l2,1 coefficients of the spherical harmonics
  71025. */
  71026. l21: Vector3;
  71027. /**
  71028. * The l2,2 coefficients of the spherical harmonics
  71029. */
  71030. l22: Vector3;
  71031. /**
  71032. * Adds a light to the spherical harmonics
  71033. * @param direction the direction of the light
  71034. * @param color the color of the light
  71035. * @param deltaSolidAngle the delta solid angle of the light
  71036. */
  71037. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  71038. /**
  71039. * Scales the spherical harmonics by the given amount
  71040. * @param scale the amount to scale
  71041. */
  71042. scaleInPlace(scale: number): void;
  71043. /**
  71044. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  71045. *
  71046. * ```
  71047. * E_lm = A_l * L_lm
  71048. * ```
  71049. *
  71050. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  71051. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  71052. * the scaling factors are given in equation 9.
  71053. */
  71054. convertIncidentRadianceToIrradiance(): void;
  71055. /**
  71056. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  71057. *
  71058. * ```
  71059. * L = (1/pi) * E * rho
  71060. * ```
  71061. *
  71062. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  71063. */
  71064. convertIrradianceToLambertianRadiance(): void;
  71065. /**
  71066. * Integrates the reconstruction coefficients directly in to the SH preventing further
  71067. * required operations at run time.
  71068. *
  71069. * This is simply done by scaling back the SH with Ylm constants parameter.
  71070. * The trigonometric part being applied by the shader at run time.
  71071. */
  71072. preScaleForRendering(): void;
  71073. /**
  71074. * Constructs a spherical harmonics from an array.
  71075. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  71076. * @returns the spherical harmonics
  71077. */
  71078. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  71079. /**
  71080. * Gets the spherical harmonics from polynomial
  71081. * @param polynomial the spherical polynomial
  71082. * @returns the spherical harmonics
  71083. */
  71084. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  71085. }
  71086. /**
  71087. * Class representing spherical polynomial coefficients to the 3rd degree
  71088. */
  71089. export class SphericalPolynomial {
  71090. private _harmonics;
  71091. /**
  71092. * The spherical harmonics used to create the polynomials.
  71093. */
  71094. readonly preScaledHarmonics: SphericalHarmonics;
  71095. /**
  71096. * The x coefficients of the spherical polynomial
  71097. */
  71098. x: Vector3;
  71099. /**
  71100. * The y coefficients of the spherical polynomial
  71101. */
  71102. y: Vector3;
  71103. /**
  71104. * The z coefficients of the spherical polynomial
  71105. */
  71106. z: Vector3;
  71107. /**
  71108. * The xx coefficients of the spherical polynomial
  71109. */
  71110. xx: Vector3;
  71111. /**
  71112. * The yy coefficients of the spherical polynomial
  71113. */
  71114. yy: Vector3;
  71115. /**
  71116. * The zz coefficients of the spherical polynomial
  71117. */
  71118. zz: Vector3;
  71119. /**
  71120. * The xy coefficients of the spherical polynomial
  71121. */
  71122. xy: Vector3;
  71123. /**
  71124. * The yz coefficients of the spherical polynomial
  71125. */
  71126. yz: Vector3;
  71127. /**
  71128. * The zx coefficients of the spherical polynomial
  71129. */
  71130. zx: Vector3;
  71131. /**
  71132. * Adds an ambient color to the spherical polynomial
  71133. * @param color the color to add
  71134. */
  71135. addAmbient(color: Color3): void;
  71136. /**
  71137. * Scales the spherical polynomial by the given amount
  71138. * @param scale the amount to scale
  71139. */
  71140. scaleInPlace(scale: number): void;
  71141. /**
  71142. * Gets the spherical polynomial from harmonics
  71143. * @param harmonics the spherical harmonics
  71144. * @returns the spherical polynomial
  71145. */
  71146. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  71147. /**
  71148. * Constructs a spherical polynomial from an array.
  71149. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  71150. * @returns the spherical polynomial
  71151. */
  71152. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  71153. }
  71154. }
  71155. declare module BABYLON {
  71156. /**
  71157. * Define options used to create a render target texture
  71158. */
  71159. export class RenderTargetCreationOptions {
  71160. /**
  71161. * Specifies is mipmaps must be generated
  71162. */
  71163. generateMipMaps?: boolean;
  71164. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  71165. generateDepthBuffer?: boolean;
  71166. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  71167. generateStencilBuffer?: boolean;
  71168. /** Defines texture type (int by default) */
  71169. type?: number;
  71170. /** Defines sampling mode (trilinear by default) */
  71171. samplingMode?: number;
  71172. /** Defines format (RGBA by default) */
  71173. format?: number;
  71174. }
  71175. }
  71176. declare module BABYLON {
  71177. /**
  71178. * @hidden
  71179. **/
  71180. export class _AlphaState {
  71181. private _isAlphaBlendDirty;
  71182. private _isBlendFunctionParametersDirty;
  71183. private _isBlendEquationParametersDirty;
  71184. private _isBlendConstantsDirty;
  71185. private _alphaBlend;
  71186. private _blendFunctionParameters;
  71187. private _blendEquationParameters;
  71188. private _blendConstants;
  71189. /**
  71190. * Initializes the state.
  71191. */
  71192. constructor();
  71193. readonly isDirty: boolean;
  71194. alphaBlend: boolean;
  71195. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  71196. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  71197. setAlphaEquationParameters(rgb: number, alpha: number): void;
  71198. reset(): void;
  71199. apply(gl: WebGLRenderingContext): void;
  71200. }
  71201. }
  71202. declare module BABYLON {
  71203. /**
  71204. * @hidden
  71205. **/
  71206. export class _DepthCullingState {
  71207. private _isDepthTestDirty;
  71208. private _isDepthMaskDirty;
  71209. private _isDepthFuncDirty;
  71210. private _isCullFaceDirty;
  71211. private _isCullDirty;
  71212. private _isZOffsetDirty;
  71213. private _isFrontFaceDirty;
  71214. private _depthTest;
  71215. private _depthMask;
  71216. private _depthFunc;
  71217. private _cull;
  71218. private _cullFace;
  71219. private _zOffset;
  71220. private _frontFace;
  71221. /**
  71222. * Initializes the state.
  71223. */
  71224. constructor();
  71225. readonly isDirty: boolean;
  71226. zOffset: number;
  71227. cullFace: Nullable<number>;
  71228. cull: Nullable<boolean>;
  71229. depthFunc: Nullable<number>;
  71230. depthMask: boolean;
  71231. depthTest: boolean;
  71232. frontFace: Nullable<number>;
  71233. reset(): void;
  71234. apply(gl: WebGLRenderingContext): void;
  71235. }
  71236. }
  71237. declare module BABYLON {
  71238. /**
  71239. * @hidden
  71240. **/
  71241. export class _StencilState {
  71242. /** 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 */
  71243. static readonly ALWAYS: number;
  71244. /** Passed to stencilOperation to specify that stencil value must be kept */
  71245. static readonly KEEP: number;
  71246. /** Passed to stencilOperation to specify that stencil value must be replaced */
  71247. static readonly REPLACE: number;
  71248. private _isStencilTestDirty;
  71249. private _isStencilMaskDirty;
  71250. private _isStencilFuncDirty;
  71251. private _isStencilOpDirty;
  71252. private _stencilTest;
  71253. private _stencilMask;
  71254. private _stencilFunc;
  71255. private _stencilFuncRef;
  71256. private _stencilFuncMask;
  71257. private _stencilOpStencilFail;
  71258. private _stencilOpDepthFail;
  71259. private _stencilOpStencilDepthPass;
  71260. readonly isDirty: boolean;
  71261. stencilFunc: number;
  71262. stencilFuncRef: number;
  71263. stencilFuncMask: number;
  71264. stencilOpStencilFail: number;
  71265. stencilOpDepthFail: number;
  71266. stencilOpStencilDepthPass: number;
  71267. stencilMask: number;
  71268. stencilTest: boolean;
  71269. constructor();
  71270. reset(): void;
  71271. apply(gl: WebGLRenderingContext): void;
  71272. }
  71273. }
  71274. declare module BABYLON {
  71275. /**
  71276. * @hidden
  71277. **/
  71278. export class _TimeToken {
  71279. _startTimeQuery: Nullable<WebGLQuery>;
  71280. _endTimeQuery: Nullable<WebGLQuery>;
  71281. _timeElapsedQuery: Nullable<WebGLQuery>;
  71282. _timeElapsedQueryEnded: boolean;
  71283. }
  71284. }
  71285. declare module BABYLON {
  71286. /**
  71287. * Class used to evalaute queries containing `and` and `or` operators
  71288. */
  71289. export class AndOrNotEvaluator {
  71290. /**
  71291. * Evaluate a query
  71292. * @param query defines the query to evaluate
  71293. * @param evaluateCallback defines the callback used to filter result
  71294. * @returns true if the query matches
  71295. */
  71296. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  71297. private static _HandleParenthesisContent;
  71298. private static _SimplifyNegation;
  71299. }
  71300. }
  71301. declare module BABYLON {
  71302. /**
  71303. * Class used to store custom tags
  71304. */
  71305. export class Tags {
  71306. /**
  71307. * Adds support for tags on the given object
  71308. * @param obj defines the object to use
  71309. */
  71310. static EnableFor(obj: any): void;
  71311. /**
  71312. * Removes tags support
  71313. * @param obj defines the object to use
  71314. */
  71315. static DisableFor(obj: any): void;
  71316. /**
  71317. * Gets a boolean indicating if the given object has tags
  71318. * @param obj defines the object to use
  71319. * @returns a boolean
  71320. */
  71321. static HasTags(obj: any): boolean;
  71322. /**
  71323. * Gets the tags available on a given object
  71324. * @param obj defines the object to use
  71325. * @param asString defines if the tags must be returned as a string instead of an array of strings
  71326. * @returns the tags
  71327. */
  71328. static GetTags(obj: any, asString?: boolean): any;
  71329. /**
  71330. * Adds tags to an object
  71331. * @param obj defines the object to use
  71332. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  71333. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  71334. */
  71335. static AddTagsTo(obj: any, tagsString: string): void;
  71336. /**
  71337. * @hidden
  71338. */
  71339. static _AddTagTo(obj: any, tag: string): void;
  71340. /**
  71341. * Removes specific tags from a specific object
  71342. * @param obj defines the object to use
  71343. * @param tagsString defines the tags to remove
  71344. */
  71345. static RemoveTagsFrom(obj: any, tagsString: string): void;
  71346. /**
  71347. * @hidden
  71348. */
  71349. static _RemoveTagFrom(obj: any, tag: string): void;
  71350. /**
  71351. * Defines if tags hosted on an object match a given query
  71352. * @param obj defines the object to use
  71353. * @param tagsQuery defines the tag query
  71354. * @returns a boolean
  71355. */
  71356. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  71357. }
  71358. }
  71359. declare module BABYLON {
  71360. /**
  71361. * Defines potential orientation for back face culling
  71362. */
  71363. export enum Orientation {
  71364. /**
  71365. * Clockwise
  71366. */
  71367. CW = 0,
  71368. /** Counter clockwise */
  71369. CCW = 1
  71370. }
  71371. /** Class used to represent a Bezier curve */
  71372. export class BezierCurve {
  71373. /**
  71374. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  71375. * @param t defines the time
  71376. * @param x1 defines the left coordinate on X axis
  71377. * @param y1 defines the left coordinate on Y axis
  71378. * @param x2 defines the right coordinate on X axis
  71379. * @param y2 defines the right coordinate on Y axis
  71380. * @returns the interpolated value
  71381. */
  71382. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  71383. }
  71384. /**
  71385. * Defines angle representation
  71386. */
  71387. export class Angle {
  71388. private _radians;
  71389. /**
  71390. * Creates an Angle object of "radians" radians (float).
  71391. * @param radians the angle in radians
  71392. */
  71393. constructor(radians: number);
  71394. /**
  71395. * Get value in degrees
  71396. * @returns the Angle value in degrees (float)
  71397. */
  71398. degrees(): number;
  71399. /**
  71400. * Get value in radians
  71401. * @returns the Angle value in radians (float)
  71402. */
  71403. radians(): number;
  71404. /**
  71405. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  71406. * @param a defines first vector
  71407. * @param b defines second vector
  71408. * @returns a new Angle
  71409. */
  71410. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  71411. /**
  71412. * Gets a new Angle object from the given float in radians
  71413. * @param radians defines the angle value in radians
  71414. * @returns a new Angle
  71415. */
  71416. static FromRadians(radians: number): Angle;
  71417. /**
  71418. * Gets a new Angle object from the given float in degrees
  71419. * @param degrees defines the angle value in degrees
  71420. * @returns a new Angle
  71421. */
  71422. static FromDegrees(degrees: number): Angle;
  71423. }
  71424. /**
  71425. * This represents an arc in a 2d space.
  71426. */
  71427. export class Arc2 {
  71428. /** Defines the start point of the arc */
  71429. startPoint: Vector2;
  71430. /** Defines the mid point of the arc */
  71431. midPoint: Vector2;
  71432. /** Defines the end point of the arc */
  71433. endPoint: Vector2;
  71434. /**
  71435. * Defines the center point of the arc.
  71436. */
  71437. centerPoint: Vector2;
  71438. /**
  71439. * Defines the radius of the arc.
  71440. */
  71441. radius: number;
  71442. /**
  71443. * Defines the angle of the arc (from mid point to end point).
  71444. */
  71445. angle: Angle;
  71446. /**
  71447. * Defines the start angle of the arc (from start point to middle point).
  71448. */
  71449. startAngle: Angle;
  71450. /**
  71451. * Defines the orientation of the arc (clock wise/counter clock wise).
  71452. */
  71453. orientation: Orientation;
  71454. /**
  71455. * Creates an Arc object from the three given points : start, middle and end.
  71456. * @param startPoint Defines the start point of the arc
  71457. * @param midPoint Defines the midlle point of the arc
  71458. * @param endPoint Defines the end point of the arc
  71459. */
  71460. constructor(
  71461. /** Defines the start point of the arc */
  71462. startPoint: Vector2,
  71463. /** Defines the mid point of the arc */
  71464. midPoint: Vector2,
  71465. /** Defines the end point of the arc */
  71466. endPoint: Vector2);
  71467. }
  71468. /**
  71469. * Represents a 2D path made up of multiple 2D points
  71470. */
  71471. export class Path2 {
  71472. private _points;
  71473. private _length;
  71474. /**
  71475. * If the path start and end point are the same
  71476. */
  71477. closed: boolean;
  71478. /**
  71479. * Creates a Path2 object from the starting 2D coordinates x and y.
  71480. * @param x the starting points x value
  71481. * @param y the starting points y value
  71482. */
  71483. constructor(x: number, y: number);
  71484. /**
  71485. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  71486. * @param x the added points x value
  71487. * @param y the added points y value
  71488. * @returns the updated Path2.
  71489. */
  71490. addLineTo(x: number, y: number): Path2;
  71491. /**
  71492. * 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.
  71493. * @param midX middle point x value
  71494. * @param midY middle point y value
  71495. * @param endX end point x value
  71496. * @param endY end point y value
  71497. * @param numberOfSegments (default: 36)
  71498. * @returns the updated Path2.
  71499. */
  71500. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  71501. /**
  71502. * Closes the Path2.
  71503. * @returns the Path2.
  71504. */
  71505. close(): Path2;
  71506. /**
  71507. * Gets the sum of the distance between each sequential point in the path
  71508. * @returns the Path2 total length (float).
  71509. */
  71510. length(): number;
  71511. /**
  71512. * Gets the points which construct the path
  71513. * @returns the Path2 internal array of points.
  71514. */
  71515. getPoints(): Vector2[];
  71516. /**
  71517. * Retreives the point at the distance aways from the starting point
  71518. * @param normalizedLengthPosition the length along the path to retreive the point from
  71519. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  71520. */
  71521. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  71522. /**
  71523. * Creates a new path starting from an x and y position
  71524. * @param x starting x value
  71525. * @param y starting y value
  71526. * @returns a new Path2 starting at the coordinates (x, y).
  71527. */
  71528. static StartingAt(x: number, y: number): Path2;
  71529. }
  71530. /**
  71531. * Represents a 3D path made up of multiple 3D points
  71532. */
  71533. export class Path3D {
  71534. /**
  71535. * an array of Vector3, the curve axis of the Path3D
  71536. */
  71537. path: Vector3[];
  71538. private _curve;
  71539. private _distances;
  71540. private _tangents;
  71541. private _normals;
  71542. private _binormals;
  71543. private _raw;
  71544. /**
  71545. * new Path3D(path, normal, raw)
  71546. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  71547. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  71548. * @param path an array of Vector3, the curve axis of the Path3D
  71549. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  71550. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  71551. */
  71552. constructor(
  71553. /**
  71554. * an array of Vector3, the curve axis of the Path3D
  71555. */
  71556. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  71557. /**
  71558. * Returns the Path3D array of successive Vector3 designing its curve.
  71559. * @returns the Path3D array of successive Vector3 designing its curve.
  71560. */
  71561. getCurve(): Vector3[];
  71562. /**
  71563. * Returns an array populated with tangent vectors on each Path3D curve point.
  71564. * @returns an array populated with tangent vectors on each Path3D curve point.
  71565. */
  71566. getTangents(): Vector3[];
  71567. /**
  71568. * Returns an array populated with normal vectors on each Path3D curve point.
  71569. * @returns an array populated with normal vectors on each Path3D curve point.
  71570. */
  71571. getNormals(): Vector3[];
  71572. /**
  71573. * Returns an array populated with binormal vectors on each Path3D curve point.
  71574. * @returns an array populated with binormal vectors on each Path3D curve point.
  71575. */
  71576. getBinormals(): Vector3[];
  71577. /**
  71578. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  71579. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  71580. */
  71581. getDistances(): number[];
  71582. /**
  71583. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  71584. * @param path path which all values are copied into the curves points
  71585. * @param firstNormal which should be projected onto the curve
  71586. * @returns the same object updated.
  71587. */
  71588. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  71589. private _compute;
  71590. private _getFirstNonNullVector;
  71591. private _getLastNonNullVector;
  71592. private _normalVector;
  71593. }
  71594. /**
  71595. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  71596. * A Curve3 is designed from a series of successive Vector3.
  71597. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  71598. */
  71599. export class Curve3 {
  71600. private _points;
  71601. private _length;
  71602. /**
  71603. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  71604. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  71605. * @param v1 (Vector3) the control point
  71606. * @param v2 (Vector3) the end point of the Quadratic Bezier
  71607. * @param nbPoints (integer) the wanted number of points in the curve
  71608. * @returns the created Curve3
  71609. */
  71610. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  71611. /**
  71612. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  71613. * @param v0 (Vector3) the origin point of the Cubic Bezier
  71614. * @param v1 (Vector3) the first control point
  71615. * @param v2 (Vector3) the second control point
  71616. * @param v3 (Vector3) the end point of the Cubic Bezier
  71617. * @param nbPoints (integer) the wanted number of points in the curve
  71618. * @returns the created Curve3
  71619. */
  71620. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  71621. /**
  71622. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  71623. * @param p1 (Vector3) the origin point of the Hermite Spline
  71624. * @param t1 (Vector3) the tangent vector at the origin point
  71625. * @param p2 (Vector3) the end point of the Hermite Spline
  71626. * @param t2 (Vector3) the tangent vector at the end point
  71627. * @param nbPoints (integer) the wanted number of points in the curve
  71628. * @returns the created Curve3
  71629. */
  71630. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  71631. /**
  71632. * Returns a Curve3 object along a CatmullRom Spline curve :
  71633. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  71634. * @param nbPoints (integer) the wanted number of points between each curve control points
  71635. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  71636. * @returns the created Curve3
  71637. */
  71638. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  71639. /**
  71640. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  71641. * A Curve3 is designed from a series of successive Vector3.
  71642. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  71643. * @param points points which make up the curve
  71644. */
  71645. constructor(points: Vector3[]);
  71646. /**
  71647. * @returns the Curve3 stored array of successive Vector3
  71648. */
  71649. getPoints(): Vector3[];
  71650. /**
  71651. * @returns the computed length (float) of the curve.
  71652. */
  71653. length(): number;
  71654. /**
  71655. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  71656. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  71657. * curveA and curveB keep unchanged.
  71658. * @param curve the curve to continue from this curve
  71659. * @returns the newly constructed curve
  71660. */
  71661. continue(curve: DeepImmutable<Curve3>): Curve3;
  71662. private _computeLength;
  71663. }
  71664. }
  71665. declare module BABYLON {
  71666. /**
  71667. * This represents the main contract an easing function should follow.
  71668. * Easing functions are used throughout the animation system.
  71669. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71670. */
  71671. export interface IEasingFunction {
  71672. /**
  71673. * Given an input gradient between 0 and 1, this returns the corrseponding value
  71674. * of the easing function.
  71675. * The link below provides some of the most common examples of easing functions.
  71676. * @see https://easings.net/
  71677. * @param gradient Defines the value between 0 and 1 we want the easing value for
  71678. * @returns the corresponding value on the curve defined by the easing function
  71679. */
  71680. ease(gradient: number): number;
  71681. }
  71682. /**
  71683. * Base class used for every default easing function.
  71684. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71685. */
  71686. export class EasingFunction implements IEasingFunction {
  71687. /**
  71688. * Interpolation follows the mathematical formula associated with the easing function.
  71689. */
  71690. static readonly EASINGMODE_EASEIN: number;
  71691. /**
  71692. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  71693. */
  71694. static readonly EASINGMODE_EASEOUT: number;
  71695. /**
  71696. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  71697. */
  71698. static readonly EASINGMODE_EASEINOUT: number;
  71699. private _easingMode;
  71700. /**
  71701. * Sets the easing mode of the current function.
  71702. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  71703. */
  71704. setEasingMode(easingMode: number): void;
  71705. /**
  71706. * Gets the current easing mode.
  71707. * @returns the easing mode
  71708. */
  71709. getEasingMode(): number;
  71710. /**
  71711. * @hidden
  71712. */
  71713. easeInCore(gradient: number): number;
  71714. /**
  71715. * Given an input gradient between 0 and 1, this returns the corresponding value
  71716. * of the easing function.
  71717. * @param gradient Defines the value between 0 and 1 we want the easing value for
  71718. * @returns the corresponding value on the curve defined by the easing function
  71719. */
  71720. ease(gradient: number): number;
  71721. }
  71722. /**
  71723. * Easing function with a circle shape (see link below).
  71724. * @see https://easings.net/#easeInCirc
  71725. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71726. */
  71727. export class CircleEase extends EasingFunction implements IEasingFunction {
  71728. /** @hidden */
  71729. easeInCore(gradient: number): number;
  71730. }
  71731. /**
  71732. * Easing function with a ease back shape (see link below).
  71733. * @see https://easings.net/#easeInBack
  71734. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71735. */
  71736. export class BackEase extends EasingFunction implements IEasingFunction {
  71737. /** Defines the amplitude of the function */
  71738. amplitude: number;
  71739. /**
  71740. * Instantiates a back ease easing
  71741. * @see https://easings.net/#easeInBack
  71742. * @param amplitude Defines the amplitude of the function
  71743. */
  71744. constructor(
  71745. /** Defines the amplitude of the function */
  71746. amplitude?: number);
  71747. /** @hidden */
  71748. easeInCore(gradient: number): number;
  71749. }
  71750. /**
  71751. * Easing function with a bouncing shape (see link below).
  71752. * @see https://easings.net/#easeInBounce
  71753. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71754. */
  71755. export class BounceEase extends EasingFunction implements IEasingFunction {
  71756. /** Defines the number of bounces */
  71757. bounces: number;
  71758. /** Defines the amplitude of the bounce */
  71759. bounciness: number;
  71760. /**
  71761. * Instantiates a bounce easing
  71762. * @see https://easings.net/#easeInBounce
  71763. * @param bounces Defines the number of bounces
  71764. * @param bounciness Defines the amplitude of the bounce
  71765. */
  71766. constructor(
  71767. /** Defines the number of bounces */
  71768. bounces?: number,
  71769. /** Defines the amplitude of the bounce */
  71770. bounciness?: number);
  71771. /** @hidden */
  71772. easeInCore(gradient: number): number;
  71773. }
  71774. /**
  71775. * Easing function with a power of 3 shape (see link below).
  71776. * @see https://easings.net/#easeInCubic
  71777. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71778. */
  71779. export class CubicEase extends EasingFunction implements IEasingFunction {
  71780. /** @hidden */
  71781. easeInCore(gradient: number): number;
  71782. }
  71783. /**
  71784. * Easing function with an elastic shape (see link below).
  71785. * @see https://easings.net/#easeInElastic
  71786. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71787. */
  71788. export class ElasticEase extends EasingFunction implements IEasingFunction {
  71789. /** Defines the number of oscillations*/
  71790. oscillations: number;
  71791. /** Defines the amplitude of the oscillations*/
  71792. springiness: number;
  71793. /**
  71794. * Instantiates an elastic easing function
  71795. * @see https://easings.net/#easeInElastic
  71796. * @param oscillations Defines the number of oscillations
  71797. * @param springiness Defines the amplitude of the oscillations
  71798. */
  71799. constructor(
  71800. /** Defines the number of oscillations*/
  71801. oscillations?: number,
  71802. /** Defines the amplitude of the oscillations*/
  71803. springiness?: number);
  71804. /** @hidden */
  71805. easeInCore(gradient: number): number;
  71806. }
  71807. /**
  71808. * Easing function with an exponential shape (see link below).
  71809. * @see https://easings.net/#easeInExpo
  71810. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71811. */
  71812. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  71813. /** Defines the exponent of the function */
  71814. exponent: number;
  71815. /**
  71816. * Instantiates an exponential easing function
  71817. * @see https://easings.net/#easeInExpo
  71818. * @param exponent Defines the exponent of the function
  71819. */
  71820. constructor(
  71821. /** Defines the exponent of the function */
  71822. exponent?: number);
  71823. /** @hidden */
  71824. easeInCore(gradient: number): number;
  71825. }
  71826. /**
  71827. * Easing function with a power shape (see link below).
  71828. * @see https://easings.net/#easeInQuad
  71829. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71830. */
  71831. export class PowerEase extends EasingFunction implements IEasingFunction {
  71832. /** Defines the power of the function */
  71833. power: number;
  71834. /**
  71835. * Instantiates an power base easing function
  71836. * @see https://easings.net/#easeInQuad
  71837. * @param power Defines the power of the function
  71838. */
  71839. constructor(
  71840. /** Defines the power of the function */
  71841. power?: number);
  71842. /** @hidden */
  71843. easeInCore(gradient: number): number;
  71844. }
  71845. /**
  71846. * Easing function with a power of 2 shape (see link below).
  71847. * @see https://easings.net/#easeInQuad
  71848. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71849. */
  71850. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  71851. /** @hidden */
  71852. easeInCore(gradient: number): number;
  71853. }
  71854. /**
  71855. * Easing function with a power of 4 shape (see link below).
  71856. * @see https://easings.net/#easeInQuart
  71857. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71858. */
  71859. export class QuarticEase extends EasingFunction implements IEasingFunction {
  71860. /** @hidden */
  71861. easeInCore(gradient: number): number;
  71862. }
  71863. /**
  71864. * Easing function with a power of 5 shape (see link below).
  71865. * @see https://easings.net/#easeInQuint
  71866. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71867. */
  71868. export class QuinticEase extends EasingFunction implements IEasingFunction {
  71869. /** @hidden */
  71870. easeInCore(gradient: number): number;
  71871. }
  71872. /**
  71873. * Easing function with a sin shape (see link below).
  71874. * @see https://easings.net/#easeInSine
  71875. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71876. */
  71877. export class SineEase extends EasingFunction implements IEasingFunction {
  71878. /** @hidden */
  71879. easeInCore(gradient: number): number;
  71880. }
  71881. /**
  71882. * Easing function with a bezier shape (see link below).
  71883. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  71884. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  71885. */
  71886. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  71887. /** Defines the x component of the start tangent in the bezier curve */
  71888. x1: number;
  71889. /** Defines the y component of the start tangent in the bezier curve */
  71890. y1: number;
  71891. /** Defines the x component of the end tangent in the bezier curve */
  71892. x2: number;
  71893. /** Defines the y component of the end tangent in the bezier curve */
  71894. y2: number;
  71895. /**
  71896. * Instantiates a bezier function
  71897. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  71898. * @param x1 Defines the x component of the start tangent in the bezier curve
  71899. * @param y1 Defines the y component of the start tangent in the bezier curve
  71900. * @param x2 Defines the x component of the end tangent in the bezier curve
  71901. * @param y2 Defines the y component of the end tangent in the bezier curve
  71902. */
  71903. constructor(
  71904. /** Defines the x component of the start tangent in the bezier curve */
  71905. x1?: number,
  71906. /** Defines the y component of the start tangent in the bezier curve */
  71907. y1?: number,
  71908. /** Defines the x component of the end tangent in the bezier curve */
  71909. x2?: number,
  71910. /** Defines the y component of the end tangent in the bezier curve */
  71911. y2?: number);
  71912. /** @hidden */
  71913. easeInCore(gradient: number): number;
  71914. }
  71915. }
  71916. declare module BABYLON {
  71917. /**
  71918. * Defines an interface which represents an animation key frame
  71919. */
  71920. export interface IAnimationKey {
  71921. /**
  71922. * Frame of the key frame
  71923. */
  71924. frame: number;
  71925. /**
  71926. * Value at the specifies key frame
  71927. */
  71928. value: any;
  71929. /**
  71930. * The input tangent for the cubic hermite spline
  71931. */
  71932. inTangent?: any;
  71933. /**
  71934. * The output tangent for the cubic hermite spline
  71935. */
  71936. outTangent?: any;
  71937. /**
  71938. * The animation interpolation type
  71939. */
  71940. interpolation?: AnimationKeyInterpolation;
  71941. }
  71942. /**
  71943. * Enum for the animation key frame interpolation type
  71944. */
  71945. export enum AnimationKeyInterpolation {
  71946. /**
  71947. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  71948. */
  71949. STEP = 1
  71950. }
  71951. }
  71952. declare module BABYLON {
  71953. /**
  71954. * Represents the range of an animation
  71955. */
  71956. export class AnimationRange {
  71957. /**The name of the animation range**/
  71958. name: string;
  71959. /**The starting frame of the animation */
  71960. from: number;
  71961. /**The ending frame of the animation*/
  71962. to: number;
  71963. /**
  71964. * Initializes the range of an animation
  71965. * @param name The name of the animation range
  71966. * @param from The starting frame of the animation
  71967. * @param to The ending frame of the animation
  71968. */
  71969. constructor(
  71970. /**The name of the animation range**/
  71971. name: string,
  71972. /**The starting frame of the animation */
  71973. from: number,
  71974. /**The ending frame of the animation*/
  71975. to: number);
  71976. /**
  71977. * Makes a copy of the animation range
  71978. * @returns A copy of the animation range
  71979. */
  71980. clone(): AnimationRange;
  71981. }
  71982. }
  71983. declare module BABYLON {
  71984. /**
  71985. * Composed of a frame, and an action function
  71986. */
  71987. export class AnimationEvent {
  71988. /** The frame for which the event is triggered **/
  71989. frame: number;
  71990. /** The event to perform when triggered **/
  71991. action: (currentFrame: number) => void;
  71992. /** Specifies if the event should be triggered only once**/
  71993. onlyOnce?: boolean | undefined;
  71994. /**
  71995. * Specifies if the animation event is done
  71996. */
  71997. isDone: boolean;
  71998. /**
  71999. * Initializes the animation event
  72000. * @param frame The frame for which the event is triggered
  72001. * @param action The event to perform when triggered
  72002. * @param onlyOnce Specifies if the event should be triggered only once
  72003. */
  72004. constructor(
  72005. /** The frame for which the event is triggered **/
  72006. frame: number,
  72007. /** The event to perform when triggered **/
  72008. action: (currentFrame: number) => void,
  72009. /** Specifies if the event should be triggered only once**/
  72010. onlyOnce?: boolean | undefined);
  72011. /** @hidden */
  72012. _clone(): AnimationEvent;
  72013. }
  72014. }
  72015. declare module BABYLON {
  72016. /**
  72017. * Interface used to define a behavior
  72018. */
  72019. export interface Behavior<T> {
  72020. /** gets or sets behavior's name */
  72021. name: string;
  72022. /**
  72023. * Function called when the behavior needs to be initialized (after attaching it to a target)
  72024. */
  72025. init(): void;
  72026. /**
  72027. * Called when the behavior is attached to a target
  72028. * @param target defines the target where the behavior is attached to
  72029. */
  72030. attach(target: T): void;
  72031. /**
  72032. * Called when the behavior is detached from its target
  72033. */
  72034. detach(): void;
  72035. }
  72036. /**
  72037. * Interface implemented by classes supporting behaviors
  72038. */
  72039. export interface IBehaviorAware<T> {
  72040. /**
  72041. * Attach a behavior
  72042. * @param behavior defines the behavior to attach
  72043. * @returns the current host
  72044. */
  72045. addBehavior(behavior: Behavior<T>): T;
  72046. /**
  72047. * Remove a behavior from the current object
  72048. * @param behavior defines the behavior to detach
  72049. * @returns the current host
  72050. */
  72051. removeBehavior(behavior: Behavior<T>): T;
  72052. /**
  72053. * Gets a behavior using its name to search
  72054. * @param name defines the name to search
  72055. * @returns the behavior or null if not found
  72056. */
  72057. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  72058. }
  72059. }
  72060. declare module BABYLON {
  72061. /**
  72062. * Defines an array and its length.
  72063. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  72064. */
  72065. export interface ISmartArrayLike<T> {
  72066. /**
  72067. * The data of the array.
  72068. */
  72069. data: Array<T>;
  72070. /**
  72071. * The active length of the array.
  72072. */
  72073. length: number;
  72074. }
  72075. /**
  72076. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  72077. */
  72078. export class SmartArray<T> implements ISmartArrayLike<T> {
  72079. /**
  72080. * The full set of data from the array.
  72081. */
  72082. data: Array<T>;
  72083. /**
  72084. * The active length of the array.
  72085. */
  72086. length: number;
  72087. protected _id: number;
  72088. /**
  72089. * Instantiates a Smart Array.
  72090. * @param capacity defines the default capacity of the array.
  72091. */
  72092. constructor(capacity: number);
  72093. /**
  72094. * Pushes a value at the end of the active data.
  72095. * @param value defines the object to push in the array.
  72096. */
  72097. push(value: T): void;
  72098. /**
  72099. * Iterates over the active data and apply the lambda to them.
  72100. * @param func defines the action to apply on each value.
  72101. */
  72102. forEach(func: (content: T) => void): void;
  72103. /**
  72104. * Sorts the full sets of data.
  72105. * @param compareFn defines the comparison function to apply.
  72106. */
  72107. sort(compareFn: (a: T, b: T) => number): void;
  72108. /**
  72109. * Resets the active data to an empty array.
  72110. */
  72111. reset(): void;
  72112. /**
  72113. * Releases all the data from the array as well as the array.
  72114. */
  72115. dispose(): void;
  72116. /**
  72117. * Concats the active data with a given array.
  72118. * @param array defines the data to concatenate with.
  72119. */
  72120. concat(array: any): void;
  72121. /**
  72122. * Returns the position of a value in the active data.
  72123. * @param value defines the value to find the index for
  72124. * @returns the index if found in the active data otherwise -1
  72125. */
  72126. indexOf(value: T): number;
  72127. /**
  72128. * Returns whether an element is part of the active data.
  72129. * @param value defines the value to look for
  72130. * @returns true if found in the active data otherwise false
  72131. */
  72132. contains(value: T): boolean;
  72133. private static _GlobalId;
  72134. }
  72135. /**
  72136. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  72137. * The data in this array can only be present once
  72138. */
  72139. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  72140. private _duplicateId;
  72141. /**
  72142. * Pushes a value at the end of the active data.
  72143. * THIS DOES NOT PREVENT DUPPLICATE DATA
  72144. * @param value defines the object to push in the array.
  72145. */
  72146. push(value: T): void;
  72147. /**
  72148. * Pushes a value at the end of the active data.
  72149. * If the data is already present, it won t be added again
  72150. * @param value defines the object to push in the array.
  72151. * @returns true if added false if it was already present
  72152. */
  72153. pushNoDuplicate(value: T): boolean;
  72154. /**
  72155. * Resets the active data to an empty array.
  72156. */
  72157. reset(): void;
  72158. /**
  72159. * Concats the active data with a given array.
  72160. * This ensures no dupplicate will be present in the result.
  72161. * @param array defines the data to concatenate with.
  72162. */
  72163. concatWithNoDuplicate(array: any): void;
  72164. }
  72165. }
  72166. declare module BABYLON {
  72167. /**
  72168. * @ignore
  72169. * This is a list of all the different input types that are available in the application.
  72170. * Fo instance: ArcRotateCameraGamepadInput...
  72171. */
  72172. export var CameraInputTypes: {};
  72173. /**
  72174. * This is the contract to implement in order to create a new input class.
  72175. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  72176. */
  72177. export interface ICameraInput<TCamera extends Camera> {
  72178. /**
  72179. * Defines the camera the input is attached to.
  72180. */
  72181. camera: Nullable<TCamera>;
  72182. /**
  72183. * Gets the class name of the current intput.
  72184. * @returns the class name
  72185. */
  72186. getClassName(): string;
  72187. /**
  72188. * Get the friendly name associated with the input class.
  72189. * @returns the input friendly name
  72190. */
  72191. getSimpleName(): string;
  72192. /**
  72193. * Attach the input controls to a specific dom element to get the input from.
  72194. * @param element Defines the element the controls should be listened from
  72195. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  72196. */
  72197. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  72198. /**
  72199. * Detach the current controls from the specified dom element.
  72200. * @param element Defines the element to stop listening the inputs from
  72201. */
  72202. detachControl(element: Nullable<HTMLElement>): void;
  72203. /**
  72204. * Update the current camera state depending on the inputs that have been used this frame.
  72205. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  72206. */
  72207. checkInputs?: () => void;
  72208. }
  72209. /**
  72210. * Represents a map of input types to input instance or input index to input instance.
  72211. */
  72212. export interface CameraInputsMap<TCamera extends Camera> {
  72213. /**
  72214. * Accessor to the input by input type.
  72215. */
  72216. [name: string]: ICameraInput<TCamera>;
  72217. /**
  72218. * Accessor to the input by input index.
  72219. */
  72220. [idx: number]: ICameraInput<TCamera>;
  72221. }
  72222. /**
  72223. * This represents the input manager used within a camera.
  72224. * It helps dealing with all the different kind of input attached to a camera.
  72225. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  72226. */
  72227. export class CameraInputsManager<TCamera extends Camera> {
  72228. /**
  72229. * Defines the list of inputs attahed to the camera.
  72230. */
  72231. attached: CameraInputsMap<TCamera>;
  72232. /**
  72233. * Defines the dom element the camera is collecting inputs from.
  72234. * This is null if the controls have not been attached.
  72235. */
  72236. attachedElement: Nullable<HTMLElement>;
  72237. /**
  72238. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  72239. */
  72240. noPreventDefault: boolean;
  72241. /**
  72242. * Defined the camera the input manager belongs to.
  72243. */
  72244. camera: TCamera;
  72245. /**
  72246. * Update the current camera state depending on the inputs that have been used this frame.
  72247. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  72248. */
  72249. checkInputs: () => void;
  72250. /**
  72251. * Instantiate a new Camera Input Manager.
  72252. * @param camera Defines the camera the input manager blongs to
  72253. */
  72254. constructor(camera: TCamera);
  72255. /**
  72256. * Add an input method to a camera
  72257. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  72258. * @param input camera input method
  72259. */
  72260. add(input: ICameraInput<TCamera>): void;
  72261. /**
  72262. * Remove a specific input method from a camera
  72263. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  72264. * @param inputToRemove camera input method
  72265. */
  72266. remove(inputToRemove: ICameraInput<TCamera>): void;
  72267. /**
  72268. * Remove a specific input type from a camera
  72269. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  72270. * @param inputType the type of the input to remove
  72271. */
  72272. removeByType(inputType: string): void;
  72273. private _addCheckInputs;
  72274. /**
  72275. * Attach the input controls to the currently attached dom element to listen the events from.
  72276. * @param input Defines the input to attach
  72277. */
  72278. attachInput(input: ICameraInput<TCamera>): void;
  72279. /**
  72280. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  72281. * @param element Defines the dom element to collect the events from
  72282. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  72283. */
  72284. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  72285. /**
  72286. * Detach the current manager inputs controls from a specific dom element.
  72287. * @param element Defines the dom element to collect the events from
  72288. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  72289. */
  72290. detachElement(element: HTMLElement, disconnect?: boolean): void;
  72291. /**
  72292. * Rebuild the dynamic inputCheck function from the current list of
  72293. * defined inputs in the manager.
  72294. */
  72295. rebuildInputCheck(): void;
  72296. /**
  72297. * Remove all attached input methods from a camera
  72298. */
  72299. clear(): void;
  72300. /**
  72301. * Serialize the current input manager attached to a camera.
  72302. * This ensures than once parsed,
  72303. * the input associated to the camera will be identical to the current ones
  72304. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  72305. */
  72306. serialize(serializedCamera: any): void;
  72307. /**
  72308. * Parses an input manager serialized JSON to restore the previous list of inputs
  72309. * and states associated to a camera.
  72310. * @param parsedCamera Defines the JSON to parse
  72311. */
  72312. parse(parsedCamera: any): void;
  72313. }
  72314. }
  72315. declare module BABYLON {
  72316. /**
  72317. * @hidden
  72318. */
  72319. export class IntersectionInfo {
  72320. bu: Nullable<number>;
  72321. bv: Nullable<number>;
  72322. distance: number;
  72323. faceId: number;
  72324. subMeshId: number;
  72325. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  72326. }
  72327. }
  72328. declare module BABYLON {
  72329. /**
  72330. * Represens a plane by the equation ax + by + cz + d = 0
  72331. */
  72332. export class Plane {
  72333. private static _TmpMatrix;
  72334. /**
  72335. * Normal of the plane (a,b,c)
  72336. */
  72337. normal: Vector3;
  72338. /**
  72339. * d component of the plane
  72340. */
  72341. d: number;
  72342. /**
  72343. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  72344. * @param a a component of the plane
  72345. * @param b b component of the plane
  72346. * @param c c component of the plane
  72347. * @param d d component of the plane
  72348. */
  72349. constructor(a: number, b: number, c: number, d: number);
  72350. /**
  72351. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  72352. */
  72353. asArray(): number[];
  72354. /**
  72355. * @returns a new plane copied from the current Plane.
  72356. */
  72357. clone(): Plane;
  72358. /**
  72359. * @returns the string "Plane".
  72360. */
  72361. getClassName(): string;
  72362. /**
  72363. * @returns the Plane hash code.
  72364. */
  72365. getHashCode(): number;
  72366. /**
  72367. * Normalize the current Plane in place.
  72368. * @returns the updated Plane.
  72369. */
  72370. normalize(): Plane;
  72371. /**
  72372. * Applies a transformation the plane and returns the result
  72373. * @param transformation the transformation matrix to be applied to the plane
  72374. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  72375. */
  72376. transform(transformation: DeepImmutable<Matrix>): Plane;
  72377. /**
  72378. * Calcualtte the dot product between the point and the plane normal
  72379. * @param point point to calculate the dot product with
  72380. * @returns the dot product (float) of the point coordinates and the plane normal.
  72381. */
  72382. dotCoordinate(point: DeepImmutable<Vector3>): number;
  72383. /**
  72384. * Updates the current Plane from the plane defined by the three given points.
  72385. * @param point1 one of the points used to contruct the plane
  72386. * @param point2 one of the points used to contruct the plane
  72387. * @param point3 one of the points used to contruct the plane
  72388. * @returns the updated Plane.
  72389. */
  72390. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  72391. /**
  72392. * Checks if the plane is facing a given direction
  72393. * @param direction the direction to check if the plane is facing
  72394. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  72395. * @returns True is the vector "direction" is the same side than the plane normal.
  72396. */
  72397. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  72398. /**
  72399. * Calculates the distance to a point
  72400. * @param point point to calculate distance to
  72401. * @returns the signed distance (float) from the given point to the Plane.
  72402. */
  72403. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  72404. /**
  72405. * Creates a plane from an array
  72406. * @param array the array to create a plane from
  72407. * @returns a new Plane from the given array.
  72408. */
  72409. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  72410. /**
  72411. * Creates a plane from three points
  72412. * @param point1 point used to create the plane
  72413. * @param point2 point used to create the plane
  72414. * @param point3 point used to create the plane
  72415. * @returns a new Plane defined by the three given points.
  72416. */
  72417. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  72418. /**
  72419. * Creates a plane from an origin point and a normal
  72420. * @param origin origin of the plane to be constructed
  72421. * @param normal normal of the plane to be constructed
  72422. * @returns a new Plane the normal vector to this plane at the given origin point.
  72423. * Note : the vector "normal" is updated because normalized.
  72424. */
  72425. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  72426. /**
  72427. * Calculates the distance from a plane and a point
  72428. * @param origin origin of the plane to be constructed
  72429. * @param normal normal of the plane to be constructed
  72430. * @param point point to calculate distance to
  72431. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  72432. */
  72433. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  72434. }
  72435. }
  72436. declare module BABYLON {
  72437. /**
  72438. * Class used to store bounding sphere information
  72439. */
  72440. export class BoundingSphere {
  72441. /**
  72442. * Gets the center of the bounding sphere in local space
  72443. */
  72444. readonly center: Vector3;
  72445. /**
  72446. * Radius of the bounding sphere in local space
  72447. */
  72448. radius: number;
  72449. /**
  72450. * Gets the center of the bounding sphere in world space
  72451. */
  72452. readonly centerWorld: Vector3;
  72453. /**
  72454. * Radius of the bounding sphere in world space
  72455. */
  72456. radiusWorld: number;
  72457. /**
  72458. * Gets the minimum vector in local space
  72459. */
  72460. readonly minimum: Vector3;
  72461. /**
  72462. * Gets the maximum vector in local space
  72463. */
  72464. readonly maximum: Vector3;
  72465. private _worldMatrix;
  72466. private static readonly TmpVector3;
  72467. /**
  72468. * Creates a new bounding sphere
  72469. * @param min defines the minimum vector (in local space)
  72470. * @param max defines the maximum vector (in local space)
  72471. * @param worldMatrix defines the new world matrix
  72472. */
  72473. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  72474. /**
  72475. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  72476. * @param min defines the new minimum vector (in local space)
  72477. * @param max defines the new maximum vector (in local space)
  72478. * @param worldMatrix defines the new world matrix
  72479. */
  72480. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  72481. /**
  72482. * Scale the current bounding sphere by applying a scale factor
  72483. * @param factor defines the scale factor to apply
  72484. * @returns the current bounding box
  72485. */
  72486. scale(factor: number): BoundingSphere;
  72487. /**
  72488. * Gets the world matrix of the bounding box
  72489. * @returns a matrix
  72490. */
  72491. getWorldMatrix(): DeepImmutable<Matrix>;
  72492. /** @hidden */
  72493. _update(worldMatrix: DeepImmutable<Matrix>): void;
  72494. /**
  72495. * Tests if the bounding sphere is intersecting the frustum planes
  72496. * @param frustumPlanes defines the frustum planes to test
  72497. * @returns true if there is an intersection
  72498. */
  72499. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72500. /**
  72501. * Tests if the bounding sphere center is in between the frustum planes.
  72502. * Used for optimistic fast inclusion.
  72503. * @param frustumPlanes defines the frustum planes to test
  72504. * @returns true if the sphere center is in between the frustum planes
  72505. */
  72506. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72507. /**
  72508. * Tests if a point is inside the bounding sphere
  72509. * @param point defines the point to test
  72510. * @returns true if the point is inside the bounding sphere
  72511. */
  72512. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  72513. /**
  72514. * Checks if two sphere intersct
  72515. * @param sphere0 sphere 0
  72516. * @param sphere1 sphere 1
  72517. * @returns true if the speres intersect
  72518. */
  72519. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  72520. }
  72521. }
  72522. declare module BABYLON {
  72523. /**
  72524. * Class used to store bounding box information
  72525. */
  72526. export class BoundingBox implements ICullable {
  72527. /**
  72528. * Gets the 8 vectors representing the bounding box in local space
  72529. */
  72530. readonly vectors: Vector3[];
  72531. /**
  72532. * Gets the center of the bounding box in local space
  72533. */
  72534. readonly center: Vector3;
  72535. /**
  72536. * Gets the center of the bounding box in world space
  72537. */
  72538. readonly centerWorld: Vector3;
  72539. /**
  72540. * Gets the extend size in local space
  72541. */
  72542. readonly extendSize: Vector3;
  72543. /**
  72544. * Gets the extend size in world space
  72545. */
  72546. readonly extendSizeWorld: Vector3;
  72547. /**
  72548. * Gets the OBB (object bounding box) directions
  72549. */
  72550. readonly directions: Vector3[];
  72551. /**
  72552. * Gets the 8 vectors representing the bounding box in world space
  72553. */
  72554. readonly vectorsWorld: Vector3[];
  72555. /**
  72556. * Gets the minimum vector in world space
  72557. */
  72558. readonly minimumWorld: Vector3;
  72559. /**
  72560. * Gets the maximum vector in world space
  72561. */
  72562. readonly maximumWorld: Vector3;
  72563. /**
  72564. * Gets the minimum vector in local space
  72565. */
  72566. readonly minimum: Vector3;
  72567. /**
  72568. * Gets the maximum vector in local space
  72569. */
  72570. readonly maximum: Vector3;
  72571. private _worldMatrix;
  72572. private static readonly TmpVector3;
  72573. /**
  72574. * @hidden
  72575. */
  72576. _tag: number;
  72577. /**
  72578. * Creates a new bounding box
  72579. * @param min defines the minimum vector (in local space)
  72580. * @param max defines the maximum vector (in local space)
  72581. * @param worldMatrix defines the new world matrix
  72582. */
  72583. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  72584. /**
  72585. * Recreates the entire bounding box from scratch as if we call the constructor in place
  72586. * @param min defines the new minimum vector (in local space)
  72587. * @param max defines the new maximum vector (in local space)
  72588. * @param worldMatrix defines the new world matrix
  72589. */
  72590. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  72591. /**
  72592. * Scale the current bounding box by applying a scale factor
  72593. * @param factor defines the scale factor to apply
  72594. * @returns the current bounding box
  72595. */
  72596. scale(factor: number): BoundingBox;
  72597. /**
  72598. * Gets the world matrix of the bounding box
  72599. * @returns a matrix
  72600. */
  72601. getWorldMatrix(): DeepImmutable<Matrix>;
  72602. /** @hidden */
  72603. _update(world: DeepImmutable<Matrix>): void;
  72604. /**
  72605. * Tests if the bounding box is intersecting the frustum planes
  72606. * @param frustumPlanes defines the frustum planes to test
  72607. * @returns true if there is an intersection
  72608. */
  72609. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72610. /**
  72611. * Tests if the bounding box is entirely inside the frustum planes
  72612. * @param frustumPlanes defines the frustum planes to test
  72613. * @returns true if there is an inclusion
  72614. */
  72615. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72616. /**
  72617. * Tests if a point is inside the bounding box
  72618. * @param point defines the point to test
  72619. * @returns true if the point is inside the bounding box
  72620. */
  72621. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  72622. /**
  72623. * Tests if the bounding box intersects with a bounding sphere
  72624. * @param sphere defines the sphere to test
  72625. * @returns true if there is an intersection
  72626. */
  72627. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  72628. /**
  72629. * Tests if the bounding box intersects with a box defined by a min and max vectors
  72630. * @param min defines the min vector to use
  72631. * @param max defines the max vector to use
  72632. * @returns true if there is an intersection
  72633. */
  72634. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  72635. /**
  72636. * Tests if two bounding boxes are intersections
  72637. * @param box0 defines the first box to test
  72638. * @param box1 defines the second box to test
  72639. * @returns true if there is an intersection
  72640. */
  72641. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  72642. /**
  72643. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  72644. * @param minPoint defines the minimum vector of the bounding box
  72645. * @param maxPoint defines the maximum vector of the bounding box
  72646. * @param sphereCenter defines the sphere center
  72647. * @param sphereRadius defines the sphere radius
  72648. * @returns true if there is an intersection
  72649. */
  72650. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  72651. /**
  72652. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  72653. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  72654. * @param frustumPlanes defines the frustum planes to test
  72655. * @return true if there is an inclusion
  72656. */
  72657. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72658. /**
  72659. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  72660. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  72661. * @param frustumPlanes defines the frustum planes to test
  72662. * @return true if there is an intersection
  72663. */
  72664. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72665. }
  72666. }
  72667. declare module BABYLON {
  72668. /** @hidden */
  72669. export class Collider {
  72670. /** Define if a collision was found */
  72671. collisionFound: boolean;
  72672. /**
  72673. * Define last intersection point in local space
  72674. */
  72675. intersectionPoint: Vector3;
  72676. /**
  72677. * Define last collided mesh
  72678. */
  72679. collidedMesh: Nullable<AbstractMesh>;
  72680. private _collisionPoint;
  72681. private _planeIntersectionPoint;
  72682. private _tempVector;
  72683. private _tempVector2;
  72684. private _tempVector3;
  72685. private _tempVector4;
  72686. private _edge;
  72687. private _baseToVertex;
  72688. private _destinationPoint;
  72689. private _slidePlaneNormal;
  72690. private _displacementVector;
  72691. /** @hidden */
  72692. _radius: Vector3;
  72693. /** @hidden */
  72694. _retry: number;
  72695. private _velocity;
  72696. private _basePoint;
  72697. private _epsilon;
  72698. /** @hidden */
  72699. _velocityWorldLength: number;
  72700. /** @hidden */
  72701. _basePointWorld: Vector3;
  72702. private _velocityWorld;
  72703. private _normalizedVelocity;
  72704. /** @hidden */
  72705. _initialVelocity: Vector3;
  72706. /** @hidden */
  72707. _initialPosition: Vector3;
  72708. private _nearestDistance;
  72709. private _collisionMask;
  72710. collisionMask: number;
  72711. /**
  72712. * Gets the plane normal used to compute the sliding response (in local space)
  72713. */
  72714. readonly slidePlaneNormal: Vector3;
  72715. /** @hidden */
  72716. _initialize(source: Vector3, dir: Vector3, e: number): void;
  72717. /** @hidden */
  72718. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  72719. /** @hidden */
  72720. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  72721. /** @hidden */
  72722. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  72723. /** @hidden */
  72724. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  72725. /** @hidden */
  72726. _getResponse(pos: Vector3, vel: Vector3): void;
  72727. }
  72728. }
  72729. declare module BABYLON {
  72730. /**
  72731. * Interface for cullable objects
  72732. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  72733. */
  72734. export interface ICullable {
  72735. /**
  72736. * Checks if the object or part of the object is in the frustum
  72737. * @param frustumPlanes Camera near/planes
  72738. * @returns true if the object is in frustum otherwise false
  72739. */
  72740. isInFrustum(frustumPlanes: Plane[]): boolean;
  72741. /**
  72742. * Checks if a cullable object (mesh...) is in the camera frustum
  72743. * Unlike isInFrustum this cheks the full bounding box
  72744. * @param frustumPlanes Camera near/planes
  72745. * @returns true if the object is in frustum otherwise false
  72746. */
  72747. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  72748. }
  72749. /**
  72750. * Info for a bounding data of a mesh
  72751. */
  72752. export class BoundingInfo implements ICullable {
  72753. /**
  72754. * Bounding box for the mesh
  72755. */
  72756. readonly boundingBox: BoundingBox;
  72757. /**
  72758. * Bounding sphere for the mesh
  72759. */
  72760. readonly boundingSphere: BoundingSphere;
  72761. private _isLocked;
  72762. private static readonly TmpVector3;
  72763. /**
  72764. * Constructs bounding info
  72765. * @param minimum min vector of the bounding box/sphere
  72766. * @param maximum max vector of the bounding box/sphere
  72767. * @param worldMatrix defines the new world matrix
  72768. */
  72769. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  72770. /**
  72771. * Recreates the entire bounding info from scratch as if we call the constructor in place
  72772. * @param min defines the new minimum vector (in local space)
  72773. * @param max defines the new maximum vector (in local space)
  72774. * @param worldMatrix defines the new world matrix
  72775. */
  72776. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  72777. /**
  72778. * min vector of the bounding box/sphere
  72779. */
  72780. readonly minimum: Vector3;
  72781. /**
  72782. * max vector of the bounding box/sphere
  72783. */
  72784. readonly maximum: Vector3;
  72785. /**
  72786. * If the info is locked and won't be updated to avoid perf overhead
  72787. */
  72788. isLocked: boolean;
  72789. /**
  72790. * Updates the bounding sphere and box
  72791. * @param world world matrix to be used to update
  72792. */
  72793. update(world: DeepImmutable<Matrix>): void;
  72794. /**
  72795. * Recreate the bounding info to be centered around a specific point given a specific extend.
  72796. * @param center New center of the bounding info
  72797. * @param extend New extend of the bounding info
  72798. * @returns the current bounding info
  72799. */
  72800. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  72801. /**
  72802. * Scale the current bounding info by applying a scale factor
  72803. * @param factor defines the scale factor to apply
  72804. * @returns the current bounding info
  72805. */
  72806. scale(factor: number): BoundingInfo;
  72807. /**
  72808. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  72809. * @param frustumPlanes defines the frustum to test
  72810. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  72811. * @returns true if the bounding info is in the frustum planes
  72812. */
  72813. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  72814. /**
  72815. * Gets the world distance between the min and max points of the bounding box
  72816. */
  72817. readonly diagonalLength: number;
  72818. /**
  72819. * Checks if a cullable object (mesh...) is in the camera frustum
  72820. * Unlike isInFrustum this cheks the full bounding box
  72821. * @param frustumPlanes Camera near/planes
  72822. * @returns true if the object is in frustum otherwise false
  72823. */
  72824. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  72825. /** @hidden */
  72826. _checkCollision(collider: Collider): boolean;
  72827. /**
  72828. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  72829. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  72830. * @param point the point to check intersection with
  72831. * @returns if the point intersects
  72832. */
  72833. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  72834. /**
  72835. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  72836. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  72837. * @param boundingInfo the bounding info to check intersection with
  72838. * @param precise if the intersection should be done using OBB
  72839. * @returns if the bounding info intersects
  72840. */
  72841. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  72842. }
  72843. }
  72844. declare module BABYLON {
  72845. /**
  72846. * Extracts minimum and maximum values from a list of indexed positions
  72847. * @param positions defines the positions to use
  72848. * @param indices defines the indices to the positions
  72849. * @param indexStart defines the start index
  72850. * @param indexCount defines the end index
  72851. * @param bias defines bias value to add to the result
  72852. * @return minimum and maximum values
  72853. */
  72854. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  72855. minimum: Vector3;
  72856. maximum: Vector3;
  72857. };
  72858. /**
  72859. * Extracts minimum and maximum values from a list of positions
  72860. * @param positions defines the positions to use
  72861. * @param start defines the start index in the positions array
  72862. * @param count defines the number of positions to handle
  72863. * @param bias defines bias value to add to the result
  72864. * @param stride defines the stride size to use (distance between two positions in the positions array)
  72865. * @return minimum and maximum values
  72866. */
  72867. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  72868. minimum: Vector3;
  72869. maximum: Vector3;
  72870. };
  72871. }
  72872. declare module BABYLON {
  72873. /**
  72874. * Enum that determines the text-wrapping mode to use.
  72875. */
  72876. export enum InspectableType {
  72877. /**
  72878. * Checkbox for booleans
  72879. */
  72880. Checkbox = 0,
  72881. /**
  72882. * Sliders for numbers
  72883. */
  72884. Slider = 1,
  72885. /**
  72886. * Vector3
  72887. */
  72888. Vector3 = 2,
  72889. /**
  72890. * Quaternions
  72891. */
  72892. Quaternion = 3,
  72893. /**
  72894. * Color3
  72895. */
  72896. Color3 = 4,
  72897. /**
  72898. * String
  72899. */
  72900. String = 5
  72901. }
  72902. /**
  72903. * Interface used to define custom inspectable properties.
  72904. * This interface is used by the inspector to display custom property grids
  72905. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  72906. */
  72907. export interface IInspectable {
  72908. /**
  72909. * Gets the label to display
  72910. */
  72911. label: string;
  72912. /**
  72913. * Gets the name of the property to edit
  72914. */
  72915. propertyName: string;
  72916. /**
  72917. * Gets the type of the editor to use
  72918. */
  72919. type: InspectableType;
  72920. /**
  72921. * Gets the minimum value of the property when using in "slider" mode
  72922. */
  72923. min?: number;
  72924. /**
  72925. * Gets the maximum value of the property when using in "slider" mode
  72926. */
  72927. max?: number;
  72928. /**
  72929. * Gets the setp to use when using in "slider" mode
  72930. */
  72931. step?: number;
  72932. }
  72933. }
  72934. declare module BABYLON {
  72935. /**
  72936. * Class used to provide helper for timing
  72937. */
  72938. export class TimingTools {
  72939. /**
  72940. * Polyfill for setImmediate
  72941. * @param action defines the action to execute after the current execution block
  72942. */
  72943. static SetImmediate(action: () => void): void;
  72944. }
  72945. }
  72946. declare module BABYLON {
  72947. /**
  72948. * Class used to enable instatition of objects by class name
  72949. */
  72950. export class InstantiationTools {
  72951. /**
  72952. * Use this object to register external classes like custom textures or material
  72953. * to allow the laoders to instantiate them
  72954. */
  72955. static RegisteredExternalClasses: {
  72956. [key: string]: Object;
  72957. };
  72958. /**
  72959. * Tries to instantiate a new object from a given class name
  72960. * @param className defines the class name to instantiate
  72961. * @returns the new object or null if the system was not able to do the instantiation
  72962. */
  72963. static Instantiate(className: string): any;
  72964. }
  72965. }
  72966. declare module BABYLON {
  72967. /**
  72968. * This represents the required contract to create a new type of texture loader.
  72969. */
  72970. export interface IInternalTextureLoader {
  72971. /**
  72972. * Defines wether the loader supports cascade loading the different faces.
  72973. */
  72974. supportCascades: boolean;
  72975. /**
  72976. * This returns if the loader support the current file information.
  72977. * @param extension defines the file extension of the file being loaded
  72978. * @param textureFormatInUse defines the current compressed format in use iun the engine
  72979. * @param fallback defines the fallback internal texture if any
  72980. * @param isBase64 defines whether the texture is encoded as a base64
  72981. * @param isBuffer defines whether the texture data are stored as a buffer
  72982. * @returns true if the loader can load the specified file
  72983. */
  72984. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  72985. /**
  72986. * Transform the url before loading if required.
  72987. * @param rootUrl the url of the texture
  72988. * @param textureFormatInUse defines the current compressed format in use iun the engine
  72989. * @returns the transformed texture
  72990. */
  72991. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  72992. /**
  72993. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  72994. * @param rootUrl the url of the texture
  72995. * @param textureFormatInUse defines the current compressed format in use iun the engine
  72996. * @returns the fallback texture
  72997. */
  72998. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  72999. /**
  73000. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  73001. * @param data contains the texture data
  73002. * @param texture defines the BabylonJS internal texture
  73003. * @param createPolynomials will be true if polynomials have been requested
  73004. * @param onLoad defines the callback to trigger once the texture is ready
  73005. * @param onError defines the callback to trigger in case of error
  73006. */
  73007. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  73008. /**
  73009. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  73010. * @param data contains the texture data
  73011. * @param texture defines the BabylonJS internal texture
  73012. * @param callback defines the method to call once ready to upload
  73013. */
  73014. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  73015. }
  73016. }
  73017. declare module BABYLON {
  73018. interface Engine {
  73019. /**
  73020. * Creates a depth stencil cube texture.
  73021. * This is only available in WebGL 2.
  73022. * @param size The size of face edge in the cube texture.
  73023. * @param options The options defining the cube texture.
  73024. * @returns The cube texture
  73025. */
  73026. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  73027. /**
  73028. * Creates a cube texture
  73029. * @param rootUrl defines the url where the files to load is located
  73030. * @param scene defines the current scene
  73031. * @param files defines the list of files to load (1 per face)
  73032. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  73033. * @param onLoad defines an optional callback raised when the texture is loaded
  73034. * @param onError defines an optional callback raised if there is an issue to load the texture
  73035. * @param format defines the format of the data
  73036. * @param forcedExtension defines the extension to use to pick the right loader
  73037. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  73038. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  73039. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  73040. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  73041. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  73042. * @returns the cube texture as an InternalTexture
  73043. */
  73044. 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;
  73045. /**
  73046. * Creates a cube texture
  73047. * @param rootUrl defines the url where the files to load is located
  73048. * @param scene defines the current scene
  73049. * @param files defines the list of files to load (1 per face)
  73050. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  73051. * @param onLoad defines an optional callback raised when the texture is loaded
  73052. * @param onError defines an optional callback raised if there is an issue to load the texture
  73053. * @param format defines the format of the data
  73054. * @param forcedExtension defines the extension to use to pick the right loader
  73055. * @returns the cube texture as an InternalTexture
  73056. */
  73057. 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;
  73058. /**
  73059. * Creates a cube texture
  73060. * @param rootUrl defines the url where the files to load is located
  73061. * @param scene defines the current scene
  73062. * @param files defines the list of files to load (1 per face)
  73063. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  73064. * @param onLoad defines an optional callback raised when the texture is loaded
  73065. * @param onError defines an optional callback raised if there is an issue to load the texture
  73066. * @param format defines the format of the data
  73067. * @param forcedExtension defines the extension to use to pick the right loader
  73068. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  73069. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  73070. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  73071. * @returns the cube texture as an InternalTexture
  73072. */
  73073. 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;
  73074. /** @hidden */
  73075. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  73076. /** @hidden */
  73077. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  73078. /** @hidden */
  73079. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  73080. /** @hidden */
  73081. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  73082. }
  73083. }
  73084. declare module BABYLON {
  73085. /**
  73086. * Class for creating a cube texture
  73087. */
  73088. export class CubeTexture extends BaseTexture {
  73089. private _delayedOnLoad;
  73090. /**
  73091. * The url of the texture
  73092. */
  73093. url: string;
  73094. /**
  73095. * Gets or sets the center of the bounding box associated with the cube texture.
  73096. * It must define where the camera used to render the texture was set
  73097. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  73098. */
  73099. boundingBoxPosition: Vector3;
  73100. private _boundingBoxSize;
  73101. /**
  73102. * Gets or sets the size of the bounding box associated with the cube texture
  73103. * When defined, the cubemap will switch to local mode
  73104. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  73105. * @example https://www.babylonjs-playground.com/#RNASML
  73106. */
  73107. /**
  73108. * Returns the bounding box size
  73109. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  73110. */
  73111. boundingBoxSize: Vector3;
  73112. protected _rotationY: number;
  73113. /**
  73114. * Sets texture matrix rotation angle around Y axis in radians.
  73115. */
  73116. /**
  73117. * Gets texture matrix rotation angle around Y axis radians.
  73118. */
  73119. rotationY: number;
  73120. /**
  73121. * Are mip maps generated for this texture or not.
  73122. */
  73123. readonly noMipmap: boolean;
  73124. private _noMipmap;
  73125. private _files;
  73126. private _extensions;
  73127. private _textureMatrix;
  73128. private _format;
  73129. private _createPolynomials;
  73130. /** @hidden */
  73131. _prefiltered: boolean;
  73132. /**
  73133. * Creates a cube texture from an array of image urls
  73134. * @param files defines an array of image urls
  73135. * @param scene defines the hosting scene
  73136. * @param noMipmap specifies if mip maps are not used
  73137. * @returns a cube texture
  73138. */
  73139. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  73140. /**
  73141. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  73142. * @param url defines the url of the prefiltered texture
  73143. * @param scene defines the scene the texture is attached to
  73144. * @param forcedExtension defines the extension of the file if different from the url
  73145. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  73146. * @return the prefiltered texture
  73147. */
  73148. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  73149. /**
  73150. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  73151. * as prefiltered data.
  73152. * @param rootUrl defines the url of the texture or the root name of the six images
  73153. * @param scene defines the scene the texture is attached to
  73154. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  73155. * @param noMipmap defines if mipmaps should be created or not
  73156. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  73157. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  73158. * @param onError defines a callback triggered in case of error during load
  73159. * @param format defines the internal format to use for the texture once loaded
  73160. * @param prefiltered defines whether or not the texture is created from prefiltered data
  73161. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  73162. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  73163. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  73164. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  73165. * @return the cube texture
  73166. */
  73167. 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);
  73168. /**
  73169. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  73170. */
  73171. readonly isPrefiltered: boolean;
  73172. /**
  73173. * Get the current class name of the texture useful for serialization or dynamic coding.
  73174. * @returns "CubeTexture"
  73175. */
  73176. getClassName(): string;
  73177. /**
  73178. * Update the url (and optional buffer) of this texture if url was null during construction.
  73179. * @param url the url of the texture
  73180. * @param forcedExtension defines the extension to use
  73181. * @param onLoad callback called when the texture is loaded (defaults to null)
  73182. */
  73183. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  73184. /**
  73185. * Delays loading of the cube texture
  73186. * @param forcedExtension defines the extension to use
  73187. */
  73188. delayLoad(forcedExtension?: string): void;
  73189. /**
  73190. * Returns the reflection texture matrix
  73191. * @returns the reflection texture matrix
  73192. */
  73193. getReflectionTextureMatrix(): Matrix;
  73194. /**
  73195. * Sets the reflection texture matrix
  73196. * @param value Reflection texture matrix
  73197. */
  73198. setReflectionTextureMatrix(value: Matrix): void;
  73199. /**
  73200. * Parses text to create a cube texture
  73201. * @param parsedTexture define the serialized text to read from
  73202. * @param scene defines the hosting scene
  73203. * @param rootUrl defines the root url of the cube texture
  73204. * @returns a cube texture
  73205. */
  73206. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  73207. /**
  73208. * Makes a clone, or deep copy, of the cube texture
  73209. * @returns a new cube texture
  73210. */
  73211. clone(): CubeTexture;
  73212. }
  73213. }
  73214. declare module BABYLON {
  73215. /**
  73216. * Manages the defines for the Material
  73217. */
  73218. export class MaterialDefines {
  73219. /** @hidden */
  73220. protected _keys: string[];
  73221. private _isDirty;
  73222. /** @hidden */
  73223. _renderId: number;
  73224. /** @hidden */
  73225. _areLightsDirty: boolean;
  73226. /** @hidden */
  73227. _areLightsDisposed: boolean;
  73228. /** @hidden */
  73229. _areAttributesDirty: boolean;
  73230. /** @hidden */
  73231. _areTexturesDirty: boolean;
  73232. /** @hidden */
  73233. _areFresnelDirty: boolean;
  73234. /** @hidden */
  73235. _areMiscDirty: boolean;
  73236. /** @hidden */
  73237. _areImageProcessingDirty: boolean;
  73238. /** @hidden */
  73239. _normals: boolean;
  73240. /** @hidden */
  73241. _uvs: boolean;
  73242. /** @hidden */
  73243. _needNormals: boolean;
  73244. /** @hidden */
  73245. _needUVs: boolean;
  73246. [id: string]: any;
  73247. /**
  73248. * Specifies if the material needs to be re-calculated
  73249. */
  73250. readonly isDirty: boolean;
  73251. /**
  73252. * Marks the material to indicate that it has been re-calculated
  73253. */
  73254. markAsProcessed(): void;
  73255. /**
  73256. * Marks the material to indicate that it needs to be re-calculated
  73257. */
  73258. markAsUnprocessed(): void;
  73259. /**
  73260. * Marks the material to indicate all of its defines need to be re-calculated
  73261. */
  73262. markAllAsDirty(): void;
  73263. /**
  73264. * Marks the material to indicate that image processing needs to be re-calculated
  73265. */
  73266. markAsImageProcessingDirty(): void;
  73267. /**
  73268. * Marks the material to indicate the lights need to be re-calculated
  73269. * @param disposed Defines whether the light is dirty due to dispose or not
  73270. */
  73271. markAsLightDirty(disposed?: boolean): void;
  73272. /**
  73273. * Marks the attribute state as changed
  73274. */
  73275. markAsAttributesDirty(): void;
  73276. /**
  73277. * Marks the texture state as changed
  73278. */
  73279. markAsTexturesDirty(): void;
  73280. /**
  73281. * Marks the fresnel state as changed
  73282. */
  73283. markAsFresnelDirty(): void;
  73284. /**
  73285. * Marks the misc state as changed
  73286. */
  73287. markAsMiscDirty(): void;
  73288. /**
  73289. * Rebuilds the material defines
  73290. */
  73291. rebuild(): void;
  73292. /**
  73293. * Specifies if two material defines are equal
  73294. * @param other - A material define instance to compare to
  73295. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  73296. */
  73297. isEqual(other: MaterialDefines): boolean;
  73298. /**
  73299. * Clones this instance's defines to another instance
  73300. * @param other - material defines to clone values to
  73301. */
  73302. cloneTo(other: MaterialDefines): void;
  73303. /**
  73304. * Resets the material define values
  73305. */
  73306. reset(): void;
  73307. /**
  73308. * Converts the material define values to a string
  73309. * @returns - String of material define information
  73310. */
  73311. toString(): string;
  73312. }
  73313. }
  73314. declare module BABYLON {
  73315. /**
  73316. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  73317. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  73318. * 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;
  73319. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  73320. */
  73321. export class ColorCurves {
  73322. private _dirty;
  73323. private _tempColor;
  73324. private _globalCurve;
  73325. private _highlightsCurve;
  73326. private _midtonesCurve;
  73327. private _shadowsCurve;
  73328. private _positiveCurve;
  73329. private _negativeCurve;
  73330. private _globalHue;
  73331. private _globalDensity;
  73332. private _globalSaturation;
  73333. private _globalExposure;
  73334. /**
  73335. * Gets the global Hue value.
  73336. * 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).
  73337. */
  73338. /**
  73339. * Sets the global Hue value.
  73340. * 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).
  73341. */
  73342. globalHue: number;
  73343. /**
  73344. * Gets the global Density value.
  73345. * 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.
  73346. * Values less than zero provide a filter of opposite hue.
  73347. */
  73348. /**
  73349. * Sets the global Density value.
  73350. * 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.
  73351. * Values less than zero provide a filter of opposite hue.
  73352. */
  73353. globalDensity: number;
  73354. /**
  73355. * Gets the global Saturation value.
  73356. * 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.
  73357. */
  73358. /**
  73359. * Sets the global Saturation value.
  73360. * 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.
  73361. */
  73362. globalSaturation: number;
  73363. /**
  73364. * Gets the global Exposure value.
  73365. * 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.
  73366. */
  73367. /**
  73368. * Sets the global Exposure value.
  73369. * 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.
  73370. */
  73371. globalExposure: number;
  73372. private _highlightsHue;
  73373. private _highlightsDensity;
  73374. private _highlightsSaturation;
  73375. private _highlightsExposure;
  73376. /**
  73377. * Gets the highlights Hue value.
  73378. * 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).
  73379. */
  73380. /**
  73381. * Sets the highlights Hue value.
  73382. * 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).
  73383. */
  73384. highlightsHue: number;
  73385. /**
  73386. * Gets the highlights Density value.
  73387. * 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.
  73388. * Values less than zero provide a filter of opposite hue.
  73389. */
  73390. /**
  73391. * Sets the highlights Density value.
  73392. * 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.
  73393. * Values less than zero provide a filter of opposite hue.
  73394. */
  73395. highlightsDensity: number;
  73396. /**
  73397. * Gets the highlights Saturation value.
  73398. * 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.
  73399. */
  73400. /**
  73401. * Sets the highlights Saturation value.
  73402. * 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.
  73403. */
  73404. highlightsSaturation: number;
  73405. /**
  73406. * Gets the highlights Exposure value.
  73407. * 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.
  73408. */
  73409. /**
  73410. * Sets the highlights Exposure value.
  73411. * 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.
  73412. */
  73413. highlightsExposure: number;
  73414. private _midtonesHue;
  73415. private _midtonesDensity;
  73416. private _midtonesSaturation;
  73417. private _midtonesExposure;
  73418. /**
  73419. * Gets the midtones Hue value.
  73420. * 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).
  73421. */
  73422. /**
  73423. * Sets the midtones Hue value.
  73424. * 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).
  73425. */
  73426. midtonesHue: number;
  73427. /**
  73428. * Gets the midtones Density value.
  73429. * 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.
  73430. * Values less than zero provide a filter of opposite hue.
  73431. */
  73432. /**
  73433. * Sets the midtones Density value.
  73434. * 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.
  73435. * Values less than zero provide a filter of opposite hue.
  73436. */
  73437. midtonesDensity: number;
  73438. /**
  73439. * Gets the midtones Saturation value.
  73440. * 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.
  73441. */
  73442. /**
  73443. * Sets the midtones Saturation value.
  73444. * 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.
  73445. */
  73446. midtonesSaturation: number;
  73447. /**
  73448. * Gets the midtones Exposure value.
  73449. * 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.
  73450. */
  73451. /**
  73452. * Sets the midtones Exposure value.
  73453. * 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.
  73454. */
  73455. midtonesExposure: number;
  73456. private _shadowsHue;
  73457. private _shadowsDensity;
  73458. private _shadowsSaturation;
  73459. private _shadowsExposure;
  73460. /**
  73461. * Gets the shadows Hue value.
  73462. * 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).
  73463. */
  73464. /**
  73465. * Sets the shadows Hue value.
  73466. * 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).
  73467. */
  73468. shadowsHue: number;
  73469. /**
  73470. * Gets the shadows Density value.
  73471. * 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.
  73472. * Values less than zero provide a filter of opposite hue.
  73473. */
  73474. /**
  73475. * Sets the shadows Density value.
  73476. * 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.
  73477. * Values less than zero provide a filter of opposite hue.
  73478. */
  73479. shadowsDensity: number;
  73480. /**
  73481. * Gets the shadows Saturation value.
  73482. * 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.
  73483. */
  73484. /**
  73485. * Sets the shadows Saturation value.
  73486. * 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.
  73487. */
  73488. shadowsSaturation: number;
  73489. /**
  73490. * Gets the shadows Exposure value.
  73491. * 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.
  73492. */
  73493. /**
  73494. * Sets the shadows Exposure value.
  73495. * 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.
  73496. */
  73497. shadowsExposure: number;
  73498. /**
  73499. * Returns the class name
  73500. * @returns The class name
  73501. */
  73502. getClassName(): string;
  73503. /**
  73504. * Binds the color curves to the shader.
  73505. * @param colorCurves The color curve to bind
  73506. * @param effect The effect to bind to
  73507. * @param positiveUniform The positive uniform shader parameter
  73508. * @param neutralUniform The neutral uniform shader parameter
  73509. * @param negativeUniform The negative uniform shader parameter
  73510. */
  73511. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  73512. /**
  73513. * Prepare the list of uniforms associated with the ColorCurves effects.
  73514. * @param uniformsList The list of uniforms used in the effect
  73515. */
  73516. static PrepareUniforms(uniformsList: string[]): void;
  73517. /**
  73518. * Returns color grading data based on a hue, density, saturation and exposure value.
  73519. * @param filterHue The hue of the color filter.
  73520. * @param filterDensity The density of the color filter.
  73521. * @param saturation The saturation.
  73522. * @param exposure The exposure.
  73523. * @param result The result data container.
  73524. */
  73525. private getColorGradingDataToRef;
  73526. /**
  73527. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  73528. * @param value The input slider value in range [-100,100].
  73529. * @returns Adjusted value.
  73530. */
  73531. private static applyColorGradingSliderNonlinear;
  73532. /**
  73533. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  73534. * @param hue The hue (H) input.
  73535. * @param saturation The saturation (S) input.
  73536. * @param brightness The brightness (B) input.
  73537. * @result An RGBA color represented as Vector4.
  73538. */
  73539. private static fromHSBToRef;
  73540. /**
  73541. * Returns a value clamped between min and max
  73542. * @param value The value to clamp
  73543. * @param min The minimum of value
  73544. * @param max The maximum of value
  73545. * @returns The clamped value.
  73546. */
  73547. private static clamp;
  73548. /**
  73549. * Clones the current color curve instance.
  73550. * @return The cloned curves
  73551. */
  73552. clone(): ColorCurves;
  73553. /**
  73554. * Serializes the current color curve instance to a json representation.
  73555. * @return a JSON representation
  73556. */
  73557. serialize(): any;
  73558. /**
  73559. * Parses the color curve from a json representation.
  73560. * @param source the JSON source to parse
  73561. * @return The parsed curves
  73562. */
  73563. static Parse(source: any): ColorCurves;
  73564. }
  73565. }
  73566. declare module BABYLON {
  73567. /**
  73568. * Interface to follow in your material defines to integrate easily the
  73569. * Image proccessing functions.
  73570. * @hidden
  73571. */
  73572. export interface IImageProcessingConfigurationDefines {
  73573. IMAGEPROCESSING: boolean;
  73574. VIGNETTE: boolean;
  73575. VIGNETTEBLENDMODEMULTIPLY: boolean;
  73576. VIGNETTEBLENDMODEOPAQUE: boolean;
  73577. TONEMAPPING: boolean;
  73578. TONEMAPPING_ACES: boolean;
  73579. CONTRAST: boolean;
  73580. EXPOSURE: boolean;
  73581. COLORCURVES: boolean;
  73582. COLORGRADING: boolean;
  73583. COLORGRADING3D: boolean;
  73584. SAMPLER3DGREENDEPTH: boolean;
  73585. SAMPLER3DBGRMAP: boolean;
  73586. IMAGEPROCESSINGPOSTPROCESS: boolean;
  73587. }
  73588. /**
  73589. * @hidden
  73590. */
  73591. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  73592. IMAGEPROCESSING: boolean;
  73593. VIGNETTE: boolean;
  73594. VIGNETTEBLENDMODEMULTIPLY: boolean;
  73595. VIGNETTEBLENDMODEOPAQUE: boolean;
  73596. TONEMAPPING: boolean;
  73597. TONEMAPPING_ACES: boolean;
  73598. CONTRAST: boolean;
  73599. COLORCURVES: boolean;
  73600. COLORGRADING: boolean;
  73601. COLORGRADING3D: boolean;
  73602. SAMPLER3DGREENDEPTH: boolean;
  73603. SAMPLER3DBGRMAP: boolean;
  73604. IMAGEPROCESSINGPOSTPROCESS: boolean;
  73605. EXPOSURE: boolean;
  73606. constructor();
  73607. }
  73608. /**
  73609. * This groups together the common properties used for image processing either in direct forward pass
  73610. * or through post processing effect depending on the use of the image processing pipeline in your scene
  73611. * or not.
  73612. */
  73613. export class ImageProcessingConfiguration {
  73614. /**
  73615. * Default tone mapping applied in BabylonJS.
  73616. */
  73617. static readonly TONEMAPPING_STANDARD: number;
  73618. /**
  73619. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  73620. * to other engines rendering to increase portability.
  73621. */
  73622. static readonly TONEMAPPING_ACES: number;
  73623. /**
  73624. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  73625. */
  73626. colorCurves: Nullable<ColorCurves>;
  73627. private _colorCurvesEnabled;
  73628. /**
  73629. * Gets wether the color curves effect is enabled.
  73630. */
  73631. /**
  73632. * Sets wether the color curves effect is enabled.
  73633. */
  73634. colorCurvesEnabled: boolean;
  73635. private _colorGradingTexture;
  73636. /**
  73637. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  73638. */
  73639. /**
  73640. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  73641. */
  73642. colorGradingTexture: Nullable<BaseTexture>;
  73643. private _colorGradingEnabled;
  73644. /**
  73645. * Gets wether the color grading effect is enabled.
  73646. */
  73647. /**
  73648. * Sets wether the color grading effect is enabled.
  73649. */
  73650. colorGradingEnabled: boolean;
  73651. private _colorGradingWithGreenDepth;
  73652. /**
  73653. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  73654. */
  73655. /**
  73656. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  73657. */
  73658. colorGradingWithGreenDepth: boolean;
  73659. private _colorGradingBGR;
  73660. /**
  73661. * Gets wether the color grading texture contains BGR values.
  73662. */
  73663. /**
  73664. * Sets wether the color grading texture contains BGR values.
  73665. */
  73666. colorGradingBGR: boolean;
  73667. /** @hidden */
  73668. _exposure: number;
  73669. /**
  73670. * Gets the Exposure used in the effect.
  73671. */
  73672. /**
  73673. * Sets the Exposure used in the effect.
  73674. */
  73675. exposure: number;
  73676. private _toneMappingEnabled;
  73677. /**
  73678. * Gets wether the tone mapping effect is enabled.
  73679. */
  73680. /**
  73681. * Sets wether the tone mapping effect is enabled.
  73682. */
  73683. toneMappingEnabled: boolean;
  73684. private _toneMappingType;
  73685. /**
  73686. * Gets the type of tone mapping effect.
  73687. */
  73688. /**
  73689. * Sets the type of tone mapping effect used in BabylonJS.
  73690. */
  73691. toneMappingType: number;
  73692. protected _contrast: number;
  73693. /**
  73694. * Gets the contrast used in the effect.
  73695. */
  73696. /**
  73697. * Sets the contrast used in the effect.
  73698. */
  73699. contrast: number;
  73700. /**
  73701. * Vignette stretch size.
  73702. */
  73703. vignetteStretch: number;
  73704. /**
  73705. * Vignette centre X Offset.
  73706. */
  73707. vignetteCentreX: number;
  73708. /**
  73709. * Vignette centre Y Offset.
  73710. */
  73711. vignetteCentreY: number;
  73712. /**
  73713. * Vignette weight or intensity of the vignette effect.
  73714. */
  73715. vignetteWeight: number;
  73716. /**
  73717. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  73718. * if vignetteEnabled is set to true.
  73719. */
  73720. vignetteColor: Color4;
  73721. /**
  73722. * Camera field of view used by the Vignette effect.
  73723. */
  73724. vignetteCameraFov: number;
  73725. private _vignetteBlendMode;
  73726. /**
  73727. * Gets the vignette blend mode allowing different kind of effect.
  73728. */
  73729. /**
  73730. * Sets the vignette blend mode allowing different kind of effect.
  73731. */
  73732. vignetteBlendMode: number;
  73733. private _vignetteEnabled;
  73734. /**
  73735. * Gets wether the vignette effect is enabled.
  73736. */
  73737. /**
  73738. * Sets wether the vignette effect is enabled.
  73739. */
  73740. vignetteEnabled: boolean;
  73741. private _applyByPostProcess;
  73742. /**
  73743. * Gets wether the image processing is applied through a post process or not.
  73744. */
  73745. /**
  73746. * Sets wether the image processing is applied through a post process or not.
  73747. */
  73748. applyByPostProcess: boolean;
  73749. private _isEnabled;
  73750. /**
  73751. * Gets wether the image processing is enabled or not.
  73752. */
  73753. /**
  73754. * Sets wether the image processing is enabled or not.
  73755. */
  73756. isEnabled: boolean;
  73757. /**
  73758. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  73759. */
  73760. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  73761. /**
  73762. * Method called each time the image processing information changes requires to recompile the effect.
  73763. */
  73764. protected _updateParameters(): void;
  73765. /**
  73766. * Gets the current class name.
  73767. * @return "ImageProcessingConfiguration"
  73768. */
  73769. getClassName(): string;
  73770. /**
  73771. * Prepare the list of uniforms associated with the Image Processing effects.
  73772. * @param uniforms The list of uniforms used in the effect
  73773. * @param defines the list of defines currently in use
  73774. */
  73775. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  73776. /**
  73777. * Prepare the list of samplers associated with the Image Processing effects.
  73778. * @param samplersList The list of uniforms used in the effect
  73779. * @param defines the list of defines currently in use
  73780. */
  73781. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  73782. /**
  73783. * Prepare the list of defines associated to the shader.
  73784. * @param defines the list of defines to complete
  73785. * @param forPostProcess Define if we are currently in post process mode or not
  73786. */
  73787. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  73788. /**
  73789. * Returns true if all the image processing information are ready.
  73790. * @returns True if ready, otherwise, false
  73791. */
  73792. isReady(): boolean;
  73793. /**
  73794. * Binds the image processing to the shader.
  73795. * @param effect The effect to bind to
  73796. * @param aspectRatio Define the current aspect ratio of the effect
  73797. */
  73798. bind(effect: Effect, aspectRatio?: number): void;
  73799. /**
  73800. * Clones the current image processing instance.
  73801. * @return The cloned image processing
  73802. */
  73803. clone(): ImageProcessingConfiguration;
  73804. /**
  73805. * Serializes the current image processing instance to a json representation.
  73806. * @return a JSON representation
  73807. */
  73808. serialize(): any;
  73809. /**
  73810. * Parses the image processing from a json representation.
  73811. * @param source the JSON source to parse
  73812. * @return The parsed image processing
  73813. */
  73814. static Parse(source: any): ImageProcessingConfiguration;
  73815. private static _VIGNETTEMODE_MULTIPLY;
  73816. private static _VIGNETTEMODE_OPAQUE;
  73817. /**
  73818. * Used to apply the vignette as a mix with the pixel color.
  73819. */
  73820. static readonly VIGNETTEMODE_MULTIPLY: number;
  73821. /**
  73822. * Used to apply the vignette as a replacement of the pixel color.
  73823. */
  73824. static readonly VIGNETTEMODE_OPAQUE: number;
  73825. }
  73826. }
  73827. declare module BABYLON {
  73828. /** @hidden */
  73829. export var postprocessVertexShader: {
  73830. name: string;
  73831. shader: string;
  73832. };
  73833. }
  73834. declare module BABYLON {
  73835. /** Defines supported spaces */
  73836. export enum Space {
  73837. /** Local (object) space */
  73838. LOCAL = 0,
  73839. /** World space */
  73840. WORLD = 1,
  73841. /** Bone space */
  73842. BONE = 2
  73843. }
  73844. /** Defines the 3 main axes */
  73845. export class Axis {
  73846. /** X axis */
  73847. static X: Vector3;
  73848. /** Y axis */
  73849. static Y: Vector3;
  73850. /** Z axis */
  73851. static Z: Vector3;
  73852. }
  73853. }
  73854. declare module BABYLON {
  73855. /**
  73856. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  73857. * This is the base of the follow, arc rotate cameras and Free camera
  73858. * @see http://doc.babylonjs.com/features/cameras
  73859. */
  73860. export class TargetCamera extends Camera {
  73861. private static _RigCamTransformMatrix;
  73862. private static _TargetTransformMatrix;
  73863. private static _TargetFocalPoint;
  73864. /**
  73865. * Define the current direction the camera is moving to
  73866. */
  73867. cameraDirection: Vector3;
  73868. /**
  73869. * Define the current rotation the camera is rotating to
  73870. */
  73871. cameraRotation: Vector2;
  73872. /**
  73873. * When set, the up vector of the camera will be updated by the rotation of the camera
  73874. */
  73875. updateUpVectorFromRotation: boolean;
  73876. private _tmpQuaternion;
  73877. /**
  73878. * Define the current rotation of the camera
  73879. */
  73880. rotation: Vector3;
  73881. /**
  73882. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  73883. */
  73884. rotationQuaternion: Quaternion;
  73885. /**
  73886. * Define the current speed of the camera
  73887. */
  73888. speed: number;
  73889. /**
  73890. * Add cconstraint to the camera to prevent it to move freely in all directions and
  73891. * around all axis.
  73892. */
  73893. noRotationConstraint: boolean;
  73894. /**
  73895. * Define the current target of the camera as an object or a position.
  73896. */
  73897. lockedTarget: any;
  73898. /** @hidden */
  73899. _currentTarget: Vector3;
  73900. /** @hidden */
  73901. _initialFocalDistance: number;
  73902. /** @hidden */
  73903. _viewMatrix: Matrix;
  73904. /** @hidden */
  73905. _camMatrix: Matrix;
  73906. /** @hidden */
  73907. _cameraTransformMatrix: Matrix;
  73908. /** @hidden */
  73909. _cameraRotationMatrix: Matrix;
  73910. /** @hidden */
  73911. _referencePoint: Vector3;
  73912. /** @hidden */
  73913. _transformedReferencePoint: Vector3;
  73914. protected _globalCurrentTarget: Vector3;
  73915. protected _globalCurrentUpVector: Vector3;
  73916. /** @hidden */
  73917. _reset: () => void;
  73918. private _defaultUp;
  73919. /**
  73920. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  73921. * This is the base of the follow, arc rotate cameras and Free camera
  73922. * @see http://doc.babylonjs.com/features/cameras
  73923. * @param name Defines the name of the camera in the scene
  73924. * @param position Defines the start position of the camera in the scene
  73925. * @param scene Defines the scene the camera belongs to
  73926. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  73927. */
  73928. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  73929. /**
  73930. * Gets the position in front of the camera at a given distance.
  73931. * @param distance The distance from the camera we want the position to be
  73932. * @returns the position
  73933. */
  73934. getFrontPosition(distance: number): Vector3;
  73935. /** @hidden */
  73936. _getLockedTargetPosition(): Nullable<Vector3>;
  73937. private _storedPosition;
  73938. private _storedRotation;
  73939. private _storedRotationQuaternion;
  73940. /**
  73941. * Store current camera state of the camera (fov, position, rotation, etc..)
  73942. * @returns the camera
  73943. */
  73944. storeState(): Camera;
  73945. /**
  73946. * Restored camera state. You must call storeState() first
  73947. * @returns whether it was successful or not
  73948. * @hidden
  73949. */
  73950. _restoreStateValues(): boolean;
  73951. /** @hidden */
  73952. _initCache(): void;
  73953. /** @hidden */
  73954. _updateCache(ignoreParentClass?: boolean): void;
  73955. /** @hidden */
  73956. _isSynchronizedViewMatrix(): boolean;
  73957. /** @hidden */
  73958. _computeLocalCameraSpeed(): number;
  73959. /**
  73960. * Defines the target the camera should look at.
  73961. * @param target Defines the new target as a Vector or a mesh
  73962. */
  73963. setTarget(target: Vector3): void;
  73964. /**
  73965. * Return the current target position of the camera. This value is expressed in local space.
  73966. * @returns the target position
  73967. */
  73968. getTarget(): Vector3;
  73969. /** @hidden */
  73970. _decideIfNeedsToMove(): boolean;
  73971. /** @hidden */
  73972. _updatePosition(): void;
  73973. /** @hidden */
  73974. _checkInputs(): void;
  73975. protected _updateCameraRotationMatrix(): void;
  73976. /**
  73977. * 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)
  73978. * @returns the current camera
  73979. */
  73980. private _rotateUpVectorWithCameraRotationMatrix;
  73981. private _cachedRotationZ;
  73982. private _cachedQuaternionRotationZ;
  73983. /** @hidden */
  73984. _getViewMatrix(): Matrix;
  73985. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  73986. /**
  73987. * @hidden
  73988. */
  73989. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  73990. /**
  73991. * @hidden
  73992. */
  73993. _updateRigCameras(): void;
  73994. private _getRigCamPositionAndTarget;
  73995. /**
  73996. * Gets the current object class name.
  73997. * @return the class name
  73998. */
  73999. getClassName(): string;
  74000. }
  74001. }
  74002. declare module BABYLON {
  74003. /**
  74004. * Gather the list of keyboard event types as constants.
  74005. */
  74006. export class KeyboardEventTypes {
  74007. /**
  74008. * The keydown event is fired when a key becomes active (pressed).
  74009. */
  74010. static readonly KEYDOWN: number;
  74011. /**
  74012. * The keyup event is fired when a key has been released.
  74013. */
  74014. static readonly KEYUP: number;
  74015. }
  74016. /**
  74017. * This class is used to store keyboard related info for the onKeyboardObservable event.
  74018. */
  74019. export class KeyboardInfo {
  74020. /**
  74021. * Defines the type of event (KeyboardEventTypes)
  74022. */
  74023. type: number;
  74024. /**
  74025. * Defines the related dom event
  74026. */
  74027. event: KeyboardEvent;
  74028. /**
  74029. * Instantiates a new keyboard info.
  74030. * This class is used to store keyboard related info for the onKeyboardObservable event.
  74031. * @param type Defines the type of event (KeyboardEventTypes)
  74032. * @param event Defines the related dom event
  74033. */
  74034. constructor(
  74035. /**
  74036. * Defines the type of event (KeyboardEventTypes)
  74037. */
  74038. type: number,
  74039. /**
  74040. * Defines the related dom event
  74041. */
  74042. event: KeyboardEvent);
  74043. }
  74044. /**
  74045. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  74046. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  74047. */
  74048. export class KeyboardInfoPre extends KeyboardInfo {
  74049. /**
  74050. * Defines the type of event (KeyboardEventTypes)
  74051. */
  74052. type: number;
  74053. /**
  74054. * Defines the related dom event
  74055. */
  74056. event: KeyboardEvent;
  74057. /**
  74058. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  74059. */
  74060. skipOnPointerObservable: boolean;
  74061. /**
  74062. * Instantiates a new keyboard pre info.
  74063. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  74064. * @param type Defines the type of event (KeyboardEventTypes)
  74065. * @param event Defines the related dom event
  74066. */
  74067. constructor(
  74068. /**
  74069. * Defines the type of event (KeyboardEventTypes)
  74070. */
  74071. type: number,
  74072. /**
  74073. * Defines the related dom event
  74074. */
  74075. event: KeyboardEvent);
  74076. }
  74077. }
  74078. declare module BABYLON {
  74079. /**
  74080. * Manage the keyboard inputs to control the movement of a free camera.
  74081. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74082. */
  74083. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  74084. /**
  74085. * Defines the camera the input is attached to.
  74086. */
  74087. camera: FreeCamera;
  74088. /**
  74089. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  74090. */
  74091. keysUp: number[];
  74092. /**
  74093. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  74094. */
  74095. keysDown: number[];
  74096. /**
  74097. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  74098. */
  74099. keysLeft: number[];
  74100. /**
  74101. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  74102. */
  74103. keysRight: number[];
  74104. private _keys;
  74105. private _onCanvasBlurObserver;
  74106. private _onKeyboardObserver;
  74107. private _engine;
  74108. private _scene;
  74109. /**
  74110. * Attach the input controls to a specific dom element to get the input from.
  74111. * @param element Defines the element the controls should be listened from
  74112. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74113. */
  74114. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  74115. /**
  74116. * Detach the current controls from the specified dom element.
  74117. * @param element Defines the element to stop listening the inputs from
  74118. */
  74119. detachControl(element: Nullable<HTMLElement>): void;
  74120. /**
  74121. * Update the current camera state depending on the inputs that have been used this frame.
  74122. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74123. */
  74124. checkInputs(): void;
  74125. /**
  74126. * Gets the class name of the current intput.
  74127. * @returns the class name
  74128. */
  74129. getClassName(): string;
  74130. /** @hidden */
  74131. _onLostFocus(): void;
  74132. /**
  74133. * Get the friendly name associated with the input class.
  74134. * @returns the input friendly name
  74135. */
  74136. getSimpleName(): string;
  74137. }
  74138. }
  74139. declare module BABYLON {
  74140. /**
  74141. * Interface describing all the common properties and methods a shadow light needs to implement.
  74142. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  74143. * as well as binding the different shadow properties to the effects.
  74144. */
  74145. export interface IShadowLight extends Light {
  74146. /**
  74147. * The light id in the scene (used in scene.findLighById for instance)
  74148. */
  74149. id: string;
  74150. /**
  74151. * The position the shdow will be casted from.
  74152. */
  74153. position: Vector3;
  74154. /**
  74155. * In 2d mode (needCube being false), the direction used to cast the shadow.
  74156. */
  74157. direction: Vector3;
  74158. /**
  74159. * The transformed position. Position of the light in world space taking parenting in account.
  74160. */
  74161. transformedPosition: Vector3;
  74162. /**
  74163. * The transformed direction. Direction of the light in world space taking parenting in account.
  74164. */
  74165. transformedDirection: Vector3;
  74166. /**
  74167. * The friendly name of the light in the scene.
  74168. */
  74169. name: string;
  74170. /**
  74171. * Defines the shadow projection clipping minimum z value.
  74172. */
  74173. shadowMinZ: number;
  74174. /**
  74175. * Defines the shadow projection clipping maximum z value.
  74176. */
  74177. shadowMaxZ: number;
  74178. /**
  74179. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  74180. * @returns true if the information has been computed, false if it does not need to (no parenting)
  74181. */
  74182. computeTransformedInformation(): boolean;
  74183. /**
  74184. * Gets the scene the light belongs to.
  74185. * @returns The scene
  74186. */
  74187. getScene(): Scene;
  74188. /**
  74189. * Callback defining a custom Projection Matrix Builder.
  74190. * This can be used to override the default projection matrix computation.
  74191. */
  74192. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  74193. /**
  74194. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  74195. * @param matrix The materix to updated with the projection information
  74196. * @param viewMatrix The transform matrix of the light
  74197. * @param renderList The list of mesh to render in the map
  74198. * @returns The current light
  74199. */
  74200. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  74201. /**
  74202. * Gets the current depth scale used in ESM.
  74203. * @returns The scale
  74204. */
  74205. getDepthScale(): number;
  74206. /**
  74207. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  74208. * @returns true if a cube texture needs to be use
  74209. */
  74210. needCube(): boolean;
  74211. /**
  74212. * Detects if the projection matrix requires to be recomputed this frame.
  74213. * @returns true if it requires to be recomputed otherwise, false.
  74214. */
  74215. needProjectionMatrixCompute(): boolean;
  74216. /**
  74217. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  74218. */
  74219. forceProjectionMatrixCompute(): void;
  74220. /**
  74221. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  74222. * @param faceIndex The index of the face we are computed the direction to generate shadow
  74223. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  74224. */
  74225. getShadowDirection(faceIndex?: number): Vector3;
  74226. /**
  74227. * Gets the minZ used for shadow according to both the scene and the light.
  74228. * @param activeCamera The camera we are returning the min for
  74229. * @returns the depth min z
  74230. */
  74231. getDepthMinZ(activeCamera: Camera): number;
  74232. /**
  74233. * Gets the maxZ used for shadow according to both the scene and the light.
  74234. * @param activeCamera The camera we are returning the max for
  74235. * @returns the depth max z
  74236. */
  74237. getDepthMaxZ(activeCamera: Camera): number;
  74238. }
  74239. /**
  74240. * Base implementation IShadowLight
  74241. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  74242. */
  74243. export abstract class ShadowLight extends Light implements IShadowLight {
  74244. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  74245. protected _position: Vector3;
  74246. protected _setPosition(value: Vector3): void;
  74247. /**
  74248. * Sets the position the shadow will be casted from. Also use as the light position for both
  74249. * point and spot lights.
  74250. */
  74251. /**
  74252. * Sets the position the shadow will be casted from. Also use as the light position for both
  74253. * point and spot lights.
  74254. */
  74255. position: Vector3;
  74256. protected _direction: Vector3;
  74257. protected _setDirection(value: Vector3): void;
  74258. /**
  74259. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  74260. * Also use as the light direction on spot and directional lights.
  74261. */
  74262. /**
  74263. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  74264. * Also use as the light direction on spot and directional lights.
  74265. */
  74266. direction: Vector3;
  74267. private _shadowMinZ;
  74268. /**
  74269. * Gets the shadow projection clipping minimum z value.
  74270. */
  74271. /**
  74272. * Sets the shadow projection clipping minimum z value.
  74273. */
  74274. shadowMinZ: number;
  74275. private _shadowMaxZ;
  74276. /**
  74277. * Sets the shadow projection clipping maximum z value.
  74278. */
  74279. /**
  74280. * Gets the shadow projection clipping maximum z value.
  74281. */
  74282. shadowMaxZ: number;
  74283. /**
  74284. * Callback defining a custom Projection Matrix Builder.
  74285. * This can be used to override the default projection matrix computation.
  74286. */
  74287. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  74288. /**
  74289. * The transformed position. Position of the light in world space taking parenting in account.
  74290. */
  74291. transformedPosition: Vector3;
  74292. /**
  74293. * The transformed direction. Direction of the light in world space taking parenting in account.
  74294. */
  74295. transformedDirection: Vector3;
  74296. private _needProjectionMatrixCompute;
  74297. /**
  74298. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  74299. * @returns true if the information has been computed, false if it does not need to (no parenting)
  74300. */
  74301. computeTransformedInformation(): boolean;
  74302. /**
  74303. * Return the depth scale used for the shadow map.
  74304. * @returns the depth scale.
  74305. */
  74306. getDepthScale(): number;
  74307. /**
  74308. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  74309. * @param faceIndex The index of the face we are computed the direction to generate shadow
  74310. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  74311. */
  74312. getShadowDirection(faceIndex?: number): Vector3;
  74313. /**
  74314. * Returns the ShadowLight absolute position in the World.
  74315. * @returns the position vector in world space
  74316. */
  74317. getAbsolutePosition(): Vector3;
  74318. /**
  74319. * Sets the ShadowLight direction toward the passed target.
  74320. * @param target The point to target in local space
  74321. * @returns the updated ShadowLight direction
  74322. */
  74323. setDirectionToTarget(target: Vector3): Vector3;
  74324. /**
  74325. * Returns the light rotation in euler definition.
  74326. * @returns the x y z rotation in local space.
  74327. */
  74328. getRotation(): Vector3;
  74329. /**
  74330. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  74331. * @returns true if a cube texture needs to be use
  74332. */
  74333. needCube(): boolean;
  74334. /**
  74335. * Detects if the projection matrix requires to be recomputed this frame.
  74336. * @returns true if it requires to be recomputed otherwise, false.
  74337. */
  74338. needProjectionMatrixCompute(): boolean;
  74339. /**
  74340. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  74341. */
  74342. forceProjectionMatrixCompute(): void;
  74343. /** @hidden */
  74344. _initCache(): void;
  74345. /** @hidden */
  74346. _isSynchronized(): boolean;
  74347. /**
  74348. * Computes the world matrix of the node
  74349. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  74350. * @returns the world matrix
  74351. */
  74352. computeWorldMatrix(force?: boolean): Matrix;
  74353. /**
  74354. * Gets the minZ used for shadow according to both the scene and the light.
  74355. * @param activeCamera The camera we are returning the min for
  74356. * @returns the depth min z
  74357. */
  74358. getDepthMinZ(activeCamera: Camera): number;
  74359. /**
  74360. * Gets the maxZ used for shadow according to both the scene and the light.
  74361. * @param activeCamera The camera we are returning the max for
  74362. * @returns the depth max z
  74363. */
  74364. getDepthMaxZ(activeCamera: Camera): number;
  74365. /**
  74366. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  74367. * @param matrix The materix to updated with the projection information
  74368. * @param viewMatrix The transform matrix of the light
  74369. * @param renderList The list of mesh to render in the map
  74370. * @returns The current light
  74371. */
  74372. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  74373. }
  74374. }
  74375. declare module BABYLON {
  74376. /**
  74377. * "Static Class" containing the most commonly used helper while dealing with material for
  74378. * rendering purpose.
  74379. *
  74380. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  74381. *
  74382. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  74383. */
  74384. export class MaterialHelper {
  74385. /**
  74386. * Bind the current view position to an effect.
  74387. * @param effect The effect to be bound
  74388. * @param scene The scene the eyes position is used from
  74389. */
  74390. static BindEyePosition(effect: Effect, scene: Scene): void;
  74391. /**
  74392. * Helps preparing the defines values about the UVs in used in the effect.
  74393. * UVs are shared as much as we can accross channels in the shaders.
  74394. * @param texture The texture we are preparing the UVs for
  74395. * @param defines The defines to update
  74396. * @param key The channel key "diffuse", "specular"... used in the shader
  74397. */
  74398. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  74399. /**
  74400. * Binds a texture matrix value to its corrsponding uniform
  74401. * @param texture The texture to bind the matrix for
  74402. * @param uniformBuffer The uniform buffer receivin the data
  74403. * @param key The channel key "diffuse", "specular"... used in the shader
  74404. */
  74405. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  74406. /**
  74407. * Gets the current status of the fog (should it be enabled?)
  74408. * @param mesh defines the mesh to evaluate for fog support
  74409. * @param scene defines the hosting scene
  74410. * @returns true if fog must be enabled
  74411. */
  74412. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  74413. /**
  74414. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  74415. * @param mesh defines the current mesh
  74416. * @param scene defines the current scene
  74417. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  74418. * @param pointsCloud defines if point cloud rendering has to be turned on
  74419. * @param fogEnabled defines if fog has to be turned on
  74420. * @param alphaTest defines if alpha testing has to be turned on
  74421. * @param defines defines the current list of defines
  74422. */
  74423. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  74424. /**
  74425. * Helper used to prepare the list of defines associated with frame values for shader compilation
  74426. * @param scene defines the current scene
  74427. * @param engine defines the current engine
  74428. * @param defines specifies the list of active defines
  74429. * @param useInstances defines if instances have to be turned on
  74430. * @param useClipPlane defines if clip plane have to be turned on
  74431. */
  74432. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  74433. /**
  74434. * Prepares the defines for bones
  74435. * @param mesh The mesh containing the geometry data we will draw
  74436. * @param defines The defines to update
  74437. */
  74438. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  74439. /**
  74440. * Prepares the defines for morph targets
  74441. * @param mesh The mesh containing the geometry data we will draw
  74442. * @param defines The defines to update
  74443. */
  74444. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  74445. /**
  74446. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  74447. * @param mesh The mesh containing the geometry data we will draw
  74448. * @param defines The defines to update
  74449. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  74450. * @param useBones Precise whether bones should be used or not (override mesh info)
  74451. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  74452. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  74453. * @returns false if defines are considered not dirty and have not been checked
  74454. */
  74455. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  74456. /**
  74457. * Prepares the defines related to multiview
  74458. * @param scene The scene we are intending to draw
  74459. * @param defines The defines to update
  74460. */
  74461. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  74462. /**
  74463. * Prepares the defines related to the light information passed in parameter
  74464. * @param scene The scene we are intending to draw
  74465. * @param mesh The mesh the effect is compiling for
  74466. * @param light The light the effect is compiling for
  74467. * @param lightIndex The index of the light
  74468. * @param defines The defines to update
  74469. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  74470. * @param state Defines the current state regarding what is needed (normals, etc...)
  74471. */
  74472. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  74473. needNormals: boolean;
  74474. needRebuild: boolean;
  74475. shadowEnabled: boolean;
  74476. specularEnabled: boolean;
  74477. lightmapMode: boolean;
  74478. }): void;
  74479. /**
  74480. * Prepares the defines related to the light information passed in parameter
  74481. * @param scene The scene we are intending to draw
  74482. * @param mesh The mesh the effect is compiling for
  74483. * @param defines The defines to update
  74484. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  74485. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  74486. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  74487. * @returns true if normals will be required for the rest of the effect
  74488. */
  74489. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  74490. /**
  74491. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  74492. * @param lightIndex defines the light index
  74493. * @param uniformsList The uniform list
  74494. * @param samplersList The sampler list
  74495. * @param projectedLightTexture defines if projected texture must be used
  74496. * @param uniformBuffersList defines an optional list of uniform buffers
  74497. */
  74498. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  74499. /**
  74500. * Prepares the uniforms and samplers list to be used in the effect
  74501. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  74502. * @param samplersList The sampler list
  74503. * @param defines The defines helping in the list generation
  74504. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  74505. */
  74506. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | EffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  74507. /**
  74508. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  74509. * @param defines The defines to update while falling back
  74510. * @param fallbacks The authorized effect fallbacks
  74511. * @param maxSimultaneousLights The maximum number of lights allowed
  74512. * @param rank the current rank of the Effect
  74513. * @returns The newly affected rank
  74514. */
  74515. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  74516. private static _TmpMorphInfluencers;
  74517. /**
  74518. * Prepares the list of attributes required for morph targets according to the effect defines.
  74519. * @param attribs The current list of supported attribs
  74520. * @param mesh The mesh to prepare the morph targets attributes for
  74521. * @param influencers The number of influencers
  74522. */
  74523. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  74524. /**
  74525. * Prepares the list of attributes required for morph targets according to the effect defines.
  74526. * @param attribs The current list of supported attribs
  74527. * @param mesh The mesh to prepare the morph targets attributes for
  74528. * @param defines The current Defines of the effect
  74529. */
  74530. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  74531. /**
  74532. * Prepares the list of attributes required for bones according to the effect defines.
  74533. * @param attribs The current list of supported attribs
  74534. * @param mesh The mesh to prepare the bones attributes for
  74535. * @param defines The current Defines of the effect
  74536. * @param fallbacks The current efffect fallback strategy
  74537. */
  74538. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  74539. /**
  74540. * Check and prepare the list of attributes required for instances according to the effect defines.
  74541. * @param attribs The current list of supported attribs
  74542. * @param defines The current MaterialDefines of the effect
  74543. */
  74544. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  74545. /**
  74546. * Add the list of attributes required for instances to the attribs array.
  74547. * @param attribs The current list of supported attribs
  74548. */
  74549. static PushAttributesForInstances(attribs: string[]): void;
  74550. /**
  74551. * Binds the light shadow information to the effect for the given mesh.
  74552. * @param light The light containing the generator
  74553. * @param scene The scene the lights belongs to
  74554. * @param mesh The mesh we are binding the information to render
  74555. * @param lightIndex The light index in the effect used to render the mesh
  74556. * @param effect The effect we are binding the data to
  74557. */
  74558. static BindLightShadow(light: Light, mesh: AbstractMesh, lightIndex: string, effect: Effect): void;
  74559. /**
  74560. * Binds the light information to the effect.
  74561. * @param light The light containing the generator
  74562. * @param effect The effect we are binding the data to
  74563. * @param lightIndex The light index in the effect used to render
  74564. */
  74565. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  74566. /**
  74567. * Binds the lights information from the scene to the effect for the given mesh.
  74568. * @param light Light to bind
  74569. * @param lightIndex Light index
  74570. * @param scene The scene where the light belongs to
  74571. * @param mesh The mesh we are binding the information to render
  74572. * @param effect The effect we are binding the data to
  74573. * @param useSpecular Defines if specular is supported
  74574. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  74575. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  74576. */
  74577. static BindLight(light: Light, lightIndex: number, scene: Scene, mesh: AbstractMesh, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  74578. /**
  74579. * Binds the lights information from the scene to the effect for the given mesh.
  74580. * @param scene The scene the lights belongs to
  74581. * @param mesh The mesh we are binding the information to render
  74582. * @param effect The effect we are binding the data to
  74583. * @param defines The generated defines for the effect
  74584. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  74585. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  74586. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  74587. */
  74588. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  74589. private static _tempFogColor;
  74590. /**
  74591. * Binds the fog information from the scene to the effect for the given mesh.
  74592. * @param scene The scene the lights belongs to
  74593. * @param mesh The mesh we are binding the information to render
  74594. * @param effect The effect we are binding the data to
  74595. * @param linearSpace Defines if the fog effect is applied in linear space
  74596. */
  74597. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  74598. /**
  74599. * Binds the bones information from the mesh to the effect.
  74600. * @param mesh The mesh we are binding the information to render
  74601. * @param effect The effect we are binding the data to
  74602. */
  74603. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  74604. /**
  74605. * Binds the morph targets information from the mesh to the effect.
  74606. * @param abstractMesh The mesh we are binding the information to render
  74607. * @param effect The effect we are binding the data to
  74608. */
  74609. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  74610. /**
  74611. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  74612. * @param defines The generated defines used in the effect
  74613. * @param effect The effect we are binding the data to
  74614. * @param scene The scene we are willing to render with logarithmic scale for
  74615. */
  74616. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  74617. /**
  74618. * Binds the clip plane information from the scene to the effect.
  74619. * @param scene The scene the clip plane information are extracted from
  74620. * @param effect The effect we are binding the data to
  74621. */
  74622. static BindClipPlane(effect: Effect, scene: Scene): void;
  74623. }
  74624. }
  74625. declare module BABYLON {
  74626. /** @hidden */
  74627. export var packingFunctions: {
  74628. name: string;
  74629. shader: string;
  74630. };
  74631. }
  74632. declare module BABYLON {
  74633. /** @hidden */
  74634. export var shadowMapPixelShader: {
  74635. name: string;
  74636. shader: string;
  74637. };
  74638. }
  74639. declare module BABYLON {
  74640. /** @hidden */
  74641. export var bonesDeclaration: {
  74642. name: string;
  74643. shader: string;
  74644. };
  74645. }
  74646. declare module BABYLON {
  74647. /** @hidden */
  74648. export var morphTargetsVertexGlobalDeclaration: {
  74649. name: string;
  74650. shader: string;
  74651. };
  74652. }
  74653. declare module BABYLON {
  74654. /** @hidden */
  74655. export var morphTargetsVertexDeclaration: {
  74656. name: string;
  74657. shader: string;
  74658. };
  74659. }
  74660. declare module BABYLON {
  74661. /** @hidden */
  74662. export var instancesDeclaration: {
  74663. name: string;
  74664. shader: string;
  74665. };
  74666. }
  74667. declare module BABYLON {
  74668. /** @hidden */
  74669. export var helperFunctions: {
  74670. name: string;
  74671. shader: string;
  74672. };
  74673. }
  74674. declare module BABYLON {
  74675. /** @hidden */
  74676. export var morphTargetsVertex: {
  74677. name: string;
  74678. shader: string;
  74679. };
  74680. }
  74681. declare module BABYLON {
  74682. /** @hidden */
  74683. export var instancesVertex: {
  74684. name: string;
  74685. shader: string;
  74686. };
  74687. }
  74688. declare module BABYLON {
  74689. /** @hidden */
  74690. export var bonesVertex: {
  74691. name: string;
  74692. shader: string;
  74693. };
  74694. }
  74695. declare module BABYLON {
  74696. /** @hidden */
  74697. export var shadowMapVertexShader: {
  74698. name: string;
  74699. shader: string;
  74700. };
  74701. }
  74702. declare module BABYLON {
  74703. /** @hidden */
  74704. export var depthBoxBlurPixelShader: {
  74705. name: string;
  74706. shader: string;
  74707. };
  74708. }
  74709. declare module BABYLON {
  74710. /**
  74711. * Defines the options associated with the creation of a custom shader for a shadow generator.
  74712. */
  74713. export interface ICustomShaderOptions {
  74714. /**
  74715. * Gets or sets the custom shader name to use
  74716. */
  74717. shaderName: string;
  74718. /**
  74719. * The list of attribute names used in the shader
  74720. */
  74721. attributes?: string[];
  74722. /**
  74723. * The list of unifrom names used in the shader
  74724. */
  74725. uniforms?: string[];
  74726. /**
  74727. * The list of sampler names used in the shader
  74728. */
  74729. samplers?: string[];
  74730. /**
  74731. * The list of defines used in the shader
  74732. */
  74733. defines?: string[];
  74734. }
  74735. /**
  74736. * Interface to implement to create a shadow generator compatible with BJS.
  74737. */
  74738. export interface IShadowGenerator {
  74739. /**
  74740. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  74741. * @returns The render target texture if present otherwise, null
  74742. */
  74743. getShadowMap(): Nullable<RenderTargetTexture>;
  74744. /**
  74745. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  74746. * @returns The render target texture if the shadow map is present otherwise, null
  74747. */
  74748. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  74749. /**
  74750. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  74751. * @param subMesh The submesh we want to render in the shadow map
  74752. * @param useInstances Defines wether will draw in the map using instances
  74753. * @returns true if ready otherwise, false
  74754. */
  74755. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  74756. /**
  74757. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  74758. * @param defines Defines of the material we want to update
  74759. * @param lightIndex Index of the light in the enabled light list of the material
  74760. */
  74761. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  74762. /**
  74763. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  74764. * defined in the generator but impacting the effect).
  74765. * It implies the unifroms available on the materials are the standard BJS ones.
  74766. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  74767. * @param effect The effect we are binfing the information for
  74768. */
  74769. bindShadowLight(lightIndex: string, effect: Effect): void;
  74770. /**
  74771. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  74772. * (eq to shadow prjection matrix * light transform matrix)
  74773. * @returns The transform matrix used to create the shadow map
  74774. */
  74775. getTransformMatrix(): Matrix;
  74776. /**
  74777. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  74778. * Cube and 2D textures for instance.
  74779. */
  74780. recreateShadowMap(): void;
  74781. /**
  74782. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  74783. * @param onCompiled Callback triggered at the and of the effects compilation
  74784. * @param options Sets of optional options forcing the compilation with different modes
  74785. */
  74786. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  74787. useInstances: boolean;
  74788. }>): void;
  74789. /**
  74790. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  74791. * @param options Sets of optional options forcing the compilation with different modes
  74792. * @returns A promise that resolves when the compilation completes
  74793. */
  74794. forceCompilationAsync(options?: Partial<{
  74795. useInstances: boolean;
  74796. }>): Promise<void>;
  74797. /**
  74798. * Serializes the shadow generator setup to a json object.
  74799. * @returns The serialized JSON object
  74800. */
  74801. serialize(): any;
  74802. /**
  74803. * Disposes the Shadow map and related Textures and effects.
  74804. */
  74805. dispose(): void;
  74806. }
  74807. /**
  74808. * Default implementation IShadowGenerator.
  74809. * This is the main object responsible of generating shadows in the framework.
  74810. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  74811. */
  74812. export class ShadowGenerator implements IShadowGenerator {
  74813. /**
  74814. * Shadow generator mode None: no filtering applied.
  74815. */
  74816. static readonly FILTER_NONE: number;
  74817. /**
  74818. * Shadow generator mode ESM: Exponential Shadow Mapping.
  74819. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  74820. */
  74821. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  74822. /**
  74823. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  74824. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  74825. */
  74826. static readonly FILTER_POISSONSAMPLING: number;
  74827. /**
  74828. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  74829. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  74830. */
  74831. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  74832. /**
  74833. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  74834. * edge artifacts on steep falloff.
  74835. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  74836. */
  74837. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  74838. /**
  74839. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  74840. * edge artifacts on steep falloff.
  74841. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  74842. */
  74843. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  74844. /**
  74845. * Shadow generator mode PCF: Percentage Closer Filtering
  74846. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  74847. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  74848. */
  74849. static readonly FILTER_PCF: number;
  74850. /**
  74851. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  74852. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  74853. * Contact Hardening
  74854. */
  74855. static readonly FILTER_PCSS: number;
  74856. /**
  74857. * Reserved for PCF and PCSS
  74858. * Highest Quality.
  74859. *
  74860. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  74861. *
  74862. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  74863. */
  74864. static readonly QUALITY_HIGH: number;
  74865. /**
  74866. * Reserved for PCF and PCSS
  74867. * Good tradeoff for quality/perf cross devices
  74868. *
  74869. * Execute PCF on a 3*3 kernel.
  74870. *
  74871. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  74872. */
  74873. static readonly QUALITY_MEDIUM: number;
  74874. /**
  74875. * Reserved for PCF and PCSS
  74876. * The lowest quality but the fastest.
  74877. *
  74878. * Execute PCF on a 1*1 kernel.
  74879. *
  74880. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  74881. */
  74882. static readonly QUALITY_LOW: number;
  74883. /** Gets or sets the custom shader name to use */
  74884. customShaderOptions: ICustomShaderOptions;
  74885. /**
  74886. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  74887. */
  74888. onBeforeShadowMapRenderObservable: Observable<Effect>;
  74889. /**
  74890. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  74891. */
  74892. onAfterShadowMapRenderObservable: Observable<Effect>;
  74893. /**
  74894. * Observable triggered before a mesh is rendered in the shadow map.
  74895. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  74896. */
  74897. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  74898. /**
  74899. * Observable triggered after a mesh is rendered in the shadow map.
  74900. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  74901. */
  74902. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  74903. private _bias;
  74904. /**
  74905. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  74906. */
  74907. /**
  74908. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  74909. */
  74910. bias: number;
  74911. private _normalBias;
  74912. /**
  74913. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  74914. */
  74915. /**
  74916. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  74917. */
  74918. normalBias: number;
  74919. private _blurBoxOffset;
  74920. /**
  74921. * Gets the blur box offset: offset applied during the blur pass.
  74922. * Only useful if useKernelBlur = false
  74923. */
  74924. /**
  74925. * Sets the blur box offset: offset applied during the blur pass.
  74926. * Only useful if useKernelBlur = false
  74927. */
  74928. blurBoxOffset: number;
  74929. private _blurScale;
  74930. /**
  74931. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  74932. * 2 means half of the size.
  74933. */
  74934. /**
  74935. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  74936. * 2 means half of the size.
  74937. */
  74938. blurScale: number;
  74939. private _blurKernel;
  74940. /**
  74941. * Gets the blur kernel: kernel size of the blur pass.
  74942. * Only useful if useKernelBlur = true
  74943. */
  74944. /**
  74945. * Sets the blur kernel: kernel size of the blur pass.
  74946. * Only useful if useKernelBlur = true
  74947. */
  74948. blurKernel: number;
  74949. private _useKernelBlur;
  74950. /**
  74951. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  74952. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  74953. */
  74954. /**
  74955. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  74956. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  74957. */
  74958. useKernelBlur: boolean;
  74959. private _depthScale;
  74960. /**
  74961. * Gets the depth scale used in ESM mode.
  74962. */
  74963. /**
  74964. * Sets the depth scale used in ESM mode.
  74965. * This can override the scale stored on the light.
  74966. */
  74967. depthScale: number;
  74968. private _filter;
  74969. /**
  74970. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  74971. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  74972. */
  74973. /**
  74974. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  74975. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  74976. */
  74977. filter: number;
  74978. /**
  74979. * Gets if the current filter is set to Poisson Sampling.
  74980. */
  74981. /**
  74982. * Sets the current filter to Poisson Sampling.
  74983. */
  74984. usePoissonSampling: boolean;
  74985. /**
  74986. * Gets if the current filter is set to ESM.
  74987. */
  74988. /**
  74989. * Sets the current filter is to ESM.
  74990. */
  74991. useExponentialShadowMap: boolean;
  74992. /**
  74993. * Gets if the current filter is set to filtered ESM.
  74994. */
  74995. /**
  74996. * Gets if the current filter is set to filtered ESM.
  74997. */
  74998. useBlurExponentialShadowMap: boolean;
  74999. /**
  75000. * Gets if the current filter is set to "close ESM" (using the inverse of the
  75001. * exponential to prevent steep falloff artifacts).
  75002. */
  75003. /**
  75004. * Sets the current filter to "close ESM" (using the inverse of the
  75005. * exponential to prevent steep falloff artifacts).
  75006. */
  75007. useCloseExponentialShadowMap: boolean;
  75008. /**
  75009. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  75010. * exponential to prevent steep falloff artifacts).
  75011. */
  75012. /**
  75013. * Sets the current filter to filtered "close ESM" (using the inverse of the
  75014. * exponential to prevent steep falloff artifacts).
  75015. */
  75016. useBlurCloseExponentialShadowMap: boolean;
  75017. /**
  75018. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  75019. */
  75020. /**
  75021. * Sets the current filter to "PCF" (percentage closer filtering).
  75022. */
  75023. usePercentageCloserFiltering: boolean;
  75024. private _filteringQuality;
  75025. /**
  75026. * Gets the PCF or PCSS Quality.
  75027. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  75028. */
  75029. /**
  75030. * Sets the PCF or PCSS Quality.
  75031. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  75032. */
  75033. filteringQuality: number;
  75034. /**
  75035. * Gets if the current filter is set to "PCSS" (contact hardening).
  75036. */
  75037. /**
  75038. * Sets the current filter to "PCSS" (contact hardening).
  75039. */
  75040. useContactHardeningShadow: boolean;
  75041. private _contactHardeningLightSizeUVRatio;
  75042. /**
  75043. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  75044. * Using a ratio helps keeping shape stability independently of the map size.
  75045. *
  75046. * It does not account for the light projection as it was having too much
  75047. * instability during the light setup or during light position changes.
  75048. *
  75049. * Only valid if useContactHardeningShadow is true.
  75050. */
  75051. /**
  75052. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  75053. * Using a ratio helps keeping shape stability independently of the map size.
  75054. *
  75055. * It does not account for the light projection as it was having too much
  75056. * instability during the light setup or during light position changes.
  75057. *
  75058. * Only valid if useContactHardeningShadow is true.
  75059. */
  75060. contactHardeningLightSizeUVRatio: number;
  75061. private _darkness;
  75062. /** Gets or sets the actual darkness of a shadow */
  75063. darkness: number;
  75064. /**
  75065. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  75066. * 0 means strongest and 1 would means no shadow.
  75067. * @returns the darkness.
  75068. */
  75069. getDarkness(): number;
  75070. /**
  75071. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  75072. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  75073. * @returns the shadow generator allowing fluent coding.
  75074. */
  75075. setDarkness(darkness: number): ShadowGenerator;
  75076. private _transparencyShadow;
  75077. /** Gets or sets the ability to have transparent shadow */
  75078. transparencyShadow: boolean;
  75079. /**
  75080. * Sets the ability to have transparent shadow (boolean).
  75081. * @param transparent True if transparent else False
  75082. * @returns the shadow generator allowing fluent coding
  75083. */
  75084. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  75085. private _shadowMap;
  75086. private _shadowMap2;
  75087. /**
  75088. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  75089. * @returns The render target texture if present otherwise, null
  75090. */
  75091. getShadowMap(): Nullable<RenderTargetTexture>;
  75092. /**
  75093. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  75094. * @returns The render target texture if the shadow map is present otherwise, null
  75095. */
  75096. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  75097. /**
  75098. * Gets the class name of that object
  75099. * @returns "ShadowGenerator"
  75100. */
  75101. getClassName(): string;
  75102. /**
  75103. * Helper function to add a mesh and its descendants to the list of shadow casters.
  75104. * @param mesh Mesh to add
  75105. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  75106. * @returns the Shadow Generator itself
  75107. */
  75108. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  75109. /**
  75110. * Helper function to remove a mesh and its descendants from the list of shadow casters
  75111. * @param mesh Mesh to remove
  75112. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  75113. * @returns the Shadow Generator itself
  75114. */
  75115. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  75116. /**
  75117. * Controls the extent to which the shadows fade out at the edge of the frustum
  75118. * Used only by directionals and spots
  75119. */
  75120. frustumEdgeFalloff: number;
  75121. private _light;
  75122. /**
  75123. * Returns the associated light object.
  75124. * @returns the light generating the shadow
  75125. */
  75126. getLight(): IShadowLight;
  75127. /**
  75128. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  75129. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  75130. * It might on the other hand introduce peter panning.
  75131. */
  75132. forceBackFacesOnly: boolean;
  75133. private _scene;
  75134. private _lightDirection;
  75135. private _effect;
  75136. private _viewMatrix;
  75137. private _projectionMatrix;
  75138. private _transformMatrix;
  75139. private _cachedPosition;
  75140. private _cachedDirection;
  75141. private _cachedDefines;
  75142. private _currentRenderID;
  75143. private _boxBlurPostprocess;
  75144. private _kernelBlurXPostprocess;
  75145. private _kernelBlurYPostprocess;
  75146. private _blurPostProcesses;
  75147. private _mapSize;
  75148. private _currentFaceIndex;
  75149. private _currentFaceIndexCache;
  75150. private _textureType;
  75151. private _defaultTextureMatrix;
  75152. /** @hidden */
  75153. static _SceneComponentInitialization: (scene: Scene) => void;
  75154. /**
  75155. * Creates a ShadowGenerator object.
  75156. * A ShadowGenerator is the required tool to use the shadows.
  75157. * Each light casting shadows needs to use its own ShadowGenerator.
  75158. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  75159. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  75160. * @param light The light object generating the shadows.
  75161. * @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.
  75162. */
  75163. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  75164. private _initializeGenerator;
  75165. private _initializeShadowMap;
  75166. private _initializeBlurRTTAndPostProcesses;
  75167. private _renderForShadowMap;
  75168. private _renderSubMeshForShadowMap;
  75169. private _applyFilterValues;
  75170. /**
  75171. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  75172. * @param onCompiled Callback triggered at the and of the effects compilation
  75173. * @param options Sets of optional options forcing the compilation with different modes
  75174. */
  75175. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  75176. useInstances: boolean;
  75177. }>): void;
  75178. /**
  75179. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  75180. * @param options Sets of optional options forcing the compilation with different modes
  75181. * @returns A promise that resolves when the compilation completes
  75182. */
  75183. forceCompilationAsync(options?: Partial<{
  75184. useInstances: boolean;
  75185. }>): Promise<void>;
  75186. /**
  75187. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  75188. * @param subMesh The submesh we want to render in the shadow map
  75189. * @param useInstances Defines wether will draw in the map using instances
  75190. * @returns true if ready otherwise, false
  75191. */
  75192. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75193. /**
  75194. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  75195. * @param defines Defines of the material we want to update
  75196. * @param lightIndex Index of the light in the enabled light list of the material
  75197. */
  75198. prepareDefines(defines: any, lightIndex: number): void;
  75199. /**
  75200. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  75201. * defined in the generator but impacting the effect).
  75202. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  75203. * @param effect The effect we are binfing the information for
  75204. */
  75205. bindShadowLight(lightIndex: string, effect: Effect): void;
  75206. /**
  75207. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  75208. * (eq to shadow prjection matrix * light transform matrix)
  75209. * @returns The transform matrix used to create the shadow map
  75210. */
  75211. getTransformMatrix(): Matrix;
  75212. /**
  75213. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  75214. * Cube and 2D textures for instance.
  75215. */
  75216. recreateShadowMap(): void;
  75217. private _disposeBlurPostProcesses;
  75218. private _disposeRTTandPostProcesses;
  75219. /**
  75220. * Disposes the ShadowGenerator.
  75221. * Returns nothing.
  75222. */
  75223. dispose(): void;
  75224. /**
  75225. * Serializes the shadow generator setup to a json object.
  75226. * @returns The serialized JSON object
  75227. */
  75228. serialize(): any;
  75229. /**
  75230. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  75231. * @param parsedShadowGenerator The JSON object to parse
  75232. * @param scene The scene to create the shadow map for
  75233. * @returns The parsed shadow generator
  75234. */
  75235. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  75236. }
  75237. }
  75238. declare module BABYLON {
  75239. /**
  75240. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  75241. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  75242. * 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.
  75243. */
  75244. export abstract class Light extends Node {
  75245. /**
  75246. * Falloff Default: light is falling off following the material specification:
  75247. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  75248. */
  75249. static readonly FALLOFF_DEFAULT: number;
  75250. /**
  75251. * Falloff Physical: light is falling off following the inverse squared distance law.
  75252. */
  75253. static readonly FALLOFF_PHYSICAL: number;
  75254. /**
  75255. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  75256. * to enhance interoperability with other engines.
  75257. */
  75258. static readonly FALLOFF_GLTF: number;
  75259. /**
  75260. * Falloff Standard: light is falling off like in the standard material
  75261. * to enhance interoperability with other materials.
  75262. */
  75263. static readonly FALLOFF_STANDARD: number;
  75264. /**
  75265. * If every light affecting the material is in this lightmapMode,
  75266. * material.lightmapTexture adds or multiplies
  75267. * (depends on material.useLightmapAsShadowmap)
  75268. * after every other light calculations.
  75269. */
  75270. static readonly LIGHTMAP_DEFAULT: number;
  75271. /**
  75272. * material.lightmapTexture as only diffuse lighting from this light
  75273. * adds only specular lighting from this light
  75274. * adds dynamic shadows
  75275. */
  75276. static readonly LIGHTMAP_SPECULAR: number;
  75277. /**
  75278. * material.lightmapTexture as only lighting
  75279. * no light calculation from this light
  75280. * only adds dynamic shadows from this light
  75281. */
  75282. static readonly LIGHTMAP_SHADOWSONLY: number;
  75283. /**
  75284. * Each light type uses the default quantity according to its type:
  75285. * point/spot lights use luminous intensity
  75286. * directional lights use illuminance
  75287. */
  75288. static readonly INTENSITYMODE_AUTOMATIC: number;
  75289. /**
  75290. * lumen (lm)
  75291. */
  75292. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  75293. /**
  75294. * candela (lm/sr)
  75295. */
  75296. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  75297. /**
  75298. * lux (lm/m^2)
  75299. */
  75300. static readonly INTENSITYMODE_ILLUMINANCE: number;
  75301. /**
  75302. * nit (cd/m^2)
  75303. */
  75304. static readonly INTENSITYMODE_LUMINANCE: number;
  75305. /**
  75306. * Light type const id of the point light.
  75307. */
  75308. static readonly LIGHTTYPEID_POINTLIGHT: number;
  75309. /**
  75310. * Light type const id of the directional light.
  75311. */
  75312. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  75313. /**
  75314. * Light type const id of the spot light.
  75315. */
  75316. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  75317. /**
  75318. * Light type const id of the hemispheric light.
  75319. */
  75320. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  75321. /**
  75322. * Diffuse gives the basic color to an object.
  75323. */
  75324. diffuse: Color3;
  75325. /**
  75326. * Specular produces a highlight color on an object.
  75327. * Note: This is note affecting PBR materials.
  75328. */
  75329. specular: Color3;
  75330. /**
  75331. * Defines the falloff type for this light. This lets overrriding how punctual light are
  75332. * falling off base on range or angle.
  75333. * This can be set to any values in Light.FALLOFF_x.
  75334. *
  75335. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  75336. * other types of materials.
  75337. */
  75338. falloffType: number;
  75339. /**
  75340. * Strength of the light.
  75341. * Note: By default it is define in the framework own unit.
  75342. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  75343. */
  75344. intensity: number;
  75345. private _range;
  75346. protected _inverseSquaredRange: number;
  75347. /**
  75348. * Defines how far from the source the light is impacting in scene units.
  75349. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  75350. */
  75351. /**
  75352. * Defines how far from the source the light is impacting in scene units.
  75353. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  75354. */
  75355. range: number;
  75356. /**
  75357. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  75358. * of light.
  75359. */
  75360. private _photometricScale;
  75361. private _intensityMode;
  75362. /**
  75363. * Gets the photometric scale used to interpret the intensity.
  75364. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  75365. */
  75366. /**
  75367. * Sets the photometric scale used to interpret the intensity.
  75368. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  75369. */
  75370. intensityMode: number;
  75371. private _radius;
  75372. /**
  75373. * Gets the light radius used by PBR Materials to simulate soft area lights.
  75374. */
  75375. /**
  75376. * sets the light radius used by PBR Materials to simulate soft area lights.
  75377. */
  75378. radius: number;
  75379. private _renderPriority;
  75380. /**
  75381. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  75382. * exceeding the number allowed of the materials.
  75383. */
  75384. renderPriority: number;
  75385. private _shadowEnabled;
  75386. /**
  75387. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  75388. * the current shadow generator.
  75389. */
  75390. /**
  75391. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  75392. * the current shadow generator.
  75393. */
  75394. shadowEnabled: boolean;
  75395. private _includedOnlyMeshes;
  75396. /**
  75397. * Gets the only meshes impacted by this light.
  75398. */
  75399. /**
  75400. * Sets the only meshes impacted by this light.
  75401. */
  75402. includedOnlyMeshes: AbstractMesh[];
  75403. private _excludedMeshes;
  75404. /**
  75405. * Gets the meshes not impacted by this light.
  75406. */
  75407. /**
  75408. * Sets the meshes not impacted by this light.
  75409. */
  75410. excludedMeshes: AbstractMesh[];
  75411. private _excludeWithLayerMask;
  75412. /**
  75413. * Gets the layer id use to find what meshes are not impacted by the light.
  75414. * Inactive if 0
  75415. */
  75416. /**
  75417. * Sets the layer id use to find what meshes are not impacted by the light.
  75418. * Inactive if 0
  75419. */
  75420. excludeWithLayerMask: number;
  75421. private _includeOnlyWithLayerMask;
  75422. /**
  75423. * Gets the layer id use to find what meshes are impacted by the light.
  75424. * Inactive if 0
  75425. */
  75426. /**
  75427. * Sets the layer id use to find what meshes are impacted by the light.
  75428. * Inactive if 0
  75429. */
  75430. includeOnlyWithLayerMask: number;
  75431. private _lightmapMode;
  75432. /**
  75433. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  75434. */
  75435. /**
  75436. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  75437. */
  75438. lightmapMode: number;
  75439. /**
  75440. * Shadow generator associted to the light.
  75441. * @hidden Internal use only.
  75442. */
  75443. _shadowGenerator: Nullable<IShadowGenerator>;
  75444. /**
  75445. * @hidden Internal use only.
  75446. */
  75447. _excludedMeshesIds: string[];
  75448. /**
  75449. * @hidden Internal use only.
  75450. */
  75451. _includedOnlyMeshesIds: string[];
  75452. /**
  75453. * The current light unifom buffer.
  75454. * @hidden Internal use only.
  75455. */
  75456. _uniformBuffer: UniformBuffer;
  75457. /**
  75458. * Creates a Light object in the scene.
  75459. * Documentation : https://doc.babylonjs.com/babylon101/lights
  75460. * @param name The firendly name of the light
  75461. * @param scene The scene the light belongs too
  75462. */
  75463. constructor(name: string, scene: Scene);
  75464. protected abstract _buildUniformLayout(): void;
  75465. /**
  75466. * Sets the passed Effect "effect" with the Light information.
  75467. * @param effect The effect to update
  75468. * @param lightIndex The index of the light in the effect to update
  75469. * @returns The light
  75470. */
  75471. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  75472. /**
  75473. * Sets the passed Effect "effect" with the Light information.
  75474. * @param effect The effect to update
  75475. * @param lightDataUniformName The uniform used to store light data (position or direction)
  75476. * @returns The light
  75477. */
  75478. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  75479. /**
  75480. * Returns the string "Light".
  75481. * @returns the class name
  75482. */
  75483. getClassName(): string;
  75484. /** @hidden */
  75485. readonly _isLight: boolean;
  75486. /**
  75487. * Converts the light information to a readable string for debug purpose.
  75488. * @param fullDetails Supports for multiple levels of logging within scene loading
  75489. * @returns the human readable light info
  75490. */
  75491. toString(fullDetails?: boolean): string;
  75492. /** @hidden */
  75493. protected _syncParentEnabledState(): void;
  75494. /**
  75495. * Set the enabled state of this node.
  75496. * @param value - the new enabled state
  75497. */
  75498. setEnabled(value: boolean): void;
  75499. /**
  75500. * Returns the Light associated shadow generator if any.
  75501. * @return the associated shadow generator.
  75502. */
  75503. getShadowGenerator(): Nullable<IShadowGenerator>;
  75504. /**
  75505. * Returns a Vector3, the absolute light position in the World.
  75506. * @returns the world space position of the light
  75507. */
  75508. getAbsolutePosition(): Vector3;
  75509. /**
  75510. * Specifies if the light will affect the passed mesh.
  75511. * @param mesh The mesh to test against the light
  75512. * @return true the mesh is affected otherwise, false.
  75513. */
  75514. canAffectMesh(mesh: AbstractMesh): boolean;
  75515. /**
  75516. * Sort function to order lights for rendering.
  75517. * @param a First Light object to compare to second.
  75518. * @param b Second Light object to compare first.
  75519. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  75520. */
  75521. static CompareLightsPriority(a: Light, b: Light): number;
  75522. /**
  75523. * Releases resources associated with this node.
  75524. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  75525. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  75526. */
  75527. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  75528. /**
  75529. * Returns the light type ID (integer).
  75530. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  75531. */
  75532. getTypeID(): number;
  75533. /**
  75534. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  75535. * @returns the scaled intensity in intensity mode unit
  75536. */
  75537. getScaledIntensity(): number;
  75538. /**
  75539. * Returns a new Light object, named "name", from the current one.
  75540. * @param name The name of the cloned light
  75541. * @returns the new created light
  75542. */
  75543. clone(name: string): Nullable<Light>;
  75544. /**
  75545. * Serializes the current light into a Serialization object.
  75546. * @returns the serialized object.
  75547. */
  75548. serialize(): any;
  75549. /**
  75550. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  75551. * This new light is named "name" and added to the passed scene.
  75552. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  75553. * @param name The friendly name of the light
  75554. * @param scene The scene the new light will belong to
  75555. * @returns the constructor function
  75556. */
  75557. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  75558. /**
  75559. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  75560. * @param parsedLight The JSON representation of the light
  75561. * @param scene The scene to create the parsed light in
  75562. * @returns the created light after parsing
  75563. */
  75564. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  75565. private _hookArrayForExcluded;
  75566. private _hookArrayForIncludedOnly;
  75567. private _resyncMeshes;
  75568. /**
  75569. * Forces the meshes to update their light related information in their rendering used effects
  75570. * @hidden Internal Use Only
  75571. */
  75572. _markMeshesAsLightDirty(): void;
  75573. /**
  75574. * Recomputes the cached photometric scale if needed.
  75575. */
  75576. private _computePhotometricScale;
  75577. /**
  75578. * Returns the Photometric Scale according to the light type and intensity mode.
  75579. */
  75580. private _getPhotometricScale;
  75581. /**
  75582. * Reorder the light in the scene according to their defined priority.
  75583. * @hidden Internal Use Only
  75584. */
  75585. _reorderLightsInScene(): void;
  75586. /**
  75587. * Prepares the list of defines specific to the light type.
  75588. * @param defines the list of defines
  75589. * @param lightIndex defines the index of the light for the effect
  75590. */
  75591. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  75592. }
  75593. }
  75594. declare module BABYLON {
  75595. /**
  75596. * Interface used to define Action
  75597. */
  75598. export interface IAction {
  75599. /**
  75600. * Trigger for the action
  75601. */
  75602. trigger: number;
  75603. /** Options of the trigger */
  75604. triggerOptions: any;
  75605. /**
  75606. * Gets the trigger parameters
  75607. * @returns the trigger parameters
  75608. */
  75609. getTriggerParameter(): any;
  75610. /**
  75611. * Internal only - executes current action event
  75612. * @hidden
  75613. */
  75614. _executeCurrent(evt?: ActionEvent): void;
  75615. /**
  75616. * Serialize placeholder for child classes
  75617. * @param parent of child
  75618. * @returns the serialized object
  75619. */
  75620. serialize(parent: any): any;
  75621. /**
  75622. * Internal only
  75623. * @hidden
  75624. */
  75625. _prepare(): void;
  75626. /**
  75627. * Internal only - manager for action
  75628. * @hidden
  75629. */
  75630. _actionManager: AbstractActionManager;
  75631. /**
  75632. * Adds action to chain of actions, may be a DoNothingAction
  75633. * @param action defines the next action to execute
  75634. * @returns The action passed in
  75635. * @see https://www.babylonjs-playground.com/#1T30HR#0
  75636. */
  75637. then(action: IAction): IAction;
  75638. }
  75639. /**
  75640. * The action to be carried out following a trigger
  75641. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  75642. */
  75643. export class Action implements IAction {
  75644. /** the trigger, with or without parameters, for the action */
  75645. triggerOptions: any;
  75646. /**
  75647. * Trigger for the action
  75648. */
  75649. trigger: number;
  75650. /**
  75651. * Internal only - manager for action
  75652. * @hidden
  75653. */
  75654. _actionManager: ActionManager;
  75655. private _nextActiveAction;
  75656. private _child;
  75657. private _condition?;
  75658. private _triggerParameter;
  75659. /**
  75660. * An event triggered prior to action being executed.
  75661. */
  75662. onBeforeExecuteObservable: Observable<Action>;
  75663. /**
  75664. * Creates a new Action
  75665. * @param triggerOptions the trigger, with or without parameters, for the action
  75666. * @param condition an optional determinant of action
  75667. */
  75668. constructor(
  75669. /** the trigger, with or without parameters, for the action */
  75670. triggerOptions: any, condition?: Condition);
  75671. /**
  75672. * Internal only
  75673. * @hidden
  75674. */
  75675. _prepare(): void;
  75676. /**
  75677. * Gets the trigger parameters
  75678. * @returns the trigger parameters
  75679. */
  75680. getTriggerParameter(): any;
  75681. /**
  75682. * Internal only - executes current action event
  75683. * @hidden
  75684. */
  75685. _executeCurrent(evt?: ActionEvent): void;
  75686. /**
  75687. * Execute placeholder for child classes
  75688. * @param evt optional action event
  75689. */
  75690. execute(evt?: ActionEvent): void;
  75691. /**
  75692. * Skips to next active action
  75693. */
  75694. skipToNextActiveAction(): void;
  75695. /**
  75696. * Adds action to chain of actions, may be a DoNothingAction
  75697. * @param action defines the next action to execute
  75698. * @returns The action passed in
  75699. * @see https://www.babylonjs-playground.com/#1T30HR#0
  75700. */
  75701. then(action: Action): Action;
  75702. /**
  75703. * Internal only
  75704. * @hidden
  75705. */
  75706. _getProperty(propertyPath: string): string;
  75707. /**
  75708. * Internal only
  75709. * @hidden
  75710. */
  75711. _getEffectiveTarget(target: any, propertyPath: string): any;
  75712. /**
  75713. * Serialize placeholder for child classes
  75714. * @param parent of child
  75715. * @returns the serialized object
  75716. */
  75717. serialize(parent: any): any;
  75718. /**
  75719. * Internal only called by serialize
  75720. * @hidden
  75721. */
  75722. protected _serialize(serializedAction: any, parent?: any): any;
  75723. /**
  75724. * Internal only
  75725. * @hidden
  75726. */
  75727. static _SerializeValueAsString: (value: any) => string;
  75728. /**
  75729. * Internal only
  75730. * @hidden
  75731. */
  75732. static _GetTargetProperty: (target: Node | Scene) => {
  75733. name: string;
  75734. targetType: string;
  75735. value: string;
  75736. };
  75737. }
  75738. }
  75739. declare module BABYLON {
  75740. /**
  75741. * A Condition applied to an Action
  75742. */
  75743. export class Condition {
  75744. /**
  75745. * Internal only - manager for action
  75746. * @hidden
  75747. */
  75748. _actionManager: ActionManager;
  75749. /**
  75750. * Internal only
  75751. * @hidden
  75752. */
  75753. _evaluationId: number;
  75754. /**
  75755. * Internal only
  75756. * @hidden
  75757. */
  75758. _currentResult: boolean;
  75759. /**
  75760. * Creates a new Condition
  75761. * @param actionManager the manager of the action the condition is applied to
  75762. */
  75763. constructor(actionManager: ActionManager);
  75764. /**
  75765. * Check if the current condition is valid
  75766. * @returns a boolean
  75767. */
  75768. isValid(): boolean;
  75769. /**
  75770. * Internal only
  75771. * @hidden
  75772. */
  75773. _getProperty(propertyPath: string): string;
  75774. /**
  75775. * Internal only
  75776. * @hidden
  75777. */
  75778. _getEffectiveTarget(target: any, propertyPath: string): any;
  75779. /**
  75780. * Serialize placeholder for child classes
  75781. * @returns the serialized object
  75782. */
  75783. serialize(): any;
  75784. /**
  75785. * Internal only
  75786. * @hidden
  75787. */
  75788. protected _serialize(serializedCondition: any): any;
  75789. }
  75790. /**
  75791. * Defines specific conditional operators as extensions of Condition
  75792. */
  75793. export class ValueCondition extends Condition {
  75794. /** path to specify the property of the target the conditional operator uses */
  75795. propertyPath: string;
  75796. /** the value compared by the conditional operator against the current value of the property */
  75797. value: any;
  75798. /** the conditional operator, default ValueCondition.IsEqual */
  75799. operator: number;
  75800. /**
  75801. * Internal only
  75802. * @hidden
  75803. */
  75804. private static _IsEqual;
  75805. /**
  75806. * Internal only
  75807. * @hidden
  75808. */
  75809. private static _IsDifferent;
  75810. /**
  75811. * Internal only
  75812. * @hidden
  75813. */
  75814. private static _IsGreater;
  75815. /**
  75816. * Internal only
  75817. * @hidden
  75818. */
  75819. private static _IsLesser;
  75820. /**
  75821. * returns the number for IsEqual
  75822. */
  75823. static readonly IsEqual: number;
  75824. /**
  75825. * Returns the number for IsDifferent
  75826. */
  75827. static readonly IsDifferent: number;
  75828. /**
  75829. * Returns the number for IsGreater
  75830. */
  75831. static readonly IsGreater: number;
  75832. /**
  75833. * Returns the number for IsLesser
  75834. */
  75835. static readonly IsLesser: number;
  75836. /**
  75837. * Internal only The action manager for the condition
  75838. * @hidden
  75839. */
  75840. _actionManager: ActionManager;
  75841. /**
  75842. * Internal only
  75843. * @hidden
  75844. */
  75845. private _target;
  75846. /**
  75847. * Internal only
  75848. * @hidden
  75849. */
  75850. private _effectiveTarget;
  75851. /**
  75852. * Internal only
  75853. * @hidden
  75854. */
  75855. private _property;
  75856. /**
  75857. * Creates a new ValueCondition
  75858. * @param actionManager manager for the action the condition applies to
  75859. * @param target for the action
  75860. * @param propertyPath path to specify the property of the target the conditional operator uses
  75861. * @param value the value compared by the conditional operator against the current value of the property
  75862. * @param operator the conditional operator, default ValueCondition.IsEqual
  75863. */
  75864. constructor(actionManager: ActionManager, target: any,
  75865. /** path to specify the property of the target the conditional operator uses */
  75866. propertyPath: string,
  75867. /** the value compared by the conditional operator against the current value of the property */
  75868. value: any,
  75869. /** the conditional operator, default ValueCondition.IsEqual */
  75870. operator?: number);
  75871. /**
  75872. * Compares the given value with the property value for the specified conditional operator
  75873. * @returns the result of the comparison
  75874. */
  75875. isValid(): boolean;
  75876. /**
  75877. * Serialize the ValueCondition into a JSON compatible object
  75878. * @returns serialization object
  75879. */
  75880. serialize(): any;
  75881. /**
  75882. * Gets the name of the conditional operator for the ValueCondition
  75883. * @param operator the conditional operator
  75884. * @returns the name
  75885. */
  75886. static GetOperatorName(operator: number): string;
  75887. }
  75888. /**
  75889. * Defines a predicate condition as an extension of Condition
  75890. */
  75891. export class PredicateCondition extends Condition {
  75892. /** defines the predicate function used to validate the condition */
  75893. predicate: () => boolean;
  75894. /**
  75895. * Internal only - manager for action
  75896. * @hidden
  75897. */
  75898. _actionManager: ActionManager;
  75899. /**
  75900. * Creates a new PredicateCondition
  75901. * @param actionManager manager for the action the condition applies to
  75902. * @param predicate defines the predicate function used to validate the condition
  75903. */
  75904. constructor(actionManager: ActionManager,
  75905. /** defines the predicate function used to validate the condition */
  75906. predicate: () => boolean);
  75907. /**
  75908. * @returns the validity of the predicate condition
  75909. */
  75910. isValid(): boolean;
  75911. }
  75912. /**
  75913. * Defines a state condition as an extension of Condition
  75914. */
  75915. export class StateCondition extends Condition {
  75916. /** Value to compare with target state */
  75917. value: string;
  75918. /**
  75919. * Internal only - manager for action
  75920. * @hidden
  75921. */
  75922. _actionManager: ActionManager;
  75923. /**
  75924. * Internal only
  75925. * @hidden
  75926. */
  75927. private _target;
  75928. /**
  75929. * Creates a new StateCondition
  75930. * @param actionManager manager for the action the condition applies to
  75931. * @param target of the condition
  75932. * @param value to compare with target state
  75933. */
  75934. constructor(actionManager: ActionManager, target: any,
  75935. /** Value to compare with target state */
  75936. value: string);
  75937. /**
  75938. * Gets a boolean indicating if the current condition is met
  75939. * @returns the validity of the state
  75940. */
  75941. isValid(): boolean;
  75942. /**
  75943. * Serialize the StateCondition into a JSON compatible object
  75944. * @returns serialization object
  75945. */
  75946. serialize(): any;
  75947. }
  75948. }
  75949. declare module BABYLON {
  75950. /**
  75951. * This defines an action responsible to toggle a boolean once triggered.
  75952. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  75953. */
  75954. export class SwitchBooleanAction extends Action {
  75955. /**
  75956. * The path to the boolean property in the target object
  75957. */
  75958. propertyPath: string;
  75959. private _target;
  75960. private _effectiveTarget;
  75961. private _property;
  75962. /**
  75963. * Instantiate the action
  75964. * @param triggerOptions defines the trigger options
  75965. * @param target defines the object containing the boolean
  75966. * @param propertyPath defines the path to the boolean property in the target object
  75967. * @param condition defines the trigger related conditions
  75968. */
  75969. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  75970. /** @hidden */
  75971. _prepare(): void;
  75972. /**
  75973. * Execute the action toggle the boolean value.
  75974. */
  75975. execute(): void;
  75976. /**
  75977. * Serializes the actions and its related information.
  75978. * @param parent defines the object to serialize in
  75979. * @returns the serialized object
  75980. */
  75981. serialize(parent: any): any;
  75982. }
  75983. /**
  75984. * This defines an action responsible to set a the state field of the target
  75985. * to a desired value once triggered.
  75986. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  75987. */
  75988. export class SetStateAction extends Action {
  75989. /**
  75990. * The value to store in the state field.
  75991. */
  75992. value: string;
  75993. private _target;
  75994. /**
  75995. * Instantiate the action
  75996. * @param triggerOptions defines the trigger options
  75997. * @param target defines the object containing the state property
  75998. * @param value defines the value to store in the state field
  75999. * @param condition defines the trigger related conditions
  76000. */
  76001. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  76002. /**
  76003. * Execute the action and store the value on the target state property.
  76004. */
  76005. execute(): void;
  76006. /**
  76007. * Serializes the actions and its related information.
  76008. * @param parent defines the object to serialize in
  76009. * @returns the serialized object
  76010. */
  76011. serialize(parent: any): any;
  76012. }
  76013. /**
  76014. * This defines an action responsible to set a property of the target
  76015. * to a desired value once triggered.
  76016. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76017. */
  76018. export class SetValueAction extends Action {
  76019. /**
  76020. * The path of the property to set in the target.
  76021. */
  76022. propertyPath: string;
  76023. /**
  76024. * The value to set in the property
  76025. */
  76026. value: any;
  76027. private _target;
  76028. private _effectiveTarget;
  76029. private _property;
  76030. /**
  76031. * Instantiate the action
  76032. * @param triggerOptions defines the trigger options
  76033. * @param target defines the object containing the property
  76034. * @param propertyPath defines the path of the property to set in the target
  76035. * @param value defines the value to set in the property
  76036. * @param condition defines the trigger related conditions
  76037. */
  76038. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  76039. /** @hidden */
  76040. _prepare(): void;
  76041. /**
  76042. * Execute the action and set the targetted property to the desired value.
  76043. */
  76044. execute(): void;
  76045. /**
  76046. * Serializes the actions and its related information.
  76047. * @param parent defines the object to serialize in
  76048. * @returns the serialized object
  76049. */
  76050. serialize(parent: any): any;
  76051. }
  76052. /**
  76053. * This defines an action responsible to increment the target value
  76054. * to a desired value once triggered.
  76055. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76056. */
  76057. export class IncrementValueAction extends Action {
  76058. /**
  76059. * The path of the property to increment in the target.
  76060. */
  76061. propertyPath: string;
  76062. /**
  76063. * The value we should increment the property by.
  76064. */
  76065. value: any;
  76066. private _target;
  76067. private _effectiveTarget;
  76068. private _property;
  76069. /**
  76070. * Instantiate the action
  76071. * @param triggerOptions defines the trigger options
  76072. * @param target defines the object containing the property
  76073. * @param propertyPath defines the path of the property to increment in the target
  76074. * @param value defines the value value we should increment the property by
  76075. * @param condition defines the trigger related conditions
  76076. */
  76077. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  76078. /** @hidden */
  76079. _prepare(): void;
  76080. /**
  76081. * Execute the action and increment the target of the value amount.
  76082. */
  76083. execute(): void;
  76084. /**
  76085. * Serializes the actions and its related information.
  76086. * @param parent defines the object to serialize in
  76087. * @returns the serialized object
  76088. */
  76089. serialize(parent: any): any;
  76090. }
  76091. /**
  76092. * This defines an action responsible to start an animation once triggered.
  76093. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76094. */
  76095. export class PlayAnimationAction extends Action {
  76096. /**
  76097. * Where the animation should start (animation frame)
  76098. */
  76099. from: number;
  76100. /**
  76101. * Where the animation should stop (animation frame)
  76102. */
  76103. to: number;
  76104. /**
  76105. * Define if the animation should loop or stop after the first play.
  76106. */
  76107. loop?: boolean;
  76108. private _target;
  76109. /**
  76110. * Instantiate the action
  76111. * @param triggerOptions defines the trigger options
  76112. * @param target defines the target animation or animation name
  76113. * @param from defines from where the animation should start (animation frame)
  76114. * @param end defines where the animation should stop (animation frame)
  76115. * @param loop defines if the animation should loop or stop after the first play
  76116. * @param condition defines the trigger related conditions
  76117. */
  76118. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  76119. /** @hidden */
  76120. _prepare(): void;
  76121. /**
  76122. * Execute the action and play the animation.
  76123. */
  76124. execute(): void;
  76125. /**
  76126. * Serializes the actions and its related information.
  76127. * @param parent defines the object to serialize in
  76128. * @returns the serialized object
  76129. */
  76130. serialize(parent: any): any;
  76131. }
  76132. /**
  76133. * This defines an action responsible to stop an animation once triggered.
  76134. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76135. */
  76136. export class StopAnimationAction extends Action {
  76137. private _target;
  76138. /**
  76139. * Instantiate the action
  76140. * @param triggerOptions defines the trigger options
  76141. * @param target defines the target animation or animation name
  76142. * @param condition defines the trigger related conditions
  76143. */
  76144. constructor(triggerOptions: any, target: any, condition?: Condition);
  76145. /** @hidden */
  76146. _prepare(): void;
  76147. /**
  76148. * Execute the action and stop the animation.
  76149. */
  76150. execute(): void;
  76151. /**
  76152. * Serializes the actions and its related information.
  76153. * @param parent defines the object to serialize in
  76154. * @returns the serialized object
  76155. */
  76156. serialize(parent: any): any;
  76157. }
  76158. /**
  76159. * This defines an action responsible that does nothing once triggered.
  76160. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76161. */
  76162. export class DoNothingAction extends Action {
  76163. /**
  76164. * Instantiate the action
  76165. * @param triggerOptions defines the trigger options
  76166. * @param condition defines the trigger related conditions
  76167. */
  76168. constructor(triggerOptions?: any, condition?: Condition);
  76169. /**
  76170. * Execute the action and do nothing.
  76171. */
  76172. execute(): void;
  76173. /**
  76174. * Serializes the actions and its related information.
  76175. * @param parent defines the object to serialize in
  76176. * @returns the serialized object
  76177. */
  76178. serialize(parent: any): any;
  76179. }
  76180. /**
  76181. * This defines an action responsible to trigger several actions once triggered.
  76182. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76183. */
  76184. export class CombineAction extends Action {
  76185. /**
  76186. * The list of aggregated animations to run.
  76187. */
  76188. children: Action[];
  76189. /**
  76190. * Instantiate the action
  76191. * @param triggerOptions defines the trigger options
  76192. * @param children defines the list of aggregated animations to run
  76193. * @param condition defines the trigger related conditions
  76194. */
  76195. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  76196. /** @hidden */
  76197. _prepare(): void;
  76198. /**
  76199. * Execute the action and executes all the aggregated actions.
  76200. */
  76201. execute(evt: ActionEvent): void;
  76202. /**
  76203. * Serializes the actions and its related information.
  76204. * @param parent defines the object to serialize in
  76205. * @returns the serialized object
  76206. */
  76207. serialize(parent: any): any;
  76208. }
  76209. /**
  76210. * This defines an action responsible to run code (external event) once triggered.
  76211. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76212. */
  76213. export class ExecuteCodeAction extends Action {
  76214. /**
  76215. * The callback function to run.
  76216. */
  76217. func: (evt: ActionEvent) => void;
  76218. /**
  76219. * Instantiate the action
  76220. * @param triggerOptions defines the trigger options
  76221. * @param func defines the callback function to run
  76222. * @param condition defines the trigger related conditions
  76223. */
  76224. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  76225. /**
  76226. * Execute the action and run the attached code.
  76227. */
  76228. execute(evt: ActionEvent): void;
  76229. }
  76230. /**
  76231. * This defines an action responsible to set the parent property of the target once triggered.
  76232. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76233. */
  76234. export class SetParentAction extends Action {
  76235. private _parent;
  76236. private _target;
  76237. /**
  76238. * Instantiate the action
  76239. * @param triggerOptions defines the trigger options
  76240. * @param target defines the target containing the parent property
  76241. * @param parent defines from where the animation should start (animation frame)
  76242. * @param condition defines the trigger related conditions
  76243. */
  76244. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  76245. /** @hidden */
  76246. _prepare(): void;
  76247. /**
  76248. * Execute the action and set the parent property.
  76249. */
  76250. execute(): void;
  76251. /**
  76252. * Serializes the actions and its related information.
  76253. * @param parent defines the object to serialize in
  76254. * @returns the serialized object
  76255. */
  76256. serialize(parent: any): any;
  76257. }
  76258. }
  76259. declare module BABYLON {
  76260. /**
  76261. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  76262. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  76263. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  76264. */
  76265. export class ActionManager extends AbstractActionManager {
  76266. /**
  76267. * Nothing
  76268. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76269. */
  76270. static readonly NothingTrigger: number;
  76271. /**
  76272. * On pick
  76273. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76274. */
  76275. static readonly OnPickTrigger: number;
  76276. /**
  76277. * On left pick
  76278. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76279. */
  76280. static readonly OnLeftPickTrigger: number;
  76281. /**
  76282. * On right pick
  76283. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76284. */
  76285. static readonly OnRightPickTrigger: number;
  76286. /**
  76287. * On center pick
  76288. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76289. */
  76290. static readonly OnCenterPickTrigger: number;
  76291. /**
  76292. * On pick down
  76293. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76294. */
  76295. static readonly OnPickDownTrigger: number;
  76296. /**
  76297. * On double pick
  76298. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76299. */
  76300. static readonly OnDoublePickTrigger: number;
  76301. /**
  76302. * On pick up
  76303. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76304. */
  76305. static readonly OnPickUpTrigger: number;
  76306. /**
  76307. * On pick out.
  76308. * This trigger will only be raised if you also declared a OnPickDown
  76309. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76310. */
  76311. static readonly OnPickOutTrigger: number;
  76312. /**
  76313. * On long press
  76314. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76315. */
  76316. static readonly OnLongPressTrigger: number;
  76317. /**
  76318. * On pointer over
  76319. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76320. */
  76321. static readonly OnPointerOverTrigger: number;
  76322. /**
  76323. * On pointer out
  76324. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76325. */
  76326. static readonly OnPointerOutTrigger: number;
  76327. /**
  76328. * On every frame
  76329. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76330. */
  76331. static readonly OnEveryFrameTrigger: number;
  76332. /**
  76333. * On intersection enter
  76334. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76335. */
  76336. static readonly OnIntersectionEnterTrigger: number;
  76337. /**
  76338. * On intersection exit
  76339. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76340. */
  76341. static readonly OnIntersectionExitTrigger: number;
  76342. /**
  76343. * On key down
  76344. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76345. */
  76346. static readonly OnKeyDownTrigger: number;
  76347. /**
  76348. * On key up
  76349. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  76350. */
  76351. static readonly OnKeyUpTrigger: number;
  76352. private _scene;
  76353. /**
  76354. * Creates a new action manager
  76355. * @param scene defines the hosting scene
  76356. */
  76357. constructor(scene: Scene);
  76358. /**
  76359. * Releases all associated resources
  76360. */
  76361. dispose(): void;
  76362. /**
  76363. * Gets hosting scene
  76364. * @returns the hosting scene
  76365. */
  76366. getScene(): Scene;
  76367. /**
  76368. * Does this action manager handles actions of any of the given triggers
  76369. * @param triggers defines the triggers to be tested
  76370. * @return a boolean indicating whether one (or more) of the triggers is handled
  76371. */
  76372. hasSpecificTriggers(triggers: number[]): boolean;
  76373. /**
  76374. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  76375. * speed.
  76376. * @param triggerA defines the trigger to be tested
  76377. * @param triggerB defines the trigger to be tested
  76378. * @return a boolean indicating whether one (or more) of the triggers is handled
  76379. */
  76380. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  76381. /**
  76382. * Does this action manager handles actions of a given trigger
  76383. * @param trigger defines the trigger to be tested
  76384. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  76385. * @return whether the trigger is handled
  76386. */
  76387. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  76388. /**
  76389. * Does this action manager has pointer triggers
  76390. */
  76391. readonly hasPointerTriggers: boolean;
  76392. /**
  76393. * Does this action manager has pick triggers
  76394. */
  76395. readonly hasPickTriggers: boolean;
  76396. /**
  76397. * Registers an action to this action manager
  76398. * @param action defines the action to be registered
  76399. * @return the action amended (prepared) after registration
  76400. */
  76401. registerAction(action: IAction): Nullable<IAction>;
  76402. /**
  76403. * Unregisters an action to this action manager
  76404. * @param action defines the action to be unregistered
  76405. * @return a boolean indicating whether the action has been unregistered
  76406. */
  76407. unregisterAction(action: IAction): Boolean;
  76408. /**
  76409. * Process a specific trigger
  76410. * @param trigger defines the trigger to process
  76411. * @param evt defines the event details to be processed
  76412. */
  76413. processTrigger(trigger: number, evt?: IActionEvent): void;
  76414. /** @hidden */
  76415. _getEffectiveTarget(target: any, propertyPath: string): any;
  76416. /** @hidden */
  76417. _getProperty(propertyPath: string): string;
  76418. /**
  76419. * Serialize this manager to a JSON object
  76420. * @param name defines the property name to store this manager
  76421. * @returns a JSON representation of this manager
  76422. */
  76423. serialize(name: string): any;
  76424. /**
  76425. * Creates a new ActionManager from a JSON data
  76426. * @param parsedActions defines the JSON data to read from
  76427. * @param object defines the hosting mesh
  76428. * @param scene defines the hosting scene
  76429. */
  76430. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  76431. /**
  76432. * Get a trigger name by index
  76433. * @param trigger defines the trigger index
  76434. * @returns a trigger name
  76435. */
  76436. static GetTriggerName(trigger: number): string;
  76437. }
  76438. }
  76439. declare module BABYLON {
  76440. /**
  76441. * Class representing a ray with position and direction
  76442. */
  76443. export class Ray {
  76444. /** origin point */
  76445. origin: Vector3;
  76446. /** direction */
  76447. direction: Vector3;
  76448. /** length of the ray */
  76449. length: number;
  76450. private static readonly TmpVector3;
  76451. private _tmpRay;
  76452. /**
  76453. * Creates a new ray
  76454. * @param origin origin point
  76455. * @param direction direction
  76456. * @param length length of the ray
  76457. */
  76458. constructor(
  76459. /** origin point */
  76460. origin: Vector3,
  76461. /** direction */
  76462. direction: Vector3,
  76463. /** length of the ray */
  76464. length?: number);
  76465. /**
  76466. * Checks if the ray intersects a box
  76467. * @param minimum bound of the box
  76468. * @param maximum bound of the box
  76469. * @param intersectionTreshold extra extend to be added to the box in all direction
  76470. * @returns if the box was hit
  76471. */
  76472. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  76473. /**
  76474. * Checks if the ray intersects a box
  76475. * @param box the bounding box to check
  76476. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  76477. * @returns if the box was hit
  76478. */
  76479. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  76480. /**
  76481. * If the ray hits a sphere
  76482. * @param sphere the bounding sphere to check
  76483. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  76484. * @returns true if it hits the sphere
  76485. */
  76486. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  76487. /**
  76488. * If the ray hits a triange
  76489. * @param vertex0 triangle vertex
  76490. * @param vertex1 triangle vertex
  76491. * @param vertex2 triangle vertex
  76492. * @returns intersection information if hit
  76493. */
  76494. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  76495. /**
  76496. * Checks if ray intersects a plane
  76497. * @param plane the plane to check
  76498. * @returns the distance away it was hit
  76499. */
  76500. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  76501. /**
  76502. * Calculate the intercept of a ray on a given axis
  76503. * @param axis to check 'x' | 'y' | 'z'
  76504. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  76505. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  76506. */
  76507. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  76508. /**
  76509. * Checks if ray intersects a mesh
  76510. * @param mesh the mesh to check
  76511. * @param fastCheck if only the bounding box should checked
  76512. * @returns picking info of the intersecton
  76513. */
  76514. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  76515. /**
  76516. * Checks if ray intersects a mesh
  76517. * @param meshes the meshes to check
  76518. * @param fastCheck if only the bounding box should checked
  76519. * @param results array to store result in
  76520. * @returns Array of picking infos
  76521. */
  76522. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  76523. private _comparePickingInfo;
  76524. private static smallnum;
  76525. private static rayl;
  76526. /**
  76527. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  76528. * @param sega the first point of the segment to test the intersection against
  76529. * @param segb the second point of the segment to test the intersection against
  76530. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  76531. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  76532. */
  76533. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  76534. /**
  76535. * Update the ray from viewport position
  76536. * @param x position
  76537. * @param y y position
  76538. * @param viewportWidth viewport width
  76539. * @param viewportHeight viewport height
  76540. * @param world world matrix
  76541. * @param view view matrix
  76542. * @param projection projection matrix
  76543. * @returns this ray updated
  76544. */
  76545. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  76546. /**
  76547. * Creates a ray with origin and direction of 0,0,0
  76548. * @returns the new ray
  76549. */
  76550. static Zero(): Ray;
  76551. /**
  76552. * Creates a new ray from screen space and viewport
  76553. * @param x position
  76554. * @param y y position
  76555. * @param viewportWidth viewport width
  76556. * @param viewportHeight viewport height
  76557. * @param world world matrix
  76558. * @param view view matrix
  76559. * @param projection projection matrix
  76560. * @returns new ray
  76561. */
  76562. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  76563. /**
  76564. * 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
  76565. * transformed to the given world matrix.
  76566. * @param origin The origin point
  76567. * @param end The end point
  76568. * @param world a matrix to transform the ray to. Default is the identity matrix.
  76569. * @returns the new ray
  76570. */
  76571. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  76572. /**
  76573. * Transforms a ray by a matrix
  76574. * @param ray ray to transform
  76575. * @param matrix matrix to apply
  76576. * @returns the resulting new ray
  76577. */
  76578. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  76579. /**
  76580. * Transforms a ray by a matrix
  76581. * @param ray ray to transform
  76582. * @param matrix matrix to apply
  76583. * @param result ray to store result in
  76584. */
  76585. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  76586. /**
  76587. * Unproject a ray from screen space to object space
  76588. * @param sourceX defines the screen space x coordinate to use
  76589. * @param sourceY defines the screen space y coordinate to use
  76590. * @param viewportWidth defines the current width of the viewport
  76591. * @param viewportHeight defines the current height of the viewport
  76592. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  76593. * @param view defines the view matrix to use
  76594. * @param projection defines the projection matrix to use
  76595. */
  76596. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  76597. }
  76598. /**
  76599. * Type used to define predicate used to select faces when a mesh intersection is detected
  76600. */
  76601. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  76602. interface Scene {
  76603. /** @hidden */
  76604. _tempPickingRay: Nullable<Ray>;
  76605. /** @hidden */
  76606. _cachedRayForTransform: Ray;
  76607. /** @hidden */
  76608. _pickWithRayInverseMatrix: Matrix;
  76609. /** @hidden */
  76610. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  76611. /** @hidden */
  76612. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  76613. }
  76614. }
  76615. declare module BABYLON {
  76616. /**
  76617. * Groups all the scene component constants in one place to ease maintenance.
  76618. * @hidden
  76619. */
  76620. export class SceneComponentConstants {
  76621. static readonly NAME_EFFECTLAYER: string;
  76622. static readonly NAME_LAYER: string;
  76623. static readonly NAME_LENSFLARESYSTEM: string;
  76624. static readonly NAME_BOUNDINGBOXRENDERER: string;
  76625. static readonly NAME_PARTICLESYSTEM: string;
  76626. static readonly NAME_GAMEPAD: string;
  76627. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  76628. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  76629. static readonly NAME_DEPTHRENDERER: string;
  76630. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  76631. static readonly NAME_SPRITE: string;
  76632. static readonly NAME_OUTLINERENDERER: string;
  76633. static readonly NAME_PROCEDURALTEXTURE: string;
  76634. static readonly NAME_SHADOWGENERATOR: string;
  76635. static readonly NAME_OCTREE: string;
  76636. static readonly NAME_PHYSICSENGINE: string;
  76637. static readonly NAME_AUDIO: string;
  76638. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  76639. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  76640. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  76641. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  76642. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  76643. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  76644. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  76645. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  76646. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  76647. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  76648. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  76649. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  76650. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  76651. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  76652. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  76653. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  76654. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  76655. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  76656. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  76657. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  76658. static readonly STEP_AFTERRENDER_AUDIO: number;
  76659. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  76660. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  76661. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  76662. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  76663. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  76664. static readonly STEP_POINTERMOVE_SPRITE: number;
  76665. static readonly STEP_POINTERDOWN_SPRITE: number;
  76666. static readonly STEP_POINTERUP_SPRITE: number;
  76667. }
  76668. /**
  76669. * This represents a scene component.
  76670. *
  76671. * This is used to decouple the dependency the scene is having on the different workloads like
  76672. * layers, post processes...
  76673. */
  76674. export interface ISceneComponent {
  76675. /**
  76676. * The name of the component. Each component must have a unique name.
  76677. */
  76678. name: string;
  76679. /**
  76680. * The scene the component belongs to.
  76681. */
  76682. scene: Scene;
  76683. /**
  76684. * Register the component to one instance of a scene.
  76685. */
  76686. register(): void;
  76687. /**
  76688. * Rebuilds the elements related to this component in case of
  76689. * context lost for instance.
  76690. */
  76691. rebuild(): void;
  76692. /**
  76693. * Disposes the component and the associated ressources.
  76694. */
  76695. dispose(): void;
  76696. }
  76697. /**
  76698. * This represents a SERIALIZABLE scene component.
  76699. *
  76700. * This extends Scene Component to add Serialization methods on top.
  76701. */
  76702. export interface ISceneSerializableComponent extends ISceneComponent {
  76703. /**
  76704. * Adds all the elements from the container to the scene
  76705. * @param container the container holding the elements
  76706. */
  76707. addFromContainer(container: AbstractScene): void;
  76708. /**
  76709. * Removes all the elements in the container from the scene
  76710. * @param container contains the elements to remove
  76711. * @param dispose if the removed element should be disposed (default: false)
  76712. */
  76713. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  76714. /**
  76715. * Serializes the component data to the specified json object
  76716. * @param serializationObject The object to serialize to
  76717. */
  76718. serialize(serializationObject: any): void;
  76719. }
  76720. /**
  76721. * Strong typing of a Mesh related stage step action
  76722. */
  76723. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  76724. /**
  76725. * Strong typing of a Evaluate Sub Mesh related stage step action
  76726. */
  76727. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  76728. /**
  76729. * Strong typing of a Active Mesh related stage step action
  76730. */
  76731. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  76732. /**
  76733. * Strong typing of a Camera related stage step action
  76734. */
  76735. export type CameraStageAction = (camera: Camera) => void;
  76736. /**
  76737. * Strong typing of a Camera Frame buffer related stage step action
  76738. */
  76739. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  76740. /**
  76741. * Strong typing of a Render Target related stage step action
  76742. */
  76743. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  76744. /**
  76745. * Strong typing of a RenderingGroup related stage step action
  76746. */
  76747. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  76748. /**
  76749. * Strong typing of a Mesh Render related stage step action
  76750. */
  76751. export type RenderingMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  76752. /**
  76753. * Strong typing of a simple stage step action
  76754. */
  76755. export type SimpleStageAction = () => void;
  76756. /**
  76757. * Strong typing of a render target action.
  76758. */
  76759. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  76760. /**
  76761. * Strong typing of a pointer move action.
  76762. */
  76763. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  76764. /**
  76765. * Strong typing of a pointer up/down action.
  76766. */
  76767. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  76768. /**
  76769. * Repressentation of a stage in the scene (Basically a list of ordered steps)
  76770. * @hidden
  76771. */
  76772. export class Stage<T extends Function> extends Array<{
  76773. index: number;
  76774. component: ISceneComponent;
  76775. action: T;
  76776. }> {
  76777. /**
  76778. * Hide ctor from the rest of the world.
  76779. * @param items The items to add.
  76780. */
  76781. private constructor();
  76782. /**
  76783. * Creates a new Stage.
  76784. * @returns A new instance of a Stage
  76785. */
  76786. static Create<T extends Function>(): Stage<T>;
  76787. /**
  76788. * Registers a step in an ordered way in the targeted stage.
  76789. * @param index Defines the position to register the step in
  76790. * @param component Defines the component attached to the step
  76791. * @param action Defines the action to launch during the step
  76792. */
  76793. registerStep(index: number, component: ISceneComponent, action: T): void;
  76794. /**
  76795. * Clears all the steps from the stage.
  76796. */
  76797. clear(): void;
  76798. }
  76799. }
  76800. declare module BABYLON {
  76801. interface Scene {
  76802. /** @hidden */
  76803. _pointerOverSprite: Nullable<Sprite>;
  76804. /** @hidden */
  76805. _pickedDownSprite: Nullable<Sprite>;
  76806. /** @hidden */
  76807. _tempSpritePickingRay: Nullable<Ray>;
  76808. /**
  76809. * All of the sprite managers added to this scene
  76810. * @see http://doc.babylonjs.com/babylon101/sprites
  76811. */
  76812. spriteManagers: Array<ISpriteManager>;
  76813. /**
  76814. * An event triggered when sprites rendering is about to start
  76815. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  76816. */
  76817. onBeforeSpritesRenderingObservable: Observable<Scene>;
  76818. /**
  76819. * An event triggered when sprites rendering is done
  76820. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  76821. */
  76822. onAfterSpritesRenderingObservable: Observable<Scene>;
  76823. /** @hidden */
  76824. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  76825. /** Launch a ray to try to pick a sprite in the scene
  76826. * @param x position on screen
  76827. * @param y position on screen
  76828. * @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
  76829. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  76830. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  76831. * @returns a PickingInfo
  76832. */
  76833. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  76834. /** Use the given ray to pick a sprite in the scene
  76835. * @param ray The ray (in world space) to use to pick meshes
  76836. * @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
  76837. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  76838. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  76839. * @returns a PickingInfo
  76840. */
  76841. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  76842. /** @hidden */
  76843. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  76844. /** Launch a ray to try to pick sprites in the scene
  76845. * @param x position on screen
  76846. * @param y position on screen
  76847. * @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
  76848. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  76849. * @returns a PickingInfo array
  76850. */
  76851. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  76852. /** Use the given ray to pick sprites in the scene
  76853. * @param ray The ray (in world space) to use to pick meshes
  76854. * @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
  76855. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  76856. * @returns a PickingInfo array
  76857. */
  76858. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  76859. /**
  76860. * Force the sprite under the pointer
  76861. * @param sprite defines the sprite to use
  76862. */
  76863. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  76864. /**
  76865. * Gets the sprite under the pointer
  76866. * @returns a Sprite or null if no sprite is under the pointer
  76867. */
  76868. getPointerOverSprite(): Nullable<Sprite>;
  76869. }
  76870. /**
  76871. * Defines the sprite scene component responsible to manage sprites
  76872. * in a given scene.
  76873. */
  76874. export class SpriteSceneComponent implements ISceneComponent {
  76875. /**
  76876. * The component name helpfull to identify the component in the list of scene components.
  76877. */
  76878. readonly name: string;
  76879. /**
  76880. * The scene the component belongs to.
  76881. */
  76882. scene: Scene;
  76883. /** @hidden */
  76884. private _spritePredicate;
  76885. /**
  76886. * Creates a new instance of the component for the given scene
  76887. * @param scene Defines the scene to register the component in
  76888. */
  76889. constructor(scene: Scene);
  76890. /**
  76891. * Registers the component in a given scene
  76892. */
  76893. register(): void;
  76894. /**
  76895. * Rebuilds the elements related to this component in case of
  76896. * context lost for instance.
  76897. */
  76898. rebuild(): void;
  76899. /**
  76900. * Disposes the component and the associated ressources.
  76901. */
  76902. dispose(): void;
  76903. private _pickSpriteButKeepRay;
  76904. private _pointerMove;
  76905. private _pointerDown;
  76906. private _pointerUp;
  76907. }
  76908. }
  76909. declare module BABYLON {
  76910. /** @hidden */
  76911. export var fogFragmentDeclaration: {
  76912. name: string;
  76913. shader: string;
  76914. };
  76915. }
  76916. declare module BABYLON {
  76917. /** @hidden */
  76918. export var fogFragment: {
  76919. name: string;
  76920. shader: string;
  76921. };
  76922. }
  76923. declare module BABYLON {
  76924. /** @hidden */
  76925. export var spritesPixelShader: {
  76926. name: string;
  76927. shader: string;
  76928. };
  76929. }
  76930. declare module BABYLON {
  76931. /** @hidden */
  76932. export var fogVertexDeclaration: {
  76933. name: string;
  76934. shader: string;
  76935. };
  76936. }
  76937. declare module BABYLON {
  76938. /** @hidden */
  76939. export var spritesVertexShader: {
  76940. name: string;
  76941. shader: string;
  76942. };
  76943. }
  76944. declare module BABYLON {
  76945. /**
  76946. * Defines the minimum interface to fullfil in order to be a sprite manager.
  76947. */
  76948. export interface ISpriteManager extends IDisposable {
  76949. /**
  76950. * Restricts the camera to viewing objects with the same layerMask.
  76951. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  76952. */
  76953. layerMask: number;
  76954. /**
  76955. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  76956. */
  76957. isPickable: boolean;
  76958. /**
  76959. * Specifies the rendering group id for this mesh (0 by default)
  76960. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  76961. */
  76962. renderingGroupId: number;
  76963. /**
  76964. * Defines the list of sprites managed by the manager.
  76965. */
  76966. sprites: Array<Sprite>;
  76967. /**
  76968. * Tests the intersection of a sprite with a specific ray.
  76969. * @param ray The ray we are sending to test the collision
  76970. * @param camera The camera space we are sending rays in
  76971. * @param predicate A predicate allowing excluding sprites from the list of object to test
  76972. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  76973. * @returns picking info or null.
  76974. */
  76975. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  76976. /**
  76977. * Intersects the sprites with a ray
  76978. * @param ray defines the ray to intersect with
  76979. * @param camera defines the current active camera
  76980. * @param predicate defines a predicate used to select candidate sprites
  76981. * @returns null if no hit or a PickingInfo array
  76982. */
  76983. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  76984. /**
  76985. * Renders the list of sprites on screen.
  76986. */
  76987. render(): void;
  76988. }
  76989. /**
  76990. * Class used to manage multiple sprites on the same spritesheet
  76991. * @see http://doc.babylonjs.com/babylon101/sprites
  76992. */
  76993. export class SpriteManager implements ISpriteManager {
  76994. /** defines the manager's name */
  76995. name: string;
  76996. /** Gets the list of sprites */
  76997. sprites: Sprite[];
  76998. /** Gets or sets the rendering group id (0 by default) */
  76999. renderingGroupId: number;
  77000. /** Gets or sets camera layer mask */
  77001. layerMask: number;
  77002. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  77003. fogEnabled: boolean;
  77004. /** Gets or sets a boolean indicating if the sprites are pickable */
  77005. isPickable: boolean;
  77006. /** Defines the default width of a cell in the spritesheet */
  77007. cellWidth: number;
  77008. /** Defines the default height of a cell in the spritesheet */
  77009. cellHeight: number;
  77010. /** Associative array from JSON sprite data file */
  77011. private _cellData;
  77012. /** Array of sprite names from JSON sprite data file */
  77013. private _spriteMap;
  77014. /** True when packed cell data from JSON file is ready*/
  77015. private _packedAndReady;
  77016. /**
  77017. * An event triggered when the manager is disposed.
  77018. */
  77019. onDisposeObservable: Observable<SpriteManager>;
  77020. private _onDisposeObserver;
  77021. /**
  77022. * Callback called when the manager is disposed
  77023. */
  77024. onDispose: () => void;
  77025. private _capacity;
  77026. private _fromPacked;
  77027. private _spriteTexture;
  77028. private _epsilon;
  77029. private _scene;
  77030. private _vertexData;
  77031. private _buffer;
  77032. private _vertexBuffers;
  77033. private _indexBuffer;
  77034. private _effectBase;
  77035. private _effectFog;
  77036. /**
  77037. * Gets or sets the spritesheet texture
  77038. */
  77039. texture: Texture;
  77040. /**
  77041. * Creates a new sprite manager
  77042. * @param name defines the manager's name
  77043. * @param imgUrl defines the sprite sheet url
  77044. * @param capacity defines the maximum allowed number of sprites
  77045. * @param cellSize defines the size of a sprite cell
  77046. * @param scene defines the hosting scene
  77047. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  77048. * @param samplingMode defines the smapling mode to use with spritesheet
  77049. * @param fromPacked set to false; do not alter
  77050. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  77051. */
  77052. constructor(
  77053. /** defines the manager's name */
  77054. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  77055. private _makePacked;
  77056. private _appendSpriteVertex;
  77057. /**
  77058. * Intersects the sprites with a ray
  77059. * @param ray defines the ray to intersect with
  77060. * @param camera defines the current active camera
  77061. * @param predicate defines a predicate used to select candidate sprites
  77062. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  77063. * @returns null if no hit or a PickingInfo
  77064. */
  77065. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  77066. /**
  77067. * Intersects the sprites with a ray
  77068. * @param ray defines the ray to intersect with
  77069. * @param camera defines the current active camera
  77070. * @param predicate defines a predicate used to select candidate sprites
  77071. * @returns null if no hit or a PickingInfo array
  77072. */
  77073. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  77074. /**
  77075. * Render all child sprites
  77076. */
  77077. render(): void;
  77078. /**
  77079. * Release associated resources
  77080. */
  77081. dispose(): void;
  77082. }
  77083. }
  77084. declare module BABYLON {
  77085. /**
  77086. * Class used to represent a sprite
  77087. * @see http://doc.babylonjs.com/babylon101/sprites
  77088. */
  77089. export class Sprite {
  77090. /** defines the name */
  77091. name: string;
  77092. /** Gets or sets the current world position */
  77093. position: Vector3;
  77094. /** Gets or sets the main color */
  77095. color: Color4;
  77096. /** Gets or sets the width */
  77097. width: number;
  77098. /** Gets or sets the height */
  77099. height: number;
  77100. /** Gets or sets rotation angle */
  77101. angle: number;
  77102. /** Gets or sets the cell index in the sprite sheet */
  77103. cellIndex: number;
  77104. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  77105. cellRef: string;
  77106. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  77107. invertU: number;
  77108. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  77109. invertV: number;
  77110. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  77111. disposeWhenFinishedAnimating: boolean;
  77112. /** Gets the list of attached animations */
  77113. animations: Animation[];
  77114. /** Gets or sets a boolean indicating if the sprite can be picked */
  77115. isPickable: boolean;
  77116. /**
  77117. * Gets or sets the associated action manager
  77118. */
  77119. actionManager: Nullable<ActionManager>;
  77120. private _animationStarted;
  77121. private _loopAnimation;
  77122. private _fromIndex;
  77123. private _toIndex;
  77124. private _delay;
  77125. private _direction;
  77126. private _manager;
  77127. private _time;
  77128. private _onAnimationEnd;
  77129. /**
  77130. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  77131. */
  77132. isVisible: boolean;
  77133. /**
  77134. * Gets or sets the sprite size
  77135. */
  77136. size: number;
  77137. /**
  77138. * Creates a new Sprite
  77139. * @param name defines the name
  77140. * @param manager defines the manager
  77141. */
  77142. constructor(
  77143. /** defines the name */
  77144. name: string, manager: ISpriteManager);
  77145. /**
  77146. * Starts an animation
  77147. * @param from defines the initial key
  77148. * @param to defines the end key
  77149. * @param loop defines if the animation must loop
  77150. * @param delay defines the start delay (in ms)
  77151. * @param onAnimationEnd defines a callback to call when animation ends
  77152. */
  77153. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  77154. /** Stops current animation (if any) */
  77155. stopAnimation(): void;
  77156. /** @hidden */
  77157. _animate(deltaTime: number): void;
  77158. /** Release associated resources */
  77159. dispose(): void;
  77160. }
  77161. }
  77162. declare module BABYLON {
  77163. /**
  77164. * Information about the result of picking within a scene
  77165. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  77166. */
  77167. export class PickingInfo {
  77168. /** @hidden */
  77169. _pickingUnavailable: boolean;
  77170. /**
  77171. * If the pick collided with an object
  77172. */
  77173. hit: boolean;
  77174. /**
  77175. * Distance away where the pick collided
  77176. */
  77177. distance: number;
  77178. /**
  77179. * The location of pick collision
  77180. */
  77181. pickedPoint: Nullable<Vector3>;
  77182. /**
  77183. * The mesh corresponding the the pick collision
  77184. */
  77185. pickedMesh: Nullable<AbstractMesh>;
  77186. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  77187. bu: number;
  77188. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  77189. bv: number;
  77190. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  77191. faceId: number;
  77192. /** Id of the the submesh that was picked */
  77193. subMeshId: number;
  77194. /** If a sprite was picked, this will be the sprite the pick collided with */
  77195. pickedSprite: Nullable<Sprite>;
  77196. /**
  77197. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  77198. */
  77199. originMesh: Nullable<AbstractMesh>;
  77200. /**
  77201. * The ray that was used to perform the picking.
  77202. */
  77203. ray: Nullable<Ray>;
  77204. /**
  77205. * Gets the normal correspodning to the face the pick collided with
  77206. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  77207. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  77208. * @returns The normal correspodning to the face the pick collided with
  77209. */
  77210. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  77211. /**
  77212. * Gets the texture coordinates of where the pick occured
  77213. * @returns the vector containing the coordnates of the texture
  77214. */
  77215. getTextureCoordinates(): Nullable<Vector2>;
  77216. }
  77217. }
  77218. declare module BABYLON {
  77219. /**
  77220. * Gather the list of pointer event types as constants.
  77221. */
  77222. export class PointerEventTypes {
  77223. /**
  77224. * 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.
  77225. */
  77226. static readonly POINTERDOWN: number;
  77227. /**
  77228. * The pointerup event is fired when a pointer is no longer active.
  77229. */
  77230. static readonly POINTERUP: number;
  77231. /**
  77232. * The pointermove event is fired when a pointer changes coordinates.
  77233. */
  77234. static readonly POINTERMOVE: number;
  77235. /**
  77236. * The pointerwheel event is fired when a mouse wheel has been rotated.
  77237. */
  77238. static readonly POINTERWHEEL: number;
  77239. /**
  77240. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  77241. */
  77242. static readonly POINTERPICK: number;
  77243. /**
  77244. * The pointertap event is fired when a the object has been touched and released without drag.
  77245. */
  77246. static readonly POINTERTAP: number;
  77247. /**
  77248. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  77249. */
  77250. static readonly POINTERDOUBLETAP: number;
  77251. }
  77252. /**
  77253. * Base class of pointer info types.
  77254. */
  77255. export class PointerInfoBase {
  77256. /**
  77257. * Defines the type of event (PointerEventTypes)
  77258. */
  77259. type: number;
  77260. /**
  77261. * Defines the related dom event
  77262. */
  77263. event: PointerEvent | MouseWheelEvent;
  77264. /**
  77265. * Instantiates the base class of pointers info.
  77266. * @param type Defines the type of event (PointerEventTypes)
  77267. * @param event Defines the related dom event
  77268. */
  77269. constructor(
  77270. /**
  77271. * Defines the type of event (PointerEventTypes)
  77272. */
  77273. type: number,
  77274. /**
  77275. * Defines the related dom event
  77276. */
  77277. event: PointerEvent | MouseWheelEvent);
  77278. }
  77279. /**
  77280. * This class is used to store pointer related info for the onPrePointerObservable event.
  77281. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  77282. */
  77283. export class PointerInfoPre extends PointerInfoBase {
  77284. /**
  77285. * Ray from a pointer if availible (eg. 6dof controller)
  77286. */
  77287. ray: Nullable<Ray>;
  77288. /**
  77289. * Defines the local position of the pointer on the canvas.
  77290. */
  77291. localPosition: Vector2;
  77292. /**
  77293. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  77294. */
  77295. skipOnPointerObservable: boolean;
  77296. /**
  77297. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  77298. * @param type Defines the type of event (PointerEventTypes)
  77299. * @param event Defines the related dom event
  77300. * @param localX Defines the local x coordinates of the pointer when the event occured
  77301. * @param localY Defines the local y coordinates of the pointer when the event occured
  77302. */
  77303. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  77304. }
  77305. /**
  77306. * This type contains all the data related to a pointer event in Babylon.js.
  77307. * 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.
  77308. */
  77309. export class PointerInfo extends PointerInfoBase {
  77310. /**
  77311. * Defines the picking info associated to the info (if any)\
  77312. */
  77313. pickInfo: Nullable<PickingInfo>;
  77314. /**
  77315. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  77316. * @param type Defines the type of event (PointerEventTypes)
  77317. * @param event Defines the related dom event
  77318. * @param pickInfo Defines the picking info associated to the info (if any)\
  77319. */
  77320. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  77321. /**
  77322. * Defines the picking info associated to the info (if any)\
  77323. */
  77324. pickInfo: Nullable<PickingInfo>);
  77325. }
  77326. /**
  77327. * Data relating to a touch event on the screen.
  77328. */
  77329. export interface PointerTouch {
  77330. /**
  77331. * X coordinate of touch.
  77332. */
  77333. x: number;
  77334. /**
  77335. * Y coordinate of touch.
  77336. */
  77337. y: number;
  77338. /**
  77339. * Id of touch. Unique for each finger.
  77340. */
  77341. pointerId: number;
  77342. /**
  77343. * Event type passed from DOM.
  77344. */
  77345. type: any;
  77346. }
  77347. }
  77348. declare module BABYLON {
  77349. /**
  77350. * Manage the mouse inputs to control the movement of a free camera.
  77351. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  77352. */
  77353. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  77354. /**
  77355. * Define if touch is enabled in the mouse input
  77356. */
  77357. touchEnabled: boolean;
  77358. /**
  77359. * Defines the camera the input is attached to.
  77360. */
  77361. camera: FreeCamera;
  77362. /**
  77363. * Defines the buttons associated with the input to handle camera move.
  77364. */
  77365. buttons: number[];
  77366. /**
  77367. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  77368. */
  77369. angularSensibility: number;
  77370. private _pointerInput;
  77371. private _onMouseMove;
  77372. private _observer;
  77373. private previousPosition;
  77374. /**
  77375. * Observable for when a pointer move event occurs containing the move offset
  77376. */
  77377. onPointerMovedObservable: Observable<{
  77378. offsetX: number;
  77379. offsetY: number;
  77380. }>;
  77381. /**
  77382. * @hidden
  77383. * If the camera should be rotated automatically based on pointer movement
  77384. */
  77385. _allowCameraRotation: boolean;
  77386. /**
  77387. * Manage the mouse inputs to control the movement of a free camera.
  77388. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  77389. * @param touchEnabled Defines if touch is enabled or not
  77390. */
  77391. constructor(
  77392. /**
  77393. * Define if touch is enabled in the mouse input
  77394. */
  77395. touchEnabled?: boolean);
  77396. /**
  77397. * Attach the input controls to a specific dom element to get the input from.
  77398. * @param element Defines the element the controls should be listened from
  77399. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  77400. */
  77401. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  77402. /**
  77403. * Called on JS contextmenu event.
  77404. * Override this method to provide functionality.
  77405. */
  77406. protected onContextMenu(evt: PointerEvent): void;
  77407. /**
  77408. * Detach the current controls from the specified dom element.
  77409. * @param element Defines the element to stop listening the inputs from
  77410. */
  77411. detachControl(element: Nullable<HTMLElement>): void;
  77412. /**
  77413. * Gets the class name of the current intput.
  77414. * @returns the class name
  77415. */
  77416. getClassName(): string;
  77417. /**
  77418. * Get the friendly name associated with the input class.
  77419. * @returns the input friendly name
  77420. */
  77421. getSimpleName(): string;
  77422. }
  77423. }
  77424. declare module BABYLON {
  77425. /**
  77426. * Manage the touch inputs to control the movement of a free camera.
  77427. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  77428. */
  77429. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  77430. /**
  77431. * Defines the camera the input is attached to.
  77432. */
  77433. camera: FreeCamera;
  77434. /**
  77435. * Defines the touch sensibility for rotation.
  77436. * The higher the faster.
  77437. */
  77438. touchAngularSensibility: number;
  77439. /**
  77440. * Defines the touch sensibility for move.
  77441. * The higher the faster.
  77442. */
  77443. touchMoveSensibility: number;
  77444. private _offsetX;
  77445. private _offsetY;
  77446. private _pointerPressed;
  77447. private _pointerInput;
  77448. private _observer;
  77449. private _onLostFocus;
  77450. /**
  77451. * Attach the input controls to a specific dom element to get the input from.
  77452. * @param element Defines the element the controls should be listened from
  77453. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  77454. */
  77455. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  77456. /**
  77457. * Detach the current controls from the specified dom element.
  77458. * @param element Defines the element to stop listening the inputs from
  77459. */
  77460. detachControl(element: Nullable<HTMLElement>): void;
  77461. /**
  77462. * Update the current camera state depending on the inputs that have been used this frame.
  77463. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  77464. */
  77465. checkInputs(): void;
  77466. /**
  77467. * Gets the class name of the current intput.
  77468. * @returns the class name
  77469. */
  77470. getClassName(): string;
  77471. /**
  77472. * Get the friendly name associated with the input class.
  77473. * @returns the input friendly name
  77474. */
  77475. getSimpleName(): string;
  77476. }
  77477. }
  77478. declare module BABYLON {
  77479. /**
  77480. * Default Inputs manager for the FreeCamera.
  77481. * It groups all the default supported inputs for ease of use.
  77482. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  77483. */
  77484. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  77485. /**
  77486. * @hidden
  77487. */
  77488. _mouseInput: Nullable<FreeCameraMouseInput>;
  77489. /**
  77490. * Instantiates a new FreeCameraInputsManager.
  77491. * @param camera Defines the camera the inputs belong to
  77492. */
  77493. constructor(camera: FreeCamera);
  77494. /**
  77495. * Add keyboard input support to the input manager.
  77496. * @returns the current input manager
  77497. */
  77498. addKeyboard(): FreeCameraInputsManager;
  77499. /**
  77500. * Add mouse input support to the input manager.
  77501. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  77502. * @returns the current input manager
  77503. */
  77504. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  77505. /**
  77506. * Removes the mouse input support from the manager
  77507. * @returns the current input manager
  77508. */
  77509. removeMouse(): FreeCameraInputsManager;
  77510. /**
  77511. * Add touch input support to the input manager.
  77512. * @returns the current input manager
  77513. */
  77514. addTouch(): FreeCameraInputsManager;
  77515. /**
  77516. * Remove all attached input methods from a camera
  77517. */
  77518. clear(): void;
  77519. }
  77520. }
  77521. declare module BABYLON {
  77522. /**
  77523. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  77524. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  77525. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  77526. */
  77527. export class FreeCamera extends TargetCamera {
  77528. /**
  77529. * Define the collision ellipsoid of the camera.
  77530. * This is helpful to simulate a camera body like the player body around the camera
  77531. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  77532. */
  77533. ellipsoid: Vector3;
  77534. /**
  77535. * Define an offset for the position of the ellipsoid around the camera.
  77536. * This can be helpful to determine the center of the body near the gravity center of the body
  77537. * instead of its head.
  77538. */
  77539. ellipsoidOffset: Vector3;
  77540. /**
  77541. * Enable or disable collisions of the camera with the rest of the scene objects.
  77542. */
  77543. checkCollisions: boolean;
  77544. /**
  77545. * Enable or disable gravity on the camera.
  77546. */
  77547. applyGravity: boolean;
  77548. /**
  77549. * Define the input manager associated to the camera.
  77550. */
  77551. inputs: FreeCameraInputsManager;
  77552. /**
  77553. * Gets the input sensibility for a mouse input. (default is 2000.0)
  77554. * Higher values reduce sensitivity.
  77555. */
  77556. /**
  77557. * Sets the input sensibility for a mouse input. (default is 2000.0)
  77558. * Higher values reduce sensitivity.
  77559. */
  77560. angularSensibility: number;
  77561. /**
  77562. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  77563. */
  77564. keysUp: number[];
  77565. /**
  77566. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  77567. */
  77568. keysDown: number[];
  77569. /**
  77570. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  77571. */
  77572. keysLeft: number[];
  77573. /**
  77574. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  77575. */
  77576. keysRight: number[];
  77577. /**
  77578. * Event raised when the camera collide with a mesh in the scene.
  77579. */
  77580. onCollide: (collidedMesh: AbstractMesh) => void;
  77581. private _collider;
  77582. private _needMoveForGravity;
  77583. private _oldPosition;
  77584. private _diffPosition;
  77585. private _newPosition;
  77586. /** @hidden */
  77587. _localDirection: Vector3;
  77588. /** @hidden */
  77589. _transformedDirection: Vector3;
  77590. /**
  77591. * Instantiates a Free Camera.
  77592. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  77593. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  77594. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  77595. * @param name Define the name of the camera in the scene
  77596. * @param position Define the start position of the camera in the scene
  77597. * @param scene Define the scene the camera belongs to
  77598. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  77599. */
  77600. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  77601. /**
  77602. * Attached controls to the current camera.
  77603. * @param element Defines the element the controls should be listened from
  77604. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  77605. */
  77606. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  77607. /**
  77608. * Detach the current controls from the camera.
  77609. * The camera will stop reacting to inputs.
  77610. * @param element Defines the element to stop listening the inputs from
  77611. */
  77612. detachControl(element: HTMLElement): void;
  77613. private _collisionMask;
  77614. /**
  77615. * Define a collision mask to limit the list of object the camera can collide with
  77616. */
  77617. collisionMask: number;
  77618. /** @hidden */
  77619. _collideWithWorld(displacement: Vector3): void;
  77620. private _onCollisionPositionChange;
  77621. /** @hidden */
  77622. _checkInputs(): void;
  77623. /** @hidden */
  77624. _decideIfNeedsToMove(): boolean;
  77625. /** @hidden */
  77626. _updatePosition(): void;
  77627. /**
  77628. * Destroy the camera and release the current resources hold by it.
  77629. */
  77630. dispose(): void;
  77631. /**
  77632. * Gets the current object class name.
  77633. * @return the class name
  77634. */
  77635. getClassName(): string;
  77636. }
  77637. }
  77638. declare module BABYLON {
  77639. /**
  77640. * Represents a gamepad control stick position
  77641. */
  77642. export class StickValues {
  77643. /**
  77644. * The x component of the control stick
  77645. */
  77646. x: number;
  77647. /**
  77648. * The y component of the control stick
  77649. */
  77650. y: number;
  77651. /**
  77652. * Initializes the gamepad x and y control stick values
  77653. * @param x The x component of the gamepad control stick value
  77654. * @param y The y component of the gamepad control stick value
  77655. */
  77656. constructor(
  77657. /**
  77658. * The x component of the control stick
  77659. */
  77660. x: number,
  77661. /**
  77662. * The y component of the control stick
  77663. */
  77664. y: number);
  77665. }
  77666. /**
  77667. * An interface which manages callbacks for gamepad button changes
  77668. */
  77669. export interface GamepadButtonChanges {
  77670. /**
  77671. * Called when a gamepad has been changed
  77672. */
  77673. changed: boolean;
  77674. /**
  77675. * Called when a gamepad press event has been triggered
  77676. */
  77677. pressChanged: boolean;
  77678. /**
  77679. * Called when a touch event has been triggered
  77680. */
  77681. touchChanged: boolean;
  77682. /**
  77683. * Called when a value has changed
  77684. */
  77685. valueChanged: boolean;
  77686. }
  77687. /**
  77688. * Represents a gamepad
  77689. */
  77690. export class Gamepad {
  77691. /**
  77692. * The id of the gamepad
  77693. */
  77694. id: string;
  77695. /**
  77696. * The index of the gamepad
  77697. */
  77698. index: number;
  77699. /**
  77700. * The browser gamepad
  77701. */
  77702. browserGamepad: any;
  77703. /**
  77704. * Specifies what type of gamepad this represents
  77705. */
  77706. type: number;
  77707. private _leftStick;
  77708. private _rightStick;
  77709. /** @hidden */
  77710. _isConnected: boolean;
  77711. private _leftStickAxisX;
  77712. private _leftStickAxisY;
  77713. private _rightStickAxisX;
  77714. private _rightStickAxisY;
  77715. /**
  77716. * Triggered when the left control stick has been changed
  77717. */
  77718. private _onleftstickchanged;
  77719. /**
  77720. * Triggered when the right control stick has been changed
  77721. */
  77722. private _onrightstickchanged;
  77723. /**
  77724. * Represents a gamepad controller
  77725. */
  77726. static GAMEPAD: number;
  77727. /**
  77728. * Represents a generic controller
  77729. */
  77730. static GENERIC: number;
  77731. /**
  77732. * Represents an XBox controller
  77733. */
  77734. static XBOX: number;
  77735. /**
  77736. * Represents a pose-enabled controller
  77737. */
  77738. static POSE_ENABLED: number;
  77739. /**
  77740. * Represents an Dual Shock controller
  77741. */
  77742. static DUALSHOCK: number;
  77743. /**
  77744. * Specifies whether the left control stick should be Y-inverted
  77745. */
  77746. protected _invertLeftStickY: boolean;
  77747. /**
  77748. * Specifies if the gamepad has been connected
  77749. */
  77750. readonly isConnected: boolean;
  77751. /**
  77752. * Initializes the gamepad
  77753. * @param id The id of the gamepad
  77754. * @param index The index of the gamepad
  77755. * @param browserGamepad The browser gamepad
  77756. * @param leftStickX The x component of the left joystick
  77757. * @param leftStickY The y component of the left joystick
  77758. * @param rightStickX The x component of the right joystick
  77759. * @param rightStickY The y component of the right joystick
  77760. */
  77761. constructor(
  77762. /**
  77763. * The id of the gamepad
  77764. */
  77765. id: string,
  77766. /**
  77767. * The index of the gamepad
  77768. */
  77769. index: number,
  77770. /**
  77771. * The browser gamepad
  77772. */
  77773. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  77774. /**
  77775. * Callback triggered when the left joystick has changed
  77776. * @param callback
  77777. */
  77778. onleftstickchanged(callback: (values: StickValues) => void): void;
  77779. /**
  77780. * Callback triggered when the right joystick has changed
  77781. * @param callback
  77782. */
  77783. onrightstickchanged(callback: (values: StickValues) => void): void;
  77784. /**
  77785. * Gets the left joystick
  77786. */
  77787. /**
  77788. * Sets the left joystick values
  77789. */
  77790. leftStick: StickValues;
  77791. /**
  77792. * Gets the right joystick
  77793. */
  77794. /**
  77795. * Sets the right joystick value
  77796. */
  77797. rightStick: StickValues;
  77798. /**
  77799. * Updates the gamepad joystick positions
  77800. */
  77801. update(): void;
  77802. /**
  77803. * Disposes the gamepad
  77804. */
  77805. dispose(): void;
  77806. }
  77807. /**
  77808. * Represents a generic gamepad
  77809. */
  77810. export class GenericPad extends Gamepad {
  77811. private _buttons;
  77812. private _onbuttondown;
  77813. private _onbuttonup;
  77814. /**
  77815. * Observable triggered when a button has been pressed
  77816. */
  77817. onButtonDownObservable: Observable<number>;
  77818. /**
  77819. * Observable triggered when a button has been released
  77820. */
  77821. onButtonUpObservable: Observable<number>;
  77822. /**
  77823. * Callback triggered when a button has been pressed
  77824. * @param callback Called when a button has been pressed
  77825. */
  77826. onbuttondown(callback: (buttonPressed: number) => void): void;
  77827. /**
  77828. * Callback triggered when a button has been released
  77829. * @param callback Called when a button has been released
  77830. */
  77831. onbuttonup(callback: (buttonReleased: number) => void): void;
  77832. /**
  77833. * Initializes the generic gamepad
  77834. * @param id The id of the generic gamepad
  77835. * @param index The index of the generic gamepad
  77836. * @param browserGamepad The browser gamepad
  77837. */
  77838. constructor(id: string, index: number, browserGamepad: any);
  77839. private _setButtonValue;
  77840. /**
  77841. * Updates the generic gamepad
  77842. */
  77843. update(): void;
  77844. /**
  77845. * Disposes the generic gamepad
  77846. */
  77847. dispose(): void;
  77848. }
  77849. }
  77850. declare module BABYLON {
  77851. interface Engine {
  77852. /**
  77853. * Creates a raw texture
  77854. * @param data defines the data to store in the texture
  77855. * @param width defines the width of the texture
  77856. * @param height defines the height of the texture
  77857. * @param format defines the format of the data
  77858. * @param generateMipMaps defines if the engine should generate the mip levels
  77859. * @param invertY defines if data must be stored with Y axis inverted
  77860. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  77861. * @param compression defines the compression used (null by default)
  77862. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  77863. * @returns the raw texture inside an InternalTexture
  77864. */
  77865. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  77866. /**
  77867. * Update a raw texture
  77868. * @param texture defines the texture to update
  77869. * @param data defines the data to store in the texture
  77870. * @param format defines the format of the data
  77871. * @param invertY defines if data must be stored with Y axis inverted
  77872. */
  77873. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  77874. /**
  77875. * Update a raw texture
  77876. * @param texture defines the texture to update
  77877. * @param data defines the data to store in the texture
  77878. * @param format defines the format of the data
  77879. * @param invertY defines if data must be stored with Y axis inverted
  77880. * @param compression defines the compression used (null by default)
  77881. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  77882. */
  77883. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  77884. /**
  77885. * Creates a new raw cube texture
  77886. * @param data defines the array of data to use to create each face
  77887. * @param size defines the size of the textures
  77888. * @param format defines the format of the data
  77889. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  77890. * @param generateMipMaps defines if the engine should generate the mip levels
  77891. * @param invertY defines if data must be stored with Y axis inverted
  77892. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  77893. * @param compression defines the compression used (null by default)
  77894. * @returns the cube texture as an InternalTexture
  77895. */
  77896. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  77897. /**
  77898. * Update a raw cube texture
  77899. * @param texture defines the texture to udpdate
  77900. * @param data defines the data to store
  77901. * @param format defines the data format
  77902. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  77903. * @param invertY defines if data must be stored with Y axis inverted
  77904. */
  77905. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  77906. /**
  77907. * Update a raw cube texture
  77908. * @param texture defines the texture to udpdate
  77909. * @param data defines the data to store
  77910. * @param format defines the data format
  77911. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  77912. * @param invertY defines if data must be stored with Y axis inverted
  77913. * @param compression defines the compression used (null by default)
  77914. */
  77915. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  77916. /**
  77917. * Update a raw cube texture
  77918. * @param texture defines the texture to udpdate
  77919. * @param data defines the data to store
  77920. * @param format defines the data format
  77921. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  77922. * @param invertY defines if data must be stored with Y axis inverted
  77923. * @param compression defines the compression used (null by default)
  77924. * @param level defines which level of the texture to update
  77925. */
  77926. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  77927. /**
  77928. * Creates a new raw cube texture from a specified url
  77929. * @param url defines the url where the data is located
  77930. * @param scene defines the current scene
  77931. * @param size defines the size of the textures
  77932. * @param format defines the format of the data
  77933. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  77934. * @param noMipmap defines if the engine should avoid generating the mip levels
  77935. * @param callback defines a callback used to extract texture data from loaded data
  77936. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  77937. * @param onLoad defines a callback called when texture is loaded
  77938. * @param onError defines a callback called if there is an error
  77939. * @returns the cube texture as an InternalTexture
  77940. */
  77941. 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;
  77942. /**
  77943. * Creates a new raw cube texture from a specified url
  77944. * @param url defines the url where the data is located
  77945. * @param scene defines the current scene
  77946. * @param size defines the size of the textures
  77947. * @param format defines the format of the data
  77948. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  77949. * @param noMipmap defines if the engine should avoid generating the mip levels
  77950. * @param callback defines a callback used to extract texture data from loaded data
  77951. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  77952. * @param onLoad defines a callback called when texture is loaded
  77953. * @param onError defines a callback called if there is an error
  77954. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  77955. * @param invertY defines if data must be stored with Y axis inverted
  77956. * @returns the cube texture as an InternalTexture
  77957. */
  77958. 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;
  77959. /**
  77960. * Creates a new raw 3D texture
  77961. * @param data defines the data used to create the texture
  77962. * @param width defines the width of the texture
  77963. * @param height defines the height of the texture
  77964. * @param depth defines the depth of the texture
  77965. * @param format defines the format of the texture
  77966. * @param generateMipMaps defines if the engine must generate mip levels
  77967. * @param invertY defines if data must be stored with Y axis inverted
  77968. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  77969. * @param compression defines the compressed used (can be null)
  77970. * @param textureType defines the compressed used (can be null)
  77971. * @returns a new raw 3D texture (stored in an InternalTexture)
  77972. */
  77973. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  77974. /**
  77975. * Update a raw 3D texture
  77976. * @param texture defines the texture to update
  77977. * @param data defines the data to store
  77978. * @param format defines the data format
  77979. * @param invertY defines if data must be stored with Y axis inverted
  77980. */
  77981. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  77982. /**
  77983. * Update a raw 3D texture
  77984. * @param texture defines the texture to update
  77985. * @param data defines the data to store
  77986. * @param format defines the data format
  77987. * @param invertY defines if data must be stored with Y axis inverted
  77988. * @param compression defines the used compression (can be null)
  77989. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  77990. */
  77991. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  77992. }
  77993. }
  77994. declare module BABYLON {
  77995. /**
  77996. * Raw texture can help creating a texture directly from an array of data.
  77997. * This can be super useful if you either get the data from an uncompressed source or
  77998. * if you wish to create your texture pixel by pixel.
  77999. */
  78000. export class RawTexture extends Texture {
  78001. /**
  78002. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  78003. */
  78004. format: number;
  78005. private _engine;
  78006. /**
  78007. * Instantiates a new RawTexture.
  78008. * Raw texture can help creating a texture directly from an array of data.
  78009. * This can be super useful if you either get the data from an uncompressed source or
  78010. * if you wish to create your texture pixel by pixel.
  78011. * @param data define the array of data to use to create the texture
  78012. * @param width define the width of the texture
  78013. * @param height define the height of the texture
  78014. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  78015. * @param scene define the scene the texture belongs to
  78016. * @param generateMipMaps define whether mip maps should be generated or not
  78017. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78018. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78019. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  78020. */
  78021. constructor(data: ArrayBufferView, width: number, height: number,
  78022. /**
  78023. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  78024. */
  78025. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  78026. /**
  78027. * Updates the texture underlying data.
  78028. * @param data Define the new data of the texture
  78029. */
  78030. update(data: ArrayBufferView): void;
  78031. /**
  78032. * Creates a luminance texture from some data.
  78033. * @param data Define the texture data
  78034. * @param width Define the width of the texture
  78035. * @param height Define the height of the texture
  78036. * @param scene Define the scene the texture belongs to
  78037. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78038. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78039. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78040. * @returns the luminance texture
  78041. */
  78042. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  78043. /**
  78044. * Creates a luminance alpha texture from some data.
  78045. * @param data Define the texture data
  78046. * @param width Define the width of the texture
  78047. * @param height Define the height of the texture
  78048. * @param scene Define the scene the texture belongs to
  78049. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78050. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78051. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78052. * @returns the luminance alpha texture
  78053. */
  78054. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  78055. /**
  78056. * Creates an alpha texture from some data.
  78057. * @param data Define the texture data
  78058. * @param width Define the width of the texture
  78059. * @param height Define the height of the texture
  78060. * @param scene Define the scene the texture belongs to
  78061. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78062. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78063. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78064. * @returns the alpha texture
  78065. */
  78066. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  78067. /**
  78068. * Creates a RGB texture from some data.
  78069. * @param data Define the texture data
  78070. * @param width Define the width of the texture
  78071. * @param height Define the height of the texture
  78072. * @param scene Define the scene the texture belongs to
  78073. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78074. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78075. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78076. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  78077. * @returns the RGB alpha texture
  78078. */
  78079. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  78080. /**
  78081. * Creates a RGBA texture from some data.
  78082. * @param data Define the texture data
  78083. * @param width Define the width of the texture
  78084. * @param height Define the height of the texture
  78085. * @param scene Define the scene the texture belongs to
  78086. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78087. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78088. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78089. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  78090. * @returns the RGBA texture
  78091. */
  78092. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  78093. /**
  78094. * Creates a R texture from some data.
  78095. * @param data Define the texture data
  78096. * @param width Define the width of the texture
  78097. * @param height Define the height of the texture
  78098. * @param scene Define the scene the texture belongs to
  78099. * @param generateMipMaps Define whether or not to create mip maps for the texture
  78100. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  78101. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  78102. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  78103. * @returns the R texture
  78104. */
  78105. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  78106. }
  78107. }
  78108. declare module BABYLON {
  78109. /**
  78110. * Interface for the size containing width and height
  78111. */
  78112. export interface ISize {
  78113. /**
  78114. * Width
  78115. */
  78116. width: number;
  78117. /**
  78118. * Heighht
  78119. */
  78120. height: number;
  78121. }
  78122. /**
  78123. * Size containing widht and height
  78124. */
  78125. export class Size implements ISize {
  78126. /**
  78127. * Width
  78128. */
  78129. width: number;
  78130. /**
  78131. * Height
  78132. */
  78133. height: number;
  78134. /**
  78135. * Creates a Size object from the given width and height (floats).
  78136. * @param width width of the new size
  78137. * @param height height of the new size
  78138. */
  78139. constructor(width: number, height: number);
  78140. /**
  78141. * Returns a string with the Size width and height
  78142. * @returns a string with the Size width and height
  78143. */
  78144. toString(): string;
  78145. /**
  78146. * "Size"
  78147. * @returns the string "Size"
  78148. */
  78149. getClassName(): string;
  78150. /**
  78151. * Returns the Size hash code.
  78152. * @returns a hash code for a unique width and height
  78153. */
  78154. getHashCode(): number;
  78155. /**
  78156. * Updates the current size from the given one.
  78157. * @param src the given size
  78158. */
  78159. copyFrom(src: Size): void;
  78160. /**
  78161. * Updates in place the current Size from the given floats.
  78162. * @param width width of the new size
  78163. * @param height height of the new size
  78164. * @returns the updated Size.
  78165. */
  78166. copyFromFloats(width: number, height: number): Size;
  78167. /**
  78168. * Updates in place the current Size from the given floats.
  78169. * @param width width to set
  78170. * @param height height to set
  78171. * @returns the updated Size.
  78172. */
  78173. set(width: number, height: number): Size;
  78174. /**
  78175. * Multiplies the width and height by numbers
  78176. * @param w factor to multiple the width by
  78177. * @param h factor to multiple the height by
  78178. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  78179. */
  78180. multiplyByFloats(w: number, h: number): Size;
  78181. /**
  78182. * Clones the size
  78183. * @returns a new Size copied from the given one.
  78184. */
  78185. clone(): Size;
  78186. /**
  78187. * True if the current Size and the given one width and height are strictly equal.
  78188. * @param other the other size to compare against
  78189. * @returns True if the current Size and the given one width and height are strictly equal.
  78190. */
  78191. equals(other: Size): boolean;
  78192. /**
  78193. * The surface of the Size : width * height (float).
  78194. */
  78195. readonly surface: number;
  78196. /**
  78197. * Create a new size of zero
  78198. * @returns a new Size set to (0.0, 0.0)
  78199. */
  78200. static Zero(): Size;
  78201. /**
  78202. * Sums the width and height of two sizes
  78203. * @param otherSize size to add to this size
  78204. * @returns a new Size set as the addition result of the current Size and the given one.
  78205. */
  78206. add(otherSize: Size): Size;
  78207. /**
  78208. * Subtracts the width and height of two
  78209. * @param otherSize size to subtract to this size
  78210. * @returns a new Size set as the subtraction result of the given one from the current Size.
  78211. */
  78212. subtract(otherSize: Size): Size;
  78213. /**
  78214. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  78215. * @param start starting size to lerp between
  78216. * @param end end size to lerp between
  78217. * @param amount amount to lerp between the start and end values
  78218. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  78219. */
  78220. static Lerp(start: Size, end: Size, amount: number): Size;
  78221. }
  78222. }
  78223. declare module BABYLON {
  78224. /**
  78225. * Defines a runtime animation
  78226. */
  78227. export class RuntimeAnimation {
  78228. private _events;
  78229. /**
  78230. * The current frame of the runtime animation
  78231. */
  78232. private _currentFrame;
  78233. /**
  78234. * The animation used by the runtime animation
  78235. */
  78236. private _animation;
  78237. /**
  78238. * The target of the runtime animation
  78239. */
  78240. private _target;
  78241. /**
  78242. * The initiating animatable
  78243. */
  78244. private _host;
  78245. /**
  78246. * The original value of the runtime animation
  78247. */
  78248. private _originalValue;
  78249. /**
  78250. * The original blend value of the runtime animation
  78251. */
  78252. private _originalBlendValue;
  78253. /**
  78254. * The offsets cache of the runtime animation
  78255. */
  78256. private _offsetsCache;
  78257. /**
  78258. * The high limits cache of the runtime animation
  78259. */
  78260. private _highLimitsCache;
  78261. /**
  78262. * Specifies if the runtime animation has been stopped
  78263. */
  78264. private _stopped;
  78265. /**
  78266. * The blending factor of the runtime animation
  78267. */
  78268. private _blendingFactor;
  78269. /**
  78270. * The BabylonJS scene
  78271. */
  78272. private _scene;
  78273. /**
  78274. * The current value of the runtime animation
  78275. */
  78276. private _currentValue;
  78277. /** @hidden */
  78278. _animationState: _IAnimationState;
  78279. /**
  78280. * The active target of the runtime animation
  78281. */
  78282. private _activeTargets;
  78283. private _currentActiveTarget;
  78284. private _directTarget;
  78285. /**
  78286. * The target path of the runtime animation
  78287. */
  78288. private _targetPath;
  78289. /**
  78290. * The weight of the runtime animation
  78291. */
  78292. private _weight;
  78293. /**
  78294. * The ratio offset of the runtime animation
  78295. */
  78296. private _ratioOffset;
  78297. /**
  78298. * The previous delay of the runtime animation
  78299. */
  78300. private _previousDelay;
  78301. /**
  78302. * The previous ratio of the runtime animation
  78303. */
  78304. private _previousRatio;
  78305. private _enableBlending;
  78306. private _keys;
  78307. private _minFrame;
  78308. private _maxFrame;
  78309. private _minValue;
  78310. private _maxValue;
  78311. private _targetIsArray;
  78312. /**
  78313. * Gets the current frame of the runtime animation
  78314. */
  78315. readonly currentFrame: number;
  78316. /**
  78317. * Gets the weight of the runtime animation
  78318. */
  78319. readonly weight: number;
  78320. /**
  78321. * Gets the current value of the runtime animation
  78322. */
  78323. readonly currentValue: any;
  78324. /**
  78325. * Gets the target path of the runtime animation
  78326. */
  78327. readonly targetPath: string;
  78328. /**
  78329. * Gets the actual target of the runtime animation
  78330. */
  78331. readonly target: any;
  78332. /** @hidden */
  78333. _onLoop: () => void;
  78334. /**
  78335. * Create a new RuntimeAnimation object
  78336. * @param target defines the target of the animation
  78337. * @param animation defines the source animation object
  78338. * @param scene defines the hosting scene
  78339. * @param host defines the initiating Animatable
  78340. */
  78341. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  78342. private _preparePath;
  78343. /**
  78344. * Gets the animation from the runtime animation
  78345. */
  78346. readonly animation: Animation;
  78347. /**
  78348. * Resets the runtime animation to the beginning
  78349. * @param restoreOriginal defines whether to restore the target property to the original value
  78350. */
  78351. reset(restoreOriginal?: boolean): void;
  78352. /**
  78353. * Specifies if the runtime animation is stopped
  78354. * @returns Boolean specifying if the runtime animation is stopped
  78355. */
  78356. isStopped(): boolean;
  78357. /**
  78358. * Disposes of the runtime animation
  78359. */
  78360. dispose(): void;
  78361. /**
  78362. * Apply the interpolated value to the target
  78363. * @param currentValue defines the value computed by the animation
  78364. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  78365. */
  78366. setValue(currentValue: any, weight: number): void;
  78367. private _getOriginalValues;
  78368. private _setValue;
  78369. /**
  78370. * Gets the loop pmode of the runtime animation
  78371. * @returns Loop Mode
  78372. */
  78373. private _getCorrectLoopMode;
  78374. /**
  78375. * Move the current animation to a given frame
  78376. * @param frame defines the frame to move to
  78377. */
  78378. goToFrame(frame: number): void;
  78379. /**
  78380. * @hidden Internal use only
  78381. */
  78382. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  78383. /**
  78384. * Execute the current animation
  78385. * @param delay defines the delay to add to the current frame
  78386. * @param from defines the lower bound of the animation range
  78387. * @param to defines the upper bound of the animation range
  78388. * @param loop defines if the current animation must loop
  78389. * @param speedRatio defines the current speed ratio
  78390. * @param weight defines the weight of the animation (default is -1 so no weight)
  78391. * @param onLoop optional callback called when animation loops
  78392. * @returns a boolean indicating if the animation is running
  78393. */
  78394. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  78395. }
  78396. }
  78397. declare module BABYLON {
  78398. /**
  78399. * Class used to store an actual running animation
  78400. */
  78401. export class Animatable {
  78402. /** defines the target object */
  78403. target: any;
  78404. /** defines the starting frame number (default is 0) */
  78405. fromFrame: number;
  78406. /** defines the ending frame number (default is 100) */
  78407. toFrame: number;
  78408. /** defines if the animation must loop (default is false) */
  78409. loopAnimation: boolean;
  78410. /** defines a callback to call when animation ends if it is not looping */
  78411. onAnimationEnd?: (() => void) | null | undefined;
  78412. /** defines a callback to call when animation loops */
  78413. onAnimationLoop?: (() => void) | null | undefined;
  78414. private _localDelayOffset;
  78415. private _pausedDelay;
  78416. private _runtimeAnimations;
  78417. private _paused;
  78418. private _scene;
  78419. private _speedRatio;
  78420. private _weight;
  78421. private _syncRoot;
  78422. /**
  78423. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  78424. * This will only apply for non looping animation (default is true)
  78425. */
  78426. disposeOnEnd: boolean;
  78427. /**
  78428. * Gets a boolean indicating if the animation has started
  78429. */
  78430. animationStarted: boolean;
  78431. /**
  78432. * Observer raised when the animation ends
  78433. */
  78434. onAnimationEndObservable: Observable<Animatable>;
  78435. /**
  78436. * Observer raised when the animation loops
  78437. */
  78438. onAnimationLoopObservable: Observable<Animatable>;
  78439. /**
  78440. * Gets the root Animatable used to synchronize and normalize animations
  78441. */
  78442. readonly syncRoot: Nullable<Animatable>;
  78443. /**
  78444. * Gets the current frame of the first RuntimeAnimation
  78445. * Used to synchronize Animatables
  78446. */
  78447. readonly masterFrame: number;
  78448. /**
  78449. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  78450. */
  78451. weight: number;
  78452. /**
  78453. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  78454. */
  78455. speedRatio: number;
  78456. /**
  78457. * Creates a new Animatable
  78458. * @param scene defines the hosting scene
  78459. * @param target defines the target object
  78460. * @param fromFrame defines the starting frame number (default is 0)
  78461. * @param toFrame defines the ending frame number (default is 100)
  78462. * @param loopAnimation defines if the animation must loop (default is false)
  78463. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  78464. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  78465. * @param animations defines a group of animation to add to the new Animatable
  78466. * @param onAnimationLoop defines a callback to call when animation loops
  78467. */
  78468. constructor(scene: Scene,
  78469. /** defines the target object */
  78470. target: any,
  78471. /** defines the starting frame number (default is 0) */
  78472. fromFrame?: number,
  78473. /** defines the ending frame number (default is 100) */
  78474. toFrame?: number,
  78475. /** defines if the animation must loop (default is false) */
  78476. loopAnimation?: boolean, speedRatio?: number,
  78477. /** defines a callback to call when animation ends if it is not looping */
  78478. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  78479. /** defines a callback to call when animation loops */
  78480. onAnimationLoop?: (() => void) | null | undefined);
  78481. /**
  78482. * Synchronize and normalize current Animatable with a source Animatable
  78483. * This is useful when using animation weights and when animations are not of the same length
  78484. * @param root defines the root Animatable to synchronize with
  78485. * @returns the current Animatable
  78486. */
  78487. syncWith(root: Animatable): Animatable;
  78488. /**
  78489. * Gets the list of runtime animations
  78490. * @returns an array of RuntimeAnimation
  78491. */
  78492. getAnimations(): RuntimeAnimation[];
  78493. /**
  78494. * Adds more animations to the current animatable
  78495. * @param target defines the target of the animations
  78496. * @param animations defines the new animations to add
  78497. */
  78498. appendAnimations(target: any, animations: Animation[]): void;
  78499. /**
  78500. * Gets the source animation for a specific property
  78501. * @param property defines the propertyu to look for
  78502. * @returns null or the source animation for the given property
  78503. */
  78504. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  78505. /**
  78506. * Gets the runtime animation for a specific property
  78507. * @param property defines the propertyu to look for
  78508. * @returns null or the runtime animation for the given property
  78509. */
  78510. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  78511. /**
  78512. * Resets the animatable to its original state
  78513. */
  78514. reset(): void;
  78515. /**
  78516. * Allows the animatable to blend with current running animations
  78517. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  78518. * @param blendingSpeed defines the blending speed to use
  78519. */
  78520. enableBlending(blendingSpeed: number): void;
  78521. /**
  78522. * Disable animation blending
  78523. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  78524. */
  78525. disableBlending(): void;
  78526. /**
  78527. * Jump directly to a given frame
  78528. * @param frame defines the frame to jump to
  78529. */
  78530. goToFrame(frame: number): void;
  78531. /**
  78532. * Pause the animation
  78533. */
  78534. pause(): void;
  78535. /**
  78536. * Restart the animation
  78537. */
  78538. restart(): void;
  78539. private _raiseOnAnimationEnd;
  78540. /**
  78541. * Stop and delete the current animation
  78542. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  78543. * @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)
  78544. */
  78545. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  78546. /**
  78547. * Wait asynchronously for the animation to end
  78548. * @returns a promise which will be fullfilled when the animation ends
  78549. */
  78550. waitAsync(): Promise<Animatable>;
  78551. /** @hidden */
  78552. _animate(delay: number): boolean;
  78553. }
  78554. interface Scene {
  78555. /** @hidden */
  78556. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  78557. /** @hidden */
  78558. _processLateAnimationBindingsForMatrices(holder: {
  78559. totalWeight: number;
  78560. animations: RuntimeAnimation[];
  78561. originalValue: Matrix;
  78562. }): any;
  78563. /** @hidden */
  78564. _processLateAnimationBindingsForQuaternions(holder: {
  78565. totalWeight: number;
  78566. animations: RuntimeAnimation[];
  78567. originalValue: Quaternion;
  78568. }, refQuaternion: Quaternion): Quaternion;
  78569. /** @hidden */
  78570. _processLateAnimationBindings(): void;
  78571. /**
  78572. * Will start the animation sequence of a given target
  78573. * @param target defines the target
  78574. * @param from defines from which frame should animation start
  78575. * @param to defines until which frame should animation run.
  78576. * @param weight defines the weight to apply to the animation (1.0 by default)
  78577. * @param loop defines if the animation loops
  78578. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  78579. * @param onAnimationEnd defines the function to be executed when the animation ends
  78580. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  78581. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  78582. * @param onAnimationLoop defines the callback to call when an animation loops
  78583. * @returns the animatable object created for this animation
  78584. */
  78585. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  78586. /**
  78587. * Will start the animation sequence of a given target
  78588. * @param target defines the target
  78589. * @param from defines from which frame should animation start
  78590. * @param to defines until which frame should animation run.
  78591. * @param loop defines if the animation loops
  78592. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  78593. * @param onAnimationEnd defines the function to be executed when the animation ends
  78594. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  78595. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  78596. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  78597. * @param onAnimationLoop defines the callback to call when an animation loops
  78598. * @returns the animatable object created for this animation
  78599. */
  78600. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  78601. /**
  78602. * Will start the animation sequence of a given target and its hierarchy
  78603. * @param target defines the target
  78604. * @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.
  78605. * @param from defines from which frame should animation start
  78606. * @param to defines until which frame should animation run.
  78607. * @param loop defines if the animation loops
  78608. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  78609. * @param onAnimationEnd defines the function to be executed when the animation ends
  78610. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  78611. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  78612. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  78613. * @param onAnimationLoop defines the callback to call when an animation loops
  78614. * @returns the list of created animatables
  78615. */
  78616. 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[];
  78617. /**
  78618. * Begin a new animation on a given node
  78619. * @param target defines the target where the animation will take place
  78620. * @param animations defines the list of animations to start
  78621. * @param from defines the initial value
  78622. * @param to defines the final value
  78623. * @param loop defines if you want animation to loop (off by default)
  78624. * @param speedRatio defines the speed ratio to apply to all animations
  78625. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  78626. * @param onAnimationLoop defines the callback to call when an animation loops
  78627. * @returns the list of created animatables
  78628. */
  78629. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  78630. /**
  78631. * Begin a new animation on a given node and its hierarchy
  78632. * @param target defines the root node where the animation will take place
  78633. * @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.
  78634. * @param animations defines the list of animations to start
  78635. * @param from defines the initial value
  78636. * @param to defines the final value
  78637. * @param loop defines if you want animation to loop (off by default)
  78638. * @param speedRatio defines the speed ratio to apply to all animations
  78639. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  78640. * @param onAnimationLoop defines the callback to call when an animation loops
  78641. * @returns the list of animatables created for all nodes
  78642. */
  78643. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  78644. /**
  78645. * Gets the animatable associated with a specific target
  78646. * @param target defines the target of the animatable
  78647. * @returns the required animatable if found
  78648. */
  78649. getAnimatableByTarget(target: any): Nullable<Animatable>;
  78650. /**
  78651. * Gets all animatables associated with a given target
  78652. * @param target defines the target to look animatables for
  78653. * @returns an array of Animatables
  78654. */
  78655. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  78656. /**
  78657. * Stops and removes all animations that have been applied to the scene
  78658. */
  78659. stopAllAnimations(): void;
  78660. }
  78661. interface Bone {
  78662. /**
  78663. * Copy an animation range from another bone
  78664. * @param source defines the source bone
  78665. * @param rangeName defines the range name to copy
  78666. * @param frameOffset defines the frame offset
  78667. * @param rescaleAsRequired defines if rescaling must be applied if required
  78668. * @param skelDimensionsRatio defines the scaling ratio
  78669. * @returns true if operation was successful
  78670. */
  78671. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  78672. }
  78673. }
  78674. declare module BABYLON {
  78675. /**
  78676. * Class used to override all child animations of a given target
  78677. */
  78678. export class AnimationPropertiesOverride {
  78679. /**
  78680. * Gets or sets a value indicating if animation blending must be used
  78681. */
  78682. enableBlending: boolean;
  78683. /**
  78684. * Gets or sets the blending speed to use when enableBlending is true
  78685. */
  78686. blendingSpeed: number;
  78687. /**
  78688. * Gets or sets the default loop mode to use
  78689. */
  78690. loopMode: number;
  78691. }
  78692. }
  78693. declare module BABYLON {
  78694. /**
  78695. * Class used to handle skinning animations
  78696. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  78697. */
  78698. export class Skeleton implements IAnimatable {
  78699. /** defines the skeleton name */
  78700. name: string;
  78701. /** defines the skeleton Id */
  78702. id: string;
  78703. /**
  78704. * Defines the list of child bones
  78705. */
  78706. bones: Bone[];
  78707. /**
  78708. * Defines an estimate of the dimension of the skeleton at rest
  78709. */
  78710. dimensionsAtRest: Vector3;
  78711. /**
  78712. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  78713. */
  78714. needInitialSkinMatrix: boolean;
  78715. /**
  78716. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  78717. */
  78718. overrideMesh: Nullable<AbstractMesh>;
  78719. /**
  78720. * Gets the list of animations attached to this skeleton
  78721. */
  78722. animations: Array<Animation>;
  78723. private _scene;
  78724. private _isDirty;
  78725. private _transformMatrices;
  78726. private _transformMatrixTexture;
  78727. private _meshesWithPoseMatrix;
  78728. private _animatables;
  78729. private _identity;
  78730. private _synchronizedWithMesh;
  78731. private _ranges;
  78732. private _lastAbsoluteTransformsUpdateId;
  78733. private _canUseTextureForBones;
  78734. private _uniqueId;
  78735. /** @hidden */
  78736. _numBonesWithLinkedTransformNode: number;
  78737. /** @hidden */
  78738. _hasWaitingData: Nullable<boolean>;
  78739. /**
  78740. * Specifies if the skeleton should be serialized
  78741. */
  78742. doNotSerialize: boolean;
  78743. private _useTextureToStoreBoneMatrices;
  78744. /**
  78745. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  78746. * Please note that this option is not available if the hardware does not support it
  78747. */
  78748. useTextureToStoreBoneMatrices: boolean;
  78749. private _animationPropertiesOverride;
  78750. /**
  78751. * Gets or sets the animation properties override
  78752. */
  78753. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  78754. /**
  78755. * List of inspectable custom properties (used by the Inspector)
  78756. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  78757. */
  78758. inspectableCustomProperties: IInspectable[];
  78759. /**
  78760. * An observable triggered before computing the skeleton's matrices
  78761. */
  78762. onBeforeComputeObservable: Observable<Skeleton>;
  78763. /**
  78764. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  78765. */
  78766. readonly isUsingTextureForMatrices: boolean;
  78767. /**
  78768. * Gets the unique ID of this skeleton
  78769. */
  78770. readonly uniqueId: number;
  78771. /**
  78772. * Creates a new skeleton
  78773. * @param name defines the skeleton name
  78774. * @param id defines the skeleton Id
  78775. * @param scene defines the hosting scene
  78776. */
  78777. constructor(
  78778. /** defines the skeleton name */
  78779. name: string,
  78780. /** defines the skeleton Id */
  78781. id: string, scene: Scene);
  78782. /**
  78783. * Gets the current object class name.
  78784. * @return the class name
  78785. */
  78786. getClassName(): string;
  78787. /**
  78788. * Returns an array containing the root bones
  78789. * @returns an array containing the root bones
  78790. */
  78791. getChildren(): Array<Bone>;
  78792. /**
  78793. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  78794. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  78795. * @returns a Float32Array containing matrices data
  78796. */
  78797. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  78798. /**
  78799. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  78800. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  78801. * @returns a raw texture containing the data
  78802. */
  78803. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  78804. /**
  78805. * Gets the current hosting scene
  78806. * @returns a scene object
  78807. */
  78808. getScene(): Scene;
  78809. /**
  78810. * Gets a string representing the current skeleton data
  78811. * @param fullDetails defines a boolean indicating if we want a verbose version
  78812. * @returns a string representing the current skeleton data
  78813. */
  78814. toString(fullDetails?: boolean): string;
  78815. /**
  78816. * Get bone's index searching by name
  78817. * @param name defines bone's name to search for
  78818. * @return the indice of the bone. Returns -1 if not found
  78819. */
  78820. getBoneIndexByName(name: string): number;
  78821. /**
  78822. * Creater a new animation range
  78823. * @param name defines the name of the range
  78824. * @param from defines the start key
  78825. * @param to defines the end key
  78826. */
  78827. createAnimationRange(name: string, from: number, to: number): void;
  78828. /**
  78829. * Delete a specific animation range
  78830. * @param name defines the name of the range
  78831. * @param deleteFrames defines if frames must be removed as well
  78832. */
  78833. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  78834. /**
  78835. * Gets a specific animation range
  78836. * @param name defines the name of the range to look for
  78837. * @returns the requested animation range or null if not found
  78838. */
  78839. getAnimationRange(name: string): Nullable<AnimationRange>;
  78840. /**
  78841. * Gets the list of all animation ranges defined on this skeleton
  78842. * @returns an array
  78843. */
  78844. getAnimationRanges(): Nullable<AnimationRange>[];
  78845. /**
  78846. * Copy animation range from a source skeleton.
  78847. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  78848. * @param source defines the source skeleton
  78849. * @param name defines the name of the range to copy
  78850. * @param rescaleAsRequired defines if rescaling must be applied if required
  78851. * @returns true if operation was successful
  78852. */
  78853. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  78854. /**
  78855. * Forces the skeleton to go to rest pose
  78856. */
  78857. returnToRest(): void;
  78858. private _getHighestAnimationFrame;
  78859. /**
  78860. * Begin a specific animation range
  78861. * @param name defines the name of the range to start
  78862. * @param loop defines if looping must be turned on (false by default)
  78863. * @param speedRatio defines the speed ratio to apply (1 by default)
  78864. * @param onAnimationEnd defines a callback which will be called when animation will end
  78865. * @returns a new animatable
  78866. */
  78867. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  78868. /** @hidden */
  78869. _markAsDirty(): void;
  78870. /** @hidden */
  78871. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  78872. /** @hidden */
  78873. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  78874. private _computeTransformMatrices;
  78875. /**
  78876. * Build all resources required to render a skeleton
  78877. */
  78878. prepare(): void;
  78879. /**
  78880. * Gets the list of animatables currently running for this skeleton
  78881. * @returns an array of animatables
  78882. */
  78883. getAnimatables(): IAnimatable[];
  78884. /**
  78885. * Clone the current skeleton
  78886. * @param name defines the name of the new skeleton
  78887. * @param id defines the id of the new skeleton
  78888. * @returns the new skeleton
  78889. */
  78890. clone(name: string, id: string): Skeleton;
  78891. /**
  78892. * Enable animation blending for this skeleton
  78893. * @param blendingSpeed defines the blending speed to apply
  78894. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  78895. */
  78896. enableBlending(blendingSpeed?: number): void;
  78897. /**
  78898. * Releases all resources associated with the current skeleton
  78899. */
  78900. dispose(): void;
  78901. /**
  78902. * Serialize the skeleton in a JSON object
  78903. * @returns a JSON object
  78904. */
  78905. serialize(): any;
  78906. /**
  78907. * Creates a new skeleton from serialized data
  78908. * @param parsedSkeleton defines the serialized data
  78909. * @param scene defines the hosting scene
  78910. * @returns a new skeleton
  78911. */
  78912. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  78913. /**
  78914. * Compute all node absolute transforms
  78915. * @param forceUpdate defines if computation must be done even if cache is up to date
  78916. */
  78917. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  78918. /**
  78919. * Gets the root pose matrix
  78920. * @returns a matrix
  78921. */
  78922. getPoseMatrix(): Nullable<Matrix>;
  78923. /**
  78924. * Sorts bones per internal index
  78925. */
  78926. sortBones(): void;
  78927. private _sortBones;
  78928. }
  78929. }
  78930. declare module BABYLON {
  78931. /**
  78932. * Class used to store bone information
  78933. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  78934. */
  78935. export class Bone extends Node {
  78936. /**
  78937. * defines the bone name
  78938. */
  78939. name: string;
  78940. private static _tmpVecs;
  78941. private static _tmpQuat;
  78942. private static _tmpMats;
  78943. /**
  78944. * Gets the list of child bones
  78945. */
  78946. children: Bone[];
  78947. /** Gets the animations associated with this bone */
  78948. animations: Animation[];
  78949. /**
  78950. * Gets or sets bone length
  78951. */
  78952. length: number;
  78953. /**
  78954. * @hidden Internal only
  78955. * Set this value to map this bone to a different index in the transform matrices
  78956. * Set this value to -1 to exclude the bone from the transform matrices
  78957. */
  78958. _index: Nullable<number>;
  78959. private _skeleton;
  78960. private _localMatrix;
  78961. private _restPose;
  78962. private _baseMatrix;
  78963. private _absoluteTransform;
  78964. private _invertedAbsoluteTransform;
  78965. private _parent;
  78966. private _scalingDeterminant;
  78967. private _worldTransform;
  78968. private _localScaling;
  78969. private _localRotation;
  78970. private _localPosition;
  78971. private _needToDecompose;
  78972. private _needToCompose;
  78973. /** @hidden */
  78974. _linkedTransformNode: Nullable<TransformNode>;
  78975. /** @hidden */
  78976. _waitingTransformNodeId: Nullable<string>;
  78977. /** @hidden */
  78978. /** @hidden */
  78979. _matrix: Matrix;
  78980. /**
  78981. * Create a new bone
  78982. * @param name defines the bone name
  78983. * @param skeleton defines the parent skeleton
  78984. * @param parentBone defines the parent (can be null if the bone is the root)
  78985. * @param localMatrix defines the local matrix
  78986. * @param restPose defines the rest pose matrix
  78987. * @param baseMatrix defines the base matrix
  78988. * @param index defines index of the bone in the hiearchy
  78989. */
  78990. constructor(
  78991. /**
  78992. * defines the bone name
  78993. */
  78994. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  78995. /**
  78996. * Gets the current object class name.
  78997. * @return the class name
  78998. */
  78999. getClassName(): string;
  79000. /**
  79001. * Gets the parent skeleton
  79002. * @returns a skeleton
  79003. */
  79004. getSkeleton(): Skeleton;
  79005. /**
  79006. * Gets parent bone
  79007. * @returns a bone or null if the bone is the root of the bone hierarchy
  79008. */
  79009. getParent(): Nullable<Bone>;
  79010. /**
  79011. * Returns an array containing the root bones
  79012. * @returns an array containing the root bones
  79013. */
  79014. getChildren(): Array<Bone>;
  79015. /**
  79016. * Sets the parent bone
  79017. * @param parent defines the parent (can be null if the bone is the root)
  79018. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  79019. */
  79020. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  79021. /**
  79022. * Gets the local matrix
  79023. * @returns a matrix
  79024. */
  79025. getLocalMatrix(): Matrix;
  79026. /**
  79027. * Gets the base matrix (initial matrix which remains unchanged)
  79028. * @returns a matrix
  79029. */
  79030. getBaseMatrix(): Matrix;
  79031. /**
  79032. * Gets the rest pose matrix
  79033. * @returns a matrix
  79034. */
  79035. getRestPose(): Matrix;
  79036. /**
  79037. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  79038. */
  79039. getWorldMatrix(): Matrix;
  79040. /**
  79041. * Sets the local matrix to rest pose matrix
  79042. */
  79043. returnToRest(): void;
  79044. /**
  79045. * Gets the inverse of the absolute transform matrix.
  79046. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  79047. * @returns a matrix
  79048. */
  79049. getInvertedAbsoluteTransform(): Matrix;
  79050. /**
  79051. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  79052. * @returns a matrix
  79053. */
  79054. getAbsoluteTransform(): Matrix;
  79055. /**
  79056. * Links with the given transform node.
  79057. * The local matrix of this bone is copied from the transform node every frame.
  79058. * @param transformNode defines the transform node to link to
  79059. */
  79060. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  79061. /**
  79062. * Gets the node used to drive the bone's transformation
  79063. * @returns a transform node or null
  79064. */
  79065. getTransformNode(): Nullable<TransformNode>;
  79066. /** Gets or sets current position (in local space) */
  79067. position: Vector3;
  79068. /** Gets or sets current rotation (in local space) */
  79069. rotation: Vector3;
  79070. /** Gets or sets current rotation quaternion (in local space) */
  79071. rotationQuaternion: Quaternion;
  79072. /** Gets or sets current scaling (in local space) */
  79073. scaling: Vector3;
  79074. /**
  79075. * Gets the animation properties override
  79076. */
  79077. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  79078. private _decompose;
  79079. private _compose;
  79080. /**
  79081. * Update the base and local matrices
  79082. * @param matrix defines the new base or local matrix
  79083. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  79084. * @param updateLocalMatrix defines if the local matrix should be updated
  79085. */
  79086. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  79087. /** @hidden */
  79088. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  79089. /**
  79090. * Flag the bone as dirty (Forcing it to update everything)
  79091. */
  79092. markAsDirty(): void;
  79093. /** @hidden */
  79094. _markAsDirtyAndCompose(): void;
  79095. private _markAsDirtyAndDecompose;
  79096. /**
  79097. * Translate the bone in local or world space
  79098. * @param vec The amount to translate the bone
  79099. * @param space The space that the translation is in
  79100. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79101. */
  79102. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  79103. /**
  79104. * Set the postion of the bone in local or world space
  79105. * @param position The position to set the bone
  79106. * @param space The space that the position is in
  79107. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79108. */
  79109. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  79110. /**
  79111. * Set the absolute position of the bone (world space)
  79112. * @param position The position to set the bone
  79113. * @param mesh The mesh that this bone is attached to
  79114. */
  79115. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  79116. /**
  79117. * Scale the bone on the x, y and z axes (in local space)
  79118. * @param x The amount to scale the bone on the x axis
  79119. * @param y The amount to scale the bone on the y axis
  79120. * @param z The amount to scale the bone on the z axis
  79121. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  79122. */
  79123. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  79124. /**
  79125. * Set the bone scaling in local space
  79126. * @param scale defines the scaling vector
  79127. */
  79128. setScale(scale: Vector3): void;
  79129. /**
  79130. * Gets the current scaling in local space
  79131. * @returns the current scaling vector
  79132. */
  79133. getScale(): Vector3;
  79134. /**
  79135. * Gets the current scaling in local space and stores it in a target vector
  79136. * @param result defines the target vector
  79137. */
  79138. getScaleToRef(result: Vector3): void;
  79139. /**
  79140. * Set the yaw, pitch, and roll of the bone in local or world space
  79141. * @param yaw The rotation of the bone on the y axis
  79142. * @param pitch The rotation of the bone on the x axis
  79143. * @param roll The rotation of the bone on the z axis
  79144. * @param space The space that the axes of rotation are in
  79145. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79146. */
  79147. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  79148. /**
  79149. * Add a rotation to the bone on an axis in local or world space
  79150. * @param axis The axis to rotate the bone on
  79151. * @param amount The amount to rotate the bone
  79152. * @param space The space that the axis is in
  79153. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79154. */
  79155. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  79156. /**
  79157. * Set the rotation of the bone to a particular axis angle in local or world space
  79158. * @param axis The axis to rotate the bone on
  79159. * @param angle The angle that the bone should be rotated to
  79160. * @param space The space that the axis is in
  79161. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79162. */
  79163. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  79164. /**
  79165. * Set the euler rotation of the bone in local of world space
  79166. * @param rotation The euler rotation that the bone should be set to
  79167. * @param space The space that the rotation is in
  79168. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79169. */
  79170. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  79171. /**
  79172. * Set the quaternion rotation of the bone in local of world space
  79173. * @param quat The quaternion rotation that the bone should be set to
  79174. * @param space The space that the rotation is in
  79175. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79176. */
  79177. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  79178. /**
  79179. * Set the rotation matrix of the bone in local of world space
  79180. * @param rotMat The rotation matrix that the bone should be set to
  79181. * @param space The space that the rotation is in
  79182. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79183. */
  79184. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  79185. private _rotateWithMatrix;
  79186. private _getNegativeRotationToRef;
  79187. /**
  79188. * Get the position of the bone in local or world space
  79189. * @param space The space that the returned position is in
  79190. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79191. * @returns The position of the bone
  79192. */
  79193. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  79194. /**
  79195. * Copy the position of the bone to a vector3 in local or world space
  79196. * @param space The space that the returned position is in
  79197. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79198. * @param result The vector3 to copy the position to
  79199. */
  79200. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  79201. /**
  79202. * Get the absolute position of the bone (world space)
  79203. * @param mesh The mesh that this bone is attached to
  79204. * @returns The absolute position of the bone
  79205. */
  79206. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  79207. /**
  79208. * Copy the absolute position of the bone (world space) to the result param
  79209. * @param mesh The mesh that this bone is attached to
  79210. * @param result The vector3 to copy the absolute position to
  79211. */
  79212. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  79213. /**
  79214. * Compute the absolute transforms of this bone and its children
  79215. */
  79216. computeAbsoluteTransforms(): void;
  79217. /**
  79218. * Get the world direction from an axis that is in the local space of the bone
  79219. * @param localAxis The local direction that is used to compute the world direction
  79220. * @param mesh The mesh that this bone is attached to
  79221. * @returns The world direction
  79222. */
  79223. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  79224. /**
  79225. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  79226. * @param localAxis The local direction that is used to compute the world direction
  79227. * @param mesh The mesh that this bone is attached to
  79228. * @param result The vector3 that the world direction will be copied to
  79229. */
  79230. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  79231. /**
  79232. * Get the euler rotation of the bone in local or world space
  79233. * @param space The space that the rotation should be in
  79234. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79235. * @returns The euler rotation
  79236. */
  79237. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  79238. /**
  79239. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  79240. * @param space The space that the rotation should be in
  79241. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79242. * @param result The vector3 that the rotation should be copied to
  79243. */
  79244. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  79245. /**
  79246. * Get the quaternion rotation of the bone in either local or world space
  79247. * @param space The space that the rotation should be in
  79248. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79249. * @returns The quaternion rotation
  79250. */
  79251. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  79252. /**
  79253. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  79254. * @param space The space that the rotation should be in
  79255. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79256. * @param result The quaternion that the rotation should be copied to
  79257. */
  79258. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  79259. /**
  79260. * Get the rotation matrix of the bone in local or world space
  79261. * @param space The space that the rotation should be in
  79262. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79263. * @returns The rotation matrix
  79264. */
  79265. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  79266. /**
  79267. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  79268. * @param space The space that the rotation should be in
  79269. * @param mesh The mesh that this bone is attached to. This is only used in world space
  79270. * @param result The quaternion that the rotation should be copied to
  79271. */
  79272. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  79273. /**
  79274. * Get the world position of a point that is in the local space of the bone
  79275. * @param position The local position
  79276. * @param mesh The mesh that this bone is attached to
  79277. * @returns The world position
  79278. */
  79279. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  79280. /**
  79281. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  79282. * @param position The local position
  79283. * @param mesh The mesh that this bone is attached to
  79284. * @param result The vector3 that the world position should be copied to
  79285. */
  79286. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  79287. /**
  79288. * Get the local position of a point that is in world space
  79289. * @param position The world position
  79290. * @param mesh The mesh that this bone is attached to
  79291. * @returns The local position
  79292. */
  79293. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  79294. /**
  79295. * Get the local position of a point that is in world space and copy it to the result param
  79296. * @param position The world position
  79297. * @param mesh The mesh that this bone is attached to
  79298. * @param result The vector3 that the local position should be copied to
  79299. */
  79300. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  79301. }
  79302. }
  79303. declare module BABYLON {
  79304. /**
  79305. * 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.
  79306. * @see https://doc.babylonjs.com/how_to/transformnode
  79307. */
  79308. export class TransformNode extends Node {
  79309. /**
  79310. * Object will not rotate to face the camera
  79311. */
  79312. static BILLBOARDMODE_NONE: number;
  79313. /**
  79314. * Object will rotate to face the camera but only on the x axis
  79315. */
  79316. static BILLBOARDMODE_X: number;
  79317. /**
  79318. * Object will rotate to face the camera but only on the y axis
  79319. */
  79320. static BILLBOARDMODE_Y: number;
  79321. /**
  79322. * Object will rotate to face the camera but only on the z axis
  79323. */
  79324. static BILLBOARDMODE_Z: number;
  79325. /**
  79326. * Object will rotate to face the camera
  79327. */
  79328. static BILLBOARDMODE_ALL: number;
  79329. /**
  79330. * Object will rotate to face the camera's position instead of orientation
  79331. */
  79332. static BILLBOARDMODE_USE_POSITION: number;
  79333. private _forward;
  79334. private _forwardInverted;
  79335. private _up;
  79336. private _right;
  79337. private _rightInverted;
  79338. private _position;
  79339. private _rotation;
  79340. private _rotationQuaternion;
  79341. protected _scaling: Vector3;
  79342. protected _isDirty: boolean;
  79343. private _transformToBoneReferal;
  79344. private _isAbsoluteSynced;
  79345. private _billboardMode;
  79346. /**
  79347. * Gets or sets the billboard mode. Default is 0.
  79348. *
  79349. * | Value | Type | Description |
  79350. * | --- | --- | --- |
  79351. * | 0 | BILLBOARDMODE_NONE | |
  79352. * | 1 | BILLBOARDMODE_X | |
  79353. * | 2 | BILLBOARDMODE_Y | |
  79354. * | 4 | BILLBOARDMODE_Z | |
  79355. * | 7 | BILLBOARDMODE_ALL | |
  79356. *
  79357. */
  79358. billboardMode: number;
  79359. private _preserveParentRotationForBillboard;
  79360. /**
  79361. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  79362. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  79363. */
  79364. preserveParentRotationForBillboard: boolean;
  79365. /**
  79366. * 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
  79367. */
  79368. scalingDeterminant: number;
  79369. private _infiniteDistance;
  79370. /**
  79371. * Gets or sets the distance of the object to max, often used by skybox
  79372. */
  79373. infiniteDistance: boolean;
  79374. /**
  79375. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  79376. * By default the system will update normals to compensate
  79377. */
  79378. ignoreNonUniformScaling: boolean;
  79379. /**
  79380. * 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
  79381. */
  79382. reIntegrateRotationIntoRotationQuaternion: boolean;
  79383. /** @hidden */
  79384. _poseMatrix: Nullable<Matrix>;
  79385. /** @hidden */
  79386. _localMatrix: Matrix;
  79387. private _usePivotMatrix;
  79388. private _absolutePosition;
  79389. private _absoluteScaling;
  79390. private _absoluteRotationQuaternion;
  79391. private _pivotMatrix;
  79392. private _pivotMatrixInverse;
  79393. protected _postMultiplyPivotMatrix: boolean;
  79394. protected _isWorldMatrixFrozen: boolean;
  79395. /** @hidden */
  79396. _indexInSceneTransformNodesArray: number;
  79397. /**
  79398. * An event triggered after the world matrix is updated
  79399. */
  79400. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  79401. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  79402. /**
  79403. * Gets a string identifying the name of the class
  79404. * @returns "TransformNode" string
  79405. */
  79406. getClassName(): string;
  79407. /**
  79408. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  79409. */
  79410. position: Vector3;
  79411. /**
  79412. * 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)).
  79413. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  79414. */
  79415. rotation: Vector3;
  79416. /**
  79417. * 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)).
  79418. */
  79419. scaling: Vector3;
  79420. /**
  79421. * 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).
  79422. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  79423. */
  79424. rotationQuaternion: Nullable<Quaternion>;
  79425. /**
  79426. * The forward direction of that transform in world space.
  79427. */
  79428. readonly forward: Vector3;
  79429. /**
  79430. * The up direction of that transform in world space.
  79431. */
  79432. readonly up: Vector3;
  79433. /**
  79434. * The right direction of that transform in world space.
  79435. */
  79436. readonly right: Vector3;
  79437. /**
  79438. * Copies the parameter passed Matrix into the mesh Pose matrix.
  79439. * @param matrix the matrix to copy the pose from
  79440. * @returns this TransformNode.
  79441. */
  79442. updatePoseMatrix(matrix: Matrix): TransformNode;
  79443. /**
  79444. * Returns the mesh Pose matrix.
  79445. * @returns the pose matrix
  79446. */
  79447. getPoseMatrix(): Matrix;
  79448. /** @hidden */
  79449. _isSynchronized(): boolean;
  79450. /** @hidden */
  79451. _initCache(): void;
  79452. /**
  79453. * Flag the transform node as dirty (Forcing it to update everything)
  79454. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  79455. * @returns this transform node
  79456. */
  79457. markAsDirty(property: string): TransformNode;
  79458. /**
  79459. * Returns the current mesh absolute position.
  79460. * Returns a Vector3.
  79461. */
  79462. readonly absolutePosition: Vector3;
  79463. /**
  79464. * Returns the current mesh absolute scaling.
  79465. * Returns a Vector3.
  79466. */
  79467. readonly absoluteScaling: Vector3;
  79468. /**
  79469. * Returns the current mesh absolute rotation.
  79470. * Returns a Quaternion.
  79471. */
  79472. readonly absoluteRotationQuaternion: Quaternion;
  79473. /**
  79474. * Sets a new matrix to apply before all other transformation
  79475. * @param matrix defines the transform matrix
  79476. * @returns the current TransformNode
  79477. */
  79478. setPreTransformMatrix(matrix: Matrix): TransformNode;
  79479. /**
  79480. * Sets a new pivot matrix to the current node
  79481. * @param matrix defines the new pivot matrix to use
  79482. * @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
  79483. * @returns the current TransformNode
  79484. */
  79485. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  79486. /**
  79487. * Returns the mesh pivot matrix.
  79488. * Default : Identity.
  79489. * @returns the matrix
  79490. */
  79491. getPivotMatrix(): Matrix;
  79492. /**
  79493. * Instantiate (when possible) or clone that node with its hierarchy
  79494. * @param newParent defines the new parent to use for the instance (or clone)
  79495. * @returns an instance (or a clone) of the current node with its hiearchy
  79496. */
  79497. instantiateHierarychy(newParent?: Nullable<TransformNode>): Nullable<TransformNode>;
  79498. /**
  79499. * Prevents the World matrix to be computed any longer
  79500. * @param newWorldMatrix defines an optional matrix to use as world matrix
  79501. * @returns the TransformNode.
  79502. */
  79503. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  79504. /**
  79505. * Allows back the World matrix computation.
  79506. * @returns the TransformNode.
  79507. */
  79508. unfreezeWorldMatrix(): this;
  79509. /**
  79510. * True if the World matrix has been frozen.
  79511. */
  79512. readonly isWorldMatrixFrozen: boolean;
  79513. /**
  79514. * Retuns the mesh absolute position in the World.
  79515. * @returns a Vector3.
  79516. */
  79517. getAbsolutePosition(): Vector3;
  79518. /**
  79519. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  79520. * @param absolutePosition the absolute position to set
  79521. * @returns the TransformNode.
  79522. */
  79523. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  79524. /**
  79525. * Sets the mesh position in its local space.
  79526. * @param vector3 the position to set in localspace
  79527. * @returns the TransformNode.
  79528. */
  79529. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  79530. /**
  79531. * Returns the mesh position in the local space from the current World matrix values.
  79532. * @returns a new Vector3.
  79533. */
  79534. getPositionExpressedInLocalSpace(): Vector3;
  79535. /**
  79536. * Translates the mesh along the passed Vector3 in its local space.
  79537. * @param vector3 the distance to translate in localspace
  79538. * @returns the TransformNode.
  79539. */
  79540. locallyTranslate(vector3: Vector3): TransformNode;
  79541. private static _lookAtVectorCache;
  79542. /**
  79543. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  79544. * @param targetPoint the position (must be in same space as current mesh) to look at
  79545. * @param yawCor optional yaw (y-axis) correction in radians
  79546. * @param pitchCor optional pitch (x-axis) correction in radians
  79547. * @param rollCor optional roll (z-axis) correction in radians
  79548. * @param space the choosen space of the target
  79549. * @returns the TransformNode.
  79550. */
  79551. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  79552. /**
  79553. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  79554. * This Vector3 is expressed in the World space.
  79555. * @param localAxis axis to rotate
  79556. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  79557. */
  79558. getDirection(localAxis: Vector3): Vector3;
  79559. /**
  79560. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  79561. * localAxis is expressed in the mesh local space.
  79562. * result is computed in the Wordl space from the mesh World matrix.
  79563. * @param localAxis axis to rotate
  79564. * @param result the resulting transformnode
  79565. * @returns this TransformNode.
  79566. */
  79567. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  79568. /**
  79569. * Sets this transform node rotation to the given local axis.
  79570. * @param localAxis the axis in local space
  79571. * @param yawCor optional yaw (y-axis) correction in radians
  79572. * @param pitchCor optional pitch (x-axis) correction in radians
  79573. * @param rollCor optional roll (z-axis) correction in radians
  79574. * @returns this TransformNode
  79575. */
  79576. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  79577. /**
  79578. * Sets a new pivot point to the current node
  79579. * @param point defines the new pivot point to use
  79580. * @param space defines if the point is in world or local space (local by default)
  79581. * @returns the current TransformNode
  79582. */
  79583. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  79584. /**
  79585. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  79586. * @returns the pivot point
  79587. */
  79588. getPivotPoint(): Vector3;
  79589. /**
  79590. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  79591. * @param result the vector3 to store the result
  79592. * @returns this TransformNode.
  79593. */
  79594. getPivotPointToRef(result: Vector3): TransformNode;
  79595. /**
  79596. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  79597. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  79598. */
  79599. getAbsolutePivotPoint(): Vector3;
  79600. /**
  79601. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  79602. * @param result vector3 to store the result
  79603. * @returns this TransformNode.
  79604. */
  79605. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  79606. /**
  79607. * Defines the passed node as the parent of the current node.
  79608. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  79609. * @see https://doc.babylonjs.com/how_to/parenting
  79610. * @param node the node ot set as the parent
  79611. * @returns this TransformNode.
  79612. */
  79613. setParent(node: Nullable<Node>): TransformNode;
  79614. private _nonUniformScaling;
  79615. /**
  79616. * True if the scaling property of this object is non uniform eg. (1,2,1)
  79617. */
  79618. readonly nonUniformScaling: boolean;
  79619. /** @hidden */
  79620. _updateNonUniformScalingState(value: boolean): boolean;
  79621. /**
  79622. * Attach the current TransformNode to another TransformNode associated with a bone
  79623. * @param bone Bone affecting the TransformNode
  79624. * @param affectedTransformNode TransformNode associated with the bone
  79625. * @returns this object
  79626. */
  79627. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  79628. /**
  79629. * Detach the transform node if its associated with a bone
  79630. * @returns this object
  79631. */
  79632. detachFromBone(): TransformNode;
  79633. private static _rotationAxisCache;
  79634. /**
  79635. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  79636. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  79637. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  79638. * The passed axis is also normalized.
  79639. * @param axis the axis to rotate around
  79640. * @param amount the amount to rotate in radians
  79641. * @param space Space to rotate in (Default: local)
  79642. * @returns the TransformNode.
  79643. */
  79644. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  79645. /**
  79646. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  79647. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  79648. * The passed axis is also normalized. .
  79649. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  79650. * @param point the point to rotate around
  79651. * @param axis the axis to rotate around
  79652. * @param amount the amount to rotate in radians
  79653. * @returns the TransformNode
  79654. */
  79655. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  79656. /**
  79657. * Translates the mesh along the axis vector for the passed distance in the given space.
  79658. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  79659. * @param axis the axis to translate in
  79660. * @param distance the distance to translate
  79661. * @param space Space to rotate in (Default: local)
  79662. * @returns the TransformNode.
  79663. */
  79664. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  79665. /**
  79666. * Adds a rotation step to the mesh current rotation.
  79667. * x, y, z are Euler angles expressed in radians.
  79668. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  79669. * This means this rotation is made in the mesh local space only.
  79670. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  79671. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  79672. * ```javascript
  79673. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  79674. * ```
  79675. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  79676. * 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.
  79677. * @param x Rotation to add
  79678. * @param y Rotation to add
  79679. * @param z Rotation to add
  79680. * @returns the TransformNode.
  79681. */
  79682. addRotation(x: number, y: number, z: number): TransformNode;
  79683. /**
  79684. * @hidden
  79685. */
  79686. protected _getEffectiveParent(): Nullable<Node>;
  79687. /**
  79688. * Computes the world matrix of the node
  79689. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  79690. * @returns the world matrix
  79691. */
  79692. computeWorldMatrix(force?: boolean): Matrix;
  79693. protected _afterComputeWorldMatrix(): void;
  79694. /**
  79695. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  79696. * @param func callback function to add
  79697. *
  79698. * @returns the TransformNode.
  79699. */
  79700. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  79701. /**
  79702. * Removes a registered callback function.
  79703. * @param func callback function to remove
  79704. * @returns the TransformNode.
  79705. */
  79706. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  79707. /**
  79708. * Gets the position of the current mesh in camera space
  79709. * @param camera defines the camera to use
  79710. * @returns a position
  79711. */
  79712. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  79713. /**
  79714. * Returns the distance from the mesh to the active camera
  79715. * @param camera defines the camera to use
  79716. * @returns the distance
  79717. */
  79718. getDistanceToCamera(camera?: Nullable<Camera>): number;
  79719. /**
  79720. * Clone the current transform node
  79721. * @param name Name of the new clone
  79722. * @param newParent New parent for the clone
  79723. * @param doNotCloneChildren Do not clone children hierarchy
  79724. * @returns the new transform node
  79725. */
  79726. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  79727. /**
  79728. * Serializes the objects information.
  79729. * @param currentSerializationObject defines the object to serialize in
  79730. * @returns the serialized object
  79731. */
  79732. serialize(currentSerializationObject?: any): any;
  79733. /**
  79734. * Returns a new TransformNode object parsed from the source provided.
  79735. * @param parsedTransformNode is the source.
  79736. * @param scene the scne the object belongs to
  79737. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  79738. * @returns a new TransformNode object parsed from the source provided.
  79739. */
  79740. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  79741. /**
  79742. * Get all child-transformNodes of this node
  79743. * @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
  79744. * @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
  79745. * @returns an array of TransformNode
  79746. */
  79747. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  79748. /**
  79749. * Releases resources associated with this transform node.
  79750. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  79751. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  79752. */
  79753. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  79754. /**
  79755. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  79756. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  79757. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  79758. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  79759. * @returns the current mesh
  79760. */
  79761. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  79762. private _syncAbsoluteScalingAndRotation;
  79763. }
  79764. }
  79765. declare module BABYLON {
  79766. /**
  79767. * Defines the types of pose enabled controllers that are supported
  79768. */
  79769. export enum PoseEnabledControllerType {
  79770. /**
  79771. * HTC Vive
  79772. */
  79773. VIVE = 0,
  79774. /**
  79775. * Oculus Rift
  79776. */
  79777. OCULUS = 1,
  79778. /**
  79779. * Windows mixed reality
  79780. */
  79781. WINDOWS = 2,
  79782. /**
  79783. * Samsung gear VR
  79784. */
  79785. GEAR_VR = 3,
  79786. /**
  79787. * Google Daydream
  79788. */
  79789. DAYDREAM = 4,
  79790. /**
  79791. * Generic
  79792. */
  79793. GENERIC = 5
  79794. }
  79795. /**
  79796. * Defines the MutableGamepadButton interface for the state of a gamepad button
  79797. */
  79798. export interface MutableGamepadButton {
  79799. /**
  79800. * Value of the button/trigger
  79801. */
  79802. value: number;
  79803. /**
  79804. * If the button/trigger is currently touched
  79805. */
  79806. touched: boolean;
  79807. /**
  79808. * If the button/trigger is currently pressed
  79809. */
  79810. pressed: boolean;
  79811. }
  79812. /**
  79813. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  79814. * @hidden
  79815. */
  79816. export interface ExtendedGamepadButton extends GamepadButton {
  79817. /**
  79818. * If the button/trigger is currently pressed
  79819. */
  79820. readonly pressed: boolean;
  79821. /**
  79822. * If the button/trigger is currently touched
  79823. */
  79824. readonly touched: boolean;
  79825. /**
  79826. * Value of the button/trigger
  79827. */
  79828. readonly value: number;
  79829. }
  79830. /** @hidden */
  79831. export interface _GamePadFactory {
  79832. /**
  79833. * Returns wether or not the current gamepad can be created for this type of controller.
  79834. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  79835. * @returns true if it can be created, otherwise false
  79836. */
  79837. canCreate(gamepadInfo: any): boolean;
  79838. /**
  79839. * Creates a new instance of the Gamepad.
  79840. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  79841. * @returns the new gamepad instance
  79842. */
  79843. create(gamepadInfo: any): Gamepad;
  79844. }
  79845. /**
  79846. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  79847. */
  79848. export class PoseEnabledControllerHelper {
  79849. /** @hidden */
  79850. static _ControllerFactories: _GamePadFactory[];
  79851. /** @hidden */
  79852. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  79853. /**
  79854. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  79855. * @param vrGamepad the gamepad to initialized
  79856. * @returns a vr controller of the type the gamepad identified as
  79857. */
  79858. static InitiateController(vrGamepad: any): Gamepad;
  79859. }
  79860. /**
  79861. * Defines the PoseEnabledController object that contains state of a vr capable controller
  79862. */
  79863. export class PoseEnabledController extends Gamepad implements PoseControlled {
  79864. /**
  79865. * If the controller is used in a webXR session
  79866. */
  79867. isXR: boolean;
  79868. private _deviceRoomPosition;
  79869. private _deviceRoomRotationQuaternion;
  79870. /**
  79871. * The device position in babylon space
  79872. */
  79873. devicePosition: Vector3;
  79874. /**
  79875. * The device rotation in babylon space
  79876. */
  79877. deviceRotationQuaternion: Quaternion;
  79878. /**
  79879. * The scale factor of the device in babylon space
  79880. */
  79881. deviceScaleFactor: number;
  79882. /**
  79883. * (Likely devicePosition should be used instead) The device position in its room space
  79884. */
  79885. position: Vector3;
  79886. /**
  79887. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  79888. */
  79889. rotationQuaternion: Quaternion;
  79890. /**
  79891. * The type of controller (Eg. Windows mixed reality)
  79892. */
  79893. controllerType: PoseEnabledControllerType;
  79894. protected _calculatedPosition: Vector3;
  79895. private _calculatedRotation;
  79896. /**
  79897. * The raw pose from the device
  79898. */
  79899. rawPose: DevicePose;
  79900. private _trackPosition;
  79901. private _maxRotationDistFromHeadset;
  79902. private _draggedRoomRotation;
  79903. /**
  79904. * @hidden
  79905. */
  79906. _disableTrackPosition(fixedPosition: Vector3): void;
  79907. /**
  79908. * Internal, the mesh attached to the controller
  79909. * @hidden
  79910. */
  79911. _mesh: Nullable<AbstractMesh>;
  79912. private _poseControlledCamera;
  79913. private _leftHandSystemQuaternion;
  79914. /**
  79915. * Internal, matrix used to convert room space to babylon space
  79916. * @hidden
  79917. */
  79918. _deviceToWorld: Matrix;
  79919. /**
  79920. * Node to be used when casting a ray from the controller
  79921. * @hidden
  79922. */
  79923. _pointingPoseNode: Nullable<TransformNode>;
  79924. /**
  79925. * Name of the child mesh that can be used to cast a ray from the controller
  79926. */
  79927. static readonly POINTING_POSE: string;
  79928. /**
  79929. * Creates a new PoseEnabledController from a gamepad
  79930. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  79931. */
  79932. constructor(browserGamepad: any);
  79933. private _workingMatrix;
  79934. /**
  79935. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  79936. */
  79937. update(): void;
  79938. /**
  79939. * Updates only the pose device and mesh without doing any button event checking
  79940. */
  79941. protected _updatePoseAndMesh(): void;
  79942. /**
  79943. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  79944. * @param poseData raw pose fromthe device
  79945. */
  79946. updateFromDevice(poseData: DevicePose): void;
  79947. /**
  79948. * @hidden
  79949. */
  79950. _meshAttachedObservable: Observable<AbstractMesh>;
  79951. /**
  79952. * Attaches a mesh to the controller
  79953. * @param mesh the mesh to be attached
  79954. */
  79955. attachToMesh(mesh: AbstractMesh): void;
  79956. /**
  79957. * Attaches the controllers mesh to a camera
  79958. * @param camera the camera the mesh should be attached to
  79959. */
  79960. attachToPoseControlledCamera(camera: TargetCamera): void;
  79961. /**
  79962. * Disposes of the controller
  79963. */
  79964. dispose(): void;
  79965. /**
  79966. * The mesh that is attached to the controller
  79967. */
  79968. readonly mesh: Nullable<AbstractMesh>;
  79969. /**
  79970. * Gets the ray of the controller in the direction the controller is pointing
  79971. * @param length the length the resulting ray should be
  79972. * @returns a ray in the direction the controller is pointing
  79973. */
  79974. getForwardRay(length?: number): Ray;
  79975. }
  79976. }
  79977. declare module BABYLON {
  79978. /**
  79979. * Defines the WebVRController object that represents controllers tracked in 3D space
  79980. */
  79981. export abstract class WebVRController extends PoseEnabledController {
  79982. /**
  79983. * Internal, the default controller model for the controller
  79984. */
  79985. protected _defaultModel: AbstractMesh;
  79986. /**
  79987. * Fired when the trigger state has changed
  79988. */
  79989. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  79990. /**
  79991. * Fired when the main button state has changed
  79992. */
  79993. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  79994. /**
  79995. * Fired when the secondary button state has changed
  79996. */
  79997. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  79998. /**
  79999. * Fired when the pad state has changed
  80000. */
  80001. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  80002. /**
  80003. * Fired when controllers stick values have changed
  80004. */
  80005. onPadValuesChangedObservable: Observable<StickValues>;
  80006. /**
  80007. * Array of button availible on the controller
  80008. */
  80009. protected _buttons: Array<MutableGamepadButton>;
  80010. private _onButtonStateChange;
  80011. /**
  80012. * Fired when a controller button's state has changed
  80013. * @param callback the callback containing the button that was modified
  80014. */
  80015. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  80016. /**
  80017. * X and Y axis corresponding to the controllers joystick
  80018. */
  80019. pad: StickValues;
  80020. /**
  80021. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  80022. */
  80023. hand: string;
  80024. /**
  80025. * The default controller model for the controller
  80026. */
  80027. readonly defaultModel: AbstractMesh;
  80028. /**
  80029. * Creates a new WebVRController from a gamepad
  80030. * @param vrGamepad the gamepad that the WebVRController should be created from
  80031. */
  80032. constructor(vrGamepad: any);
  80033. /**
  80034. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  80035. */
  80036. update(): void;
  80037. /**
  80038. * Function to be called when a button is modified
  80039. */
  80040. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  80041. /**
  80042. * Loads a mesh and attaches it to the controller
  80043. * @param scene the scene the mesh should be added to
  80044. * @param meshLoaded callback for when the mesh has been loaded
  80045. */
  80046. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  80047. private _setButtonValue;
  80048. private _changes;
  80049. private _checkChanges;
  80050. /**
  80051. * Disposes of th webVRCOntroller
  80052. */
  80053. dispose(): void;
  80054. }
  80055. }
  80056. declare module BABYLON {
  80057. /**
  80058. * The HemisphericLight simulates the ambient environment light,
  80059. * so the passed direction is the light reflection direction, not the incoming direction.
  80060. */
  80061. export class HemisphericLight extends Light {
  80062. /**
  80063. * The groundColor is the light in the opposite direction to the one specified during creation.
  80064. * 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.
  80065. */
  80066. groundColor: Color3;
  80067. /**
  80068. * The light reflection direction, not the incoming direction.
  80069. */
  80070. direction: Vector3;
  80071. /**
  80072. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  80073. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  80074. * The HemisphericLight can't cast shadows.
  80075. * Documentation : https://doc.babylonjs.com/babylon101/lights
  80076. * @param name The friendly name of the light
  80077. * @param direction The direction of the light reflection
  80078. * @param scene The scene the light belongs to
  80079. */
  80080. constructor(name: string, direction: Vector3, scene: Scene);
  80081. protected _buildUniformLayout(): void;
  80082. /**
  80083. * Returns the string "HemisphericLight".
  80084. * @return The class name
  80085. */
  80086. getClassName(): string;
  80087. /**
  80088. * Sets the HemisphericLight direction towards the passed target (Vector3).
  80089. * Returns the updated direction.
  80090. * @param target The target the direction should point to
  80091. * @return The computed direction
  80092. */
  80093. setDirectionToTarget(target: Vector3): Vector3;
  80094. /**
  80095. * Returns the shadow generator associated to the light.
  80096. * @returns Always null for hemispheric lights because it does not support shadows.
  80097. */
  80098. getShadowGenerator(): Nullable<IShadowGenerator>;
  80099. /**
  80100. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  80101. * @param effect The effect to update
  80102. * @param lightIndex The index of the light in the effect to update
  80103. * @returns The hemispheric light
  80104. */
  80105. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  80106. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  80107. /**
  80108. * Computes the world matrix of the node
  80109. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  80110. * @param useWasUpdatedFlag defines a reserved property
  80111. * @returns the world matrix
  80112. */
  80113. computeWorldMatrix(): Matrix;
  80114. /**
  80115. * Returns the integer 3.
  80116. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  80117. */
  80118. getTypeID(): number;
  80119. /**
  80120. * Prepares the list of defines specific to the light type.
  80121. * @param defines the list of defines
  80122. * @param lightIndex defines the index of the light for the effect
  80123. */
  80124. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  80125. }
  80126. }
  80127. declare module BABYLON {
  80128. /** @hidden */
  80129. export var vrMultiviewToSingleviewPixelShader: {
  80130. name: string;
  80131. shader: string;
  80132. };
  80133. }
  80134. declare module BABYLON {
  80135. /**
  80136. * Renders to multiple views with a single draw call
  80137. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  80138. */
  80139. export class MultiviewRenderTarget extends RenderTargetTexture {
  80140. /**
  80141. * Creates a multiview render target
  80142. * @param scene scene used with the render target
  80143. * @param size the size of the render target (used for each view)
  80144. */
  80145. constructor(scene: Scene, size?: number | {
  80146. width: number;
  80147. height: number;
  80148. } | {
  80149. ratio: number;
  80150. });
  80151. /**
  80152. * @hidden
  80153. * @param faceIndex the face index, if its a cube texture
  80154. */
  80155. _bindFrameBuffer(faceIndex?: number): void;
  80156. /**
  80157. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  80158. * @returns the view count
  80159. */
  80160. getViewCount(): number;
  80161. }
  80162. }
  80163. declare module BABYLON {
  80164. /**
  80165. * Represents a camera frustum
  80166. */
  80167. export class Frustum {
  80168. /**
  80169. * Gets the planes representing the frustum
  80170. * @param transform matrix to be applied to the returned planes
  80171. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  80172. */
  80173. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  80174. /**
  80175. * Gets the near frustum plane transformed by the transform matrix
  80176. * @param transform transformation matrix to be applied to the resulting frustum plane
  80177. * @param frustumPlane the resuling frustum plane
  80178. */
  80179. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80180. /**
  80181. * Gets the far frustum plane transformed by the transform matrix
  80182. * @param transform transformation matrix to be applied to the resulting frustum plane
  80183. * @param frustumPlane the resuling frustum plane
  80184. */
  80185. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80186. /**
  80187. * Gets the left frustum plane transformed by the transform matrix
  80188. * @param transform transformation matrix to be applied to the resulting frustum plane
  80189. * @param frustumPlane the resuling frustum plane
  80190. */
  80191. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80192. /**
  80193. * Gets the right frustum plane transformed by the transform matrix
  80194. * @param transform transformation matrix to be applied to the resulting frustum plane
  80195. * @param frustumPlane the resuling frustum plane
  80196. */
  80197. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80198. /**
  80199. * Gets the top frustum plane transformed by the transform matrix
  80200. * @param transform transformation matrix to be applied to the resulting frustum plane
  80201. * @param frustumPlane the resuling frustum plane
  80202. */
  80203. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80204. /**
  80205. * Gets the bottom frustum plane transformed by the transform matrix
  80206. * @param transform transformation matrix to be applied to the resulting frustum plane
  80207. * @param frustumPlane the resuling frustum plane
  80208. */
  80209. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  80210. /**
  80211. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  80212. * @param transform transformation matrix to be applied to the resulting frustum planes
  80213. * @param frustumPlanes the resuling frustum planes
  80214. */
  80215. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  80216. }
  80217. }
  80218. declare module BABYLON {
  80219. interface Engine {
  80220. /**
  80221. * Creates a new multiview render target
  80222. * @param width defines the width of the texture
  80223. * @param height defines the height of the texture
  80224. * @returns the created multiview texture
  80225. */
  80226. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  80227. /**
  80228. * Binds a multiview framebuffer to be drawn to
  80229. * @param multiviewTexture texture to bind
  80230. */
  80231. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  80232. }
  80233. interface Camera {
  80234. /**
  80235. * @hidden
  80236. * 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)
  80237. */
  80238. _useMultiviewToSingleView: boolean;
  80239. /**
  80240. * @hidden
  80241. * 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)
  80242. */
  80243. _multiviewTexture: Nullable<RenderTargetTexture>;
  80244. /**
  80245. * @hidden
  80246. * ensures the multiview texture of the camera exists and has the specified width/height
  80247. * @param width height to set on the multiview texture
  80248. * @param height width to set on the multiview texture
  80249. */
  80250. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  80251. }
  80252. interface Scene {
  80253. /** @hidden */
  80254. _transformMatrixR: Matrix;
  80255. /** @hidden */
  80256. _multiviewSceneUbo: Nullable<UniformBuffer>;
  80257. /** @hidden */
  80258. _createMultiviewUbo(): void;
  80259. /** @hidden */
  80260. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  80261. /** @hidden */
  80262. _renderMultiviewToSingleView(camera: Camera): void;
  80263. }
  80264. }
  80265. declare module BABYLON {
  80266. /**
  80267. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  80268. * This will not be used for webXR as it supports displaying texture arrays directly
  80269. */
  80270. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  80271. /**
  80272. * Initializes a VRMultiviewToSingleview
  80273. * @param name name of the post process
  80274. * @param camera camera to be applied to
  80275. * @param scaleFactor scaling factor to the size of the output texture
  80276. */
  80277. constructor(name: string, camera: Camera, scaleFactor: number);
  80278. }
  80279. }
  80280. declare module BABYLON {
  80281. interface Engine {
  80282. /** @hidden */
  80283. _vrDisplay: any;
  80284. /** @hidden */
  80285. _vrSupported: boolean;
  80286. /** @hidden */
  80287. _oldSize: Size;
  80288. /** @hidden */
  80289. _oldHardwareScaleFactor: number;
  80290. /** @hidden */
  80291. _vrExclusivePointerMode: boolean;
  80292. /** @hidden */
  80293. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  80294. /** @hidden */
  80295. _onVRDisplayPointerRestricted: () => void;
  80296. /** @hidden */
  80297. _onVRDisplayPointerUnrestricted: () => void;
  80298. /** @hidden */
  80299. _onVrDisplayConnect: Nullable<(display: any) => void>;
  80300. /** @hidden */
  80301. _onVrDisplayDisconnect: Nullable<() => void>;
  80302. /** @hidden */
  80303. _onVrDisplayPresentChange: Nullable<() => void>;
  80304. /**
  80305. * Observable signaled when VR display mode changes
  80306. */
  80307. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  80308. /**
  80309. * Observable signaled when VR request present is complete
  80310. */
  80311. onVRRequestPresentComplete: Observable<boolean>;
  80312. /**
  80313. * Observable signaled when VR request present starts
  80314. */
  80315. onVRRequestPresentStart: Observable<Engine>;
  80316. /**
  80317. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  80318. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  80319. */
  80320. isInVRExclusivePointerMode: boolean;
  80321. /**
  80322. * Gets a boolean indicating if a webVR device was detected
  80323. * @returns true if a webVR device was detected
  80324. */
  80325. isVRDevicePresent(): boolean;
  80326. /**
  80327. * Gets the current webVR device
  80328. * @returns the current webVR device (or null)
  80329. */
  80330. getVRDevice(): any;
  80331. /**
  80332. * Initializes a webVR display and starts listening to display change events
  80333. * The onVRDisplayChangedObservable will be notified upon these changes
  80334. * @returns A promise containing a VRDisplay and if vr is supported
  80335. */
  80336. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  80337. /** @hidden */
  80338. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  80339. /**
  80340. * Call this function to switch to webVR mode
  80341. * Will do nothing if webVR is not supported or if there is no webVR device
  80342. * @see http://doc.babylonjs.com/how_to/webvr_camera
  80343. */
  80344. enableVR(): void;
  80345. /** @hidden */
  80346. _onVRFullScreenTriggered(): void;
  80347. }
  80348. }
  80349. declare module BABYLON {
  80350. /**
  80351. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  80352. * IMPORTANT!! The data is right-hand data.
  80353. * @export
  80354. * @interface DevicePose
  80355. */
  80356. export interface DevicePose {
  80357. /**
  80358. * The position of the device, values in array are [x,y,z].
  80359. */
  80360. readonly position: Nullable<Float32Array>;
  80361. /**
  80362. * The linearVelocity of the device, values in array are [x,y,z].
  80363. */
  80364. readonly linearVelocity: Nullable<Float32Array>;
  80365. /**
  80366. * The linearAcceleration of the device, values in array are [x,y,z].
  80367. */
  80368. readonly linearAcceleration: Nullable<Float32Array>;
  80369. /**
  80370. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  80371. */
  80372. readonly orientation: Nullable<Float32Array>;
  80373. /**
  80374. * The angularVelocity of the device, values in array are [x,y,z].
  80375. */
  80376. readonly angularVelocity: Nullable<Float32Array>;
  80377. /**
  80378. * The angularAcceleration of the device, values in array are [x,y,z].
  80379. */
  80380. readonly angularAcceleration: Nullable<Float32Array>;
  80381. }
  80382. /**
  80383. * Interface representing a pose controlled object in Babylon.
  80384. * A pose controlled object has both regular pose values as well as pose values
  80385. * from an external device such as a VR head mounted display
  80386. */
  80387. export interface PoseControlled {
  80388. /**
  80389. * The position of the object in babylon space.
  80390. */
  80391. position: Vector3;
  80392. /**
  80393. * The rotation quaternion of the object in babylon space.
  80394. */
  80395. rotationQuaternion: Quaternion;
  80396. /**
  80397. * The position of the device in babylon space.
  80398. */
  80399. devicePosition?: Vector3;
  80400. /**
  80401. * The rotation quaternion of the device in babylon space.
  80402. */
  80403. deviceRotationQuaternion: Quaternion;
  80404. /**
  80405. * The raw pose coming from the device.
  80406. */
  80407. rawPose: Nullable<DevicePose>;
  80408. /**
  80409. * The scale of the device to be used when translating from device space to babylon space.
  80410. */
  80411. deviceScaleFactor: number;
  80412. /**
  80413. * Updates the poseControlled values based on the input device pose.
  80414. * @param poseData the pose data to update the object with
  80415. */
  80416. updateFromDevice(poseData: DevicePose): void;
  80417. }
  80418. /**
  80419. * Set of options to customize the webVRCamera
  80420. */
  80421. export interface WebVROptions {
  80422. /**
  80423. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  80424. */
  80425. trackPosition?: boolean;
  80426. /**
  80427. * Sets the scale of the vrDevice in babylon space. (default: 1)
  80428. */
  80429. positionScale?: number;
  80430. /**
  80431. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  80432. */
  80433. displayName?: string;
  80434. /**
  80435. * Should the native controller meshes be initialized. (default: true)
  80436. */
  80437. controllerMeshes?: boolean;
  80438. /**
  80439. * Creating a default HemiLight only on controllers. (default: true)
  80440. */
  80441. defaultLightingOnControllers?: boolean;
  80442. /**
  80443. * If you don't want to use the default VR button of the helper. (default: false)
  80444. */
  80445. useCustomVRButton?: boolean;
  80446. /**
  80447. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  80448. */
  80449. customVRButton?: HTMLButtonElement;
  80450. /**
  80451. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  80452. */
  80453. rayLength?: number;
  80454. /**
  80455. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  80456. */
  80457. defaultHeight?: number;
  80458. /**
  80459. * If multiview should be used if availible (default: false)
  80460. */
  80461. useMultiview?: boolean;
  80462. }
  80463. /**
  80464. * This represents a WebVR camera.
  80465. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  80466. * @example http://doc.babylonjs.com/how_to/webvr_camera
  80467. */
  80468. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  80469. private webVROptions;
  80470. /**
  80471. * @hidden
  80472. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  80473. */
  80474. _vrDevice: any;
  80475. /**
  80476. * The rawPose of the vrDevice.
  80477. */
  80478. rawPose: Nullable<DevicePose>;
  80479. private _onVREnabled;
  80480. private _specsVersion;
  80481. private _attached;
  80482. private _frameData;
  80483. protected _descendants: Array<Node>;
  80484. private _deviceRoomPosition;
  80485. /** @hidden */
  80486. _deviceRoomRotationQuaternion: Quaternion;
  80487. private _standingMatrix;
  80488. /**
  80489. * Represents device position in babylon space.
  80490. */
  80491. devicePosition: Vector3;
  80492. /**
  80493. * Represents device rotation in babylon space.
  80494. */
  80495. deviceRotationQuaternion: Quaternion;
  80496. /**
  80497. * The scale of the device to be used when translating from device space to babylon space.
  80498. */
  80499. deviceScaleFactor: number;
  80500. private _deviceToWorld;
  80501. private _worldToDevice;
  80502. /**
  80503. * References to the webVR controllers for the vrDevice.
  80504. */
  80505. controllers: Array<WebVRController>;
  80506. /**
  80507. * Emits an event when a controller is attached.
  80508. */
  80509. onControllersAttachedObservable: Observable<WebVRController[]>;
  80510. /**
  80511. * Emits an event when a controller's mesh has been loaded;
  80512. */
  80513. onControllerMeshLoadedObservable: Observable<WebVRController>;
  80514. /**
  80515. * Emits an event when the HMD's pose has been updated.
  80516. */
  80517. onPoseUpdatedFromDeviceObservable: Observable<any>;
  80518. private _poseSet;
  80519. /**
  80520. * If the rig cameras be used as parent instead of this camera.
  80521. */
  80522. rigParenting: boolean;
  80523. private _lightOnControllers;
  80524. private _defaultHeight?;
  80525. /**
  80526. * Instantiates a WebVRFreeCamera.
  80527. * @param name The name of the WebVRFreeCamera
  80528. * @param position The starting anchor position for the camera
  80529. * @param scene The scene the camera belongs to
  80530. * @param webVROptions a set of customizable options for the webVRCamera
  80531. */
  80532. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  80533. /**
  80534. * Gets the device distance from the ground in meters.
  80535. * @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.
  80536. */
  80537. deviceDistanceToRoomGround(): number;
  80538. /**
  80539. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  80540. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  80541. */
  80542. useStandingMatrix(callback?: (bool: boolean) => void): void;
  80543. /**
  80544. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  80545. * @returns A promise with a boolean set to if the standing matrix is supported.
  80546. */
  80547. useStandingMatrixAsync(): Promise<boolean>;
  80548. /**
  80549. * Disposes the camera
  80550. */
  80551. dispose(): void;
  80552. /**
  80553. * Gets a vrController by name.
  80554. * @param name The name of the controller to retreive
  80555. * @returns the controller matching the name specified or null if not found
  80556. */
  80557. getControllerByName(name: string): Nullable<WebVRController>;
  80558. private _leftController;
  80559. /**
  80560. * The controller corresponding to the users left hand.
  80561. */
  80562. readonly leftController: Nullable<WebVRController>;
  80563. private _rightController;
  80564. /**
  80565. * The controller corresponding to the users right hand.
  80566. */
  80567. readonly rightController: Nullable<WebVRController>;
  80568. /**
  80569. * Casts a ray forward from the vrCamera's gaze.
  80570. * @param length Length of the ray (default: 100)
  80571. * @returns the ray corresponding to the gaze
  80572. */
  80573. getForwardRay(length?: number): Ray;
  80574. /**
  80575. * @hidden
  80576. * Updates the camera based on device's frame data
  80577. */
  80578. _checkInputs(): void;
  80579. /**
  80580. * Updates the poseControlled values based on the input device pose.
  80581. * @param poseData Pose coming from the device
  80582. */
  80583. updateFromDevice(poseData: DevicePose): void;
  80584. private _htmlElementAttached;
  80585. private _detachIfAttached;
  80586. /**
  80587. * WebVR's attach control will start broadcasting frames to the device.
  80588. * Note that in certain browsers (chrome for example) this function must be called
  80589. * within a user-interaction callback. Example:
  80590. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  80591. *
  80592. * @param element html element to attach the vrDevice to
  80593. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  80594. */
  80595. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80596. /**
  80597. * Detaches the camera from the html element and disables VR
  80598. *
  80599. * @param element html element to detach from
  80600. */
  80601. detachControl(element: HTMLElement): void;
  80602. /**
  80603. * @returns the name of this class
  80604. */
  80605. getClassName(): string;
  80606. /**
  80607. * Calls resetPose on the vrDisplay
  80608. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  80609. */
  80610. resetToCurrentRotation(): void;
  80611. /**
  80612. * @hidden
  80613. * Updates the rig cameras (left and right eye)
  80614. */
  80615. _updateRigCameras(): void;
  80616. private _workingVector;
  80617. private _oneVector;
  80618. private _workingMatrix;
  80619. private updateCacheCalled;
  80620. private _correctPositionIfNotTrackPosition;
  80621. /**
  80622. * @hidden
  80623. * Updates the cached values of the camera
  80624. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  80625. */
  80626. _updateCache(ignoreParentClass?: boolean): void;
  80627. /**
  80628. * @hidden
  80629. * Get current device position in babylon world
  80630. */
  80631. _computeDevicePosition(): void;
  80632. /**
  80633. * Updates the current device position and rotation in the babylon world
  80634. */
  80635. update(): void;
  80636. /**
  80637. * @hidden
  80638. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  80639. * @returns an identity matrix
  80640. */
  80641. _getViewMatrix(): Matrix;
  80642. private _tmpMatrix;
  80643. /**
  80644. * This function is called by the two RIG cameras.
  80645. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  80646. * @hidden
  80647. */
  80648. _getWebVRViewMatrix(): Matrix;
  80649. /** @hidden */
  80650. _getWebVRProjectionMatrix(): Matrix;
  80651. private _onGamepadConnectedObserver;
  80652. private _onGamepadDisconnectedObserver;
  80653. private _updateCacheWhenTrackingDisabledObserver;
  80654. /**
  80655. * Initializes the controllers and their meshes
  80656. */
  80657. initControllers(): void;
  80658. }
  80659. }
  80660. declare module BABYLON {
  80661. /**
  80662. * Size options for a post process
  80663. */
  80664. export type PostProcessOptions = {
  80665. width: number;
  80666. height: number;
  80667. };
  80668. /**
  80669. * PostProcess can be used to apply a shader to a texture after it has been rendered
  80670. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  80671. */
  80672. export class PostProcess {
  80673. /** Name of the PostProcess. */
  80674. name: string;
  80675. /**
  80676. * Gets or sets the unique id of the post process
  80677. */
  80678. uniqueId: number;
  80679. /**
  80680. * Width of the texture to apply the post process on
  80681. */
  80682. width: number;
  80683. /**
  80684. * Height of the texture to apply the post process on
  80685. */
  80686. height: number;
  80687. /**
  80688. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  80689. * @hidden
  80690. */
  80691. _outputTexture: Nullable<InternalTexture>;
  80692. /**
  80693. * Sampling mode used by the shader
  80694. * See https://doc.babylonjs.com/classes/3.1/texture
  80695. */
  80696. renderTargetSamplingMode: number;
  80697. /**
  80698. * Clear color to use when screen clearing
  80699. */
  80700. clearColor: Color4;
  80701. /**
  80702. * If the buffer needs to be cleared before applying the post process. (default: true)
  80703. * Should be set to false if shader will overwrite all previous pixels.
  80704. */
  80705. autoClear: boolean;
  80706. /**
  80707. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  80708. */
  80709. alphaMode: number;
  80710. /**
  80711. * Sets the setAlphaBlendConstants of the babylon engine
  80712. */
  80713. alphaConstants: Color4;
  80714. /**
  80715. * Animations to be used for the post processing
  80716. */
  80717. animations: Animation[];
  80718. /**
  80719. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  80720. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  80721. */
  80722. enablePixelPerfectMode: boolean;
  80723. /**
  80724. * Force the postprocess to be applied without taking in account viewport
  80725. */
  80726. forceFullscreenViewport: boolean;
  80727. /**
  80728. * List of inspectable custom properties (used by the Inspector)
  80729. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  80730. */
  80731. inspectableCustomProperties: IInspectable[];
  80732. /**
  80733. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  80734. *
  80735. * | Value | Type | Description |
  80736. * | ----- | ----------------------------------- | ----------- |
  80737. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  80738. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  80739. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  80740. *
  80741. */
  80742. scaleMode: number;
  80743. /**
  80744. * Force textures to be a power of two (default: false)
  80745. */
  80746. alwaysForcePOT: boolean;
  80747. private _samples;
  80748. /**
  80749. * Number of sample textures (default: 1)
  80750. */
  80751. samples: number;
  80752. /**
  80753. * Modify the scale of the post process to be the same as the viewport (default: false)
  80754. */
  80755. adaptScaleToCurrentViewport: boolean;
  80756. private _camera;
  80757. private _scene;
  80758. private _engine;
  80759. private _options;
  80760. private _reusable;
  80761. private _textureType;
  80762. /**
  80763. * Smart array of input and output textures for the post process.
  80764. * @hidden
  80765. */
  80766. _textures: SmartArray<InternalTexture>;
  80767. /**
  80768. * The index in _textures that corresponds to the output texture.
  80769. * @hidden
  80770. */
  80771. _currentRenderTextureInd: number;
  80772. private _effect;
  80773. private _samplers;
  80774. private _fragmentUrl;
  80775. private _vertexUrl;
  80776. private _parameters;
  80777. private _scaleRatio;
  80778. protected _indexParameters: any;
  80779. private _shareOutputWithPostProcess;
  80780. private _texelSize;
  80781. private _forcedOutputTexture;
  80782. /**
  80783. * Returns the fragment url or shader name used in the post process.
  80784. * @returns the fragment url or name in the shader store.
  80785. */
  80786. getEffectName(): string;
  80787. /**
  80788. * An event triggered when the postprocess is activated.
  80789. */
  80790. onActivateObservable: Observable<Camera>;
  80791. private _onActivateObserver;
  80792. /**
  80793. * A function that is added to the onActivateObservable
  80794. */
  80795. onActivate: Nullable<(camera: Camera) => void>;
  80796. /**
  80797. * An event triggered when the postprocess changes its size.
  80798. */
  80799. onSizeChangedObservable: Observable<PostProcess>;
  80800. private _onSizeChangedObserver;
  80801. /**
  80802. * A function that is added to the onSizeChangedObservable
  80803. */
  80804. onSizeChanged: (postProcess: PostProcess) => void;
  80805. /**
  80806. * An event triggered when the postprocess applies its effect.
  80807. */
  80808. onApplyObservable: Observable<Effect>;
  80809. private _onApplyObserver;
  80810. /**
  80811. * A function that is added to the onApplyObservable
  80812. */
  80813. onApply: (effect: Effect) => void;
  80814. /**
  80815. * An event triggered before rendering the postprocess
  80816. */
  80817. onBeforeRenderObservable: Observable<Effect>;
  80818. private _onBeforeRenderObserver;
  80819. /**
  80820. * A function that is added to the onBeforeRenderObservable
  80821. */
  80822. onBeforeRender: (effect: Effect) => void;
  80823. /**
  80824. * An event triggered after rendering the postprocess
  80825. */
  80826. onAfterRenderObservable: Observable<Effect>;
  80827. private _onAfterRenderObserver;
  80828. /**
  80829. * A function that is added to the onAfterRenderObservable
  80830. */
  80831. onAfterRender: (efect: Effect) => void;
  80832. /**
  80833. * 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
  80834. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  80835. */
  80836. inputTexture: InternalTexture;
  80837. /**
  80838. * Gets the camera which post process is applied to.
  80839. * @returns The camera the post process is applied to.
  80840. */
  80841. getCamera(): Camera;
  80842. /**
  80843. * Gets the texel size of the postprocess.
  80844. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  80845. */
  80846. readonly texelSize: Vector2;
  80847. /**
  80848. * Creates a new instance PostProcess
  80849. * @param name The name of the PostProcess.
  80850. * @param fragmentUrl The url of the fragment shader to be used.
  80851. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  80852. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  80853. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  80854. * @param camera The camera to apply the render pass to.
  80855. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  80856. * @param engine The engine which the post process will be applied. (default: current engine)
  80857. * @param reusable If the post process can be reused on the same frame. (default: false)
  80858. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  80859. * @param textureType Type of textures used when performing the post process. (default: 0)
  80860. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  80861. * @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
  80862. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  80863. */
  80864. constructor(
  80865. /** Name of the PostProcess. */
  80866. 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);
  80867. /**
  80868. * Gets a string idenfifying the name of the class
  80869. * @returns "PostProcess" string
  80870. */
  80871. getClassName(): string;
  80872. /**
  80873. * Gets the engine which this post process belongs to.
  80874. * @returns The engine the post process was enabled with.
  80875. */
  80876. getEngine(): Engine;
  80877. /**
  80878. * The effect that is created when initializing the post process.
  80879. * @returns The created effect corresponding the the postprocess.
  80880. */
  80881. getEffect(): Effect;
  80882. /**
  80883. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  80884. * @param postProcess The post process to share the output with.
  80885. * @returns This post process.
  80886. */
  80887. shareOutputWith(postProcess: PostProcess): PostProcess;
  80888. /**
  80889. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  80890. * This should be called if the post process that shares output with this post process is disabled/disposed.
  80891. */
  80892. useOwnOutput(): void;
  80893. /**
  80894. * Updates the effect with the current post process compile time values and recompiles the shader.
  80895. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  80896. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  80897. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  80898. * @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
  80899. * @param onCompiled Called when the shader has been compiled.
  80900. * @param onError Called if there is an error when compiling a shader.
  80901. */
  80902. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  80903. /**
  80904. * The post process is reusable if it can be used multiple times within one frame.
  80905. * @returns If the post process is reusable
  80906. */
  80907. isReusable(): boolean;
  80908. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  80909. markTextureDirty(): void;
  80910. /**
  80911. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  80912. * 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.
  80913. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  80914. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  80915. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  80916. * @returns The target texture that was bound to be written to.
  80917. */
  80918. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  80919. /**
  80920. * If the post process is supported.
  80921. */
  80922. readonly isSupported: boolean;
  80923. /**
  80924. * The aspect ratio of the output texture.
  80925. */
  80926. readonly aspectRatio: number;
  80927. /**
  80928. * Get a value indicating if the post-process is ready to be used
  80929. * @returns true if the post-process is ready (shader is compiled)
  80930. */
  80931. isReady(): boolean;
  80932. /**
  80933. * Binds all textures and uniforms to the shader, this will be run on every pass.
  80934. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  80935. */
  80936. apply(): Nullable<Effect>;
  80937. private _disposeTextures;
  80938. /**
  80939. * Disposes the post process.
  80940. * @param camera The camera to dispose the post process on.
  80941. */
  80942. dispose(camera?: Camera): void;
  80943. }
  80944. }
  80945. declare module BABYLON {
  80946. /** @hidden */
  80947. export var kernelBlurVaryingDeclaration: {
  80948. name: string;
  80949. shader: string;
  80950. };
  80951. }
  80952. declare module BABYLON {
  80953. /** @hidden */
  80954. export var kernelBlurFragment: {
  80955. name: string;
  80956. shader: string;
  80957. };
  80958. }
  80959. declare module BABYLON {
  80960. /** @hidden */
  80961. export var kernelBlurFragment2: {
  80962. name: string;
  80963. shader: string;
  80964. };
  80965. }
  80966. declare module BABYLON {
  80967. /** @hidden */
  80968. export var kernelBlurPixelShader: {
  80969. name: string;
  80970. shader: string;
  80971. };
  80972. }
  80973. declare module BABYLON {
  80974. /** @hidden */
  80975. export var kernelBlurVertex: {
  80976. name: string;
  80977. shader: string;
  80978. };
  80979. }
  80980. declare module BABYLON {
  80981. /** @hidden */
  80982. export var kernelBlurVertexShader: {
  80983. name: string;
  80984. shader: string;
  80985. };
  80986. }
  80987. declare module BABYLON {
  80988. /**
  80989. * The Blur Post Process which blurs an image based on a kernel and direction.
  80990. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  80991. */
  80992. export class BlurPostProcess extends PostProcess {
  80993. /** The direction in which to blur the image. */
  80994. direction: Vector2;
  80995. private blockCompilation;
  80996. protected _kernel: number;
  80997. protected _idealKernel: number;
  80998. protected _packedFloat: boolean;
  80999. private _staticDefines;
  81000. /**
  81001. * Sets the length in pixels of the blur sample region
  81002. */
  81003. /**
  81004. * Gets the length in pixels of the blur sample region
  81005. */
  81006. kernel: number;
  81007. /**
  81008. * Sets wether or not the blur needs to unpack/repack floats
  81009. */
  81010. /**
  81011. * Gets wether or not the blur is unpacking/repacking floats
  81012. */
  81013. packedFloat: boolean;
  81014. /**
  81015. * Creates a new instance BlurPostProcess
  81016. * @param name The name of the effect.
  81017. * @param direction The direction in which to blur the image.
  81018. * @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.
  81019. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  81020. * @param camera The camera to apply the render pass to.
  81021. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  81022. * @param engine The engine which the post process will be applied. (default: current engine)
  81023. * @param reusable If the post process can be reused on the same frame. (default: false)
  81024. * @param textureType Type of textures used when performing the post process. (default: 0)
  81025. * @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)
  81026. */
  81027. constructor(name: string,
  81028. /** The direction in which to blur the image. */
  81029. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  81030. /**
  81031. * Updates the effect with the current post process compile time values and recompiles the shader.
  81032. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  81033. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  81034. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  81035. * @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
  81036. * @param onCompiled Called when the shader has been compiled.
  81037. * @param onError Called if there is an error when compiling a shader.
  81038. */
  81039. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  81040. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  81041. /**
  81042. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  81043. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  81044. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  81045. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  81046. * The gaps between physical kernels are compensated for in the weighting of the samples
  81047. * @param idealKernel Ideal blur kernel.
  81048. * @return Nearest best kernel.
  81049. */
  81050. protected _nearestBestKernel(idealKernel: number): number;
  81051. /**
  81052. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  81053. * @param x The point on the Gaussian distribution to sample.
  81054. * @return the value of the Gaussian function at x.
  81055. */
  81056. protected _gaussianWeight(x: number): number;
  81057. /**
  81058. * Generates a string that can be used as a floating point number in GLSL.
  81059. * @param x Value to print.
  81060. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  81061. * @return GLSL float string.
  81062. */
  81063. protected _glslFloat(x: number, decimalFigures?: number): string;
  81064. }
  81065. }
  81066. declare module BABYLON {
  81067. /**
  81068. * Mirror texture can be used to simulate the view from a mirror in a scene.
  81069. * It will dynamically be rendered every frame to adapt to the camera point of view.
  81070. * You can then easily use it as a reflectionTexture on a flat surface.
  81071. * In case the surface is not a plane, please consider relying on reflection probes.
  81072. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  81073. */
  81074. export class MirrorTexture extends RenderTargetTexture {
  81075. private scene;
  81076. /**
  81077. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  81078. * 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.
  81079. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  81080. */
  81081. mirrorPlane: Plane;
  81082. /**
  81083. * Define the blur ratio used to blur the reflection if needed.
  81084. */
  81085. blurRatio: number;
  81086. /**
  81087. * Define the adaptive blur kernel used to blur the reflection if needed.
  81088. * This will autocompute the closest best match for the `blurKernel`
  81089. */
  81090. adaptiveBlurKernel: number;
  81091. /**
  81092. * Define the blur kernel used to blur the reflection if needed.
  81093. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  81094. */
  81095. blurKernel: number;
  81096. /**
  81097. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  81098. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  81099. */
  81100. blurKernelX: number;
  81101. /**
  81102. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  81103. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  81104. */
  81105. blurKernelY: number;
  81106. private _autoComputeBlurKernel;
  81107. protected _onRatioRescale(): void;
  81108. private _updateGammaSpace;
  81109. private _imageProcessingConfigChangeObserver;
  81110. private _transformMatrix;
  81111. private _mirrorMatrix;
  81112. private _savedViewMatrix;
  81113. private _blurX;
  81114. private _blurY;
  81115. private _adaptiveBlurKernel;
  81116. private _blurKernelX;
  81117. private _blurKernelY;
  81118. private _blurRatio;
  81119. /**
  81120. * Instantiates a Mirror Texture.
  81121. * Mirror texture can be used to simulate the view from a mirror in a scene.
  81122. * It will dynamically be rendered every frame to adapt to the camera point of view.
  81123. * You can then easily use it as a reflectionTexture on a flat surface.
  81124. * In case the surface is not a plane, please consider relying on reflection probes.
  81125. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  81126. * @param name
  81127. * @param size
  81128. * @param scene
  81129. * @param generateMipMaps
  81130. * @param type
  81131. * @param samplingMode
  81132. * @param generateDepthBuffer
  81133. */
  81134. constructor(name: string, size: number | {
  81135. width: number;
  81136. height: number;
  81137. } | {
  81138. ratio: number;
  81139. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  81140. private _preparePostProcesses;
  81141. /**
  81142. * Clone the mirror texture.
  81143. * @returns the cloned texture
  81144. */
  81145. clone(): MirrorTexture;
  81146. /**
  81147. * Serialize the texture to a JSON representation you could use in Parse later on
  81148. * @returns the serialized JSON representation
  81149. */
  81150. serialize(): any;
  81151. /**
  81152. * Dispose the texture and release its associated resources.
  81153. */
  81154. dispose(): void;
  81155. }
  81156. }
  81157. declare module BABYLON {
  81158. /**
  81159. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  81160. * @see http://doc.babylonjs.com/babylon101/materials#texture
  81161. */
  81162. export class Texture extends BaseTexture {
  81163. /** @hidden */
  81164. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  81165. /** @hidden */
  81166. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  81167. /** @hidden */
  81168. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  81169. /** nearest is mag = nearest and min = nearest and mip = linear */
  81170. static readonly NEAREST_SAMPLINGMODE: number;
  81171. /** nearest is mag = nearest and min = nearest and mip = linear */
  81172. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  81173. /** Bilinear is mag = linear and min = linear and mip = nearest */
  81174. static readonly BILINEAR_SAMPLINGMODE: number;
  81175. /** Bilinear is mag = linear and min = linear and mip = nearest */
  81176. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  81177. /** Trilinear is mag = linear and min = linear and mip = linear */
  81178. static readonly TRILINEAR_SAMPLINGMODE: number;
  81179. /** Trilinear is mag = linear and min = linear and mip = linear */
  81180. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  81181. /** mag = nearest and min = nearest and mip = nearest */
  81182. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  81183. /** mag = nearest and min = linear and mip = nearest */
  81184. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  81185. /** mag = nearest and min = linear and mip = linear */
  81186. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  81187. /** mag = nearest and min = linear and mip = none */
  81188. static readonly NEAREST_LINEAR: number;
  81189. /** mag = nearest and min = nearest and mip = none */
  81190. static readonly NEAREST_NEAREST: number;
  81191. /** mag = linear and min = nearest and mip = nearest */
  81192. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  81193. /** mag = linear and min = nearest and mip = linear */
  81194. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  81195. /** mag = linear and min = linear and mip = none */
  81196. static readonly LINEAR_LINEAR: number;
  81197. /** mag = linear and min = nearest and mip = none */
  81198. static readonly LINEAR_NEAREST: number;
  81199. /** Explicit coordinates mode */
  81200. static readonly EXPLICIT_MODE: number;
  81201. /** Spherical coordinates mode */
  81202. static readonly SPHERICAL_MODE: number;
  81203. /** Planar coordinates mode */
  81204. static readonly PLANAR_MODE: number;
  81205. /** Cubic coordinates mode */
  81206. static readonly CUBIC_MODE: number;
  81207. /** Projection coordinates mode */
  81208. static readonly PROJECTION_MODE: number;
  81209. /** Inverse Cubic coordinates mode */
  81210. static readonly SKYBOX_MODE: number;
  81211. /** Inverse Cubic coordinates mode */
  81212. static readonly INVCUBIC_MODE: number;
  81213. /** Equirectangular coordinates mode */
  81214. static readonly EQUIRECTANGULAR_MODE: number;
  81215. /** Equirectangular Fixed coordinates mode */
  81216. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  81217. /** Equirectangular Fixed Mirrored coordinates mode */
  81218. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  81219. /** Texture is not repeating outside of 0..1 UVs */
  81220. static readonly CLAMP_ADDRESSMODE: number;
  81221. /** Texture is repeating outside of 0..1 UVs */
  81222. static readonly WRAP_ADDRESSMODE: number;
  81223. /** Texture is repeating and mirrored */
  81224. static readonly MIRROR_ADDRESSMODE: number;
  81225. /**
  81226. * 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
  81227. */
  81228. static UseSerializedUrlIfAny: boolean;
  81229. /**
  81230. * Define the url of the texture.
  81231. */
  81232. url: Nullable<string>;
  81233. /**
  81234. * Define an offset on the texture to offset the u coordinates of the UVs
  81235. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  81236. */
  81237. uOffset: number;
  81238. /**
  81239. * Define an offset on the texture to offset the v coordinates of the UVs
  81240. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  81241. */
  81242. vOffset: number;
  81243. /**
  81244. * Define an offset on the texture to scale the u coordinates of the UVs
  81245. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  81246. */
  81247. uScale: number;
  81248. /**
  81249. * Define an offset on the texture to scale the v coordinates of the UVs
  81250. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  81251. */
  81252. vScale: number;
  81253. /**
  81254. * Define an offset on the texture to rotate around the u coordinates of the UVs
  81255. * @see http://doc.babylonjs.com/how_to/more_materials
  81256. */
  81257. uAng: number;
  81258. /**
  81259. * Define an offset on the texture to rotate around the v coordinates of the UVs
  81260. * @see http://doc.babylonjs.com/how_to/more_materials
  81261. */
  81262. vAng: number;
  81263. /**
  81264. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  81265. * @see http://doc.babylonjs.com/how_to/more_materials
  81266. */
  81267. wAng: number;
  81268. /**
  81269. * Defines the center of rotation (U)
  81270. */
  81271. uRotationCenter: number;
  81272. /**
  81273. * Defines the center of rotation (V)
  81274. */
  81275. vRotationCenter: number;
  81276. /**
  81277. * Defines the center of rotation (W)
  81278. */
  81279. wRotationCenter: number;
  81280. /**
  81281. * Are mip maps generated for this texture or not.
  81282. */
  81283. readonly noMipmap: boolean;
  81284. /**
  81285. * List of inspectable custom properties (used by the Inspector)
  81286. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  81287. */
  81288. inspectableCustomProperties: Nullable<IInspectable[]>;
  81289. private _noMipmap;
  81290. /** @hidden */
  81291. _invertY: boolean;
  81292. private _rowGenerationMatrix;
  81293. private _cachedTextureMatrix;
  81294. private _projectionModeMatrix;
  81295. private _t0;
  81296. private _t1;
  81297. private _t2;
  81298. private _cachedUOffset;
  81299. private _cachedVOffset;
  81300. private _cachedUScale;
  81301. private _cachedVScale;
  81302. private _cachedUAng;
  81303. private _cachedVAng;
  81304. private _cachedWAng;
  81305. private _cachedProjectionMatrixId;
  81306. private _cachedCoordinatesMode;
  81307. /** @hidden */
  81308. protected _initialSamplingMode: number;
  81309. /** @hidden */
  81310. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>;
  81311. private _deleteBuffer;
  81312. protected _format: Nullable<number>;
  81313. private _delayedOnLoad;
  81314. private _delayedOnError;
  81315. /**
  81316. * Observable triggered once the texture has been loaded.
  81317. */
  81318. onLoadObservable: Observable<Texture>;
  81319. protected _isBlocking: boolean;
  81320. /**
  81321. * Is the texture preventing material to render while loading.
  81322. * If false, a default texture will be used instead of the loading one during the preparation step.
  81323. */
  81324. isBlocking: boolean;
  81325. /**
  81326. * Get the current sampling mode associated with the texture.
  81327. */
  81328. readonly samplingMode: number;
  81329. /**
  81330. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  81331. */
  81332. readonly invertY: boolean;
  81333. /**
  81334. * Instantiates a new texture.
  81335. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  81336. * @see http://doc.babylonjs.com/babylon101/materials#texture
  81337. * @param url define the url of the picture to load as a texture
  81338. * @param scene define the scene or engine the texture will belong to
  81339. * @param noMipmap define if the texture will require mip maps or not
  81340. * @param invertY define if the texture needs to be inverted on the y axis during loading
  81341. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  81342. * @param onLoad define a callback triggered when the texture has been loaded
  81343. * @param onError define a callback triggered when an error occurred during the loading session
  81344. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  81345. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  81346. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  81347. */
  81348. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | Engine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, deleteBuffer?: boolean, format?: number);
  81349. /**
  81350. * Update the url (and optional buffer) of this texture if url was null during construction.
  81351. * @param url the url of the texture
  81352. * @param buffer the buffer of the texture (defaults to null)
  81353. * @param onLoad callback called when the texture is loaded (defaults to null)
  81354. */
  81355. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  81356. /**
  81357. * Finish the loading sequence of a texture flagged as delayed load.
  81358. * @hidden
  81359. */
  81360. delayLoad(): void;
  81361. private _prepareRowForTextureGeneration;
  81362. /**
  81363. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  81364. * @returns the transform matrix of the texture.
  81365. */
  81366. getTextureMatrix(): Matrix;
  81367. /**
  81368. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  81369. * @returns The reflection texture transform
  81370. */
  81371. getReflectionTextureMatrix(): Matrix;
  81372. /**
  81373. * Clones the texture.
  81374. * @returns the cloned texture
  81375. */
  81376. clone(): Texture;
  81377. /**
  81378. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  81379. * @returns The JSON representation of the texture
  81380. */
  81381. serialize(): any;
  81382. /**
  81383. * Get the current class name of the texture useful for serialization or dynamic coding.
  81384. * @returns "Texture"
  81385. */
  81386. getClassName(): string;
  81387. /**
  81388. * Dispose the texture and release its associated resources.
  81389. */
  81390. dispose(): void;
  81391. /**
  81392. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  81393. * @param parsedTexture Define the JSON representation of the texture
  81394. * @param scene Define the scene the parsed texture should be instantiated in
  81395. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  81396. * @returns The parsed texture if successful
  81397. */
  81398. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  81399. /**
  81400. * Creates a texture from its base 64 representation.
  81401. * @param data Define the base64 payload without the data: prefix
  81402. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  81403. * @param scene Define the scene the texture should belong to
  81404. * @param noMipmap Forces the texture to not create mip map information if true
  81405. * @param invertY define if the texture needs to be inverted on the y axis during loading
  81406. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  81407. * @param onLoad define a callback triggered when the texture has been loaded
  81408. * @param onError define a callback triggered when an error occurred during the loading session
  81409. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  81410. * @returns the created texture
  81411. */
  81412. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  81413. /**
  81414. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  81415. * @param data Define the base64 payload without the data: prefix
  81416. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  81417. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  81418. * @param scene Define the scene the texture should belong to
  81419. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  81420. * @param noMipmap Forces the texture to not create mip map information if true
  81421. * @param invertY define if the texture needs to be inverted on the y axis during loading
  81422. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  81423. * @param onLoad define a callback triggered when the texture has been loaded
  81424. * @param onError define a callback triggered when an error occurred during the loading session
  81425. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  81426. * @returns the created texture
  81427. */
  81428. 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;
  81429. }
  81430. }
  81431. declare module BABYLON {
  81432. /**
  81433. * PostProcessManager is used to manage one or more post processes or post process pipelines
  81434. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  81435. */
  81436. export class PostProcessManager {
  81437. private _scene;
  81438. private _indexBuffer;
  81439. private _vertexBuffers;
  81440. /**
  81441. * Creates a new instance PostProcess
  81442. * @param scene The scene that the post process is associated with.
  81443. */
  81444. constructor(scene: Scene);
  81445. private _prepareBuffers;
  81446. private _buildIndexBuffer;
  81447. /**
  81448. * Rebuilds the vertex buffers of the manager.
  81449. * @hidden
  81450. */
  81451. _rebuild(): void;
  81452. /**
  81453. * Prepares a frame to be run through a post process.
  81454. * @param sourceTexture The input texture to the post procesess. (default: null)
  81455. * @param postProcesses An array of post processes to be run. (default: null)
  81456. * @returns True if the post processes were able to be run.
  81457. * @hidden
  81458. */
  81459. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  81460. /**
  81461. * Manually render a set of post processes to a texture.
  81462. * @param postProcesses An array of post processes to be run.
  81463. * @param targetTexture The target texture to render to.
  81464. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  81465. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  81466. * @param lodLevel defines which lod of the texture to render to
  81467. */
  81468. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  81469. /**
  81470. * Finalize the result of the output of the postprocesses.
  81471. * @param doNotPresent If true the result will not be displayed to the screen.
  81472. * @param targetTexture The target texture to render to.
  81473. * @param faceIndex The index of the face to bind the target texture to.
  81474. * @param postProcesses The array of post processes to render.
  81475. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  81476. * @hidden
  81477. */
  81478. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  81479. /**
  81480. * Disposes of the post process manager.
  81481. */
  81482. dispose(): void;
  81483. }
  81484. }
  81485. declare module BABYLON {
  81486. /** Interface used by value gradients (color, factor, ...) */
  81487. export interface IValueGradient {
  81488. /**
  81489. * Gets or sets the gradient value (between 0 and 1)
  81490. */
  81491. gradient: number;
  81492. }
  81493. /** Class used to store color4 gradient */
  81494. export class ColorGradient implements IValueGradient {
  81495. /**
  81496. * Gets or sets the gradient value (between 0 and 1)
  81497. */
  81498. gradient: number;
  81499. /**
  81500. * Gets or sets first associated color
  81501. */
  81502. color1: Color4;
  81503. /**
  81504. * Gets or sets second associated color
  81505. */
  81506. color2?: Color4;
  81507. /**
  81508. * Will get a color picked randomly between color1 and color2.
  81509. * If color2 is undefined then color1 will be used
  81510. * @param result defines the target Color4 to store the result in
  81511. */
  81512. getColorToRef(result: Color4): void;
  81513. }
  81514. /** Class used to store color 3 gradient */
  81515. export class Color3Gradient implements IValueGradient {
  81516. /**
  81517. * Gets or sets the gradient value (between 0 and 1)
  81518. */
  81519. gradient: number;
  81520. /**
  81521. * Gets or sets the associated color
  81522. */
  81523. color: Color3;
  81524. }
  81525. /** Class used to store factor gradient */
  81526. export class FactorGradient implements IValueGradient {
  81527. /**
  81528. * Gets or sets the gradient value (between 0 and 1)
  81529. */
  81530. gradient: number;
  81531. /**
  81532. * Gets or sets first associated factor
  81533. */
  81534. factor1: number;
  81535. /**
  81536. * Gets or sets second associated factor
  81537. */
  81538. factor2?: number;
  81539. /**
  81540. * Will get a number picked randomly between factor1 and factor2.
  81541. * If factor2 is undefined then factor1 will be used
  81542. * @returns the picked number
  81543. */
  81544. getFactor(): number;
  81545. }
  81546. /**
  81547. * Helper used to simplify some generic gradient tasks
  81548. */
  81549. export class GradientHelper {
  81550. /**
  81551. * Gets the current gradient from an array of IValueGradient
  81552. * @param ratio defines the current ratio to get
  81553. * @param gradients defines the array of IValueGradient
  81554. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  81555. */
  81556. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  81557. }
  81558. }
  81559. declare module BABYLON {
  81560. interface AbstractScene {
  81561. /**
  81562. * The list of procedural textures added to the scene
  81563. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  81564. */
  81565. proceduralTextures: Array<ProceduralTexture>;
  81566. }
  81567. /**
  81568. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  81569. * in a given scene.
  81570. */
  81571. export class ProceduralTextureSceneComponent implements ISceneComponent {
  81572. /**
  81573. * The component name helpfull to identify the component in the list of scene components.
  81574. */
  81575. readonly name: string;
  81576. /**
  81577. * The scene the component belongs to.
  81578. */
  81579. scene: Scene;
  81580. /**
  81581. * Creates a new instance of the component for the given scene
  81582. * @param scene Defines the scene to register the component in
  81583. */
  81584. constructor(scene: Scene);
  81585. /**
  81586. * Registers the component in a given scene
  81587. */
  81588. register(): void;
  81589. /**
  81590. * Rebuilds the elements related to this component in case of
  81591. * context lost for instance.
  81592. */
  81593. rebuild(): void;
  81594. /**
  81595. * Disposes the component and the associated ressources.
  81596. */
  81597. dispose(): void;
  81598. private _beforeClear;
  81599. }
  81600. }
  81601. declare module BABYLON {
  81602. interface Engine {
  81603. /**
  81604. * Creates a new render target cube texture
  81605. * @param size defines the size of the texture
  81606. * @param options defines the options used to create the texture
  81607. * @returns a new render target cube texture stored in an InternalTexture
  81608. */
  81609. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  81610. }
  81611. }
  81612. declare module BABYLON {
  81613. /** @hidden */
  81614. export var proceduralVertexShader: {
  81615. name: string;
  81616. shader: string;
  81617. };
  81618. }
  81619. declare module BABYLON {
  81620. /**
  81621. * 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.
  81622. * This is the base class of any Procedural texture and contains most of the shareable code.
  81623. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  81624. */
  81625. export class ProceduralTexture extends Texture {
  81626. isCube: boolean;
  81627. /**
  81628. * Define if the texture is enabled or not (disabled texture will not render)
  81629. */
  81630. isEnabled: boolean;
  81631. /**
  81632. * Define if the texture must be cleared before rendering (default is true)
  81633. */
  81634. autoClear: boolean;
  81635. /**
  81636. * Callback called when the texture is generated
  81637. */
  81638. onGenerated: () => void;
  81639. /**
  81640. * Event raised when the texture is generated
  81641. */
  81642. onGeneratedObservable: Observable<ProceduralTexture>;
  81643. /** @hidden */
  81644. _generateMipMaps: boolean;
  81645. /** @hidden **/
  81646. _effect: Effect;
  81647. /** @hidden */
  81648. _textures: {
  81649. [key: string]: Texture;
  81650. };
  81651. private _size;
  81652. private _currentRefreshId;
  81653. private _refreshRate;
  81654. private _vertexBuffers;
  81655. private _indexBuffer;
  81656. private _uniforms;
  81657. private _samplers;
  81658. private _fragment;
  81659. private _floats;
  81660. private _ints;
  81661. private _floatsArrays;
  81662. private _colors3;
  81663. private _colors4;
  81664. private _vectors2;
  81665. private _vectors3;
  81666. private _matrices;
  81667. private _fallbackTexture;
  81668. private _fallbackTextureUsed;
  81669. private _engine;
  81670. private _cachedDefines;
  81671. private _contentUpdateId;
  81672. private _contentData;
  81673. /**
  81674. * Instantiates a new procedural texture.
  81675. * 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.
  81676. * This is the base class of any Procedural texture and contains most of the shareable code.
  81677. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  81678. * @param name Define the name of the texture
  81679. * @param size Define the size of the texture to create
  81680. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  81681. * @param scene Define the scene the texture belongs to
  81682. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  81683. * @param generateMipMaps Define if the texture should creates mip maps or not
  81684. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  81685. */
  81686. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  81687. /**
  81688. * The effect that is created when initializing the post process.
  81689. * @returns The created effect corresponding the the postprocess.
  81690. */
  81691. getEffect(): Effect;
  81692. /**
  81693. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  81694. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  81695. */
  81696. getContent(): Nullable<ArrayBufferView>;
  81697. private _createIndexBuffer;
  81698. /** @hidden */
  81699. _rebuild(): void;
  81700. /**
  81701. * Resets the texture in order to recreate its associated resources.
  81702. * This can be called in case of context loss
  81703. */
  81704. reset(): void;
  81705. protected _getDefines(): string;
  81706. /**
  81707. * Is the texture ready to be used ? (rendered at least once)
  81708. * @returns true if ready, otherwise, false.
  81709. */
  81710. isReady(): boolean;
  81711. /**
  81712. * Resets the refresh counter of the texture and start bak from scratch.
  81713. * Could be useful to regenerate the texture if it is setup to render only once.
  81714. */
  81715. resetRefreshCounter(): void;
  81716. /**
  81717. * Set the fragment shader to use in order to render the texture.
  81718. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  81719. */
  81720. setFragment(fragment: any): void;
  81721. /**
  81722. * Define the refresh rate of the texture or the rendering frequency.
  81723. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  81724. */
  81725. refreshRate: number;
  81726. /** @hidden */
  81727. _shouldRender(): boolean;
  81728. /**
  81729. * Get the size the texture is rendering at.
  81730. * @returns the size (texture is always squared)
  81731. */
  81732. getRenderSize(): number;
  81733. /**
  81734. * Resize the texture to new value.
  81735. * @param size Define the new size the texture should have
  81736. * @param generateMipMaps Define whether the new texture should create mip maps
  81737. */
  81738. resize(size: number, generateMipMaps: boolean): void;
  81739. private _checkUniform;
  81740. /**
  81741. * Set a texture in the shader program used to render.
  81742. * @param name Define the name of the uniform samplers as defined in the shader
  81743. * @param texture Define the texture to bind to this sampler
  81744. * @return the texture itself allowing "fluent" like uniform updates
  81745. */
  81746. setTexture(name: string, texture: Texture): ProceduralTexture;
  81747. /**
  81748. * Set a float in the shader.
  81749. * @param name Define the name of the uniform as defined in the shader
  81750. * @param value Define the value to give to the uniform
  81751. * @return the texture itself allowing "fluent" like uniform updates
  81752. */
  81753. setFloat(name: string, value: number): ProceduralTexture;
  81754. /**
  81755. * Set a int in the shader.
  81756. * @param name Define the name of the uniform as defined in the shader
  81757. * @param value Define the value to give to the uniform
  81758. * @return the texture itself allowing "fluent" like uniform updates
  81759. */
  81760. setInt(name: string, value: number): ProceduralTexture;
  81761. /**
  81762. * Set an array of floats in the shader.
  81763. * @param name Define the name of the uniform as defined in the shader
  81764. * @param value Define the value to give to the uniform
  81765. * @return the texture itself allowing "fluent" like uniform updates
  81766. */
  81767. setFloats(name: string, value: number[]): ProceduralTexture;
  81768. /**
  81769. * Set a vec3 in the shader from a Color3.
  81770. * @param name Define the name of the uniform as defined in the shader
  81771. * @param value Define the value to give to the uniform
  81772. * @return the texture itself allowing "fluent" like uniform updates
  81773. */
  81774. setColor3(name: string, value: Color3): ProceduralTexture;
  81775. /**
  81776. * Set a vec4 in the shader from a Color4.
  81777. * @param name Define the name of the uniform as defined in the shader
  81778. * @param value Define the value to give to the uniform
  81779. * @return the texture itself allowing "fluent" like uniform updates
  81780. */
  81781. setColor4(name: string, value: Color4): ProceduralTexture;
  81782. /**
  81783. * Set a vec2 in the shader from a Vector2.
  81784. * @param name Define the name of the uniform as defined in the shader
  81785. * @param value Define the value to give to the uniform
  81786. * @return the texture itself allowing "fluent" like uniform updates
  81787. */
  81788. setVector2(name: string, value: Vector2): ProceduralTexture;
  81789. /**
  81790. * Set a vec3 in the shader from a Vector3.
  81791. * @param name Define the name of the uniform as defined in the shader
  81792. * @param value Define the value to give to the uniform
  81793. * @return the texture itself allowing "fluent" like uniform updates
  81794. */
  81795. setVector3(name: string, value: Vector3): ProceduralTexture;
  81796. /**
  81797. * Set a mat4 in the shader from a MAtrix.
  81798. * @param name Define the name of the uniform as defined in the shader
  81799. * @param value Define the value to give to the uniform
  81800. * @return the texture itself allowing "fluent" like uniform updates
  81801. */
  81802. setMatrix(name: string, value: Matrix): ProceduralTexture;
  81803. /**
  81804. * Render the texture to its associated render target.
  81805. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  81806. */
  81807. render(useCameraPostProcess?: boolean): void;
  81808. /**
  81809. * Clone the texture.
  81810. * @returns the cloned texture
  81811. */
  81812. clone(): ProceduralTexture;
  81813. /**
  81814. * Dispose the texture and release its asoociated resources.
  81815. */
  81816. dispose(): void;
  81817. }
  81818. }
  81819. declare module BABYLON {
  81820. /**
  81821. * This represents the base class for particle system in Babylon.
  81822. * 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.
  81823. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  81824. * @example https://doc.babylonjs.com/babylon101/particles
  81825. */
  81826. export class BaseParticleSystem {
  81827. /**
  81828. * Source color is added to the destination color without alpha affecting the result
  81829. */
  81830. static BLENDMODE_ONEONE: number;
  81831. /**
  81832. * Blend current color and particle color using particle’s alpha
  81833. */
  81834. static BLENDMODE_STANDARD: number;
  81835. /**
  81836. * Add current color and particle color multiplied by particle’s alpha
  81837. */
  81838. static BLENDMODE_ADD: number;
  81839. /**
  81840. * Multiply current color with particle color
  81841. */
  81842. static BLENDMODE_MULTIPLY: number;
  81843. /**
  81844. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  81845. */
  81846. static BLENDMODE_MULTIPLYADD: number;
  81847. /**
  81848. * List of animations used by the particle system.
  81849. */
  81850. animations: Animation[];
  81851. /**
  81852. * The id of the Particle system.
  81853. */
  81854. id: string;
  81855. /**
  81856. * The friendly name of the Particle system.
  81857. */
  81858. name: string;
  81859. /**
  81860. * The rendering group used by the Particle system to chose when to render.
  81861. */
  81862. renderingGroupId: number;
  81863. /**
  81864. * The emitter represents the Mesh or position we are attaching the particle system to.
  81865. */
  81866. emitter: Nullable<AbstractMesh | Vector3>;
  81867. /**
  81868. * The maximum number of particles to emit per frame
  81869. */
  81870. emitRate: number;
  81871. /**
  81872. * If you want to launch only a few particles at once, that can be done, as well.
  81873. */
  81874. manualEmitCount: number;
  81875. /**
  81876. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  81877. */
  81878. updateSpeed: number;
  81879. /**
  81880. * The amount of time the particle system is running (depends of the overall update speed).
  81881. */
  81882. targetStopDuration: number;
  81883. /**
  81884. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  81885. */
  81886. disposeOnStop: boolean;
  81887. /**
  81888. * Minimum power of emitting particles.
  81889. */
  81890. minEmitPower: number;
  81891. /**
  81892. * Maximum power of emitting particles.
  81893. */
  81894. maxEmitPower: number;
  81895. /**
  81896. * Minimum life time of emitting particles.
  81897. */
  81898. minLifeTime: number;
  81899. /**
  81900. * Maximum life time of emitting particles.
  81901. */
  81902. maxLifeTime: number;
  81903. /**
  81904. * Minimum Size of emitting particles.
  81905. */
  81906. minSize: number;
  81907. /**
  81908. * Maximum Size of emitting particles.
  81909. */
  81910. maxSize: number;
  81911. /**
  81912. * Minimum scale of emitting particles on X axis.
  81913. */
  81914. minScaleX: number;
  81915. /**
  81916. * Maximum scale of emitting particles on X axis.
  81917. */
  81918. maxScaleX: number;
  81919. /**
  81920. * Minimum scale of emitting particles on Y axis.
  81921. */
  81922. minScaleY: number;
  81923. /**
  81924. * Maximum scale of emitting particles on Y axis.
  81925. */
  81926. maxScaleY: number;
  81927. /**
  81928. * Gets or sets the minimal initial rotation in radians.
  81929. */
  81930. minInitialRotation: number;
  81931. /**
  81932. * Gets or sets the maximal initial rotation in radians.
  81933. */
  81934. maxInitialRotation: number;
  81935. /**
  81936. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  81937. */
  81938. minAngularSpeed: number;
  81939. /**
  81940. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  81941. */
  81942. maxAngularSpeed: number;
  81943. /**
  81944. * The texture used to render each particle. (this can be a spritesheet)
  81945. */
  81946. particleTexture: Nullable<Texture>;
  81947. /**
  81948. * The layer mask we are rendering the particles through.
  81949. */
  81950. layerMask: number;
  81951. /**
  81952. * This can help using your own shader to render the particle system.
  81953. * The according effect will be created
  81954. */
  81955. customShader: any;
  81956. /**
  81957. * By default particle system starts as soon as they are created. This prevents the
  81958. * automatic start to happen and let you decide when to start emitting particles.
  81959. */
  81960. preventAutoStart: boolean;
  81961. private _noiseTexture;
  81962. /**
  81963. * Gets or sets a texture used to add random noise to particle positions
  81964. */
  81965. noiseTexture: Nullable<ProceduralTexture>;
  81966. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  81967. noiseStrength: Vector3;
  81968. /**
  81969. * Callback triggered when the particle animation is ending.
  81970. */
  81971. onAnimationEnd: Nullable<() => void>;
  81972. /**
  81973. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  81974. */
  81975. blendMode: number;
  81976. /**
  81977. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  81978. * to override the particles.
  81979. */
  81980. forceDepthWrite: boolean;
  81981. /** 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 */
  81982. preWarmCycles: number;
  81983. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  81984. preWarmStepOffset: number;
  81985. /**
  81986. * 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)
  81987. */
  81988. spriteCellChangeSpeed: number;
  81989. /**
  81990. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  81991. */
  81992. startSpriteCellID: number;
  81993. /**
  81994. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  81995. */
  81996. endSpriteCellID: number;
  81997. /**
  81998. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  81999. */
  82000. spriteCellWidth: number;
  82001. /**
  82002. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  82003. */
  82004. spriteCellHeight: number;
  82005. /**
  82006. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  82007. */
  82008. spriteRandomStartCell: boolean;
  82009. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  82010. translationPivot: Vector2;
  82011. /** @hidden */
  82012. protected _isAnimationSheetEnabled: boolean;
  82013. /**
  82014. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  82015. */
  82016. beginAnimationOnStart: boolean;
  82017. /**
  82018. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  82019. */
  82020. beginAnimationFrom: number;
  82021. /**
  82022. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  82023. */
  82024. beginAnimationTo: number;
  82025. /**
  82026. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  82027. */
  82028. beginAnimationLoop: boolean;
  82029. /**
  82030. * Gets or sets a world offset applied to all particles
  82031. */
  82032. worldOffset: Vector3;
  82033. /**
  82034. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  82035. */
  82036. isAnimationSheetEnabled: boolean;
  82037. /**
  82038. * Get hosting scene
  82039. * @returns the scene
  82040. */
  82041. getScene(): Scene;
  82042. /**
  82043. * You can use gravity if you want to give an orientation to your particles.
  82044. */
  82045. gravity: Vector3;
  82046. protected _colorGradients: Nullable<Array<ColorGradient>>;
  82047. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  82048. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  82049. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  82050. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  82051. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  82052. protected _dragGradients: Nullable<Array<FactorGradient>>;
  82053. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  82054. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  82055. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  82056. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  82057. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  82058. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  82059. /**
  82060. * Defines the delay in milliseconds before starting the system (0 by default)
  82061. */
  82062. startDelay: number;
  82063. /**
  82064. * Gets the current list of drag gradients.
  82065. * You must use addDragGradient and removeDragGradient to udpate this list
  82066. * @returns the list of drag gradients
  82067. */
  82068. getDragGradients(): Nullable<Array<FactorGradient>>;
  82069. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  82070. limitVelocityDamping: number;
  82071. /**
  82072. * Gets the current list of limit velocity gradients.
  82073. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  82074. * @returns the list of limit velocity gradients
  82075. */
  82076. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  82077. /**
  82078. * Gets the current list of color gradients.
  82079. * You must use addColorGradient and removeColorGradient to udpate this list
  82080. * @returns the list of color gradients
  82081. */
  82082. getColorGradients(): Nullable<Array<ColorGradient>>;
  82083. /**
  82084. * Gets the current list of size gradients.
  82085. * You must use addSizeGradient and removeSizeGradient to udpate this list
  82086. * @returns the list of size gradients
  82087. */
  82088. getSizeGradients(): Nullable<Array<FactorGradient>>;
  82089. /**
  82090. * Gets the current list of color remap gradients.
  82091. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  82092. * @returns the list of color remap gradients
  82093. */
  82094. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  82095. /**
  82096. * Gets the current list of alpha remap gradients.
  82097. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  82098. * @returns the list of alpha remap gradients
  82099. */
  82100. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  82101. /**
  82102. * Gets the current list of life time gradients.
  82103. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  82104. * @returns the list of life time gradients
  82105. */
  82106. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  82107. /**
  82108. * Gets the current list of angular speed gradients.
  82109. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  82110. * @returns the list of angular speed gradients
  82111. */
  82112. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  82113. /**
  82114. * Gets the current list of velocity gradients.
  82115. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  82116. * @returns the list of velocity gradients
  82117. */
  82118. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  82119. /**
  82120. * Gets the current list of start size gradients.
  82121. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  82122. * @returns the list of start size gradients
  82123. */
  82124. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  82125. /**
  82126. * Gets the current list of emit rate gradients.
  82127. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  82128. * @returns the list of emit rate gradients
  82129. */
  82130. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  82131. /**
  82132. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  82133. * This only works when particleEmitterTyps is a BoxParticleEmitter
  82134. */
  82135. direction1: Vector3;
  82136. /**
  82137. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  82138. * This only works when particleEmitterTyps is a BoxParticleEmitter
  82139. */
  82140. direction2: Vector3;
  82141. /**
  82142. * 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.
  82143. * This only works when particleEmitterTyps is a BoxParticleEmitter
  82144. */
  82145. minEmitBox: Vector3;
  82146. /**
  82147. * 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.
  82148. * This only works when particleEmitterTyps is a BoxParticleEmitter
  82149. */
  82150. maxEmitBox: Vector3;
  82151. /**
  82152. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  82153. */
  82154. color1: Color4;
  82155. /**
  82156. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  82157. */
  82158. color2: Color4;
  82159. /**
  82160. * Color the particle will have at the end of its lifetime
  82161. */
  82162. colorDead: Color4;
  82163. /**
  82164. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  82165. */
  82166. textureMask: Color4;
  82167. /**
  82168. * The particle emitter type defines the emitter used by the particle system.
  82169. * It can be for example box, sphere, or cone...
  82170. */
  82171. particleEmitterType: IParticleEmitterType;
  82172. /** @hidden */
  82173. _isSubEmitter: boolean;
  82174. /**
  82175. * Gets or sets the billboard mode to use when isBillboardBased = true.
  82176. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  82177. */
  82178. billboardMode: number;
  82179. protected _isBillboardBased: boolean;
  82180. /**
  82181. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  82182. */
  82183. isBillboardBased: boolean;
  82184. /**
  82185. * The scene the particle system belongs to.
  82186. */
  82187. protected _scene: Scene;
  82188. /**
  82189. * Local cache of defines for image processing.
  82190. */
  82191. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  82192. /**
  82193. * Default configuration related to image processing available in the standard Material.
  82194. */
  82195. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  82196. /**
  82197. * Gets the image processing configuration used either in this material.
  82198. */
  82199. /**
  82200. * Sets the Default image processing configuration used either in the this material.
  82201. *
  82202. * If sets to null, the scene one is in use.
  82203. */
  82204. imageProcessingConfiguration: ImageProcessingConfiguration;
  82205. /**
  82206. * Attaches a new image processing configuration to the Standard Material.
  82207. * @param configuration
  82208. */
  82209. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  82210. /** @hidden */
  82211. protected _reset(): void;
  82212. /** @hidden */
  82213. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  82214. /**
  82215. * Instantiates a particle system.
  82216. * 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.
  82217. * @param name The name of the particle system
  82218. */
  82219. constructor(name: string);
  82220. /**
  82221. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  82222. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  82223. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  82224. * @returns the emitter
  82225. */
  82226. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  82227. /**
  82228. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  82229. * @param radius The radius of the hemisphere to emit from
  82230. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  82231. * @returns the emitter
  82232. */
  82233. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  82234. /**
  82235. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  82236. * @param radius The radius of the sphere to emit from
  82237. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  82238. * @returns the emitter
  82239. */
  82240. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  82241. /**
  82242. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  82243. * @param radius The radius of the sphere to emit from
  82244. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  82245. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  82246. * @returns the emitter
  82247. */
  82248. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  82249. /**
  82250. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  82251. * @param radius The radius of the emission cylinder
  82252. * @param height The height of the emission cylinder
  82253. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  82254. * @param directionRandomizer How much to randomize the particle direction [0-1]
  82255. * @returns the emitter
  82256. */
  82257. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  82258. /**
  82259. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  82260. * @param radius The radius of the cylinder to emit from
  82261. * @param height The height of the emission cylinder
  82262. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  82263. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  82264. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  82265. * @returns the emitter
  82266. */
  82267. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  82268. /**
  82269. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  82270. * @param radius The radius of the cone to emit from
  82271. * @param angle The base angle of the cone
  82272. * @returns the emitter
  82273. */
  82274. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  82275. /**
  82276. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  82277. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  82278. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  82279. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  82280. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  82281. * @returns the emitter
  82282. */
  82283. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  82284. }
  82285. }
  82286. declare module BABYLON {
  82287. /**
  82288. * Type of sub emitter
  82289. */
  82290. export enum SubEmitterType {
  82291. /**
  82292. * Attached to the particle over it's lifetime
  82293. */
  82294. ATTACHED = 0,
  82295. /**
  82296. * Created when the particle dies
  82297. */
  82298. END = 1
  82299. }
  82300. /**
  82301. * Sub emitter class used to emit particles from an existing particle
  82302. */
  82303. export class SubEmitter {
  82304. /**
  82305. * the particle system to be used by the sub emitter
  82306. */
  82307. particleSystem: ParticleSystem;
  82308. /**
  82309. * Type of the submitter (Default: END)
  82310. */
  82311. type: SubEmitterType;
  82312. /**
  82313. * 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)
  82314. * Note: This only is supported when using an emitter of type Mesh
  82315. */
  82316. inheritDirection: boolean;
  82317. /**
  82318. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  82319. */
  82320. inheritedVelocityAmount: number;
  82321. /**
  82322. * Creates a sub emitter
  82323. * @param particleSystem the particle system to be used by the sub emitter
  82324. */
  82325. constructor(
  82326. /**
  82327. * the particle system to be used by the sub emitter
  82328. */
  82329. particleSystem: ParticleSystem);
  82330. /**
  82331. * Clones the sub emitter
  82332. * @returns the cloned sub emitter
  82333. */
  82334. clone(): SubEmitter;
  82335. /**
  82336. * Serialize current object to a JSON object
  82337. * @returns the serialized object
  82338. */
  82339. serialize(): any;
  82340. /** @hidden */
  82341. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  82342. /**
  82343. * Creates a new SubEmitter from a serialized JSON version
  82344. * @param serializationObject defines the JSON object to read from
  82345. * @param scene defines the hosting scene
  82346. * @param rootUrl defines the rootUrl for data loading
  82347. * @returns a new SubEmitter
  82348. */
  82349. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  82350. /** Release associated resources */
  82351. dispose(): void;
  82352. }
  82353. }
  82354. declare module BABYLON {
  82355. /** @hidden */
  82356. export var clipPlaneFragmentDeclaration: {
  82357. name: string;
  82358. shader: string;
  82359. };
  82360. }
  82361. declare module BABYLON {
  82362. /** @hidden */
  82363. export var imageProcessingDeclaration: {
  82364. name: string;
  82365. shader: string;
  82366. };
  82367. }
  82368. declare module BABYLON {
  82369. /** @hidden */
  82370. export var imageProcessingFunctions: {
  82371. name: string;
  82372. shader: string;
  82373. };
  82374. }
  82375. declare module BABYLON {
  82376. /** @hidden */
  82377. export var clipPlaneFragment: {
  82378. name: string;
  82379. shader: string;
  82380. };
  82381. }
  82382. declare module BABYLON {
  82383. /** @hidden */
  82384. export var particlesPixelShader: {
  82385. name: string;
  82386. shader: string;
  82387. };
  82388. }
  82389. declare module BABYLON {
  82390. /** @hidden */
  82391. export var clipPlaneVertexDeclaration: {
  82392. name: string;
  82393. shader: string;
  82394. };
  82395. }
  82396. declare module BABYLON {
  82397. /** @hidden */
  82398. export var clipPlaneVertex: {
  82399. name: string;
  82400. shader: string;
  82401. };
  82402. }
  82403. declare module BABYLON {
  82404. /** @hidden */
  82405. export var particlesVertexShader: {
  82406. name: string;
  82407. shader: string;
  82408. };
  82409. }
  82410. declare module BABYLON {
  82411. /**
  82412. * This represents a particle system in Babylon.
  82413. * 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.
  82414. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  82415. * @example https://doc.babylonjs.com/babylon101/particles
  82416. */
  82417. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  82418. /**
  82419. * Billboard mode will only apply to Y axis
  82420. */
  82421. static readonly BILLBOARDMODE_Y: number;
  82422. /**
  82423. * Billboard mode will apply to all axes
  82424. */
  82425. static readonly BILLBOARDMODE_ALL: number;
  82426. /**
  82427. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  82428. */
  82429. static readonly BILLBOARDMODE_STRETCHED: number;
  82430. /**
  82431. * This function can be defined to provide custom update for active particles.
  82432. * This function will be called instead of regular update (age, position, color, etc.).
  82433. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  82434. */
  82435. updateFunction: (particles: Particle[]) => void;
  82436. private _emitterWorldMatrix;
  82437. /**
  82438. * This function can be defined to specify initial direction for every new particle.
  82439. * It by default use the emitterType defined function
  82440. */
  82441. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  82442. /**
  82443. * This function can be defined to specify initial position for every new particle.
  82444. * It by default use the emitterType defined function
  82445. */
  82446. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  82447. /**
  82448. * @hidden
  82449. */
  82450. _inheritedVelocityOffset: Vector3;
  82451. /**
  82452. * An event triggered when the system is disposed
  82453. */
  82454. onDisposeObservable: Observable<ParticleSystem>;
  82455. private _onDisposeObserver;
  82456. /**
  82457. * Sets a callback that will be triggered when the system is disposed
  82458. */
  82459. onDispose: () => void;
  82460. private _particles;
  82461. private _epsilon;
  82462. private _capacity;
  82463. private _stockParticles;
  82464. private _newPartsExcess;
  82465. private _vertexData;
  82466. private _vertexBuffer;
  82467. private _vertexBuffers;
  82468. private _spriteBuffer;
  82469. private _indexBuffer;
  82470. private _effect;
  82471. private _customEffect;
  82472. private _cachedDefines;
  82473. private _scaledColorStep;
  82474. private _colorDiff;
  82475. private _scaledDirection;
  82476. private _scaledGravity;
  82477. private _currentRenderId;
  82478. private _alive;
  82479. private _useInstancing;
  82480. private _started;
  82481. private _stopped;
  82482. private _actualFrame;
  82483. private _scaledUpdateSpeed;
  82484. private _vertexBufferSize;
  82485. /** @hidden */
  82486. _currentEmitRateGradient: Nullable<FactorGradient>;
  82487. /** @hidden */
  82488. _currentEmitRate1: number;
  82489. /** @hidden */
  82490. _currentEmitRate2: number;
  82491. /** @hidden */
  82492. _currentStartSizeGradient: Nullable<FactorGradient>;
  82493. /** @hidden */
  82494. _currentStartSize1: number;
  82495. /** @hidden */
  82496. _currentStartSize2: number;
  82497. private readonly _rawTextureWidth;
  82498. private _rampGradientsTexture;
  82499. private _useRampGradients;
  82500. /** Gets or sets a boolean indicating that ramp gradients must be used
  82501. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  82502. */
  82503. useRampGradients: boolean;
  82504. /**
  82505. * 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.
  82506. * 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: [])
  82507. */
  82508. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  82509. private _subEmitters;
  82510. /**
  82511. * @hidden
  82512. * If the particle systems emitter should be disposed when the particle system is disposed
  82513. */
  82514. _disposeEmitterOnDispose: boolean;
  82515. /**
  82516. * The current active Sub-systems, this property is used by the root particle system only.
  82517. */
  82518. activeSubSystems: Array<ParticleSystem>;
  82519. private _rootParticleSystem;
  82520. /**
  82521. * Gets the current list of active particles
  82522. */
  82523. readonly particles: Particle[];
  82524. /**
  82525. * Returns the string "ParticleSystem"
  82526. * @returns a string containing the class name
  82527. */
  82528. getClassName(): string;
  82529. /**
  82530. * Instantiates a particle system.
  82531. * 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.
  82532. * @param name The name of the particle system
  82533. * @param capacity The max number of particles alive at the same time
  82534. * @param scene The scene the particle system belongs to
  82535. * @param customEffect a custom effect used to change the way particles are rendered by default
  82536. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  82537. * @param epsilon Offset used to render the particles
  82538. */
  82539. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  82540. private _addFactorGradient;
  82541. private _removeFactorGradient;
  82542. /**
  82543. * Adds a new life time gradient
  82544. * @param gradient defines the gradient to use (between 0 and 1)
  82545. * @param factor defines the life time factor to affect to the specified gradient
  82546. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82547. * @returns the current particle system
  82548. */
  82549. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82550. /**
  82551. * Remove a specific life time gradient
  82552. * @param gradient defines the gradient to remove
  82553. * @returns the current particle system
  82554. */
  82555. removeLifeTimeGradient(gradient: number): IParticleSystem;
  82556. /**
  82557. * Adds a new size gradient
  82558. * @param gradient defines the gradient to use (between 0 and 1)
  82559. * @param factor defines the size factor to affect to the specified gradient
  82560. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82561. * @returns the current particle system
  82562. */
  82563. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82564. /**
  82565. * Remove a specific size gradient
  82566. * @param gradient defines the gradient to remove
  82567. * @returns the current particle system
  82568. */
  82569. removeSizeGradient(gradient: number): IParticleSystem;
  82570. /**
  82571. * Adds a new color remap gradient
  82572. * @param gradient defines the gradient to use (between 0 and 1)
  82573. * @param min defines the color remap minimal range
  82574. * @param max defines the color remap maximal range
  82575. * @returns the current particle system
  82576. */
  82577. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  82578. /**
  82579. * Remove a specific color remap gradient
  82580. * @param gradient defines the gradient to remove
  82581. * @returns the current particle system
  82582. */
  82583. removeColorRemapGradient(gradient: number): IParticleSystem;
  82584. /**
  82585. * Adds a new alpha remap gradient
  82586. * @param gradient defines the gradient to use (between 0 and 1)
  82587. * @param min defines the alpha remap minimal range
  82588. * @param max defines the alpha remap maximal range
  82589. * @returns the current particle system
  82590. */
  82591. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  82592. /**
  82593. * Remove a specific alpha remap gradient
  82594. * @param gradient defines the gradient to remove
  82595. * @returns the current particle system
  82596. */
  82597. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  82598. /**
  82599. * Adds a new angular speed gradient
  82600. * @param gradient defines the gradient to use (between 0 and 1)
  82601. * @param factor defines the angular speed to affect to the specified gradient
  82602. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82603. * @returns the current particle system
  82604. */
  82605. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82606. /**
  82607. * Remove a specific angular speed gradient
  82608. * @param gradient defines the gradient to remove
  82609. * @returns the current particle system
  82610. */
  82611. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  82612. /**
  82613. * Adds a new velocity gradient
  82614. * @param gradient defines the gradient to use (between 0 and 1)
  82615. * @param factor defines the velocity to affect to the specified gradient
  82616. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82617. * @returns the current particle system
  82618. */
  82619. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82620. /**
  82621. * Remove a specific velocity gradient
  82622. * @param gradient defines the gradient to remove
  82623. * @returns the current particle system
  82624. */
  82625. removeVelocityGradient(gradient: number): IParticleSystem;
  82626. /**
  82627. * Adds a new limit velocity gradient
  82628. * @param gradient defines the gradient to use (between 0 and 1)
  82629. * @param factor defines the limit velocity value to affect to the specified gradient
  82630. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82631. * @returns the current particle system
  82632. */
  82633. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82634. /**
  82635. * Remove a specific limit velocity gradient
  82636. * @param gradient defines the gradient to remove
  82637. * @returns the current particle system
  82638. */
  82639. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  82640. /**
  82641. * Adds a new drag gradient
  82642. * @param gradient defines the gradient to use (between 0 and 1)
  82643. * @param factor defines the drag value to affect to the specified gradient
  82644. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82645. * @returns the current particle system
  82646. */
  82647. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82648. /**
  82649. * Remove a specific drag gradient
  82650. * @param gradient defines the gradient to remove
  82651. * @returns the current particle system
  82652. */
  82653. removeDragGradient(gradient: number): IParticleSystem;
  82654. /**
  82655. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  82656. * @param gradient defines the gradient to use (between 0 and 1)
  82657. * @param factor defines the emit rate value to affect to the specified gradient
  82658. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82659. * @returns the current particle system
  82660. */
  82661. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82662. /**
  82663. * Remove a specific emit rate gradient
  82664. * @param gradient defines the gradient to remove
  82665. * @returns the current particle system
  82666. */
  82667. removeEmitRateGradient(gradient: number): IParticleSystem;
  82668. /**
  82669. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  82670. * @param gradient defines the gradient to use (between 0 and 1)
  82671. * @param factor defines the start size value to affect to the specified gradient
  82672. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82673. * @returns the current particle system
  82674. */
  82675. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82676. /**
  82677. * Remove a specific start size gradient
  82678. * @param gradient defines the gradient to remove
  82679. * @returns the current particle system
  82680. */
  82681. removeStartSizeGradient(gradient: number): IParticleSystem;
  82682. private _createRampGradientTexture;
  82683. /**
  82684. * Gets the current list of ramp gradients.
  82685. * You must use addRampGradient and removeRampGradient to udpate this list
  82686. * @returns the list of ramp gradients
  82687. */
  82688. getRampGradients(): Nullable<Array<Color3Gradient>>;
  82689. /**
  82690. * Adds a new ramp gradient used to remap particle colors
  82691. * @param gradient defines the gradient to use (between 0 and 1)
  82692. * @param color defines the color to affect to the specified gradient
  82693. * @returns the current particle system
  82694. */
  82695. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  82696. /**
  82697. * Remove a specific ramp gradient
  82698. * @param gradient defines the gradient to remove
  82699. * @returns the current particle system
  82700. */
  82701. removeRampGradient(gradient: number): ParticleSystem;
  82702. /**
  82703. * Adds a new color gradient
  82704. * @param gradient defines the gradient to use (between 0 and 1)
  82705. * @param color1 defines the color to affect to the specified gradient
  82706. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  82707. * @returns this particle system
  82708. */
  82709. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  82710. /**
  82711. * Remove a specific color gradient
  82712. * @param gradient defines the gradient to remove
  82713. * @returns this particle system
  82714. */
  82715. removeColorGradient(gradient: number): IParticleSystem;
  82716. private _fetchR;
  82717. protected _reset(): void;
  82718. private _resetEffect;
  82719. private _createVertexBuffers;
  82720. private _createIndexBuffer;
  82721. /**
  82722. * Gets the maximum number of particles active at the same time.
  82723. * @returns The max number of active particles.
  82724. */
  82725. getCapacity(): number;
  82726. /**
  82727. * Gets whether there are still active particles in the system.
  82728. * @returns True if it is alive, otherwise false.
  82729. */
  82730. isAlive(): boolean;
  82731. /**
  82732. * Gets if the system has been started. (Note: this will still be true after stop is called)
  82733. * @returns True if it has been started, otherwise false.
  82734. */
  82735. isStarted(): boolean;
  82736. private _prepareSubEmitterInternalArray;
  82737. /**
  82738. * Starts the particle system and begins to emit
  82739. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  82740. */
  82741. start(delay?: number): void;
  82742. /**
  82743. * Stops the particle system.
  82744. * @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.
  82745. */
  82746. stop(stopSubEmitters?: boolean): void;
  82747. /**
  82748. * Remove all active particles
  82749. */
  82750. reset(): void;
  82751. /**
  82752. * @hidden (for internal use only)
  82753. */
  82754. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  82755. /**
  82756. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  82757. * Its lifetime will start back at 0.
  82758. */
  82759. recycleParticle: (particle: Particle) => void;
  82760. private _stopSubEmitters;
  82761. private _createParticle;
  82762. private _removeFromRoot;
  82763. private _emitFromParticle;
  82764. private _update;
  82765. /** @hidden */
  82766. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  82767. /** @hidden */
  82768. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  82769. /** @hidden */
  82770. private _getEffect;
  82771. /**
  82772. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  82773. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  82774. */
  82775. animate(preWarmOnly?: boolean): void;
  82776. private _appendParticleVertices;
  82777. /**
  82778. * Rebuilds the particle system.
  82779. */
  82780. rebuild(): void;
  82781. /**
  82782. * Is this system ready to be used/rendered
  82783. * @return true if the system is ready
  82784. */
  82785. isReady(): boolean;
  82786. private _render;
  82787. /**
  82788. * Renders the particle system in its current state.
  82789. * @returns the current number of particles
  82790. */
  82791. render(): number;
  82792. /**
  82793. * Disposes the particle system and free the associated resources
  82794. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  82795. */
  82796. dispose(disposeTexture?: boolean): void;
  82797. /**
  82798. * Clones the particle system.
  82799. * @param name The name of the cloned object
  82800. * @param newEmitter The new emitter to use
  82801. * @returns the cloned particle system
  82802. */
  82803. clone(name: string, newEmitter: any): ParticleSystem;
  82804. /**
  82805. * Serializes the particle system to a JSON object.
  82806. * @returns the JSON object
  82807. */
  82808. serialize(): any;
  82809. /** @hidden */
  82810. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  82811. /** @hidden */
  82812. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  82813. /**
  82814. * Parses a JSON object to create a particle system.
  82815. * @param parsedParticleSystem The JSON object to parse
  82816. * @param scene The scene to create the particle system in
  82817. * @param rootUrl The root url to use to load external dependencies like texture
  82818. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  82819. * @returns the Parsed particle system
  82820. */
  82821. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  82822. }
  82823. }
  82824. declare module BABYLON {
  82825. /**
  82826. * A particle represents one of the element emitted by a particle system.
  82827. * This is mainly define by its coordinates, direction, velocity and age.
  82828. */
  82829. export class Particle {
  82830. /**
  82831. * The particle system the particle belongs to.
  82832. */
  82833. particleSystem: ParticleSystem;
  82834. private static _Count;
  82835. /**
  82836. * Unique ID of the particle
  82837. */
  82838. id: number;
  82839. /**
  82840. * The world position of the particle in the scene.
  82841. */
  82842. position: Vector3;
  82843. /**
  82844. * The world direction of the particle in the scene.
  82845. */
  82846. direction: Vector3;
  82847. /**
  82848. * The color of the particle.
  82849. */
  82850. color: Color4;
  82851. /**
  82852. * The color change of the particle per step.
  82853. */
  82854. colorStep: Color4;
  82855. /**
  82856. * Defines how long will the life of the particle be.
  82857. */
  82858. lifeTime: number;
  82859. /**
  82860. * The current age of the particle.
  82861. */
  82862. age: number;
  82863. /**
  82864. * The current size of the particle.
  82865. */
  82866. size: number;
  82867. /**
  82868. * The current scale of the particle.
  82869. */
  82870. scale: Vector2;
  82871. /**
  82872. * The current angle of the particle.
  82873. */
  82874. angle: number;
  82875. /**
  82876. * Defines how fast is the angle changing.
  82877. */
  82878. angularSpeed: number;
  82879. /**
  82880. * Defines the cell index used by the particle to be rendered from a sprite.
  82881. */
  82882. cellIndex: number;
  82883. /**
  82884. * The information required to support color remapping
  82885. */
  82886. remapData: Vector4;
  82887. /** @hidden */
  82888. _randomCellOffset?: number;
  82889. /** @hidden */
  82890. _initialDirection: Nullable<Vector3>;
  82891. /** @hidden */
  82892. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  82893. /** @hidden */
  82894. _initialStartSpriteCellID: number;
  82895. /** @hidden */
  82896. _initialEndSpriteCellID: number;
  82897. /** @hidden */
  82898. _currentColorGradient: Nullable<ColorGradient>;
  82899. /** @hidden */
  82900. _currentColor1: Color4;
  82901. /** @hidden */
  82902. _currentColor2: Color4;
  82903. /** @hidden */
  82904. _currentSizeGradient: Nullable<FactorGradient>;
  82905. /** @hidden */
  82906. _currentSize1: number;
  82907. /** @hidden */
  82908. _currentSize2: number;
  82909. /** @hidden */
  82910. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  82911. /** @hidden */
  82912. _currentAngularSpeed1: number;
  82913. /** @hidden */
  82914. _currentAngularSpeed2: number;
  82915. /** @hidden */
  82916. _currentVelocityGradient: Nullable<FactorGradient>;
  82917. /** @hidden */
  82918. _currentVelocity1: number;
  82919. /** @hidden */
  82920. _currentVelocity2: number;
  82921. /** @hidden */
  82922. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  82923. /** @hidden */
  82924. _currentLimitVelocity1: number;
  82925. /** @hidden */
  82926. _currentLimitVelocity2: number;
  82927. /** @hidden */
  82928. _currentDragGradient: Nullable<FactorGradient>;
  82929. /** @hidden */
  82930. _currentDrag1: number;
  82931. /** @hidden */
  82932. _currentDrag2: number;
  82933. /** @hidden */
  82934. _randomNoiseCoordinates1: Vector3;
  82935. /** @hidden */
  82936. _randomNoiseCoordinates2: Vector3;
  82937. /**
  82938. * Creates a new instance Particle
  82939. * @param particleSystem the particle system the particle belongs to
  82940. */
  82941. constructor(
  82942. /**
  82943. * The particle system the particle belongs to.
  82944. */
  82945. particleSystem: ParticleSystem);
  82946. private updateCellInfoFromSystem;
  82947. /**
  82948. * Defines how the sprite cell index is updated for the particle
  82949. */
  82950. updateCellIndex(): void;
  82951. /** @hidden */
  82952. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  82953. /** @hidden */
  82954. _inheritParticleInfoToSubEmitters(): void;
  82955. /** @hidden */
  82956. _reset(): void;
  82957. /**
  82958. * Copy the properties of particle to another one.
  82959. * @param other the particle to copy the information to.
  82960. */
  82961. copyTo(other: Particle): void;
  82962. }
  82963. }
  82964. declare module BABYLON {
  82965. /**
  82966. * Particle emitter represents a volume emitting particles.
  82967. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  82968. */
  82969. export interface IParticleEmitterType {
  82970. /**
  82971. * Called by the particle System when the direction is computed for the created particle.
  82972. * @param worldMatrix is the world matrix of the particle system
  82973. * @param directionToUpdate is the direction vector to update with the result
  82974. * @param particle is the particle we are computed the direction for
  82975. */
  82976. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  82977. /**
  82978. * Called by the particle System when the position is computed for the created particle.
  82979. * @param worldMatrix is the world matrix of the particle system
  82980. * @param positionToUpdate is the position vector to update with the result
  82981. * @param particle is the particle we are computed the position for
  82982. */
  82983. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  82984. /**
  82985. * Clones the current emitter and returns a copy of it
  82986. * @returns the new emitter
  82987. */
  82988. clone(): IParticleEmitterType;
  82989. /**
  82990. * Called by the GPUParticleSystem to setup the update shader
  82991. * @param effect defines the update shader
  82992. */
  82993. applyToShader(effect: Effect): void;
  82994. /**
  82995. * Returns a string to use to update the GPU particles update shader
  82996. * @returns the effect defines string
  82997. */
  82998. getEffectDefines(): string;
  82999. /**
  83000. * Returns a string representing the class name
  83001. * @returns a string containing the class name
  83002. */
  83003. getClassName(): string;
  83004. /**
  83005. * Serializes the particle system to a JSON object.
  83006. * @returns the JSON object
  83007. */
  83008. serialize(): any;
  83009. /**
  83010. * Parse properties from a JSON object
  83011. * @param serializationObject defines the JSON object
  83012. */
  83013. parse(serializationObject: any): void;
  83014. }
  83015. }
  83016. declare module BABYLON {
  83017. /**
  83018. * Particle emitter emitting particles from the inside of a box.
  83019. * It emits the particles randomly between 2 given directions.
  83020. */
  83021. export class BoxParticleEmitter implements IParticleEmitterType {
  83022. /**
  83023. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  83024. */
  83025. direction1: Vector3;
  83026. /**
  83027. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  83028. */
  83029. direction2: Vector3;
  83030. /**
  83031. * 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.
  83032. */
  83033. minEmitBox: Vector3;
  83034. /**
  83035. * 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.
  83036. */
  83037. maxEmitBox: Vector3;
  83038. /**
  83039. * Creates a new instance BoxParticleEmitter
  83040. */
  83041. constructor();
  83042. /**
  83043. * Called by the particle System when the direction is computed for the created particle.
  83044. * @param worldMatrix is the world matrix of the particle system
  83045. * @param directionToUpdate is the direction vector to update with the result
  83046. * @param particle is the particle we are computed the direction for
  83047. */
  83048. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83049. /**
  83050. * Called by the particle System when the position is computed for the created particle.
  83051. * @param worldMatrix is the world matrix of the particle system
  83052. * @param positionToUpdate is the position vector to update with the result
  83053. * @param particle is the particle we are computed the position for
  83054. */
  83055. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83056. /**
  83057. * Clones the current emitter and returns a copy of it
  83058. * @returns the new emitter
  83059. */
  83060. clone(): BoxParticleEmitter;
  83061. /**
  83062. * Called by the GPUParticleSystem to setup the update shader
  83063. * @param effect defines the update shader
  83064. */
  83065. applyToShader(effect: Effect): void;
  83066. /**
  83067. * Returns a string to use to update the GPU particles update shader
  83068. * @returns a string containng the defines string
  83069. */
  83070. getEffectDefines(): string;
  83071. /**
  83072. * Returns the string "BoxParticleEmitter"
  83073. * @returns a string containing the class name
  83074. */
  83075. getClassName(): string;
  83076. /**
  83077. * Serializes the particle system to a JSON object.
  83078. * @returns the JSON object
  83079. */
  83080. serialize(): any;
  83081. /**
  83082. * Parse properties from a JSON object
  83083. * @param serializationObject defines the JSON object
  83084. */
  83085. parse(serializationObject: any): void;
  83086. }
  83087. }
  83088. declare module BABYLON {
  83089. /**
  83090. * Particle emitter emitting particles from the inside of a cone.
  83091. * It emits the particles alongside the cone volume from the base to the particle.
  83092. * The emission direction might be randomized.
  83093. */
  83094. export class ConeParticleEmitter implements IParticleEmitterType {
  83095. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  83096. directionRandomizer: number;
  83097. private _radius;
  83098. private _angle;
  83099. private _height;
  83100. /**
  83101. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  83102. */
  83103. radiusRange: number;
  83104. /**
  83105. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  83106. */
  83107. heightRange: number;
  83108. /**
  83109. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  83110. */
  83111. emitFromSpawnPointOnly: boolean;
  83112. /**
  83113. * Gets or sets the radius of the emission cone
  83114. */
  83115. radius: number;
  83116. /**
  83117. * Gets or sets the angle of the emission cone
  83118. */
  83119. angle: number;
  83120. private _buildHeight;
  83121. /**
  83122. * Creates a new instance ConeParticleEmitter
  83123. * @param radius the radius of the emission cone (1 by default)
  83124. * @param angle the cone base angle (PI by default)
  83125. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  83126. */
  83127. constructor(radius?: number, angle?: number,
  83128. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  83129. directionRandomizer?: number);
  83130. /**
  83131. * Called by the particle System when the direction is computed for the created particle.
  83132. * @param worldMatrix is the world matrix of the particle system
  83133. * @param directionToUpdate is the direction vector to update with the result
  83134. * @param particle is the particle we are computed the direction for
  83135. */
  83136. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83137. /**
  83138. * Called by the particle System when the position is computed for the created particle.
  83139. * @param worldMatrix is the world matrix of the particle system
  83140. * @param positionToUpdate is the position vector to update with the result
  83141. * @param particle is the particle we are computed the position for
  83142. */
  83143. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83144. /**
  83145. * Clones the current emitter and returns a copy of it
  83146. * @returns the new emitter
  83147. */
  83148. clone(): ConeParticleEmitter;
  83149. /**
  83150. * Called by the GPUParticleSystem to setup the update shader
  83151. * @param effect defines the update shader
  83152. */
  83153. applyToShader(effect: Effect): void;
  83154. /**
  83155. * Returns a string to use to update the GPU particles update shader
  83156. * @returns a string containng the defines string
  83157. */
  83158. getEffectDefines(): string;
  83159. /**
  83160. * Returns the string "ConeParticleEmitter"
  83161. * @returns a string containing the class name
  83162. */
  83163. getClassName(): string;
  83164. /**
  83165. * Serializes the particle system to a JSON object.
  83166. * @returns the JSON object
  83167. */
  83168. serialize(): any;
  83169. /**
  83170. * Parse properties from a JSON object
  83171. * @param serializationObject defines the JSON object
  83172. */
  83173. parse(serializationObject: any): void;
  83174. }
  83175. }
  83176. declare module BABYLON {
  83177. /**
  83178. * Particle emitter emitting particles from the inside of a cylinder.
  83179. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  83180. */
  83181. export class CylinderParticleEmitter implements IParticleEmitterType {
  83182. /**
  83183. * The radius of the emission cylinder.
  83184. */
  83185. radius: number;
  83186. /**
  83187. * The height of the emission cylinder.
  83188. */
  83189. height: number;
  83190. /**
  83191. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83192. */
  83193. radiusRange: number;
  83194. /**
  83195. * How much to randomize the particle direction [0-1].
  83196. */
  83197. directionRandomizer: number;
  83198. /**
  83199. * Creates a new instance CylinderParticleEmitter
  83200. * @param radius the radius of the emission cylinder (1 by default)
  83201. * @param height the height of the emission cylinder (1 by default)
  83202. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  83203. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  83204. */
  83205. constructor(
  83206. /**
  83207. * The radius of the emission cylinder.
  83208. */
  83209. radius?: number,
  83210. /**
  83211. * The height of the emission cylinder.
  83212. */
  83213. height?: number,
  83214. /**
  83215. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83216. */
  83217. radiusRange?: number,
  83218. /**
  83219. * How much to randomize the particle direction [0-1].
  83220. */
  83221. directionRandomizer?: number);
  83222. /**
  83223. * Called by the particle System when the direction is computed for the created particle.
  83224. * @param worldMatrix is the world matrix of the particle system
  83225. * @param directionToUpdate is the direction vector to update with the result
  83226. * @param particle is the particle we are computed the direction for
  83227. */
  83228. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83229. /**
  83230. * Called by the particle System when the position is computed for the created particle.
  83231. * @param worldMatrix is the world matrix of the particle system
  83232. * @param positionToUpdate is the position vector to update with the result
  83233. * @param particle is the particle we are computed the position for
  83234. */
  83235. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83236. /**
  83237. * Clones the current emitter and returns a copy of it
  83238. * @returns the new emitter
  83239. */
  83240. clone(): CylinderParticleEmitter;
  83241. /**
  83242. * Called by the GPUParticleSystem to setup the update shader
  83243. * @param effect defines the update shader
  83244. */
  83245. applyToShader(effect: Effect): void;
  83246. /**
  83247. * Returns a string to use to update the GPU particles update shader
  83248. * @returns a string containng the defines string
  83249. */
  83250. getEffectDefines(): string;
  83251. /**
  83252. * Returns the string "CylinderParticleEmitter"
  83253. * @returns a string containing the class name
  83254. */
  83255. getClassName(): string;
  83256. /**
  83257. * Serializes the particle system to a JSON object.
  83258. * @returns the JSON object
  83259. */
  83260. serialize(): any;
  83261. /**
  83262. * Parse properties from a JSON object
  83263. * @param serializationObject defines the JSON object
  83264. */
  83265. parse(serializationObject: any): void;
  83266. }
  83267. /**
  83268. * Particle emitter emitting particles from the inside of a cylinder.
  83269. * It emits the particles randomly between two vectors.
  83270. */
  83271. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  83272. /**
  83273. * The min limit of the emission direction.
  83274. */
  83275. direction1: Vector3;
  83276. /**
  83277. * The max limit of the emission direction.
  83278. */
  83279. direction2: Vector3;
  83280. /**
  83281. * Creates a new instance CylinderDirectedParticleEmitter
  83282. * @param radius the radius of the emission cylinder (1 by default)
  83283. * @param height the height of the emission cylinder (1 by default)
  83284. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  83285. * @param direction1 the min limit of the emission direction (up vector by default)
  83286. * @param direction2 the max limit of the emission direction (up vector by default)
  83287. */
  83288. constructor(radius?: number, height?: number, radiusRange?: number,
  83289. /**
  83290. * The min limit of the emission direction.
  83291. */
  83292. direction1?: Vector3,
  83293. /**
  83294. * The max limit of the emission direction.
  83295. */
  83296. direction2?: Vector3);
  83297. /**
  83298. * Called by the particle System when the direction is computed for the created particle.
  83299. * @param worldMatrix is the world matrix of the particle system
  83300. * @param directionToUpdate is the direction vector to update with the result
  83301. * @param particle is the particle we are computed the direction for
  83302. */
  83303. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83304. /**
  83305. * Clones the current emitter and returns a copy of it
  83306. * @returns the new emitter
  83307. */
  83308. clone(): CylinderDirectedParticleEmitter;
  83309. /**
  83310. * Called by the GPUParticleSystem to setup the update shader
  83311. * @param effect defines the update shader
  83312. */
  83313. applyToShader(effect: Effect): void;
  83314. /**
  83315. * Returns a string to use to update the GPU particles update shader
  83316. * @returns a string containng the defines string
  83317. */
  83318. getEffectDefines(): string;
  83319. /**
  83320. * Returns the string "CylinderDirectedParticleEmitter"
  83321. * @returns a string containing the class name
  83322. */
  83323. getClassName(): string;
  83324. /**
  83325. * Serializes the particle system to a JSON object.
  83326. * @returns the JSON object
  83327. */
  83328. serialize(): any;
  83329. /**
  83330. * Parse properties from a JSON object
  83331. * @param serializationObject defines the JSON object
  83332. */
  83333. parse(serializationObject: any): void;
  83334. }
  83335. }
  83336. declare module BABYLON {
  83337. /**
  83338. * Particle emitter emitting particles from the inside of a hemisphere.
  83339. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  83340. */
  83341. export class HemisphericParticleEmitter implements IParticleEmitterType {
  83342. /**
  83343. * The radius of the emission hemisphere.
  83344. */
  83345. radius: number;
  83346. /**
  83347. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83348. */
  83349. radiusRange: number;
  83350. /**
  83351. * How much to randomize the particle direction [0-1].
  83352. */
  83353. directionRandomizer: number;
  83354. /**
  83355. * Creates a new instance HemisphericParticleEmitter
  83356. * @param radius the radius of the emission hemisphere (1 by default)
  83357. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  83358. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  83359. */
  83360. constructor(
  83361. /**
  83362. * The radius of the emission hemisphere.
  83363. */
  83364. radius?: number,
  83365. /**
  83366. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83367. */
  83368. radiusRange?: number,
  83369. /**
  83370. * How much to randomize the particle direction [0-1].
  83371. */
  83372. directionRandomizer?: number);
  83373. /**
  83374. * Called by the particle System when the direction is computed for the created particle.
  83375. * @param worldMatrix is the world matrix of the particle system
  83376. * @param directionToUpdate is the direction vector to update with the result
  83377. * @param particle is the particle we are computed the direction for
  83378. */
  83379. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83380. /**
  83381. * Called by the particle System when the position is computed for the created particle.
  83382. * @param worldMatrix is the world matrix of the particle system
  83383. * @param positionToUpdate is the position vector to update with the result
  83384. * @param particle is the particle we are computed the position for
  83385. */
  83386. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83387. /**
  83388. * Clones the current emitter and returns a copy of it
  83389. * @returns the new emitter
  83390. */
  83391. clone(): HemisphericParticleEmitter;
  83392. /**
  83393. * Called by the GPUParticleSystem to setup the update shader
  83394. * @param effect defines the update shader
  83395. */
  83396. applyToShader(effect: Effect): void;
  83397. /**
  83398. * Returns a string to use to update the GPU particles update shader
  83399. * @returns a string containng the defines string
  83400. */
  83401. getEffectDefines(): string;
  83402. /**
  83403. * Returns the string "HemisphericParticleEmitter"
  83404. * @returns a string containing the class name
  83405. */
  83406. getClassName(): string;
  83407. /**
  83408. * Serializes the particle system to a JSON object.
  83409. * @returns the JSON object
  83410. */
  83411. serialize(): any;
  83412. /**
  83413. * Parse properties from a JSON object
  83414. * @param serializationObject defines the JSON object
  83415. */
  83416. parse(serializationObject: any): void;
  83417. }
  83418. }
  83419. declare module BABYLON {
  83420. /**
  83421. * Particle emitter emitting particles from a point.
  83422. * It emits the particles randomly between 2 given directions.
  83423. */
  83424. export class PointParticleEmitter implements IParticleEmitterType {
  83425. /**
  83426. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  83427. */
  83428. direction1: Vector3;
  83429. /**
  83430. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  83431. */
  83432. direction2: Vector3;
  83433. /**
  83434. * Creates a new instance PointParticleEmitter
  83435. */
  83436. constructor();
  83437. /**
  83438. * Called by the particle System when the direction is computed for the created particle.
  83439. * @param worldMatrix is the world matrix of the particle system
  83440. * @param directionToUpdate is the direction vector to update with the result
  83441. * @param particle is the particle we are computed the direction for
  83442. */
  83443. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83444. /**
  83445. * Called by the particle System when the position is computed for the created particle.
  83446. * @param worldMatrix is the world matrix of the particle system
  83447. * @param positionToUpdate is the position vector to update with the result
  83448. * @param particle is the particle we are computed the position for
  83449. */
  83450. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83451. /**
  83452. * Clones the current emitter and returns a copy of it
  83453. * @returns the new emitter
  83454. */
  83455. clone(): PointParticleEmitter;
  83456. /**
  83457. * Called by the GPUParticleSystem to setup the update shader
  83458. * @param effect defines the update shader
  83459. */
  83460. applyToShader(effect: Effect): void;
  83461. /**
  83462. * Returns a string to use to update the GPU particles update shader
  83463. * @returns a string containng the defines string
  83464. */
  83465. getEffectDefines(): string;
  83466. /**
  83467. * Returns the string "PointParticleEmitter"
  83468. * @returns a string containing the class name
  83469. */
  83470. getClassName(): string;
  83471. /**
  83472. * Serializes the particle system to a JSON object.
  83473. * @returns the JSON object
  83474. */
  83475. serialize(): any;
  83476. /**
  83477. * Parse properties from a JSON object
  83478. * @param serializationObject defines the JSON object
  83479. */
  83480. parse(serializationObject: any): void;
  83481. }
  83482. }
  83483. declare module BABYLON {
  83484. /**
  83485. * Particle emitter emitting particles from the inside of a sphere.
  83486. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  83487. */
  83488. export class SphereParticleEmitter implements IParticleEmitterType {
  83489. /**
  83490. * The radius of the emission sphere.
  83491. */
  83492. radius: number;
  83493. /**
  83494. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83495. */
  83496. radiusRange: number;
  83497. /**
  83498. * How much to randomize the particle direction [0-1].
  83499. */
  83500. directionRandomizer: number;
  83501. /**
  83502. * Creates a new instance SphereParticleEmitter
  83503. * @param radius the radius of the emission sphere (1 by default)
  83504. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  83505. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  83506. */
  83507. constructor(
  83508. /**
  83509. * The radius of the emission sphere.
  83510. */
  83511. radius?: number,
  83512. /**
  83513. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  83514. */
  83515. radiusRange?: number,
  83516. /**
  83517. * How much to randomize the particle direction [0-1].
  83518. */
  83519. directionRandomizer?: number);
  83520. /**
  83521. * Called by the particle System when the direction is computed for the created particle.
  83522. * @param worldMatrix is the world matrix of the particle system
  83523. * @param directionToUpdate is the direction vector to update with the result
  83524. * @param particle is the particle we are computed the direction for
  83525. */
  83526. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83527. /**
  83528. * Called by the particle System when the position is computed for the created particle.
  83529. * @param worldMatrix is the world matrix of the particle system
  83530. * @param positionToUpdate is the position vector to update with the result
  83531. * @param particle is the particle we are computed the position for
  83532. */
  83533. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  83534. /**
  83535. * Clones the current emitter and returns a copy of it
  83536. * @returns the new emitter
  83537. */
  83538. clone(): SphereParticleEmitter;
  83539. /**
  83540. * Called by the GPUParticleSystem to setup the update shader
  83541. * @param effect defines the update shader
  83542. */
  83543. applyToShader(effect: Effect): void;
  83544. /**
  83545. * Returns a string to use to update the GPU particles update shader
  83546. * @returns a string containng the defines string
  83547. */
  83548. getEffectDefines(): string;
  83549. /**
  83550. * Returns the string "SphereParticleEmitter"
  83551. * @returns a string containing the class name
  83552. */
  83553. getClassName(): string;
  83554. /**
  83555. * Serializes the particle system to a JSON object.
  83556. * @returns the JSON object
  83557. */
  83558. serialize(): any;
  83559. /**
  83560. * Parse properties from a JSON object
  83561. * @param serializationObject defines the JSON object
  83562. */
  83563. parse(serializationObject: any): void;
  83564. }
  83565. /**
  83566. * Particle emitter emitting particles from the inside of a sphere.
  83567. * It emits the particles randomly between two vectors.
  83568. */
  83569. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  83570. /**
  83571. * The min limit of the emission direction.
  83572. */
  83573. direction1: Vector3;
  83574. /**
  83575. * The max limit of the emission direction.
  83576. */
  83577. direction2: Vector3;
  83578. /**
  83579. * Creates a new instance SphereDirectedParticleEmitter
  83580. * @param radius the radius of the emission sphere (1 by default)
  83581. * @param direction1 the min limit of the emission direction (up vector by default)
  83582. * @param direction2 the max limit of the emission direction (up vector by default)
  83583. */
  83584. constructor(radius?: number,
  83585. /**
  83586. * The min limit of the emission direction.
  83587. */
  83588. direction1?: Vector3,
  83589. /**
  83590. * The max limit of the emission direction.
  83591. */
  83592. direction2?: Vector3);
  83593. /**
  83594. * Called by the particle System when the direction is computed for the created particle.
  83595. * @param worldMatrix is the world matrix of the particle system
  83596. * @param directionToUpdate is the direction vector to update with the result
  83597. * @param particle is the particle we are computed the direction for
  83598. */
  83599. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  83600. /**
  83601. * Clones the current emitter and returns a copy of it
  83602. * @returns the new emitter
  83603. */
  83604. clone(): SphereDirectedParticleEmitter;
  83605. /**
  83606. * Called by the GPUParticleSystem to setup the update shader
  83607. * @param effect defines the update shader
  83608. */
  83609. applyToShader(effect: Effect): void;
  83610. /**
  83611. * Returns a string to use to update the GPU particles update shader
  83612. * @returns a string containng the defines string
  83613. */
  83614. getEffectDefines(): string;
  83615. /**
  83616. * Returns the string "SphereDirectedParticleEmitter"
  83617. * @returns a string containing the class name
  83618. */
  83619. getClassName(): string;
  83620. /**
  83621. * Serializes the particle system to a JSON object.
  83622. * @returns the JSON object
  83623. */
  83624. serialize(): any;
  83625. /**
  83626. * Parse properties from a JSON object
  83627. * @param serializationObject defines the JSON object
  83628. */
  83629. parse(serializationObject: any): void;
  83630. }
  83631. }
  83632. declare module BABYLON {
  83633. /**
  83634. * Interface representing a particle system in Babylon.js.
  83635. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  83636. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  83637. */
  83638. export interface IParticleSystem {
  83639. /**
  83640. * List of animations used by the particle system.
  83641. */
  83642. animations: Animation[];
  83643. /**
  83644. * The id of the Particle system.
  83645. */
  83646. id: string;
  83647. /**
  83648. * The name of the Particle system.
  83649. */
  83650. name: string;
  83651. /**
  83652. * The emitter represents the Mesh or position we are attaching the particle system to.
  83653. */
  83654. emitter: Nullable<AbstractMesh | Vector3>;
  83655. /**
  83656. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  83657. */
  83658. isBillboardBased: boolean;
  83659. /**
  83660. * The rendering group used by the Particle system to chose when to render.
  83661. */
  83662. renderingGroupId: number;
  83663. /**
  83664. * The layer mask we are rendering the particles through.
  83665. */
  83666. layerMask: number;
  83667. /**
  83668. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  83669. */
  83670. updateSpeed: number;
  83671. /**
  83672. * The amount of time the particle system is running (depends of the overall update speed).
  83673. */
  83674. targetStopDuration: number;
  83675. /**
  83676. * The texture used to render each particle. (this can be a spritesheet)
  83677. */
  83678. particleTexture: Nullable<Texture>;
  83679. /**
  83680. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  83681. */
  83682. blendMode: number;
  83683. /**
  83684. * Minimum life time of emitting particles.
  83685. */
  83686. minLifeTime: number;
  83687. /**
  83688. * Maximum life time of emitting particles.
  83689. */
  83690. maxLifeTime: number;
  83691. /**
  83692. * Minimum Size of emitting particles.
  83693. */
  83694. minSize: number;
  83695. /**
  83696. * Maximum Size of emitting particles.
  83697. */
  83698. maxSize: number;
  83699. /**
  83700. * Minimum scale of emitting particles on X axis.
  83701. */
  83702. minScaleX: number;
  83703. /**
  83704. * Maximum scale of emitting particles on X axis.
  83705. */
  83706. maxScaleX: number;
  83707. /**
  83708. * Minimum scale of emitting particles on Y axis.
  83709. */
  83710. minScaleY: number;
  83711. /**
  83712. * Maximum scale of emitting particles on Y axis.
  83713. */
  83714. maxScaleY: number;
  83715. /**
  83716. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  83717. */
  83718. color1: Color4;
  83719. /**
  83720. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  83721. */
  83722. color2: Color4;
  83723. /**
  83724. * Color the particle will have at the end of its lifetime.
  83725. */
  83726. colorDead: Color4;
  83727. /**
  83728. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  83729. */
  83730. emitRate: number;
  83731. /**
  83732. * You can use gravity if you want to give an orientation to your particles.
  83733. */
  83734. gravity: Vector3;
  83735. /**
  83736. * Minimum power of emitting particles.
  83737. */
  83738. minEmitPower: number;
  83739. /**
  83740. * Maximum power of emitting particles.
  83741. */
  83742. maxEmitPower: number;
  83743. /**
  83744. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  83745. */
  83746. minAngularSpeed: number;
  83747. /**
  83748. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  83749. */
  83750. maxAngularSpeed: number;
  83751. /**
  83752. * Gets or sets the minimal initial rotation in radians.
  83753. */
  83754. minInitialRotation: number;
  83755. /**
  83756. * Gets or sets the maximal initial rotation in radians.
  83757. */
  83758. maxInitialRotation: number;
  83759. /**
  83760. * The particle emitter type defines the emitter used by the particle system.
  83761. * It can be for example box, sphere, or cone...
  83762. */
  83763. particleEmitterType: Nullable<IParticleEmitterType>;
  83764. /**
  83765. * Defines the delay in milliseconds before starting the system (0 by default)
  83766. */
  83767. startDelay: number;
  83768. /**
  83769. * 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
  83770. */
  83771. preWarmCycles: number;
  83772. /**
  83773. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  83774. */
  83775. preWarmStepOffset: number;
  83776. /**
  83777. * 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)
  83778. */
  83779. spriteCellChangeSpeed: number;
  83780. /**
  83781. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  83782. */
  83783. startSpriteCellID: number;
  83784. /**
  83785. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  83786. */
  83787. endSpriteCellID: number;
  83788. /**
  83789. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  83790. */
  83791. spriteCellWidth: number;
  83792. /**
  83793. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  83794. */
  83795. spriteCellHeight: number;
  83796. /**
  83797. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  83798. */
  83799. spriteRandomStartCell: boolean;
  83800. /**
  83801. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  83802. */
  83803. isAnimationSheetEnabled: boolean;
  83804. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  83805. translationPivot: Vector2;
  83806. /**
  83807. * Gets or sets a texture used to add random noise to particle positions
  83808. */
  83809. noiseTexture: Nullable<BaseTexture>;
  83810. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  83811. noiseStrength: Vector3;
  83812. /**
  83813. * Gets or sets the billboard mode to use when isBillboardBased = true.
  83814. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  83815. */
  83816. billboardMode: number;
  83817. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  83818. limitVelocityDamping: number;
  83819. /**
  83820. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  83821. */
  83822. beginAnimationOnStart: boolean;
  83823. /**
  83824. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  83825. */
  83826. beginAnimationFrom: number;
  83827. /**
  83828. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  83829. */
  83830. beginAnimationTo: number;
  83831. /**
  83832. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  83833. */
  83834. beginAnimationLoop: boolean;
  83835. /**
  83836. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  83837. */
  83838. disposeOnStop: boolean;
  83839. /**
  83840. * Gets the maximum number of particles active at the same time.
  83841. * @returns The max number of active particles.
  83842. */
  83843. getCapacity(): number;
  83844. /**
  83845. * Gets if the system has been started. (Note: this will still be true after stop is called)
  83846. * @returns True if it has been started, otherwise false.
  83847. */
  83848. isStarted(): boolean;
  83849. /**
  83850. * Animates the particle system for this frame.
  83851. */
  83852. animate(): void;
  83853. /**
  83854. * Renders the particle system in its current state.
  83855. * @returns the current number of particles
  83856. */
  83857. render(): number;
  83858. /**
  83859. * Dispose the particle system and frees its associated resources.
  83860. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  83861. */
  83862. dispose(disposeTexture?: boolean): void;
  83863. /**
  83864. * Clones the particle system.
  83865. * @param name The name of the cloned object
  83866. * @param newEmitter The new emitter to use
  83867. * @returns the cloned particle system
  83868. */
  83869. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  83870. /**
  83871. * Serializes the particle system to a JSON object.
  83872. * @returns the JSON object
  83873. */
  83874. serialize(): any;
  83875. /**
  83876. * Rebuild the particle system
  83877. */
  83878. rebuild(): void;
  83879. /**
  83880. * Starts the particle system and begins to emit
  83881. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  83882. */
  83883. start(delay?: number): void;
  83884. /**
  83885. * Stops the particle system.
  83886. */
  83887. stop(): void;
  83888. /**
  83889. * Remove all active particles
  83890. */
  83891. reset(): void;
  83892. /**
  83893. * Is this system ready to be used/rendered
  83894. * @return true if the system is ready
  83895. */
  83896. isReady(): boolean;
  83897. /**
  83898. * Adds a new color gradient
  83899. * @param gradient defines the gradient to use (between 0 and 1)
  83900. * @param color1 defines the color to affect to the specified gradient
  83901. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  83902. * @returns the current particle system
  83903. */
  83904. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  83905. /**
  83906. * Remove a specific color gradient
  83907. * @param gradient defines the gradient to remove
  83908. * @returns the current particle system
  83909. */
  83910. removeColorGradient(gradient: number): IParticleSystem;
  83911. /**
  83912. * Adds a new size gradient
  83913. * @param gradient defines the gradient to use (between 0 and 1)
  83914. * @param factor defines the size factor to affect to the specified gradient
  83915. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  83916. * @returns the current particle system
  83917. */
  83918. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  83919. /**
  83920. * Remove a specific size gradient
  83921. * @param gradient defines the gradient to remove
  83922. * @returns the current particle system
  83923. */
  83924. removeSizeGradient(gradient: number): IParticleSystem;
  83925. /**
  83926. * Gets the current list of color gradients.
  83927. * You must use addColorGradient and removeColorGradient to udpate this list
  83928. * @returns the list of color gradients
  83929. */
  83930. getColorGradients(): Nullable<Array<ColorGradient>>;
  83931. /**
  83932. * Gets the current list of size gradients.
  83933. * You must use addSizeGradient and removeSizeGradient to udpate this list
  83934. * @returns the list of size gradients
  83935. */
  83936. getSizeGradients(): Nullable<Array<FactorGradient>>;
  83937. /**
  83938. * Gets the current list of angular speed gradients.
  83939. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  83940. * @returns the list of angular speed gradients
  83941. */
  83942. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  83943. /**
  83944. * Adds a new angular speed gradient
  83945. * @param gradient defines the gradient to use (between 0 and 1)
  83946. * @param factor defines the angular speed to affect to the specified gradient
  83947. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  83948. * @returns the current particle system
  83949. */
  83950. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  83951. /**
  83952. * Remove a specific angular speed gradient
  83953. * @param gradient defines the gradient to remove
  83954. * @returns the current particle system
  83955. */
  83956. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  83957. /**
  83958. * Gets the current list of velocity gradients.
  83959. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  83960. * @returns the list of velocity gradients
  83961. */
  83962. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  83963. /**
  83964. * Adds a new velocity gradient
  83965. * @param gradient defines the gradient to use (between 0 and 1)
  83966. * @param factor defines the velocity to affect to the specified gradient
  83967. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  83968. * @returns the current particle system
  83969. */
  83970. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  83971. /**
  83972. * Remove a specific velocity gradient
  83973. * @param gradient defines the gradient to remove
  83974. * @returns the current particle system
  83975. */
  83976. removeVelocityGradient(gradient: number): IParticleSystem;
  83977. /**
  83978. * Gets the current list of limit velocity gradients.
  83979. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  83980. * @returns the list of limit velocity gradients
  83981. */
  83982. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  83983. /**
  83984. * Adds a new limit velocity gradient
  83985. * @param gradient defines the gradient to use (between 0 and 1)
  83986. * @param factor defines the limit velocity to affect to the specified gradient
  83987. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  83988. * @returns the current particle system
  83989. */
  83990. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  83991. /**
  83992. * Remove a specific limit velocity gradient
  83993. * @param gradient defines the gradient to remove
  83994. * @returns the current particle system
  83995. */
  83996. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  83997. /**
  83998. * Adds a new drag gradient
  83999. * @param gradient defines the gradient to use (between 0 and 1)
  84000. * @param factor defines the drag to affect to the specified gradient
  84001. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84002. * @returns the current particle system
  84003. */
  84004. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84005. /**
  84006. * Remove a specific drag gradient
  84007. * @param gradient defines the gradient to remove
  84008. * @returns the current particle system
  84009. */
  84010. removeDragGradient(gradient: number): IParticleSystem;
  84011. /**
  84012. * Gets the current list of drag gradients.
  84013. * You must use addDragGradient and removeDragGradient to udpate this list
  84014. * @returns the list of drag gradients
  84015. */
  84016. getDragGradients(): Nullable<Array<FactorGradient>>;
  84017. /**
  84018. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  84019. * @param gradient defines the gradient to use (between 0 and 1)
  84020. * @param factor defines the emit rate to affect to the specified gradient
  84021. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84022. * @returns the current particle system
  84023. */
  84024. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84025. /**
  84026. * Remove a specific emit rate gradient
  84027. * @param gradient defines the gradient to remove
  84028. * @returns the current particle system
  84029. */
  84030. removeEmitRateGradient(gradient: number): IParticleSystem;
  84031. /**
  84032. * Gets the current list of emit rate gradients.
  84033. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  84034. * @returns the list of emit rate gradients
  84035. */
  84036. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  84037. /**
  84038. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  84039. * @param gradient defines the gradient to use (between 0 and 1)
  84040. * @param factor defines the start size to affect to the specified gradient
  84041. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84042. * @returns the current particle system
  84043. */
  84044. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84045. /**
  84046. * Remove a specific start size gradient
  84047. * @param gradient defines the gradient to remove
  84048. * @returns the current particle system
  84049. */
  84050. removeStartSizeGradient(gradient: number): IParticleSystem;
  84051. /**
  84052. * Gets the current list of start size gradients.
  84053. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  84054. * @returns the list of start size gradients
  84055. */
  84056. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  84057. /**
  84058. * Adds a new life time gradient
  84059. * @param gradient defines the gradient to use (between 0 and 1)
  84060. * @param factor defines the life time factor to affect to the specified gradient
  84061. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84062. * @returns the current particle system
  84063. */
  84064. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84065. /**
  84066. * Remove a specific life time gradient
  84067. * @param gradient defines the gradient to remove
  84068. * @returns the current particle system
  84069. */
  84070. removeLifeTimeGradient(gradient: number): IParticleSystem;
  84071. /**
  84072. * Gets the current list of life time gradients.
  84073. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  84074. * @returns the list of life time gradients
  84075. */
  84076. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  84077. /**
  84078. * Gets the current list of color gradients.
  84079. * You must use addColorGradient and removeColorGradient to udpate this list
  84080. * @returns the list of color gradients
  84081. */
  84082. getColorGradients(): Nullable<Array<ColorGradient>>;
  84083. /**
  84084. * Adds a new ramp gradient used to remap particle colors
  84085. * @param gradient defines the gradient to use (between 0 and 1)
  84086. * @param color defines the color to affect to the specified gradient
  84087. * @returns the current particle system
  84088. */
  84089. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  84090. /**
  84091. * Gets the current list of ramp gradients.
  84092. * You must use addRampGradient and removeRampGradient to udpate this list
  84093. * @returns the list of ramp gradients
  84094. */
  84095. getRampGradients(): Nullable<Array<Color3Gradient>>;
  84096. /** Gets or sets a boolean indicating that ramp gradients must be used
  84097. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  84098. */
  84099. useRampGradients: boolean;
  84100. /**
  84101. * Adds a new color remap gradient
  84102. * @param gradient defines the gradient to use (between 0 and 1)
  84103. * @param min defines the color remap minimal range
  84104. * @param max defines the color remap maximal range
  84105. * @returns the current particle system
  84106. */
  84107. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84108. /**
  84109. * Gets the current list of color remap gradients.
  84110. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  84111. * @returns the list of color remap gradients
  84112. */
  84113. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  84114. /**
  84115. * Adds a new alpha remap gradient
  84116. * @param gradient defines the gradient to use (between 0 and 1)
  84117. * @param min defines the alpha remap minimal range
  84118. * @param max defines the alpha remap maximal range
  84119. * @returns the current particle system
  84120. */
  84121. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84122. /**
  84123. * Gets the current list of alpha remap gradients.
  84124. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  84125. * @returns the list of alpha remap gradients
  84126. */
  84127. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  84128. /**
  84129. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  84130. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84131. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84132. * @returns the emitter
  84133. */
  84134. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  84135. /**
  84136. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  84137. * @param radius The radius of the hemisphere to emit from
  84138. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84139. * @returns the emitter
  84140. */
  84141. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  84142. /**
  84143. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  84144. * @param radius The radius of the sphere to emit from
  84145. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84146. * @returns the emitter
  84147. */
  84148. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  84149. /**
  84150. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  84151. * @param radius The radius of the sphere to emit from
  84152. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  84153. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  84154. * @returns the emitter
  84155. */
  84156. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  84157. /**
  84158. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  84159. * @param radius The radius of the emission cylinder
  84160. * @param height The height of the emission cylinder
  84161. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  84162. * @param directionRandomizer How much to randomize the particle direction [0-1]
  84163. * @returns the emitter
  84164. */
  84165. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  84166. /**
  84167. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  84168. * @param radius The radius of the cylinder to emit from
  84169. * @param height The height of the emission cylinder
  84170. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  84171. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  84172. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  84173. * @returns the emitter
  84174. */
  84175. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  84176. /**
  84177. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  84178. * @param radius The radius of the cone to emit from
  84179. * @param angle The base angle of the cone
  84180. * @returns the emitter
  84181. */
  84182. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  84183. /**
  84184. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  84185. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84186. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84187. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84188. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84189. * @returns the emitter
  84190. */
  84191. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  84192. /**
  84193. * Get hosting scene
  84194. * @returns the scene
  84195. */
  84196. getScene(): Scene;
  84197. }
  84198. }
  84199. declare module BABYLON {
  84200. /**
  84201. * Creates an instance based on a source mesh.
  84202. */
  84203. export class InstancedMesh extends AbstractMesh {
  84204. private _sourceMesh;
  84205. private _currentLOD;
  84206. /** @hidden */
  84207. _indexInSourceMeshInstanceArray: number;
  84208. constructor(name: string, source: Mesh);
  84209. /**
  84210. * Returns the string "InstancedMesh".
  84211. */
  84212. getClassName(): string;
  84213. /** Gets the list of lights affecting that mesh */
  84214. readonly lightSources: Light[];
  84215. _resyncLightSources(): void;
  84216. _resyncLighSource(light: Light): void;
  84217. _removeLightSource(light: Light, dispose: boolean): void;
  84218. /**
  84219. * If the source mesh receives shadows
  84220. */
  84221. readonly receiveShadows: boolean;
  84222. /**
  84223. * The material of the source mesh
  84224. */
  84225. readonly material: Nullable<Material>;
  84226. /**
  84227. * Visibility of the source mesh
  84228. */
  84229. readonly visibility: number;
  84230. /**
  84231. * Skeleton of the source mesh
  84232. */
  84233. readonly skeleton: Nullable<Skeleton>;
  84234. /**
  84235. * Rendering ground id of the source mesh
  84236. */
  84237. renderingGroupId: number;
  84238. /**
  84239. * Returns the total number of vertices (integer).
  84240. */
  84241. getTotalVertices(): number;
  84242. /**
  84243. * Returns a positive integer : the total number of indices in this mesh geometry.
  84244. * @returns the numner of indices or zero if the mesh has no geometry.
  84245. */
  84246. getTotalIndices(): number;
  84247. /**
  84248. * The source mesh of the instance
  84249. */
  84250. readonly sourceMesh: Mesh;
  84251. /**
  84252. * Is this node ready to be used/rendered
  84253. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  84254. * @return {boolean} is it ready
  84255. */
  84256. isReady(completeCheck?: boolean): boolean;
  84257. /**
  84258. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  84259. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  84260. * @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.
  84261. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  84262. */
  84263. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  84264. /**
  84265. * Sets the vertex data of the mesh geometry for the requested `kind`.
  84266. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  84267. * The `data` are either a numeric array either a Float32Array.
  84268. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  84269. * 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).
  84270. * Note that a new underlying VertexBuffer object is created each call.
  84271. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  84272. *
  84273. * Possible `kind` values :
  84274. * - VertexBuffer.PositionKind
  84275. * - VertexBuffer.UVKind
  84276. * - VertexBuffer.UV2Kind
  84277. * - VertexBuffer.UV3Kind
  84278. * - VertexBuffer.UV4Kind
  84279. * - VertexBuffer.UV5Kind
  84280. * - VertexBuffer.UV6Kind
  84281. * - VertexBuffer.ColorKind
  84282. * - VertexBuffer.MatricesIndicesKind
  84283. * - VertexBuffer.MatricesIndicesExtraKind
  84284. * - VertexBuffer.MatricesWeightsKind
  84285. * - VertexBuffer.MatricesWeightsExtraKind
  84286. *
  84287. * Returns the Mesh.
  84288. */
  84289. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  84290. /**
  84291. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  84292. * If the mesh has no geometry, it is simply returned as it is.
  84293. * The `data` are either a numeric array either a Float32Array.
  84294. * No new underlying VertexBuffer object is created.
  84295. * 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.
  84296. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  84297. *
  84298. * Possible `kind` values :
  84299. * - VertexBuffer.PositionKind
  84300. * - VertexBuffer.UVKind
  84301. * - VertexBuffer.UV2Kind
  84302. * - VertexBuffer.UV3Kind
  84303. * - VertexBuffer.UV4Kind
  84304. * - VertexBuffer.UV5Kind
  84305. * - VertexBuffer.UV6Kind
  84306. * - VertexBuffer.ColorKind
  84307. * - VertexBuffer.MatricesIndicesKind
  84308. * - VertexBuffer.MatricesIndicesExtraKind
  84309. * - VertexBuffer.MatricesWeightsKind
  84310. * - VertexBuffer.MatricesWeightsExtraKind
  84311. *
  84312. * Returns the Mesh.
  84313. */
  84314. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  84315. /**
  84316. * Sets the mesh indices.
  84317. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  84318. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  84319. * This method creates a new index buffer each call.
  84320. * Returns the Mesh.
  84321. */
  84322. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  84323. /**
  84324. * Boolean : True if the mesh owns the requested kind of data.
  84325. */
  84326. isVerticesDataPresent(kind: string): boolean;
  84327. /**
  84328. * Returns an array of indices (IndicesArray).
  84329. */
  84330. getIndices(): Nullable<IndicesArray>;
  84331. readonly _positions: Nullable<Vector3[]>;
  84332. /**
  84333. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  84334. * This means the mesh underlying bounding box and sphere are recomputed.
  84335. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  84336. * @returns the current mesh
  84337. */
  84338. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  84339. /** @hidden */
  84340. _preActivate(): InstancedMesh;
  84341. /** @hidden */
  84342. _activate(renderId: number, intermediateRendering: boolean): boolean;
  84343. /** @hidden */
  84344. _postActivate(): void;
  84345. getWorldMatrix(): Matrix;
  84346. readonly isAnInstance: boolean;
  84347. /**
  84348. * Returns the current associated LOD AbstractMesh.
  84349. */
  84350. getLOD(camera: Camera): AbstractMesh;
  84351. /** @hidden */
  84352. _syncSubMeshes(): InstancedMesh;
  84353. /** @hidden */
  84354. _generatePointsArray(): boolean;
  84355. /**
  84356. * Creates a new InstancedMesh from the current mesh.
  84357. * - name (string) : the cloned mesh name
  84358. * - newParent (optional Node) : the optional Node to parent the clone to.
  84359. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  84360. *
  84361. * Returns the clone.
  84362. */
  84363. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  84364. /**
  84365. * Disposes the InstancedMesh.
  84366. * Returns nothing.
  84367. */
  84368. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  84369. }
  84370. }
  84371. declare module BABYLON {
  84372. /**
  84373. * Defines the options associated with the creation of a shader material.
  84374. */
  84375. export interface IShaderMaterialOptions {
  84376. /**
  84377. * Does the material work in alpha blend mode
  84378. */
  84379. needAlphaBlending: boolean;
  84380. /**
  84381. * Does the material work in alpha test mode
  84382. */
  84383. needAlphaTesting: boolean;
  84384. /**
  84385. * The list of attribute names used in the shader
  84386. */
  84387. attributes: string[];
  84388. /**
  84389. * The list of unifrom names used in the shader
  84390. */
  84391. uniforms: string[];
  84392. /**
  84393. * The list of UBO names used in the shader
  84394. */
  84395. uniformBuffers: string[];
  84396. /**
  84397. * The list of sampler names used in the shader
  84398. */
  84399. samplers: string[];
  84400. /**
  84401. * The list of defines used in the shader
  84402. */
  84403. defines: string[];
  84404. }
  84405. /**
  84406. * 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.
  84407. *
  84408. * This returned material effects how the mesh will look based on the code in the shaders.
  84409. *
  84410. * @see http://doc.babylonjs.com/how_to/shader_material
  84411. */
  84412. export class ShaderMaterial extends Material {
  84413. private _shaderPath;
  84414. private _options;
  84415. private _textures;
  84416. private _textureArrays;
  84417. private _floats;
  84418. private _ints;
  84419. private _floatsArrays;
  84420. private _colors3;
  84421. private _colors3Arrays;
  84422. private _colors4;
  84423. private _colors4Arrays;
  84424. private _vectors2;
  84425. private _vectors3;
  84426. private _vectors4;
  84427. private _matrices;
  84428. private _matrices3x3;
  84429. private _matrices2x2;
  84430. private _vectors2Arrays;
  84431. private _vectors3Arrays;
  84432. private _vectors4Arrays;
  84433. private _cachedWorldViewMatrix;
  84434. private _cachedWorldViewProjectionMatrix;
  84435. private _renderId;
  84436. /**
  84437. * Instantiate a new shader material.
  84438. * 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.
  84439. * This returned material effects how the mesh will look based on the code in the shaders.
  84440. * @see http://doc.babylonjs.com/how_to/shader_material
  84441. * @param name Define the name of the material in the scene
  84442. * @param scene Define the scene the material belongs to
  84443. * @param shaderPath Defines the route to the shader code in one of three ways:
  84444. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  84445. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  84446. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  84447. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  84448. * @param options Define the options used to create the shader
  84449. */
  84450. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  84451. /**
  84452. * Gets the options used to compile the shader.
  84453. * They can be modified to trigger a new compilation
  84454. */
  84455. readonly options: IShaderMaterialOptions;
  84456. /**
  84457. * Gets the current class name of the material e.g. "ShaderMaterial"
  84458. * Mainly use in serialization.
  84459. * @returns the class name
  84460. */
  84461. getClassName(): string;
  84462. /**
  84463. * Specifies if the material will require alpha blending
  84464. * @returns a boolean specifying if alpha blending is needed
  84465. */
  84466. needAlphaBlending(): boolean;
  84467. /**
  84468. * Specifies if this material should be rendered in alpha test mode
  84469. * @returns a boolean specifying if an alpha test is needed.
  84470. */
  84471. needAlphaTesting(): boolean;
  84472. private _checkUniform;
  84473. /**
  84474. * Set a texture in the shader.
  84475. * @param name Define the name of the uniform samplers as defined in the shader
  84476. * @param texture Define the texture to bind to this sampler
  84477. * @return the material itself allowing "fluent" like uniform updates
  84478. */
  84479. setTexture(name: string, texture: Texture): ShaderMaterial;
  84480. /**
  84481. * Set a texture array in the shader.
  84482. * @param name Define the name of the uniform sampler array as defined in the shader
  84483. * @param textures Define the list of textures to bind to this sampler
  84484. * @return the material itself allowing "fluent" like uniform updates
  84485. */
  84486. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  84487. /**
  84488. * Set a float in the shader.
  84489. * @param name Define the name of the uniform as defined in the shader
  84490. * @param value Define the value to give to the uniform
  84491. * @return the material itself allowing "fluent" like uniform updates
  84492. */
  84493. setFloat(name: string, value: number): ShaderMaterial;
  84494. /**
  84495. * Set a int in the shader.
  84496. * @param name Define the name of the uniform as defined in the shader
  84497. * @param value Define the value to give to the uniform
  84498. * @return the material itself allowing "fluent" like uniform updates
  84499. */
  84500. setInt(name: string, value: number): ShaderMaterial;
  84501. /**
  84502. * Set an array of floats in the shader.
  84503. * @param name Define the name of the uniform as defined in the shader
  84504. * @param value Define the value to give to the uniform
  84505. * @return the material itself allowing "fluent" like uniform updates
  84506. */
  84507. setFloats(name: string, value: number[]): ShaderMaterial;
  84508. /**
  84509. * Set a vec3 in the shader from a Color3.
  84510. * @param name Define the name of the uniform as defined in the shader
  84511. * @param value Define the value to give to the uniform
  84512. * @return the material itself allowing "fluent" like uniform updates
  84513. */
  84514. setColor3(name: string, value: Color3): ShaderMaterial;
  84515. /**
  84516. * Set a vec3 array in the shader from a Color3 array.
  84517. * @param name Define the name of the uniform as defined in the shader
  84518. * @param value Define the value to give to the uniform
  84519. * @return the material itself allowing "fluent" like uniform updates
  84520. */
  84521. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  84522. /**
  84523. * Set a vec4 in the shader from a Color4.
  84524. * @param name Define the name of the uniform as defined in the shader
  84525. * @param value Define the value to give to the uniform
  84526. * @return the material itself allowing "fluent" like uniform updates
  84527. */
  84528. setColor4(name: string, value: Color4): ShaderMaterial;
  84529. /**
  84530. * Set a vec4 array in the shader from a Color4 array.
  84531. * @param name Define the name of the uniform as defined in the shader
  84532. * @param value Define the value to give to the uniform
  84533. * @return the material itself allowing "fluent" like uniform updates
  84534. */
  84535. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  84536. /**
  84537. * Set a vec2 in the shader from a Vector2.
  84538. * @param name Define the name of the uniform as defined in the shader
  84539. * @param value Define the value to give to the uniform
  84540. * @return the material itself allowing "fluent" like uniform updates
  84541. */
  84542. setVector2(name: string, value: Vector2): ShaderMaterial;
  84543. /**
  84544. * Set a vec3 in the shader from a Vector3.
  84545. * @param name Define the name of the uniform as defined in the shader
  84546. * @param value Define the value to give to the uniform
  84547. * @return the material itself allowing "fluent" like uniform updates
  84548. */
  84549. setVector3(name: string, value: Vector3): ShaderMaterial;
  84550. /**
  84551. * Set a vec4 in the shader from a Vector4.
  84552. * @param name Define the name of the uniform as defined in the shader
  84553. * @param value Define the value to give to the uniform
  84554. * @return the material itself allowing "fluent" like uniform updates
  84555. */
  84556. setVector4(name: string, value: Vector4): ShaderMaterial;
  84557. /**
  84558. * Set a mat4 in the shader from a Matrix.
  84559. * @param name Define the name of the uniform as defined in the shader
  84560. * @param value Define the value to give to the uniform
  84561. * @return the material itself allowing "fluent" like uniform updates
  84562. */
  84563. setMatrix(name: string, value: Matrix): ShaderMaterial;
  84564. /**
  84565. * Set a mat3 in the shader from a Float32Array.
  84566. * @param name Define the name of the uniform as defined in the shader
  84567. * @param value Define the value to give to the uniform
  84568. * @return the material itself allowing "fluent" like uniform updates
  84569. */
  84570. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  84571. /**
  84572. * Set a mat2 in the shader from a Float32Array.
  84573. * @param name Define the name of the uniform as defined in the shader
  84574. * @param value Define the value to give to the uniform
  84575. * @return the material itself allowing "fluent" like uniform updates
  84576. */
  84577. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  84578. /**
  84579. * Set a vec2 array in the shader from a number array.
  84580. * @param name Define the name of the uniform as defined in the shader
  84581. * @param value Define the value to give to the uniform
  84582. * @return the material itself allowing "fluent" like uniform updates
  84583. */
  84584. setArray2(name: string, value: number[]): ShaderMaterial;
  84585. /**
  84586. * Set a vec3 array in the shader from a number array.
  84587. * @param name Define the name of the uniform as defined in the shader
  84588. * @param value Define the value to give to the uniform
  84589. * @return the material itself allowing "fluent" like uniform updates
  84590. */
  84591. setArray3(name: string, value: number[]): ShaderMaterial;
  84592. /**
  84593. * Set a vec4 array in the shader from a number array.
  84594. * @param name Define the name of the uniform as defined in the shader
  84595. * @param value Define the value to give to the uniform
  84596. * @return the material itself allowing "fluent" like uniform updates
  84597. */
  84598. setArray4(name: string, value: number[]): ShaderMaterial;
  84599. private _checkCache;
  84600. /**
  84601. * Specifies that the submesh is ready to be used
  84602. * @param mesh defines the mesh to check
  84603. * @param subMesh defines which submesh to check
  84604. * @param useInstances specifies that instances should be used
  84605. * @returns a boolean indicating that the submesh is ready or not
  84606. */
  84607. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  84608. /**
  84609. * Checks if the material is ready to render the requested mesh
  84610. * @param mesh Define the mesh to render
  84611. * @param useInstances Define whether or not the material is used with instances
  84612. * @returns true if ready, otherwise false
  84613. */
  84614. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  84615. /**
  84616. * Binds the world matrix to the material
  84617. * @param world defines the world transformation matrix
  84618. */
  84619. bindOnlyWorldMatrix(world: Matrix): void;
  84620. /**
  84621. * Binds the material to the mesh
  84622. * @param world defines the world transformation matrix
  84623. * @param mesh defines the mesh to bind the material to
  84624. */
  84625. bind(world: Matrix, mesh?: Mesh): void;
  84626. /**
  84627. * Gets the active textures from the material
  84628. * @returns an array of textures
  84629. */
  84630. getActiveTextures(): BaseTexture[];
  84631. /**
  84632. * Specifies if the material uses a texture
  84633. * @param texture defines the texture to check against the material
  84634. * @returns a boolean specifying if the material uses the texture
  84635. */
  84636. hasTexture(texture: BaseTexture): boolean;
  84637. /**
  84638. * Makes a duplicate of the material, and gives it a new name
  84639. * @param name defines the new name for the duplicated material
  84640. * @returns the cloned material
  84641. */
  84642. clone(name: string): ShaderMaterial;
  84643. /**
  84644. * Disposes the material
  84645. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  84646. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  84647. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  84648. */
  84649. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  84650. /**
  84651. * Serializes this material in a JSON representation
  84652. * @returns the serialized material object
  84653. */
  84654. serialize(): any;
  84655. /**
  84656. * Creates a shader material from parsed shader material data
  84657. * @param source defines the JSON represnetation of the material
  84658. * @param scene defines the hosting scene
  84659. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  84660. * @returns a new material
  84661. */
  84662. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  84663. }
  84664. }
  84665. declare module BABYLON {
  84666. /** @hidden */
  84667. export var colorPixelShader: {
  84668. name: string;
  84669. shader: string;
  84670. };
  84671. }
  84672. declare module BABYLON {
  84673. /** @hidden */
  84674. export var colorVertexShader: {
  84675. name: string;
  84676. shader: string;
  84677. };
  84678. }
  84679. declare module BABYLON {
  84680. /**
  84681. * Line mesh
  84682. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  84683. */
  84684. export class LinesMesh extends Mesh {
  84685. /**
  84686. * If vertex color should be applied to the mesh
  84687. */
  84688. readonly useVertexColor?: boolean | undefined;
  84689. /**
  84690. * If vertex alpha should be applied to the mesh
  84691. */
  84692. readonly useVertexAlpha?: boolean | undefined;
  84693. /**
  84694. * Color of the line (Default: White)
  84695. */
  84696. color: Color3;
  84697. /**
  84698. * Alpha of the line (Default: 1)
  84699. */
  84700. alpha: number;
  84701. /**
  84702. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  84703. * This margin is expressed in world space coordinates, so its value may vary.
  84704. * Default value is 0.1
  84705. */
  84706. intersectionThreshold: number;
  84707. private _colorShader;
  84708. private color4;
  84709. /**
  84710. * Creates a new LinesMesh
  84711. * @param name defines the name
  84712. * @param scene defines the hosting scene
  84713. * @param parent defines the parent mesh if any
  84714. * @param source defines the optional source LinesMesh used to clone data from
  84715. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  84716. * When false, achieved by calling a clone(), also passing False.
  84717. * This will make creation of children, recursive.
  84718. * @param useVertexColor defines if this LinesMesh supports vertex color
  84719. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  84720. */
  84721. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  84722. /**
  84723. * If vertex color should be applied to the mesh
  84724. */
  84725. useVertexColor?: boolean | undefined,
  84726. /**
  84727. * If vertex alpha should be applied to the mesh
  84728. */
  84729. useVertexAlpha?: boolean | undefined);
  84730. private _addClipPlaneDefine;
  84731. private _removeClipPlaneDefine;
  84732. isReady(): boolean;
  84733. /**
  84734. * Returns the string "LineMesh"
  84735. */
  84736. getClassName(): string;
  84737. /**
  84738. * @hidden
  84739. */
  84740. /**
  84741. * @hidden
  84742. */
  84743. material: Material;
  84744. /**
  84745. * @hidden
  84746. */
  84747. readonly checkCollisions: boolean;
  84748. /** @hidden */
  84749. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  84750. /** @hidden */
  84751. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  84752. /**
  84753. * Disposes of the line mesh
  84754. * @param doNotRecurse If children should be disposed
  84755. */
  84756. dispose(doNotRecurse?: boolean): void;
  84757. /**
  84758. * Returns a new LineMesh object cloned from the current one.
  84759. */
  84760. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  84761. /**
  84762. * Creates a new InstancedLinesMesh object from the mesh model.
  84763. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  84764. * @param name defines the name of the new instance
  84765. * @returns a new InstancedLinesMesh
  84766. */
  84767. createInstance(name: string): InstancedLinesMesh;
  84768. }
  84769. /**
  84770. * Creates an instance based on a source LinesMesh
  84771. */
  84772. export class InstancedLinesMesh extends InstancedMesh {
  84773. /**
  84774. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  84775. * This margin is expressed in world space coordinates, so its value may vary.
  84776. * Initilized with the intersectionThreshold value of the source LinesMesh
  84777. */
  84778. intersectionThreshold: number;
  84779. constructor(name: string, source: LinesMesh);
  84780. /**
  84781. * Returns the string "InstancedLinesMesh".
  84782. */
  84783. getClassName(): string;
  84784. }
  84785. }
  84786. declare module BABYLON {
  84787. /** @hidden */
  84788. export var linePixelShader: {
  84789. name: string;
  84790. shader: string;
  84791. };
  84792. }
  84793. declare module BABYLON {
  84794. /** @hidden */
  84795. export var lineVertexShader: {
  84796. name: string;
  84797. shader: string;
  84798. };
  84799. }
  84800. declare module BABYLON {
  84801. interface AbstractMesh {
  84802. /**
  84803. * Gets the edgesRenderer associated with the mesh
  84804. */
  84805. edgesRenderer: Nullable<EdgesRenderer>;
  84806. }
  84807. interface LinesMesh {
  84808. /**
  84809. * Enables the edge rendering mode on the mesh.
  84810. * This mode makes the mesh edges visible
  84811. * @param epsilon defines the maximal distance between two angles to detect a face
  84812. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  84813. * @returns the currentAbstractMesh
  84814. * @see https://www.babylonjs-playground.com/#19O9TU#0
  84815. */
  84816. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  84817. }
  84818. interface InstancedLinesMesh {
  84819. /**
  84820. * Enables the edge rendering mode on the mesh.
  84821. * This mode makes the mesh edges visible
  84822. * @param epsilon defines the maximal distance between two angles to detect a face
  84823. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  84824. * @returns the current InstancedLinesMesh
  84825. * @see https://www.babylonjs-playground.com/#19O9TU#0
  84826. */
  84827. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  84828. }
  84829. /**
  84830. * Defines the minimum contract an Edges renderer should follow.
  84831. */
  84832. export interface IEdgesRenderer extends IDisposable {
  84833. /**
  84834. * Gets or sets a boolean indicating if the edgesRenderer is active
  84835. */
  84836. isEnabled: boolean;
  84837. /**
  84838. * Renders the edges of the attached mesh,
  84839. */
  84840. render(): void;
  84841. /**
  84842. * Checks wether or not the edges renderer is ready to render.
  84843. * @return true if ready, otherwise false.
  84844. */
  84845. isReady(): boolean;
  84846. }
  84847. /**
  84848. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  84849. */
  84850. export class EdgesRenderer implements IEdgesRenderer {
  84851. /**
  84852. * Define the size of the edges with an orthographic camera
  84853. */
  84854. edgesWidthScalerForOrthographic: number;
  84855. /**
  84856. * Define the size of the edges with a perspective camera
  84857. */
  84858. edgesWidthScalerForPerspective: number;
  84859. protected _source: AbstractMesh;
  84860. protected _linesPositions: number[];
  84861. protected _linesNormals: number[];
  84862. protected _linesIndices: number[];
  84863. protected _epsilon: number;
  84864. protected _indicesCount: number;
  84865. protected _lineShader: ShaderMaterial;
  84866. protected _ib: DataBuffer;
  84867. protected _buffers: {
  84868. [key: string]: Nullable<VertexBuffer>;
  84869. };
  84870. protected _checkVerticesInsteadOfIndices: boolean;
  84871. private _meshRebuildObserver;
  84872. private _meshDisposeObserver;
  84873. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  84874. isEnabled: boolean;
  84875. /**
  84876. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  84877. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  84878. * @param source Mesh used to create edges
  84879. * @param epsilon sum of angles in adjacency to check for edge
  84880. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  84881. * @param generateEdgesLines - should generate Lines or only prepare resources.
  84882. */
  84883. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  84884. protected _prepareRessources(): void;
  84885. /** @hidden */
  84886. _rebuild(): void;
  84887. /**
  84888. * Releases the required resources for the edges renderer
  84889. */
  84890. dispose(): void;
  84891. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  84892. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  84893. /**
  84894. * Checks if the pair of p0 and p1 is en edge
  84895. * @param faceIndex
  84896. * @param edge
  84897. * @param faceNormals
  84898. * @param p0
  84899. * @param p1
  84900. * @private
  84901. */
  84902. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  84903. /**
  84904. * push line into the position, normal and index buffer
  84905. * @protected
  84906. */
  84907. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  84908. /**
  84909. * Generates lines edges from adjacencjes
  84910. * @private
  84911. */
  84912. _generateEdgesLines(): void;
  84913. /**
  84914. * Checks wether or not the edges renderer is ready to render.
  84915. * @return true if ready, otherwise false.
  84916. */
  84917. isReady(): boolean;
  84918. /**
  84919. * Renders the edges of the attached mesh,
  84920. */
  84921. render(): void;
  84922. }
  84923. /**
  84924. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  84925. */
  84926. export class LineEdgesRenderer extends EdgesRenderer {
  84927. /**
  84928. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  84929. * @param source LineMesh used to generate edges
  84930. * @param epsilon not important (specified angle for edge detection)
  84931. * @param checkVerticesInsteadOfIndices not important for LineMesh
  84932. */
  84933. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  84934. /**
  84935. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  84936. */
  84937. _generateEdgesLines(): void;
  84938. }
  84939. }
  84940. declare module BABYLON {
  84941. /**
  84942. * This represents the object necessary to create a rendering group.
  84943. * This is exclusively used and created by the rendering manager.
  84944. * To modify the behavior, you use the available helpers in your scene or meshes.
  84945. * @hidden
  84946. */
  84947. export class RenderingGroup {
  84948. index: number;
  84949. private static _zeroVector;
  84950. private _scene;
  84951. private _opaqueSubMeshes;
  84952. private _transparentSubMeshes;
  84953. private _alphaTestSubMeshes;
  84954. private _depthOnlySubMeshes;
  84955. private _particleSystems;
  84956. private _spriteManagers;
  84957. private _opaqueSortCompareFn;
  84958. private _alphaTestSortCompareFn;
  84959. private _transparentSortCompareFn;
  84960. private _renderOpaque;
  84961. private _renderAlphaTest;
  84962. private _renderTransparent;
  84963. /** @hidden */
  84964. _edgesRenderers: SmartArray<IEdgesRenderer>;
  84965. onBeforeTransparentRendering: () => void;
  84966. /**
  84967. * Set the opaque sort comparison function.
  84968. * If null the sub meshes will be render in the order they were created
  84969. */
  84970. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  84971. /**
  84972. * Set the alpha test sort comparison function.
  84973. * If null the sub meshes will be render in the order they were created
  84974. */
  84975. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  84976. /**
  84977. * Set the transparent sort comparison function.
  84978. * If null the sub meshes will be render in the order they were created
  84979. */
  84980. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  84981. /**
  84982. * Creates a new rendering group.
  84983. * @param index The rendering group index
  84984. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  84985. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  84986. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  84987. */
  84988. 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>);
  84989. /**
  84990. * Render all the sub meshes contained in the group.
  84991. * @param customRenderFunction Used to override the default render behaviour of the group.
  84992. * @returns true if rendered some submeshes.
  84993. */
  84994. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  84995. /**
  84996. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  84997. * @param subMeshes The submeshes to render
  84998. */
  84999. private renderOpaqueSorted;
  85000. /**
  85001. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  85002. * @param subMeshes The submeshes to render
  85003. */
  85004. private renderAlphaTestSorted;
  85005. /**
  85006. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  85007. * @param subMeshes The submeshes to render
  85008. */
  85009. private renderTransparentSorted;
  85010. /**
  85011. * Renders the submeshes in a specified order.
  85012. * @param subMeshes The submeshes to sort before render
  85013. * @param sortCompareFn The comparison function use to sort
  85014. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  85015. * @param transparent Specifies to activate blending if true
  85016. */
  85017. private static renderSorted;
  85018. /**
  85019. * Renders the submeshes in the order they were dispatched (no sort applied).
  85020. * @param subMeshes The submeshes to render
  85021. */
  85022. private static renderUnsorted;
  85023. /**
  85024. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  85025. * are rendered back to front if in the same alpha index.
  85026. *
  85027. * @param a The first submesh
  85028. * @param b The second submesh
  85029. * @returns The result of the comparison
  85030. */
  85031. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  85032. /**
  85033. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  85034. * are rendered back to front.
  85035. *
  85036. * @param a The first submesh
  85037. * @param b The second submesh
  85038. * @returns The result of the comparison
  85039. */
  85040. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  85041. /**
  85042. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  85043. * are rendered front to back (prevent overdraw).
  85044. *
  85045. * @param a The first submesh
  85046. * @param b The second submesh
  85047. * @returns The result of the comparison
  85048. */
  85049. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  85050. /**
  85051. * Resets the different lists of submeshes to prepare a new frame.
  85052. */
  85053. prepare(): void;
  85054. dispose(): void;
  85055. /**
  85056. * Inserts the submesh in its correct queue depending on its material.
  85057. * @param subMesh The submesh to dispatch
  85058. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  85059. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  85060. */
  85061. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  85062. dispatchSprites(spriteManager: ISpriteManager): void;
  85063. dispatchParticles(particleSystem: IParticleSystem): void;
  85064. private _renderParticles;
  85065. private _renderSprites;
  85066. }
  85067. }
  85068. declare module BABYLON {
  85069. /**
  85070. * Interface describing the different options available in the rendering manager
  85071. * regarding Auto Clear between groups.
  85072. */
  85073. export interface IRenderingManagerAutoClearSetup {
  85074. /**
  85075. * Defines whether or not autoclear is enable.
  85076. */
  85077. autoClear: boolean;
  85078. /**
  85079. * Defines whether or not to autoclear the depth buffer.
  85080. */
  85081. depth: boolean;
  85082. /**
  85083. * Defines whether or not to autoclear the stencil buffer.
  85084. */
  85085. stencil: boolean;
  85086. }
  85087. /**
  85088. * This class is used by the onRenderingGroupObservable
  85089. */
  85090. export class RenderingGroupInfo {
  85091. /**
  85092. * The Scene that being rendered
  85093. */
  85094. scene: Scene;
  85095. /**
  85096. * The camera currently used for the rendering pass
  85097. */
  85098. camera: Nullable<Camera>;
  85099. /**
  85100. * The ID of the renderingGroup being processed
  85101. */
  85102. renderingGroupId: number;
  85103. }
  85104. /**
  85105. * This is the manager responsible of all the rendering for meshes sprites and particles.
  85106. * It is enable to manage the different groups as well as the different necessary sort functions.
  85107. * This should not be used directly aside of the few static configurations
  85108. */
  85109. export class RenderingManager {
  85110. /**
  85111. * The max id used for rendering groups (not included)
  85112. */
  85113. static MAX_RENDERINGGROUPS: number;
  85114. /**
  85115. * The min id used for rendering groups (included)
  85116. */
  85117. static MIN_RENDERINGGROUPS: number;
  85118. /**
  85119. * Used to globally prevent autoclearing scenes.
  85120. */
  85121. static AUTOCLEAR: boolean;
  85122. /**
  85123. * @hidden
  85124. */
  85125. _useSceneAutoClearSetup: boolean;
  85126. private _scene;
  85127. private _renderingGroups;
  85128. private _depthStencilBufferAlreadyCleaned;
  85129. private _autoClearDepthStencil;
  85130. private _customOpaqueSortCompareFn;
  85131. private _customAlphaTestSortCompareFn;
  85132. private _customTransparentSortCompareFn;
  85133. private _renderingGroupInfo;
  85134. /**
  85135. * Instantiates a new rendering group for a particular scene
  85136. * @param scene Defines the scene the groups belongs to
  85137. */
  85138. constructor(scene: Scene);
  85139. private _clearDepthStencilBuffer;
  85140. /**
  85141. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  85142. * @hidden
  85143. */
  85144. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  85145. /**
  85146. * Resets the different information of the group to prepare a new frame
  85147. * @hidden
  85148. */
  85149. reset(): void;
  85150. /**
  85151. * Dispose and release the group and its associated resources.
  85152. * @hidden
  85153. */
  85154. dispose(): void;
  85155. /**
  85156. * Clear the info related to rendering groups preventing retention points during dispose.
  85157. */
  85158. freeRenderingGroups(): void;
  85159. private _prepareRenderingGroup;
  85160. /**
  85161. * Add a sprite manager to the rendering manager in order to render it this frame.
  85162. * @param spriteManager Define the sprite manager to render
  85163. */
  85164. dispatchSprites(spriteManager: ISpriteManager): void;
  85165. /**
  85166. * Add a particle system to the rendering manager in order to render it this frame.
  85167. * @param particleSystem Define the particle system to render
  85168. */
  85169. dispatchParticles(particleSystem: IParticleSystem): void;
  85170. /**
  85171. * Add a submesh to the manager in order to render it this frame
  85172. * @param subMesh The submesh to dispatch
  85173. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  85174. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  85175. */
  85176. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  85177. /**
  85178. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  85179. * This allowed control for front to back rendering or reversly depending of the special needs.
  85180. *
  85181. * @param renderingGroupId The rendering group id corresponding to its index
  85182. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  85183. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  85184. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  85185. */
  85186. 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;
  85187. /**
  85188. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  85189. *
  85190. * @param renderingGroupId The rendering group id corresponding to its index
  85191. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  85192. * @param depth Automatically clears depth between groups if true and autoClear is true.
  85193. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  85194. */
  85195. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  85196. /**
  85197. * Gets the current auto clear configuration for one rendering group of the rendering
  85198. * manager.
  85199. * @param index the rendering group index to get the information for
  85200. * @returns The auto clear setup for the requested rendering group
  85201. */
  85202. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  85203. }
  85204. }
  85205. declare module BABYLON {
  85206. /**
  85207. * This Helps creating a texture that will be created from a camera in your scene.
  85208. * It is basically a dynamic texture that could be used to create special effects for instance.
  85209. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  85210. */
  85211. export class RenderTargetTexture extends Texture {
  85212. isCube: boolean;
  85213. /**
  85214. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  85215. */
  85216. static readonly REFRESHRATE_RENDER_ONCE: number;
  85217. /**
  85218. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  85219. */
  85220. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  85221. /**
  85222. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  85223. * the central point of your effect and can save a lot of performances.
  85224. */
  85225. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  85226. /**
  85227. * Use this predicate to dynamically define the list of mesh you want to render.
  85228. * If set, the renderList property will be overwritten.
  85229. */
  85230. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  85231. private _renderList;
  85232. /**
  85233. * Use this list to define the list of mesh you want to render.
  85234. */
  85235. renderList: Nullable<Array<AbstractMesh>>;
  85236. private _hookArray;
  85237. /**
  85238. * Define if particles should be rendered in your texture.
  85239. */
  85240. renderParticles: boolean;
  85241. /**
  85242. * Define if sprites should be rendered in your texture.
  85243. */
  85244. renderSprites: boolean;
  85245. /**
  85246. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  85247. */
  85248. coordinatesMode: number;
  85249. /**
  85250. * Define the camera used to render the texture.
  85251. */
  85252. activeCamera: Nullable<Camera>;
  85253. /**
  85254. * Override the render function of the texture with your own one.
  85255. */
  85256. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  85257. /**
  85258. * Define if camera post processes should be use while rendering the texture.
  85259. */
  85260. useCameraPostProcesses: boolean;
  85261. /**
  85262. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  85263. */
  85264. ignoreCameraViewport: boolean;
  85265. private _postProcessManager;
  85266. private _postProcesses;
  85267. private _resizeObserver;
  85268. /**
  85269. * An event triggered when the texture is unbind.
  85270. */
  85271. onBeforeBindObservable: Observable<RenderTargetTexture>;
  85272. /**
  85273. * An event triggered when the texture is unbind.
  85274. */
  85275. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  85276. private _onAfterUnbindObserver;
  85277. /**
  85278. * Set a after unbind callback in the texture.
  85279. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  85280. */
  85281. onAfterUnbind: () => void;
  85282. /**
  85283. * An event triggered before rendering the texture
  85284. */
  85285. onBeforeRenderObservable: Observable<number>;
  85286. private _onBeforeRenderObserver;
  85287. /**
  85288. * Set a before render callback in the texture.
  85289. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  85290. */
  85291. onBeforeRender: (faceIndex: number) => void;
  85292. /**
  85293. * An event triggered after rendering the texture
  85294. */
  85295. onAfterRenderObservable: Observable<number>;
  85296. private _onAfterRenderObserver;
  85297. /**
  85298. * Set a after render callback in the texture.
  85299. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  85300. */
  85301. onAfterRender: (faceIndex: number) => void;
  85302. /**
  85303. * An event triggered after the texture clear
  85304. */
  85305. onClearObservable: Observable<Engine>;
  85306. private _onClearObserver;
  85307. /**
  85308. * Set a clear callback in the texture.
  85309. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  85310. */
  85311. onClear: (Engine: Engine) => void;
  85312. /**
  85313. * An event triggered when the texture is resized.
  85314. */
  85315. onResizeObservable: Observable<RenderTargetTexture>;
  85316. /**
  85317. * Define the clear color of the Render Target if it should be different from the scene.
  85318. */
  85319. clearColor: Color4;
  85320. protected _size: number | {
  85321. width: number;
  85322. height: number;
  85323. };
  85324. protected _initialSizeParameter: number | {
  85325. width: number;
  85326. height: number;
  85327. } | {
  85328. ratio: number;
  85329. };
  85330. protected _sizeRatio: Nullable<number>;
  85331. /** @hidden */
  85332. _generateMipMaps: boolean;
  85333. protected _renderingManager: RenderingManager;
  85334. /** @hidden */
  85335. _waitingRenderList: string[];
  85336. protected _doNotChangeAspectRatio: boolean;
  85337. protected _currentRefreshId: number;
  85338. protected _refreshRate: number;
  85339. protected _textureMatrix: Matrix;
  85340. protected _samples: number;
  85341. protected _renderTargetOptions: RenderTargetCreationOptions;
  85342. /**
  85343. * Gets render target creation options that were used.
  85344. */
  85345. readonly renderTargetOptions: RenderTargetCreationOptions;
  85346. protected _engine: Engine;
  85347. protected _onRatioRescale(): void;
  85348. /**
  85349. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  85350. * It must define where the camera used to render the texture is set
  85351. */
  85352. boundingBoxPosition: Vector3;
  85353. private _boundingBoxSize;
  85354. /**
  85355. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  85356. * When defined, the cubemap will switch to local mode
  85357. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  85358. * @example https://www.babylonjs-playground.com/#RNASML
  85359. */
  85360. boundingBoxSize: Vector3;
  85361. /**
  85362. * In case the RTT has been created with a depth texture, get the associated
  85363. * depth texture.
  85364. * Otherwise, return null.
  85365. */
  85366. depthStencilTexture: Nullable<InternalTexture>;
  85367. /**
  85368. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  85369. * or used a shadow, depth texture...
  85370. * @param name The friendly name of the texture
  85371. * @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)
  85372. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  85373. * @param generateMipMaps True if mip maps need to be generated after render.
  85374. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  85375. * @param type The type of the buffer in the RTT (int, half float, float...)
  85376. * @param isCube True if a cube texture needs to be created
  85377. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  85378. * @param generateDepthBuffer True to generate a depth buffer
  85379. * @param generateStencilBuffer True to generate a stencil buffer
  85380. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  85381. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  85382. * @param delayAllocation if the texture allocation should be delayed (default: false)
  85383. */
  85384. constructor(name: string, size: number | {
  85385. width: number;
  85386. height: number;
  85387. } | {
  85388. ratio: number;
  85389. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  85390. /**
  85391. * Creates a depth stencil texture.
  85392. * This is only available in WebGL 2 or with the depth texture extension available.
  85393. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  85394. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  85395. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  85396. */
  85397. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  85398. private _processSizeParameter;
  85399. /**
  85400. * Define the number of samples to use in case of MSAA.
  85401. * It defaults to one meaning no MSAA has been enabled.
  85402. */
  85403. samples: number;
  85404. /**
  85405. * Resets the refresh counter of the texture and start bak from scratch.
  85406. * Could be useful to regenerate the texture if it is setup to render only once.
  85407. */
  85408. resetRefreshCounter(): void;
  85409. /**
  85410. * Define the refresh rate of the texture or the rendering frequency.
  85411. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  85412. */
  85413. refreshRate: number;
  85414. /**
  85415. * Adds a post process to the render target rendering passes.
  85416. * @param postProcess define the post process to add
  85417. */
  85418. addPostProcess(postProcess: PostProcess): void;
  85419. /**
  85420. * Clear all the post processes attached to the render target
  85421. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  85422. */
  85423. clearPostProcesses(dispose?: boolean): void;
  85424. /**
  85425. * Remove one of the post process from the list of attached post processes to the texture
  85426. * @param postProcess define the post process to remove from the list
  85427. */
  85428. removePostProcess(postProcess: PostProcess): void;
  85429. /** @hidden */
  85430. _shouldRender(): boolean;
  85431. /**
  85432. * Gets the actual render size of the texture.
  85433. * @returns the width of the render size
  85434. */
  85435. getRenderSize(): number;
  85436. /**
  85437. * Gets the actual render width of the texture.
  85438. * @returns the width of the render size
  85439. */
  85440. getRenderWidth(): number;
  85441. /**
  85442. * Gets the actual render height of the texture.
  85443. * @returns the height of the render size
  85444. */
  85445. getRenderHeight(): number;
  85446. /**
  85447. * Get if the texture can be rescaled or not.
  85448. */
  85449. readonly canRescale: boolean;
  85450. /**
  85451. * Resize the texture using a ratio.
  85452. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  85453. */
  85454. scale(ratio: number): void;
  85455. /**
  85456. * Get the texture reflection matrix used to rotate/transform the reflection.
  85457. * @returns the reflection matrix
  85458. */
  85459. getReflectionTextureMatrix(): Matrix;
  85460. /**
  85461. * Resize the texture to a new desired size.
  85462. * Be carrefull as it will recreate all the data in the new texture.
  85463. * @param size Define the new size. It can be:
  85464. * - a number for squared texture,
  85465. * - an object containing { width: number, height: number }
  85466. * - or an object containing a ratio { ratio: number }
  85467. */
  85468. resize(size: number | {
  85469. width: number;
  85470. height: number;
  85471. } | {
  85472. ratio: number;
  85473. }): void;
  85474. /**
  85475. * Renders all the objects from the render list into the texture.
  85476. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  85477. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  85478. */
  85479. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  85480. private _bestReflectionRenderTargetDimension;
  85481. /**
  85482. * @hidden
  85483. * @param faceIndex face index to bind to if this is a cubetexture
  85484. */
  85485. _bindFrameBuffer(faceIndex?: number): void;
  85486. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  85487. private renderToTarget;
  85488. /**
  85489. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  85490. * This allowed control for front to back rendering or reversly depending of the special needs.
  85491. *
  85492. * @param renderingGroupId The rendering group id corresponding to its index
  85493. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  85494. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  85495. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  85496. */
  85497. 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;
  85498. /**
  85499. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  85500. *
  85501. * @param renderingGroupId The rendering group id corresponding to its index
  85502. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  85503. */
  85504. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  85505. /**
  85506. * Clones the texture.
  85507. * @returns the cloned texture
  85508. */
  85509. clone(): RenderTargetTexture;
  85510. /**
  85511. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  85512. * @returns The JSON representation of the texture
  85513. */
  85514. serialize(): any;
  85515. /**
  85516. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  85517. */
  85518. disposeFramebufferObjects(): void;
  85519. /**
  85520. * Dispose the texture and release its associated resources.
  85521. */
  85522. dispose(): void;
  85523. /** @hidden */
  85524. _rebuild(): void;
  85525. /**
  85526. * Clear the info related to rendering groups preventing retention point in material dispose.
  85527. */
  85528. freeRenderingGroups(): void;
  85529. /**
  85530. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  85531. * @returns the view count
  85532. */
  85533. getViewCount(): number;
  85534. }
  85535. }
  85536. declare module BABYLON {
  85537. /**
  85538. * Base class for the main features of a material in Babylon.js
  85539. */
  85540. export class Material implements IAnimatable {
  85541. /**
  85542. * Returns the triangle fill mode
  85543. */
  85544. static readonly TriangleFillMode: number;
  85545. /**
  85546. * Returns the wireframe mode
  85547. */
  85548. static readonly WireFrameFillMode: number;
  85549. /**
  85550. * Returns the point fill mode
  85551. */
  85552. static readonly PointFillMode: number;
  85553. /**
  85554. * Returns the point list draw mode
  85555. */
  85556. static readonly PointListDrawMode: number;
  85557. /**
  85558. * Returns the line list draw mode
  85559. */
  85560. static readonly LineListDrawMode: number;
  85561. /**
  85562. * Returns the line loop draw mode
  85563. */
  85564. static readonly LineLoopDrawMode: number;
  85565. /**
  85566. * Returns the line strip draw mode
  85567. */
  85568. static readonly LineStripDrawMode: number;
  85569. /**
  85570. * Returns the triangle strip draw mode
  85571. */
  85572. static readonly TriangleStripDrawMode: number;
  85573. /**
  85574. * Returns the triangle fan draw mode
  85575. */
  85576. static readonly TriangleFanDrawMode: number;
  85577. /**
  85578. * Stores the clock-wise side orientation
  85579. */
  85580. static readonly ClockWiseSideOrientation: number;
  85581. /**
  85582. * Stores the counter clock-wise side orientation
  85583. */
  85584. static readonly CounterClockWiseSideOrientation: number;
  85585. /**
  85586. * The dirty texture flag value
  85587. */
  85588. static readonly TextureDirtyFlag: number;
  85589. /**
  85590. * The dirty light flag value
  85591. */
  85592. static readonly LightDirtyFlag: number;
  85593. /**
  85594. * The dirty fresnel flag value
  85595. */
  85596. static readonly FresnelDirtyFlag: number;
  85597. /**
  85598. * The dirty attribute flag value
  85599. */
  85600. static readonly AttributesDirtyFlag: number;
  85601. /**
  85602. * The dirty misc flag value
  85603. */
  85604. static readonly MiscDirtyFlag: number;
  85605. /**
  85606. * The all dirty flag value
  85607. */
  85608. static readonly AllDirtyFlag: number;
  85609. /**
  85610. * The ID of the material
  85611. */
  85612. id: string;
  85613. /**
  85614. * Gets or sets the unique id of the material
  85615. */
  85616. uniqueId: number;
  85617. /**
  85618. * The name of the material
  85619. */
  85620. name: string;
  85621. /**
  85622. * Gets or sets user defined metadata
  85623. */
  85624. metadata: any;
  85625. /**
  85626. * For internal use only. Please do not use.
  85627. */
  85628. reservedDataStore: any;
  85629. /**
  85630. * Specifies if the ready state should be checked on each call
  85631. */
  85632. checkReadyOnEveryCall: boolean;
  85633. /**
  85634. * Specifies if the ready state should be checked once
  85635. */
  85636. checkReadyOnlyOnce: boolean;
  85637. /**
  85638. * The state of the material
  85639. */
  85640. state: string;
  85641. /**
  85642. * The alpha value of the material
  85643. */
  85644. protected _alpha: number;
  85645. /**
  85646. * List of inspectable custom properties (used by the Inspector)
  85647. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  85648. */
  85649. inspectableCustomProperties: IInspectable[];
  85650. /**
  85651. * Sets the alpha value of the material
  85652. */
  85653. /**
  85654. * Gets the alpha value of the material
  85655. */
  85656. alpha: number;
  85657. /**
  85658. * Specifies if back face culling is enabled
  85659. */
  85660. protected _backFaceCulling: boolean;
  85661. /**
  85662. * Sets the back-face culling state
  85663. */
  85664. /**
  85665. * Gets the back-face culling state
  85666. */
  85667. backFaceCulling: boolean;
  85668. /**
  85669. * Stores the value for side orientation
  85670. */
  85671. sideOrientation: number;
  85672. /**
  85673. * Callback triggered when the material is compiled
  85674. */
  85675. onCompiled: Nullable<(effect: Effect) => void>;
  85676. /**
  85677. * Callback triggered when an error occurs
  85678. */
  85679. onError: Nullable<(effect: Effect, errors: string) => void>;
  85680. /**
  85681. * Callback triggered to get the render target textures
  85682. */
  85683. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  85684. /**
  85685. * Gets a boolean indicating that current material needs to register RTT
  85686. */
  85687. readonly hasRenderTargetTextures: boolean;
  85688. /**
  85689. * Specifies if the material should be serialized
  85690. */
  85691. doNotSerialize: boolean;
  85692. /**
  85693. * @hidden
  85694. */
  85695. _storeEffectOnSubMeshes: boolean;
  85696. /**
  85697. * Stores the animations for the material
  85698. */
  85699. animations: Nullable<Array<Animation>>;
  85700. /**
  85701. * An event triggered when the material is disposed
  85702. */
  85703. onDisposeObservable: Observable<Material>;
  85704. /**
  85705. * An observer which watches for dispose events
  85706. */
  85707. private _onDisposeObserver;
  85708. private _onUnBindObservable;
  85709. /**
  85710. * Called during a dispose event
  85711. */
  85712. onDispose: () => void;
  85713. private _onBindObservable;
  85714. /**
  85715. * An event triggered when the material is bound
  85716. */
  85717. readonly onBindObservable: Observable<AbstractMesh>;
  85718. /**
  85719. * An observer which watches for bind events
  85720. */
  85721. private _onBindObserver;
  85722. /**
  85723. * Called during a bind event
  85724. */
  85725. onBind: (Mesh: AbstractMesh) => void;
  85726. /**
  85727. * An event triggered when the material is unbound
  85728. */
  85729. readonly onUnBindObservable: Observable<Material>;
  85730. /**
  85731. * Stores the value of the alpha mode
  85732. */
  85733. private _alphaMode;
  85734. /**
  85735. * Sets the value of the alpha mode.
  85736. *
  85737. * | Value | Type | Description |
  85738. * | --- | --- | --- |
  85739. * | 0 | ALPHA_DISABLE | |
  85740. * | 1 | ALPHA_ADD | |
  85741. * | 2 | ALPHA_COMBINE | |
  85742. * | 3 | ALPHA_SUBTRACT | |
  85743. * | 4 | ALPHA_MULTIPLY | |
  85744. * | 5 | ALPHA_MAXIMIZED | |
  85745. * | 6 | ALPHA_ONEONE | |
  85746. * | 7 | ALPHA_PREMULTIPLIED | |
  85747. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  85748. * | 9 | ALPHA_INTERPOLATE | |
  85749. * | 10 | ALPHA_SCREENMODE | |
  85750. *
  85751. */
  85752. /**
  85753. * Gets the value of the alpha mode
  85754. */
  85755. alphaMode: number;
  85756. /**
  85757. * Stores the state of the need depth pre-pass value
  85758. */
  85759. private _needDepthPrePass;
  85760. /**
  85761. * Sets the need depth pre-pass value
  85762. */
  85763. /**
  85764. * Gets the depth pre-pass value
  85765. */
  85766. needDepthPrePass: boolean;
  85767. /**
  85768. * Specifies if depth writing should be disabled
  85769. */
  85770. disableDepthWrite: boolean;
  85771. /**
  85772. * Specifies if depth writing should be forced
  85773. */
  85774. forceDepthWrite: boolean;
  85775. /**
  85776. * Specifies if there should be a separate pass for culling
  85777. */
  85778. separateCullingPass: boolean;
  85779. /**
  85780. * Stores the state specifing if fog should be enabled
  85781. */
  85782. private _fogEnabled;
  85783. /**
  85784. * Sets the state for enabling fog
  85785. */
  85786. /**
  85787. * Gets the value of the fog enabled state
  85788. */
  85789. fogEnabled: boolean;
  85790. /**
  85791. * Stores the size of points
  85792. */
  85793. pointSize: number;
  85794. /**
  85795. * Stores the z offset value
  85796. */
  85797. zOffset: number;
  85798. /**
  85799. * Gets a value specifying if wireframe mode is enabled
  85800. */
  85801. /**
  85802. * Sets the state of wireframe mode
  85803. */
  85804. wireframe: boolean;
  85805. /**
  85806. * Gets the value specifying if point clouds are enabled
  85807. */
  85808. /**
  85809. * Sets the state of point cloud mode
  85810. */
  85811. pointsCloud: boolean;
  85812. /**
  85813. * Gets the material fill mode
  85814. */
  85815. /**
  85816. * Sets the material fill mode
  85817. */
  85818. fillMode: number;
  85819. /**
  85820. * @hidden
  85821. * Stores the effects for the material
  85822. */
  85823. _effect: Nullable<Effect>;
  85824. /**
  85825. * @hidden
  85826. * Specifies if the material was previously ready
  85827. */
  85828. _wasPreviouslyReady: boolean;
  85829. /**
  85830. * Specifies if uniform buffers should be used
  85831. */
  85832. private _useUBO;
  85833. /**
  85834. * Stores a reference to the scene
  85835. */
  85836. private _scene;
  85837. /**
  85838. * Stores the fill mode state
  85839. */
  85840. private _fillMode;
  85841. /**
  85842. * Specifies if the depth write state should be cached
  85843. */
  85844. private _cachedDepthWriteState;
  85845. /**
  85846. * Stores the uniform buffer
  85847. */
  85848. protected _uniformBuffer: UniformBuffer;
  85849. /** @hidden */
  85850. _indexInSceneMaterialArray: number;
  85851. /** @hidden */
  85852. meshMap: Nullable<{
  85853. [id: string]: AbstractMesh | undefined;
  85854. }>;
  85855. /**
  85856. * Creates a material instance
  85857. * @param name defines the name of the material
  85858. * @param scene defines the scene to reference
  85859. * @param doNotAdd specifies if the material should be added to the scene
  85860. */
  85861. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  85862. /**
  85863. * Returns a string representation of the current material
  85864. * @param fullDetails defines a boolean indicating which levels of logging is desired
  85865. * @returns a string with material information
  85866. */
  85867. toString(fullDetails?: boolean): string;
  85868. /**
  85869. * Gets the class name of the material
  85870. * @returns a string with the class name of the material
  85871. */
  85872. getClassName(): string;
  85873. /**
  85874. * Specifies if updates for the material been locked
  85875. */
  85876. readonly isFrozen: boolean;
  85877. /**
  85878. * Locks updates for the material
  85879. */
  85880. freeze(): void;
  85881. /**
  85882. * Unlocks updates for the material
  85883. */
  85884. unfreeze(): void;
  85885. /**
  85886. * Specifies if the material is ready to be used
  85887. * @param mesh defines the mesh to check
  85888. * @param useInstances specifies if instances should be used
  85889. * @returns a boolean indicating if the material is ready to be used
  85890. */
  85891. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  85892. /**
  85893. * Specifies that the submesh is ready to be used
  85894. * @param mesh defines the mesh to check
  85895. * @param subMesh defines which submesh to check
  85896. * @param useInstances specifies that instances should be used
  85897. * @returns a boolean indicating that the submesh is ready or not
  85898. */
  85899. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  85900. /**
  85901. * Returns the material effect
  85902. * @returns the effect associated with the material
  85903. */
  85904. getEffect(): Nullable<Effect>;
  85905. /**
  85906. * Returns the current scene
  85907. * @returns a Scene
  85908. */
  85909. getScene(): Scene;
  85910. /**
  85911. * Specifies if the material will require alpha blending
  85912. * @returns a boolean specifying if alpha blending is needed
  85913. */
  85914. needAlphaBlending(): boolean;
  85915. /**
  85916. * Specifies if the mesh will require alpha blending
  85917. * @param mesh defines the mesh to check
  85918. * @returns a boolean specifying if alpha blending is needed for the mesh
  85919. */
  85920. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  85921. /**
  85922. * Specifies if this material should be rendered in alpha test mode
  85923. * @returns a boolean specifying if an alpha test is needed.
  85924. */
  85925. needAlphaTesting(): boolean;
  85926. /**
  85927. * Gets the texture used for the alpha test
  85928. * @returns the texture to use for alpha testing
  85929. */
  85930. getAlphaTestTexture(): Nullable<BaseTexture>;
  85931. /**
  85932. * Marks the material to indicate that it needs to be re-calculated
  85933. */
  85934. markDirty(): void;
  85935. /** @hidden */
  85936. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  85937. /**
  85938. * Binds the material to the mesh
  85939. * @param world defines the world transformation matrix
  85940. * @param mesh defines the mesh to bind the material to
  85941. */
  85942. bind(world: Matrix, mesh?: Mesh): void;
  85943. /**
  85944. * Binds the submesh to the material
  85945. * @param world defines the world transformation matrix
  85946. * @param mesh defines the mesh containing the submesh
  85947. * @param subMesh defines the submesh to bind the material to
  85948. */
  85949. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  85950. /**
  85951. * Binds the world matrix to the material
  85952. * @param world defines the world transformation matrix
  85953. */
  85954. bindOnlyWorldMatrix(world: Matrix): void;
  85955. /**
  85956. * Binds the scene's uniform buffer to the effect.
  85957. * @param effect defines the effect to bind to the scene uniform buffer
  85958. * @param sceneUbo defines the uniform buffer storing scene data
  85959. */
  85960. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  85961. /**
  85962. * Binds the view matrix to the effect
  85963. * @param effect defines the effect to bind the view matrix to
  85964. */
  85965. bindView(effect: Effect): void;
  85966. /**
  85967. * Binds the view projection matrix to the effect
  85968. * @param effect defines the effect to bind the view projection matrix to
  85969. */
  85970. bindViewProjection(effect: Effect): void;
  85971. /**
  85972. * Specifies if material alpha testing should be turned on for the mesh
  85973. * @param mesh defines the mesh to check
  85974. */
  85975. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  85976. /**
  85977. * Processes to execute after binding the material to a mesh
  85978. * @param mesh defines the rendered mesh
  85979. */
  85980. protected _afterBind(mesh?: Mesh): void;
  85981. /**
  85982. * Unbinds the material from the mesh
  85983. */
  85984. unbind(): void;
  85985. /**
  85986. * Gets the active textures from the material
  85987. * @returns an array of textures
  85988. */
  85989. getActiveTextures(): BaseTexture[];
  85990. /**
  85991. * Specifies if the material uses a texture
  85992. * @param texture defines the texture to check against the material
  85993. * @returns a boolean specifying if the material uses the texture
  85994. */
  85995. hasTexture(texture: BaseTexture): boolean;
  85996. /**
  85997. * Makes a duplicate of the material, and gives it a new name
  85998. * @param name defines the new name for the duplicated material
  85999. * @returns the cloned material
  86000. */
  86001. clone(name: string): Nullable<Material>;
  86002. /**
  86003. * Gets the meshes bound to the material
  86004. * @returns an array of meshes bound to the material
  86005. */
  86006. getBindedMeshes(): AbstractMesh[];
  86007. /**
  86008. * Force shader compilation
  86009. * @param mesh defines the mesh associated with this material
  86010. * @param onCompiled defines a function to execute once the material is compiled
  86011. * @param options defines the options to configure the compilation
  86012. */
  86013. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  86014. clipPlane: boolean;
  86015. }>): void;
  86016. /**
  86017. * Force shader compilation
  86018. * @param mesh defines the mesh that will use this material
  86019. * @param options defines additional options for compiling the shaders
  86020. * @returns a promise that resolves when the compilation completes
  86021. */
  86022. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<{
  86023. clipPlane: boolean;
  86024. }>): Promise<void>;
  86025. private static readonly _AllDirtyCallBack;
  86026. private static readonly _ImageProcessingDirtyCallBack;
  86027. private static readonly _TextureDirtyCallBack;
  86028. private static readonly _FresnelDirtyCallBack;
  86029. private static readonly _MiscDirtyCallBack;
  86030. private static readonly _LightsDirtyCallBack;
  86031. private static readonly _AttributeDirtyCallBack;
  86032. private static _FresnelAndMiscDirtyCallBack;
  86033. private static _TextureAndMiscDirtyCallBack;
  86034. private static readonly _DirtyCallbackArray;
  86035. private static readonly _RunDirtyCallBacks;
  86036. /**
  86037. * Marks a define in the material to indicate that it needs to be re-computed
  86038. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  86039. */
  86040. markAsDirty(flag: number): void;
  86041. /**
  86042. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  86043. * @param func defines a function which checks material defines against the submeshes
  86044. */
  86045. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  86046. /**
  86047. * Indicates that we need to re-calculated for all submeshes
  86048. */
  86049. protected _markAllSubMeshesAsAllDirty(): void;
  86050. /**
  86051. * Indicates that image processing needs to be re-calculated for all submeshes
  86052. */
  86053. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  86054. /**
  86055. * Indicates that textures need to be re-calculated for all submeshes
  86056. */
  86057. protected _markAllSubMeshesAsTexturesDirty(): void;
  86058. /**
  86059. * Indicates that fresnel needs to be re-calculated for all submeshes
  86060. */
  86061. protected _markAllSubMeshesAsFresnelDirty(): void;
  86062. /**
  86063. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  86064. */
  86065. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  86066. /**
  86067. * Indicates that lights need to be re-calculated for all submeshes
  86068. */
  86069. protected _markAllSubMeshesAsLightsDirty(): void;
  86070. /**
  86071. * Indicates that attributes need to be re-calculated for all submeshes
  86072. */
  86073. protected _markAllSubMeshesAsAttributesDirty(): void;
  86074. /**
  86075. * Indicates that misc needs to be re-calculated for all submeshes
  86076. */
  86077. protected _markAllSubMeshesAsMiscDirty(): void;
  86078. /**
  86079. * Indicates that textures and misc need to be re-calculated for all submeshes
  86080. */
  86081. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  86082. /**
  86083. * Disposes the material
  86084. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  86085. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  86086. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  86087. */
  86088. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  86089. /** @hidden */
  86090. private releaseVertexArrayObject;
  86091. /**
  86092. * Serializes this material
  86093. * @returns the serialized material object
  86094. */
  86095. serialize(): any;
  86096. /**
  86097. * Creates a material from parsed material data
  86098. * @param parsedMaterial defines parsed material data
  86099. * @param scene defines the hosting scene
  86100. * @param rootUrl defines the root URL to use to load textures
  86101. * @returns a new material
  86102. */
  86103. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  86104. }
  86105. }
  86106. declare module BABYLON {
  86107. /**
  86108. * A multi-material is used to apply different materials to different parts of the same object without the need of
  86109. * separate meshes. This can be use to improve performances.
  86110. * @see http://doc.babylonjs.com/how_to/multi_materials
  86111. */
  86112. export class MultiMaterial extends Material {
  86113. private _subMaterials;
  86114. /**
  86115. * Gets or Sets the list of Materials used within the multi material.
  86116. * They need to be ordered according to the submeshes order in the associated mesh
  86117. */
  86118. subMaterials: Nullable<Material>[];
  86119. /**
  86120. * Function used to align with Node.getChildren()
  86121. * @returns the list of Materials used within the multi material
  86122. */
  86123. getChildren(): Nullable<Material>[];
  86124. /**
  86125. * Instantiates a new Multi Material
  86126. * A multi-material is used to apply different materials to different parts of the same object without the need of
  86127. * separate meshes. This can be use to improve performances.
  86128. * @see http://doc.babylonjs.com/how_to/multi_materials
  86129. * @param name Define the name in the scene
  86130. * @param scene Define the scene the material belongs to
  86131. */
  86132. constructor(name: string, scene: Scene);
  86133. private _hookArray;
  86134. /**
  86135. * Get one of the submaterial by its index in the submaterials array
  86136. * @param index The index to look the sub material at
  86137. * @returns The Material if the index has been defined
  86138. */
  86139. getSubMaterial(index: number): Nullable<Material>;
  86140. /**
  86141. * Get the list of active textures for the whole sub materials list.
  86142. * @returns All the textures that will be used during the rendering
  86143. */
  86144. getActiveTextures(): BaseTexture[];
  86145. /**
  86146. * Gets the current class name of the material e.g. "MultiMaterial"
  86147. * Mainly use in serialization.
  86148. * @returns the class name
  86149. */
  86150. getClassName(): string;
  86151. /**
  86152. * Checks if the material is ready to render the requested sub mesh
  86153. * @param mesh Define the mesh the submesh belongs to
  86154. * @param subMesh Define the sub mesh to look readyness for
  86155. * @param useInstances Define whether or not the material is used with instances
  86156. * @returns true if ready, otherwise false
  86157. */
  86158. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  86159. /**
  86160. * Clones the current material and its related sub materials
  86161. * @param name Define the name of the newly cloned material
  86162. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  86163. * @returns the cloned material
  86164. */
  86165. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  86166. /**
  86167. * Serializes the materials into a JSON representation.
  86168. * @returns the JSON representation
  86169. */
  86170. serialize(): any;
  86171. /**
  86172. * Dispose the material and release its associated resources
  86173. * @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)
  86174. * @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)
  86175. * @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)
  86176. */
  86177. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  86178. /**
  86179. * Creates a MultiMaterial from parsed MultiMaterial data.
  86180. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  86181. * @param scene defines the hosting scene
  86182. * @returns a new MultiMaterial
  86183. */
  86184. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  86185. }
  86186. }
  86187. declare module BABYLON {
  86188. /**
  86189. * Base class for submeshes
  86190. */
  86191. export class BaseSubMesh {
  86192. /** @hidden */
  86193. _materialDefines: Nullable<MaterialDefines>;
  86194. /** @hidden */
  86195. _materialEffect: Nullable<Effect>;
  86196. /**
  86197. * Gets associated effect
  86198. */
  86199. readonly effect: Nullable<Effect>;
  86200. /**
  86201. * Sets associated effect (effect used to render this submesh)
  86202. * @param effect defines the effect to associate with
  86203. * @param defines defines the set of defines used to compile this effect
  86204. */
  86205. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  86206. }
  86207. /**
  86208. * Defines a subdivision inside a mesh
  86209. */
  86210. export class SubMesh extends BaseSubMesh implements ICullable {
  86211. /** the material index to use */
  86212. materialIndex: number;
  86213. /** vertex index start */
  86214. verticesStart: number;
  86215. /** vertices count */
  86216. verticesCount: number;
  86217. /** index start */
  86218. indexStart: number;
  86219. /** indices count */
  86220. indexCount: number;
  86221. /** @hidden */
  86222. _linesIndexCount: number;
  86223. private _mesh;
  86224. private _renderingMesh;
  86225. private _boundingInfo;
  86226. private _linesIndexBuffer;
  86227. /** @hidden */
  86228. _lastColliderWorldVertices: Nullable<Vector3[]>;
  86229. /** @hidden */
  86230. _trianglePlanes: Plane[];
  86231. /** @hidden */
  86232. _lastColliderTransformMatrix: Nullable<Matrix>;
  86233. /** @hidden */
  86234. _renderId: number;
  86235. /** @hidden */
  86236. _alphaIndex: number;
  86237. /** @hidden */
  86238. _distanceToCamera: number;
  86239. /** @hidden */
  86240. _id: number;
  86241. private _currentMaterial;
  86242. /**
  86243. * Add a new submesh to a mesh
  86244. * @param materialIndex defines the material index to use
  86245. * @param verticesStart defines vertex index start
  86246. * @param verticesCount defines vertices count
  86247. * @param indexStart defines index start
  86248. * @param indexCount defines indices count
  86249. * @param mesh defines the parent mesh
  86250. * @param renderingMesh defines an optional rendering mesh
  86251. * @param createBoundingBox defines if bounding box should be created for this submesh
  86252. * @returns the new submesh
  86253. */
  86254. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  86255. /**
  86256. * Creates a new submesh
  86257. * @param materialIndex defines the material index to use
  86258. * @param verticesStart defines vertex index start
  86259. * @param verticesCount defines vertices count
  86260. * @param indexStart defines index start
  86261. * @param indexCount defines indices count
  86262. * @param mesh defines the parent mesh
  86263. * @param renderingMesh defines an optional rendering mesh
  86264. * @param createBoundingBox defines if bounding box should be created for this submesh
  86265. */
  86266. constructor(
  86267. /** the material index to use */
  86268. materialIndex: number,
  86269. /** vertex index start */
  86270. verticesStart: number,
  86271. /** vertices count */
  86272. verticesCount: number,
  86273. /** index start */
  86274. indexStart: number,
  86275. /** indices count */
  86276. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  86277. /**
  86278. * Returns true if this submesh covers the entire parent mesh
  86279. * @ignorenaming
  86280. */
  86281. readonly IsGlobal: boolean;
  86282. /**
  86283. * Returns the submesh BoudingInfo object
  86284. * @returns current bounding info (or mesh's one if the submesh is global)
  86285. */
  86286. getBoundingInfo(): BoundingInfo;
  86287. /**
  86288. * Sets the submesh BoundingInfo
  86289. * @param boundingInfo defines the new bounding info to use
  86290. * @returns the SubMesh
  86291. */
  86292. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  86293. /**
  86294. * Returns the mesh of the current submesh
  86295. * @return the parent mesh
  86296. */
  86297. getMesh(): AbstractMesh;
  86298. /**
  86299. * Returns the rendering mesh of the submesh
  86300. * @returns the rendering mesh (could be different from parent mesh)
  86301. */
  86302. getRenderingMesh(): Mesh;
  86303. /**
  86304. * Returns the submesh material
  86305. * @returns null or the current material
  86306. */
  86307. getMaterial(): Nullable<Material>;
  86308. /**
  86309. * Sets a new updated BoundingInfo object to the submesh
  86310. * @param data defines an optional position array to use to determine the bounding info
  86311. * @returns the SubMesh
  86312. */
  86313. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  86314. /** @hidden */
  86315. _checkCollision(collider: Collider): boolean;
  86316. /**
  86317. * Updates the submesh BoundingInfo
  86318. * @param world defines the world matrix to use to update the bounding info
  86319. * @returns the submesh
  86320. */
  86321. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  86322. /**
  86323. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  86324. * @param frustumPlanes defines the frustum planes
  86325. * @returns true if the submesh is intersecting with the frustum
  86326. */
  86327. isInFrustum(frustumPlanes: Plane[]): boolean;
  86328. /**
  86329. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  86330. * @param frustumPlanes defines the frustum planes
  86331. * @returns true if the submesh is inside the frustum
  86332. */
  86333. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86334. /**
  86335. * Renders the submesh
  86336. * @param enableAlphaMode defines if alpha needs to be used
  86337. * @returns the submesh
  86338. */
  86339. render(enableAlphaMode: boolean): SubMesh;
  86340. /**
  86341. * @hidden
  86342. */
  86343. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  86344. /**
  86345. * Checks if the submesh intersects with a ray
  86346. * @param ray defines the ray to test
  86347. * @returns true is the passed ray intersects the submesh bounding box
  86348. */
  86349. canIntersects(ray: Ray): boolean;
  86350. /**
  86351. * Intersects current submesh with a ray
  86352. * @param ray defines the ray to test
  86353. * @param positions defines mesh's positions array
  86354. * @param indices defines mesh's indices array
  86355. * @param fastCheck defines if only bounding info should be used
  86356. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  86357. * @returns intersection info or null if no intersection
  86358. */
  86359. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  86360. /** @hidden */
  86361. private _intersectLines;
  86362. /** @hidden */
  86363. private _intersectUnIndexedLines;
  86364. /** @hidden */
  86365. private _intersectTriangles;
  86366. /** @hidden */
  86367. private _intersectUnIndexedTriangles;
  86368. /** @hidden */
  86369. _rebuild(): void;
  86370. /**
  86371. * Creates a new submesh from the passed mesh
  86372. * @param newMesh defines the new hosting mesh
  86373. * @param newRenderingMesh defines an optional rendering mesh
  86374. * @returns the new submesh
  86375. */
  86376. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  86377. /**
  86378. * Release associated resources
  86379. */
  86380. dispose(): void;
  86381. /**
  86382. * Gets the class name
  86383. * @returns the string "SubMesh".
  86384. */
  86385. getClassName(): string;
  86386. /**
  86387. * Creates a new submesh from indices data
  86388. * @param materialIndex the index of the main mesh material
  86389. * @param startIndex the index where to start the copy in the mesh indices array
  86390. * @param indexCount the number of indices to copy then from the startIndex
  86391. * @param mesh the main mesh to create the submesh from
  86392. * @param renderingMesh the optional rendering mesh
  86393. * @returns a new submesh
  86394. */
  86395. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  86396. }
  86397. }
  86398. declare module BABYLON {
  86399. /**
  86400. * Class used to represent data loading progression
  86401. */
  86402. export class SceneLoaderFlags {
  86403. private static _ForceFullSceneLoadingForIncremental;
  86404. private static _ShowLoadingScreen;
  86405. private static _CleanBoneMatrixWeights;
  86406. private static _loggingLevel;
  86407. /**
  86408. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  86409. */
  86410. static ForceFullSceneLoadingForIncremental: boolean;
  86411. /**
  86412. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  86413. */
  86414. static ShowLoadingScreen: boolean;
  86415. /**
  86416. * Defines the current logging level (while loading the scene)
  86417. * @ignorenaming
  86418. */
  86419. static loggingLevel: number;
  86420. /**
  86421. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  86422. */
  86423. static CleanBoneMatrixWeights: boolean;
  86424. }
  86425. }
  86426. declare module BABYLON {
  86427. /**
  86428. * Class used to store geometry data (vertex buffers + index buffer)
  86429. */
  86430. export class Geometry implements IGetSetVerticesData {
  86431. /**
  86432. * Gets or sets the ID of the geometry
  86433. */
  86434. id: string;
  86435. /**
  86436. * Gets or sets the unique ID of the geometry
  86437. */
  86438. uniqueId: number;
  86439. /**
  86440. * Gets the delay loading state of the geometry (none by default which means not delayed)
  86441. */
  86442. delayLoadState: number;
  86443. /**
  86444. * Gets the file containing the data to load when running in delay load state
  86445. */
  86446. delayLoadingFile: Nullable<string>;
  86447. /**
  86448. * Callback called when the geometry is updated
  86449. */
  86450. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  86451. private _scene;
  86452. private _engine;
  86453. private _meshes;
  86454. private _totalVertices;
  86455. /** @hidden */
  86456. _indices: IndicesArray;
  86457. /** @hidden */
  86458. _vertexBuffers: {
  86459. [key: string]: VertexBuffer;
  86460. };
  86461. private _isDisposed;
  86462. private _extend;
  86463. private _boundingBias;
  86464. /** @hidden */
  86465. _delayInfo: Array<string>;
  86466. private _indexBuffer;
  86467. private _indexBufferIsUpdatable;
  86468. /** @hidden */
  86469. _boundingInfo: Nullable<BoundingInfo>;
  86470. /** @hidden */
  86471. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  86472. /** @hidden */
  86473. _softwareSkinningFrameId: number;
  86474. private _vertexArrayObjects;
  86475. private _updatable;
  86476. /** @hidden */
  86477. _positions: Nullable<Vector3[]>;
  86478. /**
  86479. * 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
  86480. */
  86481. /**
  86482. * 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
  86483. */
  86484. boundingBias: Vector2;
  86485. /**
  86486. * Static function used to attach a new empty geometry to a mesh
  86487. * @param mesh defines the mesh to attach the geometry to
  86488. * @returns the new Geometry
  86489. */
  86490. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  86491. /**
  86492. * Creates a new geometry
  86493. * @param id defines the unique ID
  86494. * @param scene defines the hosting scene
  86495. * @param vertexData defines the VertexData used to get geometry data
  86496. * @param updatable defines if geometry must be updatable (false by default)
  86497. * @param mesh defines the mesh that will be associated with the geometry
  86498. */
  86499. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  86500. /**
  86501. * Gets the current extend of the geometry
  86502. */
  86503. readonly extend: {
  86504. minimum: Vector3;
  86505. maximum: Vector3;
  86506. };
  86507. /**
  86508. * Gets the hosting scene
  86509. * @returns the hosting Scene
  86510. */
  86511. getScene(): Scene;
  86512. /**
  86513. * Gets the hosting engine
  86514. * @returns the hosting Engine
  86515. */
  86516. getEngine(): Engine;
  86517. /**
  86518. * Defines if the geometry is ready to use
  86519. * @returns true if the geometry is ready to be used
  86520. */
  86521. isReady(): boolean;
  86522. /**
  86523. * Gets a value indicating that the geometry should not be serialized
  86524. */
  86525. readonly doNotSerialize: boolean;
  86526. /** @hidden */
  86527. _rebuild(): void;
  86528. /**
  86529. * Affects all geometry data in one call
  86530. * @param vertexData defines the geometry data
  86531. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  86532. */
  86533. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  86534. /**
  86535. * Set specific vertex data
  86536. * @param kind defines the data kind (Position, normal, etc...)
  86537. * @param data defines the vertex data to use
  86538. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  86539. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  86540. */
  86541. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  86542. /**
  86543. * Removes a specific vertex data
  86544. * @param kind defines the data kind (Position, normal, etc...)
  86545. */
  86546. removeVerticesData(kind: string): void;
  86547. /**
  86548. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  86549. * @param buffer defines the vertex buffer to use
  86550. * @param totalVertices defines the total number of vertices for position kind (could be null)
  86551. */
  86552. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  86553. /**
  86554. * Update a specific vertex buffer
  86555. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  86556. * It will do nothing if the buffer is not updatable
  86557. * @param kind defines the data kind (Position, normal, etc...)
  86558. * @param data defines the data to use
  86559. * @param offset defines the offset in the target buffer where to store the data
  86560. * @param useBytes set to true if the offset is in bytes
  86561. */
  86562. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  86563. /**
  86564. * Update a specific vertex buffer
  86565. * This function will create a new buffer if the current one is not updatable
  86566. * @param kind defines the data kind (Position, normal, etc...)
  86567. * @param data defines the data to use
  86568. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  86569. */
  86570. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  86571. private _updateBoundingInfo;
  86572. /** @hidden */
  86573. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  86574. /**
  86575. * Gets total number of vertices
  86576. * @returns the total number of vertices
  86577. */
  86578. getTotalVertices(): number;
  86579. /**
  86580. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  86581. * @param kind defines the data kind (Position, normal, etc...)
  86582. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  86583. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  86584. * @returns a float array containing vertex data
  86585. */
  86586. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  86587. /**
  86588. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  86589. * @param kind defines the data kind (Position, normal, etc...)
  86590. * @returns true if the vertex buffer with the specified kind is updatable
  86591. */
  86592. isVertexBufferUpdatable(kind: string): boolean;
  86593. /**
  86594. * Gets a specific vertex buffer
  86595. * @param kind defines the data kind (Position, normal, etc...)
  86596. * @returns a VertexBuffer
  86597. */
  86598. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  86599. /**
  86600. * Returns all vertex buffers
  86601. * @return an object holding all vertex buffers indexed by kind
  86602. */
  86603. getVertexBuffers(): Nullable<{
  86604. [key: string]: VertexBuffer;
  86605. }>;
  86606. /**
  86607. * Gets a boolean indicating if specific vertex buffer is present
  86608. * @param kind defines the data kind (Position, normal, etc...)
  86609. * @returns true if data is present
  86610. */
  86611. isVerticesDataPresent(kind: string): boolean;
  86612. /**
  86613. * Gets a list of all attached data kinds (Position, normal, etc...)
  86614. * @returns a list of string containing all kinds
  86615. */
  86616. getVerticesDataKinds(): string[];
  86617. /**
  86618. * Update index buffer
  86619. * @param indices defines the indices to store in the index buffer
  86620. * @param offset defines the offset in the target buffer where to store the data
  86621. * @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)
  86622. */
  86623. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  86624. /**
  86625. * Creates a new index buffer
  86626. * @param indices defines the indices to store in the index buffer
  86627. * @param totalVertices defines the total number of vertices (could be null)
  86628. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  86629. */
  86630. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  86631. /**
  86632. * Return the total number of indices
  86633. * @returns the total number of indices
  86634. */
  86635. getTotalIndices(): number;
  86636. /**
  86637. * Gets the index buffer array
  86638. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  86639. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  86640. * @returns the index buffer array
  86641. */
  86642. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  86643. /**
  86644. * Gets the index buffer
  86645. * @return the index buffer
  86646. */
  86647. getIndexBuffer(): Nullable<DataBuffer>;
  86648. /** @hidden */
  86649. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  86650. /**
  86651. * Release the associated resources for a specific mesh
  86652. * @param mesh defines the source mesh
  86653. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  86654. */
  86655. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  86656. /**
  86657. * Apply current geometry to a given mesh
  86658. * @param mesh defines the mesh to apply geometry to
  86659. */
  86660. applyToMesh(mesh: Mesh): void;
  86661. private _updateExtend;
  86662. private _applyToMesh;
  86663. private notifyUpdate;
  86664. /**
  86665. * Load the geometry if it was flagged as delay loaded
  86666. * @param scene defines the hosting scene
  86667. * @param onLoaded defines a callback called when the geometry is loaded
  86668. */
  86669. load(scene: Scene, onLoaded?: () => void): void;
  86670. private _queueLoad;
  86671. /**
  86672. * Invert the geometry to move from a right handed system to a left handed one.
  86673. */
  86674. toLeftHanded(): void;
  86675. /** @hidden */
  86676. _resetPointsArrayCache(): void;
  86677. /** @hidden */
  86678. _generatePointsArray(): boolean;
  86679. /**
  86680. * Gets a value indicating if the geometry is disposed
  86681. * @returns true if the geometry was disposed
  86682. */
  86683. isDisposed(): boolean;
  86684. private _disposeVertexArrayObjects;
  86685. /**
  86686. * Free all associated resources
  86687. */
  86688. dispose(): void;
  86689. /**
  86690. * Clone the current geometry into a new geometry
  86691. * @param id defines the unique ID of the new geometry
  86692. * @returns a new geometry object
  86693. */
  86694. copy(id: string): Geometry;
  86695. /**
  86696. * Serialize the current geometry info (and not the vertices data) into a JSON object
  86697. * @return a JSON representation of the current geometry data (without the vertices data)
  86698. */
  86699. serialize(): any;
  86700. private toNumberArray;
  86701. /**
  86702. * Serialize all vertices data into a JSON oject
  86703. * @returns a JSON representation of the current geometry data
  86704. */
  86705. serializeVerticeData(): any;
  86706. /**
  86707. * Extracts a clone of a mesh geometry
  86708. * @param mesh defines the source mesh
  86709. * @param id defines the unique ID of the new geometry object
  86710. * @returns the new geometry object
  86711. */
  86712. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  86713. /**
  86714. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  86715. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  86716. * Be aware Math.random() could cause collisions, but:
  86717. * "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"
  86718. * @returns a string containing a new GUID
  86719. */
  86720. static RandomId(): string;
  86721. /** @hidden */
  86722. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  86723. private static _CleanMatricesWeights;
  86724. /**
  86725. * Create a new geometry from persisted data (Using .babylon file format)
  86726. * @param parsedVertexData defines the persisted data
  86727. * @param scene defines the hosting scene
  86728. * @param rootUrl defines the root url to use to load assets (like delayed data)
  86729. * @returns the new geometry object
  86730. */
  86731. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  86732. }
  86733. }
  86734. declare module BABYLON {
  86735. /**
  86736. * Define an interface for all classes that will get and set the data on vertices
  86737. */
  86738. export interface IGetSetVerticesData {
  86739. /**
  86740. * Gets a boolean indicating if specific vertex data is present
  86741. * @param kind defines the vertex data kind to use
  86742. * @returns true is data kind is present
  86743. */
  86744. isVerticesDataPresent(kind: string): boolean;
  86745. /**
  86746. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  86747. * @param kind defines the data kind (Position, normal, etc...)
  86748. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  86749. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  86750. * @returns a float array containing vertex data
  86751. */
  86752. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  86753. /**
  86754. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  86755. * @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.
  86756. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  86757. * @returns the indices array or an empty array if the mesh has no geometry
  86758. */
  86759. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  86760. /**
  86761. * Set specific vertex data
  86762. * @param kind defines the data kind (Position, normal, etc...)
  86763. * @param data defines the vertex data to use
  86764. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  86765. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  86766. */
  86767. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  86768. /**
  86769. * Update a specific associated vertex buffer
  86770. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  86771. * - VertexBuffer.PositionKind
  86772. * - VertexBuffer.UVKind
  86773. * - VertexBuffer.UV2Kind
  86774. * - VertexBuffer.UV3Kind
  86775. * - VertexBuffer.UV4Kind
  86776. * - VertexBuffer.UV5Kind
  86777. * - VertexBuffer.UV6Kind
  86778. * - VertexBuffer.ColorKind
  86779. * - VertexBuffer.MatricesIndicesKind
  86780. * - VertexBuffer.MatricesIndicesExtraKind
  86781. * - VertexBuffer.MatricesWeightsKind
  86782. * - VertexBuffer.MatricesWeightsExtraKind
  86783. * @param data defines the data source
  86784. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  86785. * @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)
  86786. */
  86787. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  86788. /**
  86789. * Creates a new index buffer
  86790. * @param indices defines the indices to store in the index buffer
  86791. * @param totalVertices defines the total number of vertices (could be null)
  86792. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  86793. */
  86794. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  86795. }
  86796. /**
  86797. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  86798. */
  86799. export class VertexData {
  86800. /**
  86801. * Mesh side orientation : usually the external or front surface
  86802. */
  86803. static readonly FRONTSIDE: number;
  86804. /**
  86805. * Mesh side orientation : usually the internal or back surface
  86806. */
  86807. static readonly BACKSIDE: number;
  86808. /**
  86809. * Mesh side orientation : both internal and external or front and back surfaces
  86810. */
  86811. static readonly DOUBLESIDE: number;
  86812. /**
  86813. * Mesh side orientation : by default, `FRONTSIDE`
  86814. */
  86815. static readonly DEFAULTSIDE: number;
  86816. /**
  86817. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  86818. */
  86819. positions: Nullable<FloatArray>;
  86820. /**
  86821. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  86822. */
  86823. normals: Nullable<FloatArray>;
  86824. /**
  86825. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  86826. */
  86827. tangents: Nullable<FloatArray>;
  86828. /**
  86829. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86830. */
  86831. uvs: Nullable<FloatArray>;
  86832. /**
  86833. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86834. */
  86835. uvs2: Nullable<FloatArray>;
  86836. /**
  86837. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86838. */
  86839. uvs3: Nullable<FloatArray>;
  86840. /**
  86841. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86842. */
  86843. uvs4: Nullable<FloatArray>;
  86844. /**
  86845. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86846. */
  86847. uvs5: Nullable<FloatArray>;
  86848. /**
  86849. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  86850. */
  86851. uvs6: Nullable<FloatArray>;
  86852. /**
  86853. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  86854. */
  86855. colors: Nullable<FloatArray>;
  86856. /**
  86857. * 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).
  86858. */
  86859. matricesIndices: Nullable<FloatArray>;
  86860. /**
  86861. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  86862. */
  86863. matricesWeights: Nullable<FloatArray>;
  86864. /**
  86865. * An array extending the number of possible indices
  86866. */
  86867. matricesIndicesExtra: Nullable<FloatArray>;
  86868. /**
  86869. * An array extending the number of possible weights when the number of indices is extended
  86870. */
  86871. matricesWeightsExtra: Nullable<FloatArray>;
  86872. /**
  86873. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  86874. */
  86875. indices: Nullable<IndicesArray>;
  86876. /**
  86877. * Uses the passed data array to set the set the values for the specified kind of data
  86878. * @param data a linear array of floating numbers
  86879. * @param kind the type of data that is being set, eg positions, colors etc
  86880. */
  86881. set(data: FloatArray, kind: string): void;
  86882. /**
  86883. * Associates the vertexData to the passed Mesh.
  86884. * Sets it as updatable or not (default `false`)
  86885. * @param mesh the mesh the vertexData is applied to
  86886. * @param updatable when used and having the value true allows new data to update the vertexData
  86887. * @returns the VertexData
  86888. */
  86889. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  86890. /**
  86891. * Associates the vertexData to the passed Geometry.
  86892. * Sets it as updatable or not (default `false`)
  86893. * @param geometry the geometry the vertexData is applied to
  86894. * @param updatable when used and having the value true allows new data to update the vertexData
  86895. * @returns VertexData
  86896. */
  86897. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  86898. /**
  86899. * Updates the associated mesh
  86900. * @param mesh the mesh to be updated
  86901. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  86902. * @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
  86903. * @returns VertexData
  86904. */
  86905. updateMesh(mesh: Mesh): VertexData;
  86906. /**
  86907. * Updates the associated geometry
  86908. * @param geometry the geometry to be updated
  86909. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  86910. * @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
  86911. * @returns VertexData.
  86912. */
  86913. updateGeometry(geometry: Geometry): VertexData;
  86914. private _applyTo;
  86915. private _update;
  86916. /**
  86917. * Transforms each position and each normal of the vertexData according to the passed Matrix
  86918. * @param matrix the transforming matrix
  86919. * @returns the VertexData
  86920. */
  86921. transform(matrix: Matrix): VertexData;
  86922. /**
  86923. * Merges the passed VertexData into the current one
  86924. * @param other the VertexData to be merged into the current one
  86925. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  86926. * @returns the modified VertexData
  86927. */
  86928. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  86929. private _mergeElement;
  86930. private _validate;
  86931. /**
  86932. * Serializes the VertexData
  86933. * @returns a serialized object
  86934. */
  86935. serialize(): any;
  86936. /**
  86937. * Extracts the vertexData from a mesh
  86938. * @param mesh the mesh from which to extract the VertexData
  86939. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  86940. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  86941. * @returns the object VertexData associated to the passed mesh
  86942. */
  86943. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  86944. /**
  86945. * Extracts the vertexData from the geometry
  86946. * @param geometry the geometry from which to extract the VertexData
  86947. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  86948. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  86949. * @returns the object VertexData associated to the passed mesh
  86950. */
  86951. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  86952. private static _ExtractFrom;
  86953. /**
  86954. * Creates the VertexData for a Ribbon
  86955. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  86956. * * pathArray array of paths, each of which an array of successive Vector3
  86957. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  86958. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  86959. * * 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
  86960. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  86961. * * 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)
  86962. * * 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)
  86963. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  86964. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  86965. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  86966. * @returns the VertexData of the ribbon
  86967. */
  86968. static CreateRibbon(options: {
  86969. pathArray: Vector3[][];
  86970. closeArray?: boolean;
  86971. closePath?: boolean;
  86972. offset?: number;
  86973. sideOrientation?: number;
  86974. frontUVs?: Vector4;
  86975. backUVs?: Vector4;
  86976. invertUV?: boolean;
  86977. uvs?: Vector2[];
  86978. colors?: Color4[];
  86979. }): VertexData;
  86980. /**
  86981. * Creates the VertexData for a box
  86982. * @param options an object used to set the following optional parameters for the box, required but can be empty
  86983. * * size sets the width, height and depth of the box to the value of size, optional default 1
  86984. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  86985. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  86986. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  86987. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  86988. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  86989. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  86990. * * 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)
  86991. * * 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)
  86992. * @returns the VertexData of the box
  86993. */
  86994. static CreateBox(options: {
  86995. size?: number;
  86996. width?: number;
  86997. height?: number;
  86998. depth?: number;
  86999. faceUV?: Vector4[];
  87000. faceColors?: Color4[];
  87001. sideOrientation?: number;
  87002. frontUVs?: Vector4;
  87003. backUVs?: Vector4;
  87004. }): VertexData;
  87005. /**
  87006. * Creates the VertexData for a tiled box
  87007. * @param options an object used to set the following optional parameters for the box, required but can be empty
  87008. * * faceTiles sets the pattern, tile size and number of tiles for a face
  87009. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  87010. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  87011. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87012. * @returns the VertexData of the box
  87013. */
  87014. static CreateTiledBox(options: {
  87015. pattern?: number;
  87016. width?: number;
  87017. height?: number;
  87018. depth?: number;
  87019. tileSize?: number;
  87020. tileWidth?: number;
  87021. tileHeight?: number;
  87022. alignHorizontal?: number;
  87023. alignVertical?: number;
  87024. faceUV?: Vector4[];
  87025. faceColors?: Color4[];
  87026. sideOrientation?: number;
  87027. }): VertexData;
  87028. /**
  87029. * Creates the VertexData for a tiled plane
  87030. * @param options an object used to set the following optional parameters for the box, required but can be empty
  87031. * * pattern a limited pattern arrangement depending on the number
  87032. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  87033. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  87034. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  87035. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87036. * * 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)
  87037. * * 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)
  87038. * @returns the VertexData of the tiled plane
  87039. */
  87040. static CreateTiledPlane(options: {
  87041. pattern?: number;
  87042. tileSize?: number;
  87043. tileWidth?: number;
  87044. tileHeight?: number;
  87045. size?: number;
  87046. width?: number;
  87047. height?: number;
  87048. alignHorizontal?: number;
  87049. alignVertical?: number;
  87050. sideOrientation?: number;
  87051. frontUVs?: Vector4;
  87052. backUVs?: Vector4;
  87053. }): VertexData;
  87054. /**
  87055. * Creates the VertexData for an ellipsoid, defaults to a sphere
  87056. * @param options an object used to set the following optional parameters for the box, required but can be empty
  87057. * * segments sets the number of horizontal strips optional, default 32
  87058. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  87059. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  87060. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  87061. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  87062. * * 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
  87063. * * 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
  87064. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87065. * * 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)
  87066. * * 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)
  87067. * @returns the VertexData of the ellipsoid
  87068. */
  87069. static CreateSphere(options: {
  87070. segments?: number;
  87071. diameter?: number;
  87072. diameterX?: number;
  87073. diameterY?: number;
  87074. diameterZ?: number;
  87075. arc?: number;
  87076. slice?: number;
  87077. sideOrientation?: number;
  87078. frontUVs?: Vector4;
  87079. backUVs?: Vector4;
  87080. }): VertexData;
  87081. /**
  87082. * Creates the VertexData for a cylinder, cone or prism
  87083. * @param options an object used to set the following optional parameters for the box, required but can be empty
  87084. * * height sets the height (y direction) of the cylinder, optional, default 2
  87085. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  87086. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  87087. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  87088. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  87089. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  87090. * * 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
  87091. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  87092. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  87093. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  87094. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  87095. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87096. * * 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)
  87097. * * 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)
  87098. * @returns the VertexData of the cylinder, cone or prism
  87099. */
  87100. static CreateCylinder(options: {
  87101. height?: number;
  87102. diameterTop?: number;
  87103. diameterBottom?: number;
  87104. diameter?: number;
  87105. tessellation?: number;
  87106. subdivisions?: number;
  87107. arc?: number;
  87108. faceColors?: Color4[];
  87109. faceUV?: Vector4[];
  87110. hasRings?: boolean;
  87111. enclose?: boolean;
  87112. sideOrientation?: number;
  87113. frontUVs?: Vector4;
  87114. backUVs?: Vector4;
  87115. }): VertexData;
  87116. /**
  87117. * Creates the VertexData for a torus
  87118. * @param options an object used to set the following optional parameters for the box, required but can be empty
  87119. * * diameter the diameter of the torus, optional default 1
  87120. * * thickness the diameter of the tube forming the torus, optional default 0.5
  87121. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  87122. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87123. * * 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)
  87124. * * 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)
  87125. * @returns the VertexData of the torus
  87126. */
  87127. static CreateTorus(options: {
  87128. diameter?: number;
  87129. thickness?: number;
  87130. tessellation?: number;
  87131. sideOrientation?: number;
  87132. frontUVs?: Vector4;
  87133. backUVs?: Vector4;
  87134. }): VertexData;
  87135. /**
  87136. * Creates the VertexData of the LineSystem
  87137. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  87138. * - lines an array of lines, each line being an array of successive Vector3
  87139. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  87140. * @returns the VertexData of the LineSystem
  87141. */
  87142. static CreateLineSystem(options: {
  87143. lines: Vector3[][];
  87144. colors?: Nullable<Color4[][]>;
  87145. }): VertexData;
  87146. /**
  87147. * Create the VertexData for a DashedLines
  87148. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  87149. * - points an array successive Vector3
  87150. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  87151. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  87152. * - dashNb the intended total number of dashes, optional, default 200
  87153. * @returns the VertexData for the DashedLines
  87154. */
  87155. static CreateDashedLines(options: {
  87156. points: Vector3[];
  87157. dashSize?: number;
  87158. gapSize?: number;
  87159. dashNb?: number;
  87160. }): VertexData;
  87161. /**
  87162. * Creates the VertexData for a Ground
  87163. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  87164. * - width the width (x direction) of the ground, optional, default 1
  87165. * - height the height (z direction) of the ground, optional, default 1
  87166. * - subdivisions the number of subdivisions per side, optional, default 1
  87167. * @returns the VertexData of the Ground
  87168. */
  87169. static CreateGround(options: {
  87170. width?: number;
  87171. height?: number;
  87172. subdivisions?: number;
  87173. subdivisionsX?: number;
  87174. subdivisionsY?: number;
  87175. }): VertexData;
  87176. /**
  87177. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  87178. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  87179. * * xmin the ground minimum X coordinate, optional, default -1
  87180. * * zmin the ground minimum Z coordinate, optional, default -1
  87181. * * xmax the ground maximum X coordinate, optional, default 1
  87182. * * zmax the ground maximum Z coordinate, optional, default 1
  87183. * * 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}
  87184. * * 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}
  87185. * @returns the VertexData of the TiledGround
  87186. */
  87187. static CreateTiledGround(options: {
  87188. xmin: number;
  87189. zmin: number;
  87190. xmax: number;
  87191. zmax: number;
  87192. subdivisions?: {
  87193. w: number;
  87194. h: number;
  87195. };
  87196. precision?: {
  87197. w: number;
  87198. h: number;
  87199. };
  87200. }): VertexData;
  87201. /**
  87202. * Creates the VertexData of the Ground designed from a heightmap
  87203. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  87204. * * width the width (x direction) of the ground
  87205. * * height the height (z direction) of the ground
  87206. * * subdivisions the number of subdivisions per side
  87207. * * minHeight the minimum altitude on the ground, optional, default 0
  87208. * * maxHeight the maximum altitude on the ground, optional default 1
  87209. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  87210. * * buffer the array holding the image color data
  87211. * * bufferWidth the width of image
  87212. * * bufferHeight the height of image
  87213. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  87214. * @returns the VertexData of the Ground designed from a heightmap
  87215. */
  87216. static CreateGroundFromHeightMap(options: {
  87217. width: number;
  87218. height: number;
  87219. subdivisions: number;
  87220. minHeight: number;
  87221. maxHeight: number;
  87222. colorFilter: Color3;
  87223. buffer: Uint8Array;
  87224. bufferWidth: number;
  87225. bufferHeight: number;
  87226. alphaFilter: number;
  87227. }): VertexData;
  87228. /**
  87229. * Creates the VertexData for a Plane
  87230. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  87231. * * size sets the width and height of the plane to the value of size, optional default 1
  87232. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  87233. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  87234. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87235. * * 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)
  87236. * * 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)
  87237. * @returns the VertexData of the box
  87238. */
  87239. static CreatePlane(options: {
  87240. size?: number;
  87241. width?: number;
  87242. height?: number;
  87243. sideOrientation?: number;
  87244. frontUVs?: Vector4;
  87245. backUVs?: Vector4;
  87246. }): VertexData;
  87247. /**
  87248. * Creates the VertexData of the Disc or regular Polygon
  87249. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  87250. * * radius the radius of the disc, optional default 0.5
  87251. * * tessellation the number of polygon sides, optional, default 64
  87252. * * 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
  87253. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87254. * * 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)
  87255. * * 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)
  87256. * @returns the VertexData of the box
  87257. */
  87258. static CreateDisc(options: {
  87259. radius?: number;
  87260. tessellation?: number;
  87261. arc?: number;
  87262. sideOrientation?: number;
  87263. frontUVs?: Vector4;
  87264. backUVs?: Vector4;
  87265. }): VertexData;
  87266. /**
  87267. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  87268. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  87269. * @param polygon a mesh built from polygonTriangulation.build()
  87270. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87271. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  87272. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  87273. * @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)
  87274. * @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)
  87275. * @returns the VertexData of the Polygon
  87276. */
  87277. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  87278. /**
  87279. * Creates the VertexData of the IcoSphere
  87280. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  87281. * * radius the radius of the IcoSphere, optional default 1
  87282. * * radiusX allows stretching in the x direction, optional, default radius
  87283. * * radiusY allows stretching in the y direction, optional, default radius
  87284. * * radiusZ allows stretching in the z direction, optional, default radius
  87285. * * flat when true creates a flat shaded mesh, optional, default true
  87286. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  87287. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87288. * * 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)
  87289. * * 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)
  87290. * @returns the VertexData of the IcoSphere
  87291. */
  87292. static CreateIcoSphere(options: {
  87293. radius?: number;
  87294. radiusX?: number;
  87295. radiusY?: number;
  87296. radiusZ?: number;
  87297. flat?: boolean;
  87298. subdivisions?: number;
  87299. sideOrientation?: number;
  87300. frontUVs?: Vector4;
  87301. backUVs?: Vector4;
  87302. }): VertexData;
  87303. /**
  87304. * Creates the VertexData for a Polyhedron
  87305. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  87306. * * type provided types are:
  87307. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  87308. * * 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)
  87309. * * size the size of the IcoSphere, optional default 1
  87310. * * sizeX allows stretching in the x direction, optional, default size
  87311. * * sizeY allows stretching in the y direction, optional, default size
  87312. * * sizeZ allows stretching in the z direction, optional, default size
  87313. * * 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
  87314. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  87315. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  87316. * * flat when true creates a flat shaded mesh, optional, default true
  87317. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  87318. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87319. * * 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)
  87320. * * 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)
  87321. * @returns the VertexData of the Polyhedron
  87322. */
  87323. static CreatePolyhedron(options: {
  87324. type?: number;
  87325. size?: number;
  87326. sizeX?: number;
  87327. sizeY?: number;
  87328. sizeZ?: number;
  87329. custom?: any;
  87330. faceUV?: Vector4[];
  87331. faceColors?: Color4[];
  87332. flat?: boolean;
  87333. sideOrientation?: number;
  87334. frontUVs?: Vector4;
  87335. backUVs?: Vector4;
  87336. }): VertexData;
  87337. /**
  87338. * Creates the VertexData for a TorusKnot
  87339. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  87340. * * radius the radius of the torus knot, optional, default 2
  87341. * * tube the thickness of the tube, optional, default 0.5
  87342. * * radialSegments the number of sides on each tube segments, optional, default 32
  87343. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  87344. * * p the number of windings around the z axis, optional, default 2
  87345. * * q the number of windings around the x axis, optional, default 3
  87346. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  87347. * * 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)
  87348. * * 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)
  87349. * @returns the VertexData of the Torus Knot
  87350. */
  87351. static CreateTorusKnot(options: {
  87352. radius?: number;
  87353. tube?: number;
  87354. radialSegments?: number;
  87355. tubularSegments?: number;
  87356. p?: number;
  87357. q?: number;
  87358. sideOrientation?: number;
  87359. frontUVs?: Vector4;
  87360. backUVs?: Vector4;
  87361. }): VertexData;
  87362. /**
  87363. * Compute normals for given positions and indices
  87364. * @param positions an array of vertex positions, [...., x, y, z, ......]
  87365. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  87366. * @param normals an array of vertex normals, [...., x, y, z, ......]
  87367. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  87368. * * facetNormals : optional array of facet normals (vector3)
  87369. * * facetPositions : optional array of facet positions (vector3)
  87370. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  87371. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  87372. * * bInfo : optional bounding info, required for facetPartitioning computation
  87373. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  87374. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  87375. * * useRightHandedSystem: optional boolean to for right handed system computation
  87376. * * depthSort : optional boolean to enable the facet depth sort computation
  87377. * * distanceTo : optional Vector3 to compute the facet depth from this location
  87378. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  87379. */
  87380. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  87381. facetNormals?: any;
  87382. facetPositions?: any;
  87383. facetPartitioning?: any;
  87384. ratio?: number;
  87385. bInfo?: any;
  87386. bbSize?: Vector3;
  87387. subDiv?: any;
  87388. useRightHandedSystem?: boolean;
  87389. depthSort?: boolean;
  87390. distanceTo?: Vector3;
  87391. depthSortedFacets?: any;
  87392. }): void;
  87393. /** @hidden */
  87394. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  87395. /**
  87396. * Applies VertexData created from the imported parameters to the geometry
  87397. * @param parsedVertexData the parsed data from an imported file
  87398. * @param geometry the geometry to apply the VertexData to
  87399. */
  87400. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  87401. }
  87402. }
  87403. declare module BABYLON {
  87404. /**
  87405. * Defines a target to use with MorphTargetManager
  87406. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  87407. */
  87408. export class MorphTarget implements IAnimatable {
  87409. /** defines the name of the target */
  87410. name: string;
  87411. /**
  87412. * Gets or sets the list of animations
  87413. */
  87414. animations: Animation[];
  87415. private _scene;
  87416. private _positions;
  87417. private _normals;
  87418. private _tangents;
  87419. private _uvs;
  87420. private _influence;
  87421. /**
  87422. * Observable raised when the influence changes
  87423. */
  87424. onInfluenceChanged: Observable<boolean>;
  87425. /** @hidden */
  87426. _onDataLayoutChanged: Observable<void>;
  87427. /**
  87428. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  87429. */
  87430. influence: number;
  87431. /**
  87432. * Gets or sets the id of the morph Target
  87433. */
  87434. id: string;
  87435. private _animationPropertiesOverride;
  87436. /**
  87437. * Gets or sets the animation properties override
  87438. */
  87439. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  87440. /**
  87441. * Creates a new MorphTarget
  87442. * @param name defines the name of the target
  87443. * @param influence defines the influence to use
  87444. * @param scene defines the scene the morphtarget belongs to
  87445. */
  87446. constructor(
  87447. /** defines the name of the target */
  87448. name: string, influence?: number, scene?: Nullable<Scene>);
  87449. /**
  87450. * Gets a boolean defining if the target contains position data
  87451. */
  87452. readonly hasPositions: boolean;
  87453. /**
  87454. * Gets a boolean defining if the target contains normal data
  87455. */
  87456. readonly hasNormals: boolean;
  87457. /**
  87458. * Gets a boolean defining if the target contains tangent data
  87459. */
  87460. readonly hasTangents: boolean;
  87461. /**
  87462. * Gets a boolean defining if the target contains texture coordinates data
  87463. */
  87464. readonly hasUVs: boolean;
  87465. /**
  87466. * Affects position data to this target
  87467. * @param data defines the position data to use
  87468. */
  87469. setPositions(data: Nullable<FloatArray>): void;
  87470. /**
  87471. * Gets the position data stored in this target
  87472. * @returns a FloatArray containing the position data (or null if not present)
  87473. */
  87474. getPositions(): Nullable<FloatArray>;
  87475. /**
  87476. * Affects normal data to this target
  87477. * @param data defines the normal data to use
  87478. */
  87479. setNormals(data: Nullable<FloatArray>): void;
  87480. /**
  87481. * Gets the normal data stored in this target
  87482. * @returns a FloatArray containing the normal data (or null if not present)
  87483. */
  87484. getNormals(): Nullable<FloatArray>;
  87485. /**
  87486. * Affects tangent data to this target
  87487. * @param data defines the tangent data to use
  87488. */
  87489. setTangents(data: Nullable<FloatArray>): void;
  87490. /**
  87491. * Gets the tangent data stored in this target
  87492. * @returns a FloatArray containing the tangent data (or null if not present)
  87493. */
  87494. getTangents(): Nullable<FloatArray>;
  87495. /**
  87496. * Affects texture coordinates data to this target
  87497. * @param data defines the texture coordinates data to use
  87498. */
  87499. setUVs(data: Nullable<FloatArray>): void;
  87500. /**
  87501. * Gets the texture coordinates data stored in this target
  87502. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  87503. */
  87504. getUVs(): Nullable<FloatArray>;
  87505. /**
  87506. * Serializes the current target into a Serialization object
  87507. * @returns the serialized object
  87508. */
  87509. serialize(): any;
  87510. /**
  87511. * Returns the string "MorphTarget"
  87512. * @returns "MorphTarget"
  87513. */
  87514. getClassName(): string;
  87515. /**
  87516. * Creates a new target from serialized data
  87517. * @param serializationObject defines the serialized data to use
  87518. * @returns a new MorphTarget
  87519. */
  87520. static Parse(serializationObject: any): MorphTarget;
  87521. /**
  87522. * Creates a MorphTarget from mesh data
  87523. * @param mesh defines the source mesh
  87524. * @param name defines the name to use for the new target
  87525. * @param influence defines the influence to attach to the target
  87526. * @returns a new MorphTarget
  87527. */
  87528. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  87529. }
  87530. }
  87531. declare module BABYLON {
  87532. /**
  87533. * This class is used to deform meshes using morphing between different targets
  87534. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  87535. */
  87536. export class MorphTargetManager {
  87537. private _targets;
  87538. private _targetInfluenceChangedObservers;
  87539. private _targetDataLayoutChangedObservers;
  87540. private _activeTargets;
  87541. private _scene;
  87542. private _influences;
  87543. private _supportsNormals;
  87544. private _supportsTangents;
  87545. private _supportsUVs;
  87546. private _vertexCount;
  87547. private _uniqueId;
  87548. private _tempInfluences;
  87549. /**
  87550. * Gets or sets a boolean indicating if normals must be morphed
  87551. */
  87552. enableNormalMorphing: boolean;
  87553. /**
  87554. * Gets or sets a boolean indicating if tangents must be morphed
  87555. */
  87556. enableTangentMorphing: boolean;
  87557. /**
  87558. * Gets or sets a boolean indicating if UV must be morphed
  87559. */
  87560. enableUVMorphing: boolean;
  87561. /**
  87562. * Creates a new MorphTargetManager
  87563. * @param scene defines the current scene
  87564. */
  87565. constructor(scene?: Nullable<Scene>);
  87566. /**
  87567. * Gets the unique ID of this manager
  87568. */
  87569. readonly uniqueId: number;
  87570. /**
  87571. * Gets the number of vertices handled by this manager
  87572. */
  87573. readonly vertexCount: number;
  87574. /**
  87575. * Gets a boolean indicating if this manager supports morphing of normals
  87576. */
  87577. readonly supportsNormals: boolean;
  87578. /**
  87579. * Gets a boolean indicating if this manager supports morphing of tangents
  87580. */
  87581. readonly supportsTangents: boolean;
  87582. /**
  87583. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  87584. */
  87585. readonly supportsUVs: boolean;
  87586. /**
  87587. * Gets the number of targets stored in this manager
  87588. */
  87589. readonly numTargets: number;
  87590. /**
  87591. * Gets the number of influencers (ie. the number of targets with influences > 0)
  87592. */
  87593. readonly numInfluencers: number;
  87594. /**
  87595. * Gets the list of influences (one per target)
  87596. */
  87597. readonly influences: Float32Array;
  87598. /**
  87599. * Gets the active target at specified index. An active target is a target with an influence > 0
  87600. * @param index defines the index to check
  87601. * @returns the requested target
  87602. */
  87603. getActiveTarget(index: number): MorphTarget;
  87604. /**
  87605. * Gets the target at specified index
  87606. * @param index defines the index to check
  87607. * @returns the requested target
  87608. */
  87609. getTarget(index: number): MorphTarget;
  87610. /**
  87611. * Add a new target to this manager
  87612. * @param target defines the target to add
  87613. */
  87614. addTarget(target: MorphTarget): void;
  87615. /**
  87616. * Removes a target from the manager
  87617. * @param target defines the target to remove
  87618. */
  87619. removeTarget(target: MorphTarget): void;
  87620. /**
  87621. * Serializes the current manager into a Serialization object
  87622. * @returns the serialized object
  87623. */
  87624. serialize(): any;
  87625. private _syncActiveTargets;
  87626. /**
  87627. * Syncrhonize the targets with all the meshes using this morph target manager
  87628. */
  87629. synchronize(): void;
  87630. /**
  87631. * Creates a new MorphTargetManager from serialized data
  87632. * @param serializationObject defines the serialized data
  87633. * @param scene defines the hosting scene
  87634. * @returns the new MorphTargetManager
  87635. */
  87636. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  87637. }
  87638. }
  87639. declare module BABYLON {
  87640. /**
  87641. * Class used to represent a specific level of detail of a mesh
  87642. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  87643. */
  87644. export class MeshLODLevel {
  87645. /** Defines the distance where this level should start being displayed */
  87646. distance: number;
  87647. /** Defines the mesh to use to render this level */
  87648. mesh: Nullable<Mesh>;
  87649. /**
  87650. * Creates a new LOD level
  87651. * @param distance defines the distance where this level should star being displayed
  87652. * @param mesh defines the mesh to use to render this level
  87653. */
  87654. constructor(
  87655. /** Defines the distance where this level should start being displayed */
  87656. distance: number,
  87657. /** Defines the mesh to use to render this level */
  87658. mesh: Nullable<Mesh>);
  87659. }
  87660. }
  87661. declare module BABYLON {
  87662. /**
  87663. * Mesh representing the gorund
  87664. */
  87665. export class GroundMesh extends Mesh {
  87666. /** If octree should be generated */
  87667. generateOctree: boolean;
  87668. private _heightQuads;
  87669. /** @hidden */
  87670. _subdivisionsX: number;
  87671. /** @hidden */
  87672. _subdivisionsY: number;
  87673. /** @hidden */
  87674. _width: number;
  87675. /** @hidden */
  87676. _height: number;
  87677. /** @hidden */
  87678. _minX: number;
  87679. /** @hidden */
  87680. _maxX: number;
  87681. /** @hidden */
  87682. _minZ: number;
  87683. /** @hidden */
  87684. _maxZ: number;
  87685. constructor(name: string, scene: Scene);
  87686. /**
  87687. * "GroundMesh"
  87688. * @returns "GroundMesh"
  87689. */
  87690. getClassName(): string;
  87691. /**
  87692. * The minimum of x and y subdivisions
  87693. */
  87694. readonly subdivisions: number;
  87695. /**
  87696. * X subdivisions
  87697. */
  87698. readonly subdivisionsX: number;
  87699. /**
  87700. * Y subdivisions
  87701. */
  87702. readonly subdivisionsY: number;
  87703. /**
  87704. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  87705. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  87706. * @param chunksCount the number of subdivisions for x and y
  87707. * @param octreeBlocksSize (Default: 32)
  87708. */
  87709. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  87710. /**
  87711. * Returns a height (y) value in the Worl system :
  87712. * the ground altitude at the coordinates (x, z) expressed in the World system.
  87713. * @param x x coordinate
  87714. * @param z z coordinate
  87715. * @returns the ground y position if (x, z) are outside the ground surface.
  87716. */
  87717. getHeightAtCoordinates(x: number, z: number): number;
  87718. /**
  87719. * Returns a normalized vector (Vector3) orthogonal to the ground
  87720. * at the ground coordinates (x, z) expressed in the World system.
  87721. * @param x x coordinate
  87722. * @param z z coordinate
  87723. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  87724. */
  87725. getNormalAtCoordinates(x: number, z: number): Vector3;
  87726. /**
  87727. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  87728. * at the ground coordinates (x, z) expressed in the World system.
  87729. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  87730. * @param x x coordinate
  87731. * @param z z coordinate
  87732. * @param ref vector to store the result
  87733. * @returns the GroundMesh.
  87734. */
  87735. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  87736. /**
  87737. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  87738. * if the ground has been updated.
  87739. * This can be used in the render loop.
  87740. * @returns the GroundMesh.
  87741. */
  87742. updateCoordinateHeights(): GroundMesh;
  87743. private _getFacetAt;
  87744. private _initHeightQuads;
  87745. private _computeHeightQuads;
  87746. /**
  87747. * Serializes this ground mesh
  87748. * @param serializationObject object to write serialization to
  87749. */
  87750. serialize(serializationObject: any): void;
  87751. /**
  87752. * Parses a serialized ground mesh
  87753. * @param parsedMesh the serialized mesh
  87754. * @param scene the scene to create the ground mesh in
  87755. * @returns the created ground mesh
  87756. */
  87757. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  87758. }
  87759. }
  87760. declare module BABYLON {
  87761. /**
  87762. * Interface for Physics-Joint data
  87763. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87764. */
  87765. export interface PhysicsJointData {
  87766. /**
  87767. * The main pivot of the joint
  87768. */
  87769. mainPivot?: Vector3;
  87770. /**
  87771. * The connected pivot of the joint
  87772. */
  87773. connectedPivot?: Vector3;
  87774. /**
  87775. * The main axis of the joint
  87776. */
  87777. mainAxis?: Vector3;
  87778. /**
  87779. * The connected axis of the joint
  87780. */
  87781. connectedAxis?: Vector3;
  87782. /**
  87783. * The collision of the joint
  87784. */
  87785. collision?: boolean;
  87786. /**
  87787. * Native Oimo/Cannon/Energy data
  87788. */
  87789. nativeParams?: any;
  87790. }
  87791. /**
  87792. * This is a holder class for the physics joint created by the physics plugin
  87793. * It holds a set of functions to control the underlying joint
  87794. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87795. */
  87796. export class PhysicsJoint {
  87797. /**
  87798. * The type of the physics joint
  87799. */
  87800. type: number;
  87801. /**
  87802. * The data for the physics joint
  87803. */
  87804. jointData: PhysicsJointData;
  87805. private _physicsJoint;
  87806. protected _physicsPlugin: IPhysicsEnginePlugin;
  87807. /**
  87808. * Initializes the physics joint
  87809. * @param type The type of the physics joint
  87810. * @param jointData The data for the physics joint
  87811. */
  87812. constructor(
  87813. /**
  87814. * The type of the physics joint
  87815. */
  87816. type: number,
  87817. /**
  87818. * The data for the physics joint
  87819. */
  87820. jointData: PhysicsJointData);
  87821. /**
  87822. * Gets the physics joint
  87823. */
  87824. /**
  87825. * Sets the physics joint
  87826. */
  87827. physicsJoint: any;
  87828. /**
  87829. * Sets the physics plugin
  87830. */
  87831. physicsPlugin: IPhysicsEnginePlugin;
  87832. /**
  87833. * Execute a function that is physics-plugin specific.
  87834. * @param {Function} func the function that will be executed.
  87835. * It accepts two parameters: the physics world and the physics joint
  87836. */
  87837. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  87838. /**
  87839. * Distance-Joint type
  87840. */
  87841. static DistanceJoint: number;
  87842. /**
  87843. * Hinge-Joint type
  87844. */
  87845. static HingeJoint: number;
  87846. /**
  87847. * Ball-and-Socket joint type
  87848. */
  87849. static BallAndSocketJoint: number;
  87850. /**
  87851. * Wheel-Joint type
  87852. */
  87853. static WheelJoint: number;
  87854. /**
  87855. * Slider-Joint type
  87856. */
  87857. static SliderJoint: number;
  87858. /**
  87859. * Prismatic-Joint type
  87860. */
  87861. static PrismaticJoint: number;
  87862. /**
  87863. * Universal-Joint type
  87864. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  87865. */
  87866. static UniversalJoint: number;
  87867. /**
  87868. * Hinge-Joint 2 type
  87869. */
  87870. static Hinge2Joint: number;
  87871. /**
  87872. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  87873. */
  87874. static PointToPointJoint: number;
  87875. /**
  87876. * Spring-Joint type
  87877. */
  87878. static SpringJoint: number;
  87879. /**
  87880. * Lock-Joint type
  87881. */
  87882. static LockJoint: number;
  87883. }
  87884. /**
  87885. * A class representing a physics distance joint
  87886. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87887. */
  87888. export class DistanceJoint extends PhysicsJoint {
  87889. /**
  87890. *
  87891. * @param jointData The data for the Distance-Joint
  87892. */
  87893. constructor(jointData: DistanceJointData);
  87894. /**
  87895. * Update the predefined distance.
  87896. * @param maxDistance The maximum preferred distance
  87897. * @param minDistance The minimum preferred distance
  87898. */
  87899. updateDistance(maxDistance: number, minDistance?: number): void;
  87900. }
  87901. /**
  87902. * Represents a Motor-Enabled Joint
  87903. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87904. */
  87905. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  87906. /**
  87907. * Initializes the Motor-Enabled Joint
  87908. * @param type The type of the joint
  87909. * @param jointData The physica joint data for the joint
  87910. */
  87911. constructor(type: number, jointData: PhysicsJointData);
  87912. /**
  87913. * Set the motor values.
  87914. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87915. * @param force the force to apply
  87916. * @param maxForce max force for this motor.
  87917. */
  87918. setMotor(force?: number, maxForce?: number): void;
  87919. /**
  87920. * Set the motor's limits.
  87921. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87922. * @param upperLimit The upper limit of the motor
  87923. * @param lowerLimit The lower limit of the motor
  87924. */
  87925. setLimit(upperLimit: number, lowerLimit?: number): void;
  87926. }
  87927. /**
  87928. * This class represents a single physics Hinge-Joint
  87929. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87930. */
  87931. export class HingeJoint extends MotorEnabledJoint {
  87932. /**
  87933. * Initializes the Hinge-Joint
  87934. * @param jointData The joint data for the Hinge-Joint
  87935. */
  87936. constructor(jointData: PhysicsJointData);
  87937. /**
  87938. * Set the motor values.
  87939. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87940. * @param {number} force the force to apply
  87941. * @param {number} maxForce max force for this motor.
  87942. */
  87943. setMotor(force?: number, maxForce?: number): void;
  87944. /**
  87945. * Set the motor's limits.
  87946. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87947. * @param upperLimit The upper limit of the motor
  87948. * @param lowerLimit The lower limit of the motor
  87949. */
  87950. setLimit(upperLimit: number, lowerLimit?: number): void;
  87951. }
  87952. /**
  87953. * This class represents a dual hinge physics joint (same as wheel joint)
  87954. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87955. */
  87956. export class Hinge2Joint extends MotorEnabledJoint {
  87957. /**
  87958. * Initializes the Hinge2-Joint
  87959. * @param jointData The joint data for the Hinge2-Joint
  87960. */
  87961. constructor(jointData: PhysicsJointData);
  87962. /**
  87963. * Set the motor values.
  87964. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87965. * @param {number} targetSpeed the speed the motor is to reach
  87966. * @param {number} maxForce max force for this motor.
  87967. * @param {motorIndex} the motor's index, 0 or 1.
  87968. */
  87969. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  87970. /**
  87971. * Set the motor limits.
  87972. * Attention, this function is plugin specific. Engines won't react 100% the same.
  87973. * @param {number} upperLimit the upper limit
  87974. * @param {number} lowerLimit lower limit
  87975. * @param {motorIndex} the motor's index, 0 or 1.
  87976. */
  87977. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  87978. }
  87979. /**
  87980. * Interface for a motor enabled joint
  87981. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  87982. */
  87983. export interface IMotorEnabledJoint {
  87984. /**
  87985. * Physics joint
  87986. */
  87987. physicsJoint: any;
  87988. /**
  87989. * Sets the motor of the motor-enabled joint
  87990. * @param force The force of the motor
  87991. * @param maxForce The maximum force of the motor
  87992. * @param motorIndex The index of the motor
  87993. */
  87994. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  87995. /**
  87996. * Sets the limit of the motor
  87997. * @param upperLimit The upper limit of the motor
  87998. * @param lowerLimit The lower limit of the motor
  87999. * @param motorIndex The index of the motor
  88000. */
  88001. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  88002. }
  88003. /**
  88004. * Joint data for a Distance-Joint
  88005. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88006. */
  88007. export interface DistanceJointData extends PhysicsJointData {
  88008. /**
  88009. * Max distance the 2 joint objects can be apart
  88010. */
  88011. maxDistance: number;
  88012. }
  88013. /**
  88014. * Joint data from a spring joint
  88015. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88016. */
  88017. export interface SpringJointData extends PhysicsJointData {
  88018. /**
  88019. * Length of the spring
  88020. */
  88021. length: number;
  88022. /**
  88023. * Stiffness of the spring
  88024. */
  88025. stiffness: number;
  88026. /**
  88027. * Damping of the spring
  88028. */
  88029. damping: number;
  88030. /** this callback will be called when applying the force to the impostors. */
  88031. forceApplicationCallback: () => void;
  88032. }
  88033. }
  88034. declare module BABYLON {
  88035. /**
  88036. * Holds the data for the raycast result
  88037. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88038. */
  88039. export class PhysicsRaycastResult {
  88040. private _hasHit;
  88041. private _hitDistance;
  88042. private _hitNormalWorld;
  88043. private _hitPointWorld;
  88044. private _rayFromWorld;
  88045. private _rayToWorld;
  88046. /**
  88047. * Gets if there was a hit
  88048. */
  88049. readonly hasHit: boolean;
  88050. /**
  88051. * Gets the distance from the hit
  88052. */
  88053. readonly hitDistance: number;
  88054. /**
  88055. * Gets the hit normal/direction in the world
  88056. */
  88057. readonly hitNormalWorld: Vector3;
  88058. /**
  88059. * Gets the hit point in the world
  88060. */
  88061. readonly hitPointWorld: Vector3;
  88062. /**
  88063. * Gets the ray "start point" of the ray in the world
  88064. */
  88065. readonly rayFromWorld: Vector3;
  88066. /**
  88067. * Gets the ray "end point" of the ray in the world
  88068. */
  88069. readonly rayToWorld: Vector3;
  88070. /**
  88071. * Sets the hit data (normal & point in world space)
  88072. * @param hitNormalWorld defines the normal in world space
  88073. * @param hitPointWorld defines the point in world space
  88074. */
  88075. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  88076. /**
  88077. * Sets the distance from the start point to the hit point
  88078. * @param distance
  88079. */
  88080. setHitDistance(distance: number): void;
  88081. /**
  88082. * Calculates the distance manually
  88083. */
  88084. calculateHitDistance(): void;
  88085. /**
  88086. * Resets all the values to default
  88087. * @param from The from point on world space
  88088. * @param to The to point on world space
  88089. */
  88090. reset(from?: Vector3, to?: Vector3): void;
  88091. }
  88092. /**
  88093. * Interface for the size containing width and height
  88094. */
  88095. interface IXYZ {
  88096. /**
  88097. * X
  88098. */
  88099. x: number;
  88100. /**
  88101. * Y
  88102. */
  88103. y: number;
  88104. /**
  88105. * Z
  88106. */
  88107. z: number;
  88108. }
  88109. }
  88110. declare module BABYLON {
  88111. /**
  88112. * Interface used to describe a physics joint
  88113. */
  88114. export interface PhysicsImpostorJoint {
  88115. /** Defines the main impostor to which the joint is linked */
  88116. mainImpostor: PhysicsImpostor;
  88117. /** Defines the impostor that is connected to the main impostor using this joint */
  88118. connectedImpostor: PhysicsImpostor;
  88119. /** Defines the joint itself */
  88120. joint: PhysicsJoint;
  88121. }
  88122. /** @hidden */
  88123. export interface IPhysicsEnginePlugin {
  88124. world: any;
  88125. name: string;
  88126. setGravity(gravity: Vector3): void;
  88127. setTimeStep(timeStep: number): void;
  88128. getTimeStep(): number;
  88129. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  88130. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  88131. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  88132. generatePhysicsBody(impostor: PhysicsImpostor): void;
  88133. removePhysicsBody(impostor: PhysicsImpostor): void;
  88134. generateJoint(joint: PhysicsImpostorJoint): void;
  88135. removeJoint(joint: PhysicsImpostorJoint): void;
  88136. isSupported(): boolean;
  88137. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  88138. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  88139. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  88140. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  88141. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  88142. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  88143. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  88144. getBodyMass(impostor: PhysicsImpostor): number;
  88145. getBodyFriction(impostor: PhysicsImpostor): number;
  88146. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  88147. getBodyRestitution(impostor: PhysicsImpostor): number;
  88148. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  88149. getBodyPressure?(impostor: PhysicsImpostor): number;
  88150. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  88151. getBodyStiffness?(impostor: PhysicsImpostor): number;
  88152. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  88153. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  88154. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  88155. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  88156. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  88157. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  88158. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  88159. sleepBody(impostor: PhysicsImpostor): void;
  88160. wakeUpBody(impostor: PhysicsImpostor): void;
  88161. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  88162. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  88163. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  88164. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  88165. getRadius(impostor: PhysicsImpostor): number;
  88166. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  88167. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  88168. dispose(): void;
  88169. }
  88170. /**
  88171. * Interface used to define a physics engine
  88172. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  88173. */
  88174. export interface IPhysicsEngine {
  88175. /**
  88176. * Gets the gravity vector used by the simulation
  88177. */
  88178. gravity: Vector3;
  88179. /**
  88180. * Sets the gravity vector used by the simulation
  88181. * @param gravity defines the gravity vector to use
  88182. */
  88183. setGravity(gravity: Vector3): void;
  88184. /**
  88185. * Set the time step of the physics engine.
  88186. * Default is 1/60.
  88187. * To slow it down, enter 1/600 for example.
  88188. * To speed it up, 1/30
  88189. * @param newTimeStep the new timestep to apply to this world.
  88190. */
  88191. setTimeStep(newTimeStep: number): void;
  88192. /**
  88193. * Get the time step of the physics engine.
  88194. * @returns the current time step
  88195. */
  88196. getTimeStep(): number;
  88197. /**
  88198. * Release all resources
  88199. */
  88200. dispose(): void;
  88201. /**
  88202. * Gets the name of the current physics plugin
  88203. * @returns the name of the plugin
  88204. */
  88205. getPhysicsPluginName(): string;
  88206. /**
  88207. * Adding a new impostor for the impostor tracking.
  88208. * This will be done by the impostor itself.
  88209. * @param impostor the impostor to add
  88210. */
  88211. addImpostor(impostor: PhysicsImpostor): void;
  88212. /**
  88213. * Remove an impostor from the engine.
  88214. * This impostor and its mesh will not longer be updated by the physics engine.
  88215. * @param impostor the impostor to remove
  88216. */
  88217. removeImpostor(impostor: PhysicsImpostor): void;
  88218. /**
  88219. * Add a joint to the physics engine
  88220. * @param mainImpostor defines the main impostor to which the joint is added.
  88221. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  88222. * @param joint defines the joint that will connect both impostors.
  88223. */
  88224. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  88225. /**
  88226. * Removes a joint from the simulation
  88227. * @param mainImpostor defines the impostor used with the joint
  88228. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  88229. * @param joint defines the joint to remove
  88230. */
  88231. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  88232. /**
  88233. * Gets the current plugin used to run the simulation
  88234. * @returns current plugin
  88235. */
  88236. getPhysicsPlugin(): IPhysicsEnginePlugin;
  88237. /**
  88238. * Gets the list of physic impostors
  88239. * @returns an array of PhysicsImpostor
  88240. */
  88241. getImpostors(): Array<PhysicsImpostor>;
  88242. /**
  88243. * Gets the impostor for a physics enabled object
  88244. * @param object defines the object impersonated by the impostor
  88245. * @returns the PhysicsImpostor or null if not found
  88246. */
  88247. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  88248. /**
  88249. * Gets the impostor for a physics body object
  88250. * @param body defines physics body used by the impostor
  88251. * @returns the PhysicsImpostor or null if not found
  88252. */
  88253. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  88254. /**
  88255. * Does a raycast in the physics world
  88256. * @param from when should the ray start?
  88257. * @param to when should the ray end?
  88258. * @returns PhysicsRaycastResult
  88259. */
  88260. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  88261. /**
  88262. * Called by the scene. No need to call it.
  88263. * @param delta defines the timespam between frames
  88264. */
  88265. _step(delta: number): void;
  88266. }
  88267. }
  88268. declare module BABYLON {
  88269. /**
  88270. * The interface for the physics imposter parameters
  88271. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88272. */
  88273. export interface PhysicsImpostorParameters {
  88274. /**
  88275. * The mass of the physics imposter
  88276. */
  88277. mass: number;
  88278. /**
  88279. * The friction of the physics imposter
  88280. */
  88281. friction?: number;
  88282. /**
  88283. * The coefficient of restitution of the physics imposter
  88284. */
  88285. restitution?: number;
  88286. /**
  88287. * The native options of the physics imposter
  88288. */
  88289. nativeOptions?: any;
  88290. /**
  88291. * Specifies if the parent should be ignored
  88292. */
  88293. ignoreParent?: boolean;
  88294. /**
  88295. * Specifies if bi-directional transformations should be disabled
  88296. */
  88297. disableBidirectionalTransformation?: boolean;
  88298. /**
  88299. * The pressure inside the physics imposter, soft object only
  88300. */
  88301. pressure?: number;
  88302. /**
  88303. * The stiffness the physics imposter, soft object only
  88304. */
  88305. stiffness?: number;
  88306. /**
  88307. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  88308. */
  88309. velocityIterations?: number;
  88310. /**
  88311. * The number of iterations used in maintaining consistent vertex positions, soft object only
  88312. */
  88313. positionIterations?: number;
  88314. /**
  88315. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  88316. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  88317. * Add to fix multiple points
  88318. */
  88319. fixedPoints?: number;
  88320. /**
  88321. * The collision margin around a soft object
  88322. */
  88323. margin?: number;
  88324. /**
  88325. * The collision margin around a soft object
  88326. */
  88327. damping?: number;
  88328. /**
  88329. * The path for a rope based on an extrusion
  88330. */
  88331. path?: any;
  88332. /**
  88333. * The shape of an extrusion used for a rope based on an extrusion
  88334. */
  88335. shape?: any;
  88336. }
  88337. /**
  88338. * Interface for a physics-enabled object
  88339. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88340. */
  88341. export interface IPhysicsEnabledObject {
  88342. /**
  88343. * The position of the physics-enabled object
  88344. */
  88345. position: Vector3;
  88346. /**
  88347. * The rotation of the physics-enabled object
  88348. */
  88349. rotationQuaternion: Nullable<Quaternion>;
  88350. /**
  88351. * The scale of the physics-enabled object
  88352. */
  88353. scaling: Vector3;
  88354. /**
  88355. * The rotation of the physics-enabled object
  88356. */
  88357. rotation?: Vector3;
  88358. /**
  88359. * The parent of the physics-enabled object
  88360. */
  88361. parent?: any;
  88362. /**
  88363. * The bounding info of the physics-enabled object
  88364. * @returns The bounding info of the physics-enabled object
  88365. */
  88366. getBoundingInfo(): BoundingInfo;
  88367. /**
  88368. * Computes the world matrix
  88369. * @param force Specifies if the world matrix should be computed by force
  88370. * @returns A world matrix
  88371. */
  88372. computeWorldMatrix(force: boolean): Matrix;
  88373. /**
  88374. * Gets the world matrix
  88375. * @returns A world matrix
  88376. */
  88377. getWorldMatrix?(): Matrix;
  88378. /**
  88379. * Gets the child meshes
  88380. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  88381. * @returns An array of abstract meshes
  88382. */
  88383. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  88384. /**
  88385. * Gets the vertex data
  88386. * @param kind The type of vertex data
  88387. * @returns A nullable array of numbers, or a float32 array
  88388. */
  88389. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  88390. /**
  88391. * Gets the indices from the mesh
  88392. * @returns A nullable array of index arrays
  88393. */
  88394. getIndices?(): Nullable<IndicesArray>;
  88395. /**
  88396. * Gets the scene from the mesh
  88397. * @returns the indices array or null
  88398. */
  88399. getScene?(): Scene;
  88400. /**
  88401. * Gets the absolute position from the mesh
  88402. * @returns the absolute position
  88403. */
  88404. getAbsolutePosition(): Vector3;
  88405. /**
  88406. * Gets the absolute pivot point from the mesh
  88407. * @returns the absolute pivot point
  88408. */
  88409. getAbsolutePivotPoint(): Vector3;
  88410. /**
  88411. * Rotates the mesh
  88412. * @param axis The axis of rotation
  88413. * @param amount The amount of rotation
  88414. * @param space The space of the rotation
  88415. * @returns The rotation transform node
  88416. */
  88417. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  88418. /**
  88419. * Translates the mesh
  88420. * @param axis The axis of translation
  88421. * @param distance The distance of translation
  88422. * @param space The space of the translation
  88423. * @returns The transform node
  88424. */
  88425. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  88426. /**
  88427. * Sets the absolute position of the mesh
  88428. * @param absolutePosition The absolute position of the mesh
  88429. * @returns The transform node
  88430. */
  88431. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  88432. /**
  88433. * Gets the class name of the mesh
  88434. * @returns The class name
  88435. */
  88436. getClassName(): string;
  88437. }
  88438. /**
  88439. * Represents a physics imposter
  88440. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  88441. */
  88442. export class PhysicsImpostor {
  88443. /**
  88444. * The physics-enabled object used as the physics imposter
  88445. */
  88446. object: IPhysicsEnabledObject;
  88447. /**
  88448. * The type of the physics imposter
  88449. */
  88450. type: number;
  88451. private _options;
  88452. private _scene?;
  88453. /**
  88454. * The default object size of the imposter
  88455. */
  88456. static DEFAULT_OBJECT_SIZE: Vector3;
  88457. /**
  88458. * The identity quaternion of the imposter
  88459. */
  88460. static IDENTITY_QUATERNION: Quaternion;
  88461. /** @hidden */
  88462. _pluginData: any;
  88463. private _physicsEngine;
  88464. private _physicsBody;
  88465. private _bodyUpdateRequired;
  88466. private _onBeforePhysicsStepCallbacks;
  88467. private _onAfterPhysicsStepCallbacks;
  88468. /** @hidden */
  88469. _onPhysicsCollideCallbacks: Array<{
  88470. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  88471. otherImpostors: Array<PhysicsImpostor>;
  88472. }>;
  88473. private _deltaPosition;
  88474. private _deltaRotation;
  88475. private _deltaRotationConjugated;
  88476. /** @hidden */
  88477. _isFromLine: boolean;
  88478. private _parent;
  88479. private _isDisposed;
  88480. private static _tmpVecs;
  88481. private static _tmpQuat;
  88482. /**
  88483. * Specifies if the physics imposter is disposed
  88484. */
  88485. readonly isDisposed: boolean;
  88486. /**
  88487. * Gets the mass of the physics imposter
  88488. */
  88489. mass: number;
  88490. /**
  88491. * Gets the coefficient of friction
  88492. */
  88493. /**
  88494. * Sets the coefficient of friction
  88495. */
  88496. friction: number;
  88497. /**
  88498. * Gets the coefficient of restitution
  88499. */
  88500. /**
  88501. * Sets the coefficient of restitution
  88502. */
  88503. restitution: number;
  88504. /**
  88505. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  88506. */
  88507. /**
  88508. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  88509. */
  88510. pressure: number;
  88511. /**
  88512. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  88513. */
  88514. /**
  88515. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  88516. */
  88517. stiffness: number;
  88518. /**
  88519. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  88520. */
  88521. /**
  88522. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  88523. */
  88524. velocityIterations: number;
  88525. /**
  88526. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  88527. */
  88528. /**
  88529. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  88530. */
  88531. positionIterations: number;
  88532. /**
  88533. * The unique id of the physics imposter
  88534. * set by the physics engine when adding this impostor to the array
  88535. */
  88536. uniqueId: number;
  88537. /**
  88538. * @hidden
  88539. */
  88540. soft: boolean;
  88541. /**
  88542. * @hidden
  88543. */
  88544. segments: number;
  88545. private _joints;
  88546. /**
  88547. * Initializes the physics imposter
  88548. * @param object The physics-enabled object used as the physics imposter
  88549. * @param type The type of the physics imposter
  88550. * @param _options The options for the physics imposter
  88551. * @param _scene The Babylon scene
  88552. */
  88553. constructor(
  88554. /**
  88555. * The physics-enabled object used as the physics imposter
  88556. */
  88557. object: IPhysicsEnabledObject,
  88558. /**
  88559. * The type of the physics imposter
  88560. */
  88561. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  88562. /**
  88563. * This function will completly initialize this impostor.
  88564. * It will create a new body - but only if this mesh has no parent.
  88565. * If it has, this impostor will not be used other than to define the impostor
  88566. * of the child mesh.
  88567. * @hidden
  88568. */
  88569. _init(): void;
  88570. private _getPhysicsParent;
  88571. /**
  88572. * Should a new body be generated.
  88573. * @returns boolean specifying if body initialization is required
  88574. */
  88575. isBodyInitRequired(): boolean;
  88576. /**
  88577. * Sets the updated scaling
  88578. * @param updated Specifies if the scaling is updated
  88579. */
  88580. setScalingUpdated(): void;
  88581. /**
  88582. * Force a regeneration of this or the parent's impostor's body.
  88583. * Use under cautious - This will remove all joints already implemented.
  88584. */
  88585. forceUpdate(): void;
  88586. /**
  88587. * Gets the body that holds this impostor. Either its own, or its parent.
  88588. */
  88589. /**
  88590. * Set the physics body. Used mainly by the physics engine/plugin
  88591. */
  88592. physicsBody: any;
  88593. /**
  88594. * Get the parent of the physics imposter
  88595. * @returns Physics imposter or null
  88596. */
  88597. /**
  88598. * Sets the parent of the physics imposter
  88599. */
  88600. parent: Nullable<PhysicsImpostor>;
  88601. /**
  88602. * Resets the update flags
  88603. */
  88604. resetUpdateFlags(): void;
  88605. /**
  88606. * Gets the object extend size
  88607. * @returns the object extend size
  88608. */
  88609. getObjectExtendSize(): Vector3;
  88610. /**
  88611. * Gets the object center
  88612. * @returns The object center
  88613. */
  88614. getObjectCenter(): Vector3;
  88615. /**
  88616. * Get a specific parametes from the options parameter
  88617. * @param paramName The object parameter name
  88618. * @returns The object parameter
  88619. */
  88620. getParam(paramName: string): any;
  88621. /**
  88622. * Sets a specific parameter in the options given to the physics plugin
  88623. * @param paramName The parameter name
  88624. * @param value The value of the parameter
  88625. */
  88626. setParam(paramName: string, value: number): void;
  88627. /**
  88628. * Specifically change the body's mass option. Won't recreate the physics body object
  88629. * @param mass The mass of the physics imposter
  88630. */
  88631. setMass(mass: number): void;
  88632. /**
  88633. * Gets the linear velocity
  88634. * @returns linear velocity or null
  88635. */
  88636. getLinearVelocity(): Nullable<Vector3>;
  88637. /**
  88638. * Sets the linear velocity
  88639. * @param velocity linear velocity or null
  88640. */
  88641. setLinearVelocity(velocity: Nullable<Vector3>): void;
  88642. /**
  88643. * Gets the angular velocity
  88644. * @returns angular velocity or null
  88645. */
  88646. getAngularVelocity(): Nullable<Vector3>;
  88647. /**
  88648. * Sets the angular velocity
  88649. * @param velocity The velocity or null
  88650. */
  88651. setAngularVelocity(velocity: Nullable<Vector3>): void;
  88652. /**
  88653. * Execute a function with the physics plugin native code
  88654. * Provide a function the will have two variables - the world object and the physics body object
  88655. * @param func The function to execute with the physics plugin native code
  88656. */
  88657. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  88658. /**
  88659. * Register a function that will be executed before the physics world is stepping forward
  88660. * @param func The function to execute before the physics world is stepped forward
  88661. */
  88662. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  88663. /**
  88664. * Unregister a function that will be executed before the physics world is stepping forward
  88665. * @param func The function to execute before the physics world is stepped forward
  88666. */
  88667. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  88668. /**
  88669. * Register a function that will be executed after the physics step
  88670. * @param func The function to execute after physics step
  88671. */
  88672. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  88673. /**
  88674. * Unregisters a function that will be executed after the physics step
  88675. * @param func The function to execute after physics step
  88676. */
  88677. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  88678. /**
  88679. * register a function that will be executed when this impostor collides against a different body
  88680. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  88681. * @param func Callback that is executed on collision
  88682. */
  88683. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  88684. /**
  88685. * Unregisters the physics imposter on contact
  88686. * @param collideAgainst The physics object to collide against
  88687. * @param func Callback to execute on collision
  88688. */
  88689. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  88690. private _tmpQuat;
  88691. private _tmpQuat2;
  88692. /**
  88693. * Get the parent rotation
  88694. * @returns The parent rotation
  88695. */
  88696. getParentsRotation(): Quaternion;
  88697. /**
  88698. * this function is executed by the physics engine.
  88699. */
  88700. beforeStep: () => void;
  88701. /**
  88702. * this function is executed by the physics engine
  88703. */
  88704. afterStep: () => void;
  88705. /**
  88706. * Legacy collision detection event support
  88707. */
  88708. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  88709. /**
  88710. * event and body object due to cannon's event-based architecture.
  88711. */
  88712. onCollide: (e: {
  88713. body: any;
  88714. }) => void;
  88715. /**
  88716. * Apply a force
  88717. * @param force The force to apply
  88718. * @param contactPoint The contact point for the force
  88719. * @returns The physics imposter
  88720. */
  88721. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  88722. /**
  88723. * Apply an impulse
  88724. * @param force The impulse force
  88725. * @param contactPoint The contact point for the impulse force
  88726. * @returns The physics imposter
  88727. */
  88728. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  88729. /**
  88730. * A help function to create a joint
  88731. * @param otherImpostor A physics imposter used to create a joint
  88732. * @param jointType The type of joint
  88733. * @param jointData The data for the joint
  88734. * @returns The physics imposter
  88735. */
  88736. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  88737. /**
  88738. * Add a joint to this impostor with a different impostor
  88739. * @param otherImpostor A physics imposter used to add a joint
  88740. * @param joint The joint to add
  88741. * @returns The physics imposter
  88742. */
  88743. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  88744. /**
  88745. * Add an anchor to a cloth impostor
  88746. * @param otherImpostor rigid impostor to anchor to
  88747. * @param width ratio across width from 0 to 1
  88748. * @param height ratio up height from 0 to 1
  88749. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  88750. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  88751. * @returns impostor the soft imposter
  88752. */
  88753. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  88754. /**
  88755. * Add a hook to a rope impostor
  88756. * @param otherImpostor rigid impostor to anchor to
  88757. * @param length ratio across rope from 0 to 1
  88758. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  88759. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  88760. * @returns impostor the rope imposter
  88761. */
  88762. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  88763. /**
  88764. * Will keep this body still, in a sleep mode.
  88765. * @returns the physics imposter
  88766. */
  88767. sleep(): PhysicsImpostor;
  88768. /**
  88769. * Wake the body up.
  88770. * @returns The physics imposter
  88771. */
  88772. wakeUp(): PhysicsImpostor;
  88773. /**
  88774. * Clones the physics imposter
  88775. * @param newObject The physics imposter clones to this physics-enabled object
  88776. * @returns A nullable physics imposter
  88777. */
  88778. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  88779. /**
  88780. * Disposes the physics imposter
  88781. */
  88782. dispose(): void;
  88783. /**
  88784. * Sets the delta position
  88785. * @param position The delta position amount
  88786. */
  88787. setDeltaPosition(position: Vector3): void;
  88788. /**
  88789. * Sets the delta rotation
  88790. * @param rotation The delta rotation amount
  88791. */
  88792. setDeltaRotation(rotation: Quaternion): void;
  88793. /**
  88794. * Gets the box size of the physics imposter and stores the result in the input parameter
  88795. * @param result Stores the box size
  88796. * @returns The physics imposter
  88797. */
  88798. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  88799. /**
  88800. * Gets the radius of the physics imposter
  88801. * @returns Radius of the physics imposter
  88802. */
  88803. getRadius(): number;
  88804. /**
  88805. * Sync a bone with this impostor
  88806. * @param bone The bone to sync to the impostor.
  88807. * @param boneMesh The mesh that the bone is influencing.
  88808. * @param jointPivot The pivot of the joint / bone in local space.
  88809. * @param distToJoint Optional distance from the impostor to the joint.
  88810. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  88811. */
  88812. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  88813. /**
  88814. * Sync impostor to a bone
  88815. * @param bone The bone that the impostor will be synced to.
  88816. * @param boneMesh The mesh that the bone is influencing.
  88817. * @param jointPivot The pivot of the joint / bone in local space.
  88818. * @param distToJoint Optional distance from the impostor to the joint.
  88819. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  88820. * @param boneAxis Optional vector3 axis the bone is aligned with
  88821. */
  88822. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  88823. /**
  88824. * No-Imposter type
  88825. */
  88826. static NoImpostor: number;
  88827. /**
  88828. * Sphere-Imposter type
  88829. */
  88830. static SphereImpostor: number;
  88831. /**
  88832. * Box-Imposter type
  88833. */
  88834. static BoxImpostor: number;
  88835. /**
  88836. * Plane-Imposter type
  88837. */
  88838. static PlaneImpostor: number;
  88839. /**
  88840. * Mesh-imposter type
  88841. */
  88842. static MeshImpostor: number;
  88843. /**
  88844. * Capsule-Impostor type (Ammo.js plugin only)
  88845. */
  88846. static CapsuleImpostor: number;
  88847. /**
  88848. * Cylinder-Imposter type
  88849. */
  88850. static CylinderImpostor: number;
  88851. /**
  88852. * Particle-Imposter type
  88853. */
  88854. static ParticleImpostor: number;
  88855. /**
  88856. * Heightmap-Imposter type
  88857. */
  88858. static HeightmapImpostor: number;
  88859. /**
  88860. * ConvexHull-Impostor type (Ammo.js plugin only)
  88861. */
  88862. static ConvexHullImpostor: number;
  88863. /**
  88864. * Rope-Imposter type
  88865. */
  88866. static RopeImpostor: number;
  88867. /**
  88868. * Cloth-Imposter type
  88869. */
  88870. static ClothImpostor: number;
  88871. /**
  88872. * Softbody-Imposter type
  88873. */
  88874. static SoftbodyImpostor: number;
  88875. }
  88876. }
  88877. declare module BABYLON {
  88878. /**
  88879. * @hidden
  88880. **/
  88881. export class _CreationDataStorage {
  88882. closePath?: boolean;
  88883. closeArray?: boolean;
  88884. idx: number[];
  88885. dashSize: number;
  88886. gapSize: number;
  88887. path3D: Path3D;
  88888. pathArray: Vector3[][];
  88889. arc: number;
  88890. radius: number;
  88891. cap: number;
  88892. tessellation: number;
  88893. }
  88894. /**
  88895. * @hidden
  88896. **/
  88897. class _InstanceDataStorage {
  88898. visibleInstances: any;
  88899. batchCache: _InstancesBatch;
  88900. instancesBufferSize: number;
  88901. instancesBuffer: Nullable<Buffer>;
  88902. instancesData: Float32Array;
  88903. overridenInstanceCount: number;
  88904. isFrozen: boolean;
  88905. previousBatch: Nullable<_InstancesBatch>;
  88906. hardwareInstancedRendering: boolean;
  88907. sideOrientation: number;
  88908. }
  88909. /**
  88910. * @hidden
  88911. **/
  88912. export class _InstancesBatch {
  88913. mustReturn: boolean;
  88914. visibleInstances: Nullable<InstancedMesh[]>[];
  88915. renderSelf: boolean[];
  88916. hardwareInstancedRendering: boolean[];
  88917. }
  88918. /**
  88919. * Class used to represent renderable models
  88920. */
  88921. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  88922. /**
  88923. * Mesh side orientation : usually the external or front surface
  88924. */
  88925. static readonly FRONTSIDE: number;
  88926. /**
  88927. * Mesh side orientation : usually the internal or back surface
  88928. */
  88929. static readonly BACKSIDE: number;
  88930. /**
  88931. * Mesh side orientation : both internal and external or front and back surfaces
  88932. */
  88933. static readonly DOUBLESIDE: number;
  88934. /**
  88935. * Mesh side orientation : by default, `FRONTSIDE`
  88936. */
  88937. static readonly DEFAULTSIDE: number;
  88938. /**
  88939. * Mesh cap setting : no cap
  88940. */
  88941. static readonly NO_CAP: number;
  88942. /**
  88943. * Mesh cap setting : one cap at the beginning of the mesh
  88944. */
  88945. static readonly CAP_START: number;
  88946. /**
  88947. * Mesh cap setting : one cap at the end of the mesh
  88948. */
  88949. static readonly CAP_END: number;
  88950. /**
  88951. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  88952. */
  88953. static readonly CAP_ALL: number;
  88954. /**
  88955. * Mesh pattern setting : no flip or rotate
  88956. */
  88957. static readonly NO_FLIP: number;
  88958. /**
  88959. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  88960. */
  88961. static readonly FLIP_TILE: number;
  88962. /**
  88963. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  88964. */
  88965. static readonly ROTATE_TILE: number;
  88966. /**
  88967. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  88968. */
  88969. static readonly FLIP_ROW: number;
  88970. /**
  88971. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  88972. */
  88973. static readonly ROTATE_ROW: number;
  88974. /**
  88975. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  88976. */
  88977. static readonly FLIP_N_ROTATE_TILE: number;
  88978. /**
  88979. * Mesh pattern setting : rotate pattern and rotate
  88980. */
  88981. static readonly FLIP_N_ROTATE_ROW: number;
  88982. /**
  88983. * Mesh tile positioning : part tiles same on left/right or top/bottom
  88984. */
  88985. static readonly CENTER: number;
  88986. /**
  88987. * Mesh tile positioning : part tiles on left
  88988. */
  88989. static readonly LEFT: number;
  88990. /**
  88991. * Mesh tile positioning : part tiles on right
  88992. */
  88993. static readonly RIGHT: number;
  88994. /**
  88995. * Mesh tile positioning : part tiles on top
  88996. */
  88997. static readonly TOP: number;
  88998. /**
  88999. * Mesh tile positioning : part tiles on bottom
  89000. */
  89001. static readonly BOTTOM: number;
  89002. /**
  89003. * Gets the default side orientation.
  89004. * @param orientation the orientation to value to attempt to get
  89005. * @returns the default orientation
  89006. * @hidden
  89007. */
  89008. static _GetDefaultSideOrientation(orientation?: number): number;
  89009. private _internalMeshDataInfo;
  89010. /**
  89011. * An event triggered before rendering the mesh
  89012. */
  89013. readonly onBeforeRenderObservable: Observable<Mesh>;
  89014. /**
  89015. * An event triggered before binding the mesh
  89016. */
  89017. readonly onBeforeBindObservable: Observable<Mesh>;
  89018. /**
  89019. * An event triggered after rendering the mesh
  89020. */
  89021. readonly onAfterRenderObservable: Observable<Mesh>;
  89022. /**
  89023. * An event triggered before drawing the mesh
  89024. */
  89025. readonly onBeforeDrawObservable: Observable<Mesh>;
  89026. private _onBeforeDrawObserver;
  89027. /**
  89028. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  89029. */
  89030. onBeforeDraw: () => void;
  89031. readonly hasInstances: boolean;
  89032. /**
  89033. * Gets the delay loading state of the mesh (when delay loading is turned on)
  89034. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  89035. */
  89036. delayLoadState: number;
  89037. /**
  89038. * Gets the list of instances created from this mesh
  89039. * it is not supposed to be modified manually.
  89040. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  89041. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  89042. */
  89043. instances: InstancedMesh[];
  89044. /**
  89045. * Gets the file containing delay loading data for this mesh
  89046. */
  89047. delayLoadingFile: string;
  89048. /** @hidden */
  89049. _binaryInfo: any;
  89050. /**
  89051. * User defined function used to change how LOD level selection is done
  89052. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  89053. */
  89054. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  89055. /**
  89056. * Gets or sets the morph target manager
  89057. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  89058. */
  89059. morphTargetManager: Nullable<MorphTargetManager>;
  89060. /** @hidden */
  89061. _creationDataStorage: Nullable<_CreationDataStorage>;
  89062. /** @hidden */
  89063. _geometry: Nullable<Geometry>;
  89064. /** @hidden */
  89065. _delayInfo: Array<string>;
  89066. /** @hidden */
  89067. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  89068. /** @hidden */
  89069. _instanceDataStorage: _InstanceDataStorage;
  89070. private _effectiveMaterial;
  89071. /** @hidden */
  89072. _shouldGenerateFlatShading: boolean;
  89073. /** @hidden */
  89074. _originalBuilderSideOrientation: number;
  89075. /**
  89076. * Use this property to change the original side orientation defined at construction time
  89077. */
  89078. overrideMaterialSideOrientation: Nullable<number>;
  89079. /**
  89080. * Gets the source mesh (the one used to clone this one from)
  89081. */
  89082. readonly source: Nullable<Mesh>;
  89083. /**
  89084. * Gets or sets a boolean indicating that this mesh does not use index buffer
  89085. */
  89086. isUnIndexed: boolean;
  89087. /**
  89088. * @constructor
  89089. * @param name The value used by scene.getMeshByName() to do a lookup.
  89090. * @param scene The scene to add this mesh to.
  89091. * @param parent The parent of this mesh, if it has one
  89092. * @param source An optional Mesh from which geometry is shared, cloned.
  89093. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  89094. * When false, achieved by calling a clone(), also passing False.
  89095. * This will make creation of children, recursive.
  89096. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  89097. */
  89098. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  89099. instantiateHierarychy(newParent?: Nullable<TransformNode>): Nullable<TransformNode>;
  89100. /**
  89101. * Gets the class name
  89102. * @returns the string "Mesh".
  89103. */
  89104. getClassName(): string;
  89105. /** @hidden */
  89106. readonly _isMesh: boolean;
  89107. /**
  89108. * Returns a description of this mesh
  89109. * @param fullDetails define if full details about this mesh must be used
  89110. * @returns a descriptive string representing this mesh
  89111. */
  89112. toString(fullDetails?: boolean): string;
  89113. /** @hidden */
  89114. _unBindEffect(): void;
  89115. /**
  89116. * Gets a boolean indicating if this mesh has LOD
  89117. */
  89118. readonly hasLODLevels: boolean;
  89119. /**
  89120. * Gets the list of MeshLODLevel associated with the current mesh
  89121. * @returns an array of MeshLODLevel
  89122. */
  89123. getLODLevels(): MeshLODLevel[];
  89124. private _sortLODLevels;
  89125. /**
  89126. * Add a mesh as LOD level triggered at the given distance.
  89127. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  89128. * @param distance The distance from the center of the object to show this level
  89129. * @param mesh The mesh to be added as LOD level (can be null)
  89130. * @return This mesh (for chaining)
  89131. */
  89132. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  89133. /**
  89134. * Returns the LOD level mesh at the passed distance or null if not found.
  89135. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  89136. * @param distance The distance from the center of the object to show this level
  89137. * @returns a Mesh or `null`
  89138. */
  89139. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  89140. /**
  89141. * Remove a mesh from the LOD array
  89142. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  89143. * @param mesh defines the mesh to be removed
  89144. * @return This mesh (for chaining)
  89145. */
  89146. removeLODLevel(mesh: Mesh): Mesh;
  89147. /**
  89148. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  89149. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  89150. * @param camera defines the camera to use to compute distance
  89151. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  89152. * @return This mesh (for chaining)
  89153. */
  89154. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  89155. /**
  89156. * Gets the mesh internal Geometry object
  89157. */
  89158. readonly geometry: Nullable<Geometry>;
  89159. /**
  89160. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  89161. * @returns the total number of vertices
  89162. */
  89163. getTotalVertices(): number;
  89164. /**
  89165. * Returns the content of an associated vertex buffer
  89166. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  89167. * - VertexBuffer.PositionKind
  89168. * - VertexBuffer.UVKind
  89169. * - VertexBuffer.UV2Kind
  89170. * - VertexBuffer.UV3Kind
  89171. * - VertexBuffer.UV4Kind
  89172. * - VertexBuffer.UV5Kind
  89173. * - VertexBuffer.UV6Kind
  89174. * - VertexBuffer.ColorKind
  89175. * - VertexBuffer.MatricesIndicesKind
  89176. * - VertexBuffer.MatricesIndicesExtraKind
  89177. * - VertexBuffer.MatricesWeightsKind
  89178. * - VertexBuffer.MatricesWeightsExtraKind
  89179. * @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
  89180. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  89181. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  89182. */
  89183. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89184. /**
  89185. * Returns the mesh VertexBuffer object from the requested `kind`
  89186. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  89187. * - VertexBuffer.PositionKind
  89188. * - VertexBuffer.NormalKind
  89189. * - VertexBuffer.UVKind
  89190. * - VertexBuffer.UV2Kind
  89191. * - VertexBuffer.UV3Kind
  89192. * - VertexBuffer.UV4Kind
  89193. * - VertexBuffer.UV5Kind
  89194. * - VertexBuffer.UV6Kind
  89195. * - VertexBuffer.ColorKind
  89196. * - VertexBuffer.MatricesIndicesKind
  89197. * - VertexBuffer.MatricesIndicesExtraKind
  89198. * - VertexBuffer.MatricesWeightsKind
  89199. * - VertexBuffer.MatricesWeightsExtraKind
  89200. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  89201. */
  89202. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  89203. /**
  89204. * Tests if a specific vertex buffer is associated with this mesh
  89205. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  89206. * - VertexBuffer.PositionKind
  89207. * - VertexBuffer.NormalKind
  89208. * - VertexBuffer.UVKind
  89209. * - VertexBuffer.UV2Kind
  89210. * - VertexBuffer.UV3Kind
  89211. * - VertexBuffer.UV4Kind
  89212. * - VertexBuffer.UV5Kind
  89213. * - VertexBuffer.UV6Kind
  89214. * - VertexBuffer.ColorKind
  89215. * - VertexBuffer.MatricesIndicesKind
  89216. * - VertexBuffer.MatricesIndicesExtraKind
  89217. * - VertexBuffer.MatricesWeightsKind
  89218. * - VertexBuffer.MatricesWeightsExtraKind
  89219. * @returns a boolean
  89220. */
  89221. isVerticesDataPresent(kind: string): boolean;
  89222. /**
  89223. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  89224. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  89225. * - VertexBuffer.PositionKind
  89226. * - VertexBuffer.UVKind
  89227. * - VertexBuffer.UV2Kind
  89228. * - VertexBuffer.UV3Kind
  89229. * - VertexBuffer.UV4Kind
  89230. * - VertexBuffer.UV5Kind
  89231. * - VertexBuffer.UV6Kind
  89232. * - VertexBuffer.ColorKind
  89233. * - VertexBuffer.MatricesIndicesKind
  89234. * - VertexBuffer.MatricesIndicesExtraKind
  89235. * - VertexBuffer.MatricesWeightsKind
  89236. * - VertexBuffer.MatricesWeightsExtraKind
  89237. * @returns a boolean
  89238. */
  89239. isVertexBufferUpdatable(kind: string): boolean;
  89240. /**
  89241. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  89242. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  89243. * - VertexBuffer.PositionKind
  89244. * - VertexBuffer.NormalKind
  89245. * - VertexBuffer.UVKind
  89246. * - VertexBuffer.UV2Kind
  89247. * - VertexBuffer.UV3Kind
  89248. * - VertexBuffer.UV4Kind
  89249. * - VertexBuffer.UV5Kind
  89250. * - VertexBuffer.UV6Kind
  89251. * - VertexBuffer.ColorKind
  89252. * - VertexBuffer.MatricesIndicesKind
  89253. * - VertexBuffer.MatricesIndicesExtraKind
  89254. * - VertexBuffer.MatricesWeightsKind
  89255. * - VertexBuffer.MatricesWeightsExtraKind
  89256. * @returns an array of strings
  89257. */
  89258. getVerticesDataKinds(): string[];
  89259. /**
  89260. * Returns a positive integer : the total number of indices in this mesh geometry.
  89261. * @returns the numner of indices or zero if the mesh has no geometry.
  89262. */
  89263. getTotalIndices(): number;
  89264. /**
  89265. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89266. * @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.
  89267. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89268. * @returns the indices array or an empty array if the mesh has no geometry
  89269. */
  89270. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89271. readonly isBlocked: boolean;
  89272. /**
  89273. * Determine if the current mesh is ready to be rendered
  89274. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  89275. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  89276. * @returns true if all associated assets are ready (material, textures, shaders)
  89277. */
  89278. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  89279. /**
  89280. * 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.
  89281. */
  89282. readonly areNormalsFrozen: boolean;
  89283. /**
  89284. * 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.
  89285. * @returns the current mesh
  89286. */
  89287. freezeNormals(): Mesh;
  89288. /**
  89289. * 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
  89290. * @returns the current mesh
  89291. */
  89292. unfreezeNormals(): Mesh;
  89293. /**
  89294. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  89295. */
  89296. overridenInstanceCount: number;
  89297. /** @hidden */
  89298. _preActivate(): Mesh;
  89299. /** @hidden */
  89300. _preActivateForIntermediateRendering(renderId: number): Mesh;
  89301. /** @hidden */
  89302. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  89303. /**
  89304. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  89305. * This means the mesh underlying bounding box and sphere are recomputed.
  89306. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  89307. * @returns the current mesh
  89308. */
  89309. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  89310. /** @hidden */
  89311. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  89312. /**
  89313. * This function will subdivide the mesh into multiple submeshes
  89314. * @param count defines the expected number of submeshes
  89315. */
  89316. subdivide(count: number): void;
  89317. /**
  89318. * Copy a FloatArray into a specific associated vertex buffer
  89319. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89320. * - VertexBuffer.PositionKind
  89321. * - VertexBuffer.UVKind
  89322. * - VertexBuffer.UV2Kind
  89323. * - VertexBuffer.UV3Kind
  89324. * - VertexBuffer.UV4Kind
  89325. * - VertexBuffer.UV5Kind
  89326. * - VertexBuffer.UV6Kind
  89327. * - VertexBuffer.ColorKind
  89328. * - VertexBuffer.MatricesIndicesKind
  89329. * - VertexBuffer.MatricesIndicesExtraKind
  89330. * - VertexBuffer.MatricesWeightsKind
  89331. * - VertexBuffer.MatricesWeightsExtraKind
  89332. * @param data defines the data source
  89333. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  89334. * @param stride defines the data stride size (can be null)
  89335. * @returns the current mesh
  89336. */
  89337. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  89338. /**
  89339. * Flags an associated vertex buffer as updatable
  89340. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  89341. * - VertexBuffer.PositionKind
  89342. * - VertexBuffer.UVKind
  89343. * - VertexBuffer.UV2Kind
  89344. * - VertexBuffer.UV3Kind
  89345. * - VertexBuffer.UV4Kind
  89346. * - VertexBuffer.UV5Kind
  89347. * - VertexBuffer.UV6Kind
  89348. * - VertexBuffer.ColorKind
  89349. * - VertexBuffer.MatricesIndicesKind
  89350. * - VertexBuffer.MatricesIndicesExtraKind
  89351. * - VertexBuffer.MatricesWeightsKind
  89352. * - VertexBuffer.MatricesWeightsExtraKind
  89353. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  89354. */
  89355. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  89356. /**
  89357. * Sets the mesh global Vertex Buffer
  89358. * @param buffer defines the buffer to use
  89359. * @returns the current mesh
  89360. */
  89361. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  89362. /**
  89363. * Update a specific associated vertex buffer
  89364. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89365. * - VertexBuffer.PositionKind
  89366. * - VertexBuffer.UVKind
  89367. * - VertexBuffer.UV2Kind
  89368. * - VertexBuffer.UV3Kind
  89369. * - VertexBuffer.UV4Kind
  89370. * - VertexBuffer.UV5Kind
  89371. * - VertexBuffer.UV6Kind
  89372. * - VertexBuffer.ColorKind
  89373. * - VertexBuffer.MatricesIndicesKind
  89374. * - VertexBuffer.MatricesIndicesExtraKind
  89375. * - VertexBuffer.MatricesWeightsKind
  89376. * - VertexBuffer.MatricesWeightsExtraKind
  89377. * @param data defines the data source
  89378. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  89379. * @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)
  89380. * @returns the current mesh
  89381. */
  89382. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  89383. /**
  89384. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  89385. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  89386. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  89387. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  89388. * @returns the current mesh
  89389. */
  89390. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  89391. /**
  89392. * Creates a un-shared specific occurence of the geometry for the mesh.
  89393. * @returns the current mesh
  89394. */
  89395. makeGeometryUnique(): Mesh;
  89396. /**
  89397. * Set the index buffer of this mesh
  89398. * @param indices defines the source data
  89399. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  89400. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  89401. * @returns the current mesh
  89402. */
  89403. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  89404. /**
  89405. * Update the current index buffer
  89406. * @param indices defines the source data
  89407. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  89408. * @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)
  89409. * @returns the current mesh
  89410. */
  89411. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  89412. /**
  89413. * Invert the geometry to move from a right handed system to a left handed one.
  89414. * @returns the current mesh
  89415. */
  89416. toLeftHanded(): Mesh;
  89417. /** @hidden */
  89418. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  89419. /** @hidden */
  89420. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  89421. /**
  89422. * Registers for this mesh a javascript function called just before the rendering process
  89423. * @param func defines the function to call before rendering this mesh
  89424. * @returns the current mesh
  89425. */
  89426. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  89427. /**
  89428. * Disposes a previously registered javascript function called before the rendering
  89429. * @param func defines the function to remove
  89430. * @returns the current mesh
  89431. */
  89432. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  89433. /**
  89434. * Registers for this mesh a javascript function called just after the rendering is complete
  89435. * @param func defines the function to call after rendering this mesh
  89436. * @returns the current mesh
  89437. */
  89438. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  89439. /**
  89440. * Disposes a previously registered javascript function called after the rendering.
  89441. * @param func defines the function to remove
  89442. * @returns the current mesh
  89443. */
  89444. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  89445. /** @hidden */
  89446. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  89447. /** @hidden */
  89448. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  89449. /** @hidden */
  89450. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  89451. /** @hidden */
  89452. _rebuild(): void;
  89453. /** @hidden */
  89454. _freeze(): void;
  89455. /** @hidden */
  89456. _unFreeze(): void;
  89457. /**
  89458. * 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
  89459. * @param subMesh defines the subMesh to render
  89460. * @param enableAlphaMode defines if alpha mode can be changed
  89461. * @returns the current mesh
  89462. */
  89463. render(subMesh: SubMesh, enableAlphaMode: boolean): Mesh;
  89464. private _onBeforeDraw;
  89465. /**
  89466. * Renormalize the mesh and patch it up if there are no weights
  89467. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  89468. * However in the case of zero weights then we set just a single influence to 1.
  89469. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  89470. */
  89471. cleanMatrixWeights(): void;
  89472. private normalizeSkinFourWeights;
  89473. private normalizeSkinWeightsAndExtra;
  89474. /**
  89475. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  89476. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  89477. * the user know there was an issue with importing the mesh
  89478. * @returns a validation object with skinned, valid and report string
  89479. */
  89480. validateSkinning(): {
  89481. skinned: boolean;
  89482. valid: boolean;
  89483. report: string;
  89484. };
  89485. /** @hidden */
  89486. _checkDelayState(): Mesh;
  89487. private _queueLoad;
  89488. /**
  89489. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  89490. * A mesh is in the frustum if its bounding box intersects the frustum
  89491. * @param frustumPlanes defines the frustum to test
  89492. * @returns true if the mesh is in the frustum planes
  89493. */
  89494. isInFrustum(frustumPlanes: Plane[]): boolean;
  89495. /**
  89496. * Sets the mesh material by the material or multiMaterial `id` property
  89497. * @param id is a string identifying the material or the multiMaterial
  89498. * @returns the current mesh
  89499. */
  89500. setMaterialByID(id: string): Mesh;
  89501. /**
  89502. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  89503. * @returns an array of IAnimatable
  89504. */
  89505. getAnimatables(): IAnimatable[];
  89506. /**
  89507. * Modifies the mesh geometry according to the passed transformation matrix.
  89508. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  89509. * The mesh normals are modified using the same transformation.
  89510. * Note that, under the hood, this method sets a new VertexBuffer each call.
  89511. * @param transform defines the transform matrix to use
  89512. * @see http://doc.babylonjs.com/resources/baking_transformations
  89513. * @returns the current mesh
  89514. */
  89515. bakeTransformIntoVertices(transform: Matrix): Mesh;
  89516. /**
  89517. * Modifies the mesh geometry according to its own current World Matrix.
  89518. * The mesh World Matrix is then reset.
  89519. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  89520. * Note that, under the hood, this method sets a new VertexBuffer each call.
  89521. * @see http://doc.babylonjs.com/resources/baking_transformations
  89522. * @returns the current mesh
  89523. */
  89524. bakeCurrentTransformIntoVertices(): Mesh;
  89525. /** @hidden */
  89526. readonly _positions: Nullable<Vector3[]>;
  89527. /** @hidden */
  89528. _resetPointsArrayCache(): Mesh;
  89529. /** @hidden */
  89530. _generatePointsArray(): boolean;
  89531. /**
  89532. * Returns a new Mesh object generated from the current mesh properties.
  89533. * This method must not get confused with createInstance()
  89534. * @param name is a string, the name given to the new mesh
  89535. * @param newParent can be any Node object (default `null`)
  89536. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  89537. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  89538. * @returns a new mesh
  89539. */
  89540. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  89541. /**
  89542. * Releases resources associated with this mesh.
  89543. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  89544. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  89545. */
  89546. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  89547. /**
  89548. * Modifies the mesh geometry according to a displacement map.
  89549. * 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.
  89550. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  89551. * @param url is a string, the URL from the image file is to be downloaded.
  89552. * @param minHeight is the lower limit of the displacement.
  89553. * @param maxHeight is the upper limit of the displacement.
  89554. * @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.
  89555. * @param uvOffset is an optional vector2 used to offset UV.
  89556. * @param uvScale is an optional vector2 used to scale UV.
  89557. * @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.
  89558. * @returns the Mesh.
  89559. */
  89560. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  89561. /**
  89562. * Modifies the mesh geometry according to a displacementMap buffer.
  89563. * 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.
  89564. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  89565. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  89566. * @param heightMapWidth is the width of the buffer image.
  89567. * @param heightMapHeight is the height of the buffer image.
  89568. * @param minHeight is the lower limit of the displacement.
  89569. * @param maxHeight is the upper limit of the displacement.
  89570. * @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.
  89571. * @param uvOffset is an optional vector2 used to offset UV.
  89572. * @param uvScale is an optional vector2 used to scale UV.
  89573. * @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.
  89574. * @returns the Mesh.
  89575. */
  89576. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  89577. /**
  89578. * Modify the mesh to get a flat shading rendering.
  89579. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  89580. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  89581. * @returns current mesh
  89582. */
  89583. convertToFlatShadedMesh(): Mesh;
  89584. /**
  89585. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  89586. * In other words, more vertices, no more indices and a single bigger VBO.
  89587. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  89588. * @returns current mesh
  89589. */
  89590. convertToUnIndexedMesh(): Mesh;
  89591. /**
  89592. * Inverses facet orientations.
  89593. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  89594. * @param flipNormals will also inverts the normals
  89595. * @returns current mesh
  89596. */
  89597. flipFaces(flipNormals?: boolean): Mesh;
  89598. /**
  89599. * Increase the number of facets and hence vertices in a mesh
  89600. * Vertex normals are interpolated from existing vertex normals
  89601. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  89602. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  89603. */
  89604. increaseVertices(numberPerEdge: number): void;
  89605. /**
  89606. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  89607. * This will undo any application of covertToFlatShadedMesh
  89608. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  89609. */
  89610. forceSharedVertices(): void;
  89611. /** @hidden */
  89612. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  89613. /** @hidden */
  89614. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  89615. /**
  89616. * Creates a new InstancedMesh object from the mesh model.
  89617. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  89618. * @param name defines the name of the new instance
  89619. * @returns a new InstancedMesh
  89620. */
  89621. createInstance(name: string): InstancedMesh;
  89622. /**
  89623. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  89624. * After this call, all the mesh instances have the same submeshes than the current mesh.
  89625. * @returns the current mesh
  89626. */
  89627. synchronizeInstances(): Mesh;
  89628. /**
  89629. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  89630. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  89631. * This should be used together with the simplification to avoid disappearing triangles.
  89632. * @param successCallback an optional success callback to be called after the optimization finished.
  89633. * @returns the current mesh
  89634. */
  89635. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  89636. /**
  89637. * Serialize current mesh
  89638. * @param serializationObject defines the object which will receive the serialization data
  89639. */
  89640. serialize(serializationObject: any): void;
  89641. /** @hidden */
  89642. _syncGeometryWithMorphTargetManager(): void;
  89643. /** @hidden */
  89644. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  89645. /**
  89646. * Returns a new Mesh object parsed from the source provided.
  89647. * @param parsedMesh is the source
  89648. * @param scene defines the hosting scene
  89649. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  89650. * @returns a new Mesh
  89651. */
  89652. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  89653. /**
  89654. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  89655. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  89656. * @param name defines the name of the mesh to create
  89657. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  89658. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  89659. * @param closePath creates a seam between the first and the last points of each path of the path array
  89660. * @param offset is taken in account only if the `pathArray` is containing a single path
  89661. * @param scene defines the hosting scene
  89662. * @param updatable defines if the mesh must be flagged as updatable
  89663. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89664. * @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)
  89665. * @returns a new Mesh
  89666. */
  89667. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  89668. /**
  89669. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  89670. * @param name defines the name of the mesh to create
  89671. * @param radius sets the radius size (float) of the polygon (default 0.5)
  89672. * @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
  89673. * @param scene defines the hosting scene
  89674. * @param updatable defines if the mesh must be flagged as updatable
  89675. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89676. * @returns a new Mesh
  89677. */
  89678. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  89679. /**
  89680. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  89681. * @param name defines the name of the mesh to create
  89682. * @param size sets the size (float) of each box side (default 1)
  89683. * @param scene defines the hosting scene
  89684. * @param updatable defines if the mesh must be flagged as updatable
  89685. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89686. * @returns a new Mesh
  89687. */
  89688. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  89689. /**
  89690. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  89691. * @param name defines the name of the mesh to create
  89692. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  89693. * @param diameter sets the diameter size (float) of the sphere (default 1)
  89694. * @param scene defines the hosting scene
  89695. * @param updatable defines if the mesh must be flagged as updatable
  89696. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89697. * @returns a new Mesh
  89698. */
  89699. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  89700. /**
  89701. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  89702. * @param name defines the name of the mesh to create
  89703. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  89704. * @param diameter sets the diameter size (float) of the sphere (default 1)
  89705. * @param scene defines the hosting scene
  89706. * @returns a new Mesh
  89707. */
  89708. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  89709. /**
  89710. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  89711. * @param name defines the name of the mesh to create
  89712. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  89713. * @param diameterTop set the top cap diameter (floats, default 1)
  89714. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  89715. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  89716. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  89717. * @param scene defines the hosting scene
  89718. * @param updatable defines if the mesh must be flagged as updatable
  89719. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89720. * @returns a new Mesh
  89721. */
  89722. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  89723. /**
  89724. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  89725. * @param name defines the name of the mesh to create
  89726. * @param diameter sets the diameter size (float) of the torus (default 1)
  89727. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  89728. * @param tessellation sets the number of torus sides (postive integer, default 16)
  89729. * @param scene defines the hosting scene
  89730. * @param updatable defines if the mesh must be flagged as updatable
  89731. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89732. * @returns a new Mesh
  89733. */
  89734. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  89735. /**
  89736. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  89737. * @param name defines the name of the mesh to create
  89738. * @param radius sets the global radius size (float) of the torus knot (default 2)
  89739. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  89740. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  89741. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  89742. * @param p the number of windings on X axis (positive integers, default 2)
  89743. * @param q the number of windings on Y axis (positive integers, default 3)
  89744. * @param scene defines the hosting scene
  89745. * @param updatable defines if the mesh must be flagged as updatable
  89746. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89747. * @returns a new Mesh
  89748. */
  89749. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  89750. /**
  89751. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  89752. * @param name defines the name of the mesh to create
  89753. * @param points is an array successive Vector3
  89754. * @param scene defines the hosting scene
  89755. * @param updatable defines if the mesh must be flagged as updatable
  89756. * @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).
  89757. * @returns a new Mesh
  89758. */
  89759. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  89760. /**
  89761. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  89762. * @param name defines the name of the mesh to create
  89763. * @param points is an array successive Vector3
  89764. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  89765. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  89766. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  89767. * @param scene defines the hosting scene
  89768. * @param updatable defines if the mesh must be flagged as updatable
  89769. * @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)
  89770. * @returns a new Mesh
  89771. */
  89772. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  89773. /**
  89774. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  89775. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  89776. * 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.
  89777. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89778. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  89779. * Remember you can only change the shape positions, not their number when updating a polygon.
  89780. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  89781. * @param name defines the name of the mesh to create
  89782. * @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
  89783. * @param scene defines the hosting scene
  89784. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  89785. * @param updatable defines if the mesh must be flagged as updatable
  89786. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89787. * @param earcutInjection can be used to inject your own earcut reference
  89788. * @returns a new Mesh
  89789. */
  89790. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  89791. /**
  89792. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  89793. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  89794. * @param name defines the name of the mesh to create
  89795. * @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
  89796. * @param depth defines the height of extrusion
  89797. * @param scene defines the hosting scene
  89798. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  89799. * @param updatable defines if the mesh must be flagged as updatable
  89800. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89801. * @param earcutInjection can be used to inject your own earcut reference
  89802. * @returns a new Mesh
  89803. */
  89804. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  89805. /**
  89806. * Creates an extruded shape mesh.
  89807. * 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
  89808. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  89809. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  89810. * @param name defines the name of the mesh to create
  89811. * @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
  89812. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  89813. * @param scale is the value to scale the shape
  89814. * @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
  89815. * @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
  89816. * @param scene defines the hosting scene
  89817. * @param updatable defines if the mesh must be flagged as updatable
  89818. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89819. * @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)
  89820. * @returns a new Mesh
  89821. */
  89822. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  89823. /**
  89824. * Creates an custom extruded shape mesh.
  89825. * The custom extrusion is a parametric shape.
  89826. * It has no predefined shape. Its final shape will depend on the input parameters.
  89827. * Please consider using the same method from the MeshBuilder class instead
  89828. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  89829. * @param name defines the name of the mesh to create
  89830. * @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
  89831. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  89832. * @param scaleFunction is a custom Javascript function called on each path point
  89833. * @param rotationFunction is a custom Javascript function called on each path point
  89834. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  89835. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  89836. * @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
  89837. * @param scene defines the hosting scene
  89838. * @param updatable defines if the mesh must be flagged as updatable
  89839. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89840. * @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)
  89841. * @returns a new Mesh
  89842. */
  89843. 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;
  89844. /**
  89845. * Creates lathe mesh.
  89846. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  89847. * Please consider using the same method from the MeshBuilder class instead
  89848. * @param name defines the name of the mesh to create
  89849. * @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
  89850. * @param radius is the radius value of the lathe
  89851. * @param tessellation is the side number of the lathe.
  89852. * @param scene defines the hosting scene
  89853. * @param updatable defines if the mesh must be flagged as updatable
  89854. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89855. * @returns a new Mesh
  89856. */
  89857. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  89858. /**
  89859. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  89860. * @param name defines the name of the mesh to create
  89861. * @param size sets the size (float) of both sides of the plane at once (default 1)
  89862. * @param scene defines the hosting scene
  89863. * @param updatable defines if the mesh must be flagged as updatable
  89864. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89865. * @returns a new Mesh
  89866. */
  89867. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  89868. /**
  89869. * Creates a ground mesh.
  89870. * Please consider using the same method from the MeshBuilder class instead
  89871. * @param name defines the name of the mesh to create
  89872. * @param width set the width of the ground
  89873. * @param height set the height of the ground
  89874. * @param subdivisions sets the number of subdivisions per side
  89875. * @param scene defines the hosting scene
  89876. * @param updatable defines if the mesh must be flagged as updatable
  89877. * @returns a new Mesh
  89878. */
  89879. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  89880. /**
  89881. * Creates a tiled ground mesh.
  89882. * Please consider using the same method from the MeshBuilder class instead
  89883. * @param name defines the name of the mesh to create
  89884. * @param xmin set the ground minimum X coordinate
  89885. * @param zmin set the ground minimum Y coordinate
  89886. * @param xmax set the ground maximum X coordinate
  89887. * @param zmax set the ground maximum Z coordinate
  89888. * @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
  89889. * @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
  89890. * @param scene defines the hosting scene
  89891. * @param updatable defines if the mesh must be flagged as updatable
  89892. * @returns a new Mesh
  89893. */
  89894. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  89895. w: number;
  89896. h: number;
  89897. }, precision: {
  89898. w: number;
  89899. h: number;
  89900. }, scene: Scene, updatable?: boolean): Mesh;
  89901. /**
  89902. * Creates a ground mesh from a height map.
  89903. * Please consider using the same method from the MeshBuilder class instead
  89904. * @see http://doc.babylonjs.com/babylon101/height_map
  89905. * @param name defines the name of the mesh to create
  89906. * @param url sets the URL of the height map image resource
  89907. * @param width set the ground width size
  89908. * @param height set the ground height size
  89909. * @param subdivisions sets the number of subdivision per side
  89910. * @param minHeight is the minimum altitude on the ground
  89911. * @param maxHeight is the maximum altitude on the ground
  89912. * @param scene defines the hosting scene
  89913. * @param updatable defines if the mesh must be flagged as updatable
  89914. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  89915. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  89916. * @returns a new Mesh
  89917. */
  89918. 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;
  89919. /**
  89920. * Creates a tube mesh.
  89921. * The tube is a parametric shape.
  89922. * It has no predefined shape. Its final shape will depend on the input parameters.
  89923. * Please consider using the same method from the MeshBuilder class instead
  89924. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  89925. * @param name defines the name of the mesh to create
  89926. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  89927. * @param radius sets the tube radius size
  89928. * @param tessellation is the number of sides on the tubular surface
  89929. * @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
  89930. * @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
  89931. * @param scene defines the hosting scene
  89932. * @param updatable defines if the mesh must be flagged as updatable
  89933. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  89934. * @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)
  89935. * @returns a new Mesh
  89936. */
  89937. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  89938. (i: number, distance: number): number;
  89939. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  89940. /**
  89941. * Creates a polyhedron mesh.
  89942. * Please consider using the same method from the MeshBuilder class instead.
  89943. * * 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
  89944. * * The parameter `size` (positive float, default 1) sets the polygon size
  89945. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  89946. * * 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`
  89947. * * 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
  89948. * * 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)`)
  89949. * * 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
  89950. * * 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
  89951. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89952. * * If you create a double-sided mesh, you can choose what parts of 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
  89953. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  89954. * @param name defines the name of the mesh to create
  89955. * @param options defines the options used to create the mesh
  89956. * @param scene defines the hosting scene
  89957. * @returns a new Mesh
  89958. */
  89959. static CreatePolyhedron(name: string, options: {
  89960. type?: number;
  89961. size?: number;
  89962. sizeX?: number;
  89963. sizeY?: number;
  89964. sizeZ?: number;
  89965. custom?: any;
  89966. faceUV?: Vector4[];
  89967. faceColors?: Color4[];
  89968. updatable?: boolean;
  89969. sideOrientation?: number;
  89970. }, scene: Scene): Mesh;
  89971. /**
  89972. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  89973. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  89974. * * 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`)
  89975. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  89976. * * 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
  89977. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89978. * * If you create a double-sided mesh, you can choose what parts of 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
  89979. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  89980. * @param name defines the name of the mesh
  89981. * @param options defines the options used to create the mesh
  89982. * @param scene defines the hosting scene
  89983. * @returns a new Mesh
  89984. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  89985. */
  89986. static CreateIcoSphere(name: string, options: {
  89987. radius?: number;
  89988. flat?: boolean;
  89989. subdivisions?: number;
  89990. sideOrientation?: number;
  89991. updatable?: boolean;
  89992. }, scene: Scene): Mesh;
  89993. /**
  89994. * Creates a decal mesh.
  89995. * Please consider using the same method from the MeshBuilder class instead.
  89996. * A decal is a mesh usually applied as a model onto the surface of another mesh
  89997. * @param name defines the name of the mesh
  89998. * @param sourceMesh defines the mesh receiving the decal
  89999. * @param position sets the position of the decal in world coordinates
  90000. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  90001. * @param size sets the decal scaling
  90002. * @param angle sets the angle to rotate the decal
  90003. * @returns a new Mesh
  90004. */
  90005. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  90006. /**
  90007. * Prepare internal position array for software CPU skinning
  90008. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  90009. */
  90010. setPositionsForCPUSkinning(): Float32Array;
  90011. /**
  90012. * Prepare internal normal array for software CPU skinning
  90013. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  90014. */
  90015. setNormalsForCPUSkinning(): Float32Array;
  90016. /**
  90017. * Updates the vertex buffer by applying transformation from the bones
  90018. * @param skeleton defines the skeleton to apply to current mesh
  90019. * @returns the current mesh
  90020. */
  90021. applySkeleton(skeleton: Skeleton): Mesh;
  90022. /**
  90023. * 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
  90024. * @param meshes defines the list of meshes to scan
  90025. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  90026. */
  90027. static MinMax(meshes: AbstractMesh[]): {
  90028. min: Vector3;
  90029. max: Vector3;
  90030. };
  90031. /**
  90032. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  90033. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  90034. * @returns a vector3
  90035. */
  90036. static Center(meshesOrMinMaxVector: {
  90037. min: Vector3;
  90038. max: Vector3;
  90039. } | AbstractMesh[]): Vector3;
  90040. /**
  90041. * Merge the array of meshes into a single mesh for performance reasons.
  90042. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  90043. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  90044. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  90045. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  90046. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  90047. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  90048. * @returns a new mesh
  90049. */
  90050. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  90051. /** @hidden */
  90052. addInstance(instance: InstancedMesh): void;
  90053. /** @hidden */
  90054. removeInstance(instance: InstancedMesh): void;
  90055. }
  90056. }
  90057. declare module BABYLON {
  90058. /**
  90059. * This is the base class of all the camera used in the application.
  90060. * @see http://doc.babylonjs.com/features/cameras
  90061. */
  90062. export class Camera extends Node {
  90063. /** @hidden */
  90064. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  90065. /**
  90066. * This is the default projection mode used by the cameras.
  90067. * It helps recreating a feeling of perspective and better appreciate depth.
  90068. * This is the best way to simulate real life cameras.
  90069. */
  90070. static readonly PERSPECTIVE_CAMERA: number;
  90071. /**
  90072. * This helps creating camera with an orthographic mode.
  90073. * 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.
  90074. */
  90075. static readonly ORTHOGRAPHIC_CAMERA: number;
  90076. /**
  90077. * This is the default FOV mode for perspective cameras.
  90078. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  90079. */
  90080. static readonly FOVMODE_VERTICAL_FIXED: number;
  90081. /**
  90082. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  90083. */
  90084. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  90085. /**
  90086. * This specifies ther is no need for a camera rig.
  90087. * Basically only one eye is rendered corresponding to the camera.
  90088. */
  90089. static readonly RIG_MODE_NONE: number;
  90090. /**
  90091. * Simulates a camera Rig with one blue eye and one red eye.
  90092. * This can be use with 3d blue and red glasses.
  90093. */
  90094. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  90095. /**
  90096. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  90097. */
  90098. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  90099. /**
  90100. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  90101. */
  90102. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  90103. /**
  90104. * Defines that both eyes of the camera will be rendered over under each other.
  90105. */
  90106. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  90107. /**
  90108. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  90109. */
  90110. static readonly RIG_MODE_VR: number;
  90111. /**
  90112. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  90113. */
  90114. static readonly RIG_MODE_WEBVR: number;
  90115. /**
  90116. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  90117. */
  90118. static readonly RIG_MODE_CUSTOM: number;
  90119. /**
  90120. * Defines if by default attaching controls should prevent the default javascript event to continue.
  90121. */
  90122. static ForceAttachControlToAlwaysPreventDefault: boolean;
  90123. /**
  90124. * Define the input manager associated with the camera.
  90125. */
  90126. inputs: CameraInputsManager<Camera>;
  90127. /** @hidden */
  90128. _position: Vector3;
  90129. /**
  90130. * Define the current local position of the camera in the scene
  90131. */
  90132. position: Vector3;
  90133. /**
  90134. * The vector the camera should consider as up.
  90135. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  90136. */
  90137. upVector: Vector3;
  90138. /**
  90139. * Define the current limit on the left side for an orthographic camera
  90140. * In scene unit
  90141. */
  90142. orthoLeft: Nullable<number>;
  90143. /**
  90144. * Define the current limit on the right side for an orthographic camera
  90145. * In scene unit
  90146. */
  90147. orthoRight: Nullable<number>;
  90148. /**
  90149. * Define the current limit on the bottom side for an orthographic camera
  90150. * In scene unit
  90151. */
  90152. orthoBottom: Nullable<number>;
  90153. /**
  90154. * Define the current limit on the top side for an orthographic camera
  90155. * In scene unit
  90156. */
  90157. orthoTop: Nullable<number>;
  90158. /**
  90159. * Field Of View is set in Radians. (default is 0.8)
  90160. */
  90161. fov: number;
  90162. /**
  90163. * Define the minimum distance the camera can see from.
  90164. * This is important to note that the depth buffer are not infinite and the closer it starts
  90165. * the more your scene might encounter depth fighting issue.
  90166. */
  90167. minZ: number;
  90168. /**
  90169. * Define the maximum distance the camera can see to.
  90170. * This is important to note that the depth buffer are not infinite and the further it end
  90171. * the more your scene might encounter depth fighting issue.
  90172. */
  90173. maxZ: number;
  90174. /**
  90175. * Define the default inertia of the camera.
  90176. * This helps giving a smooth feeling to the camera movement.
  90177. */
  90178. inertia: number;
  90179. /**
  90180. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  90181. */
  90182. mode: number;
  90183. /**
  90184. * Define wether the camera is intermediate.
  90185. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  90186. */
  90187. isIntermediate: boolean;
  90188. /**
  90189. * Define the viewport of the camera.
  90190. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  90191. */
  90192. viewport: Viewport;
  90193. /**
  90194. * Restricts the camera to viewing objects with the same layerMask.
  90195. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  90196. */
  90197. layerMask: number;
  90198. /**
  90199. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  90200. */
  90201. fovMode: number;
  90202. /**
  90203. * Rig mode of the camera.
  90204. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  90205. * This is normally controlled byt the camera themselves as internal use.
  90206. */
  90207. cameraRigMode: number;
  90208. /**
  90209. * Defines the distance between both "eyes" in case of a RIG
  90210. */
  90211. interaxialDistance: number;
  90212. /**
  90213. * Defines if stereoscopic rendering is done side by side or over under.
  90214. */
  90215. isStereoscopicSideBySide: boolean;
  90216. /**
  90217. * 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
  90218. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  90219. * else in the scene. (Eg. security camera)
  90220. *
  90221. * 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)
  90222. */
  90223. customRenderTargets: RenderTargetTexture[];
  90224. /**
  90225. * When set, the camera will render to this render target instead of the default canvas
  90226. *
  90227. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  90228. */
  90229. outputRenderTarget: Nullable<RenderTargetTexture>;
  90230. /**
  90231. * Observable triggered when the camera view matrix has changed.
  90232. */
  90233. onViewMatrixChangedObservable: Observable<Camera>;
  90234. /**
  90235. * Observable triggered when the camera Projection matrix has changed.
  90236. */
  90237. onProjectionMatrixChangedObservable: Observable<Camera>;
  90238. /**
  90239. * Observable triggered when the inputs have been processed.
  90240. */
  90241. onAfterCheckInputsObservable: Observable<Camera>;
  90242. /**
  90243. * Observable triggered when reset has been called and applied to the camera.
  90244. */
  90245. onRestoreStateObservable: Observable<Camera>;
  90246. /** @hidden */
  90247. _cameraRigParams: any;
  90248. /** @hidden */
  90249. _rigCameras: Camera[];
  90250. /** @hidden */
  90251. _rigPostProcess: Nullable<PostProcess>;
  90252. protected _webvrViewMatrix: Matrix;
  90253. /** @hidden */
  90254. _skipRendering: boolean;
  90255. /** @hidden */
  90256. _projectionMatrix: Matrix;
  90257. /** @hidden */
  90258. _postProcesses: Nullable<PostProcess>[];
  90259. /** @hidden */
  90260. _activeMeshes: SmartArray<AbstractMesh>;
  90261. protected _globalPosition: Vector3;
  90262. /** @hidden */
  90263. _computedViewMatrix: Matrix;
  90264. private _doNotComputeProjectionMatrix;
  90265. private _transformMatrix;
  90266. private _frustumPlanes;
  90267. private _refreshFrustumPlanes;
  90268. private _storedFov;
  90269. private _stateStored;
  90270. /**
  90271. * Instantiates a new camera object.
  90272. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  90273. * @see http://doc.babylonjs.com/features/cameras
  90274. * @param name Defines the name of the camera in the scene
  90275. * @param position Defines the position of the camera
  90276. * @param scene Defines the scene the camera belongs too
  90277. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  90278. */
  90279. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  90280. /**
  90281. * Store current camera state (fov, position, etc..)
  90282. * @returns the camera
  90283. */
  90284. storeState(): Camera;
  90285. /**
  90286. * Restores the camera state values if it has been stored. You must call storeState() first
  90287. */
  90288. protected _restoreStateValues(): boolean;
  90289. /**
  90290. * Restored camera state. You must call storeState() first.
  90291. * @returns true if restored and false otherwise
  90292. */
  90293. restoreState(): boolean;
  90294. /**
  90295. * Gets the class name of the camera.
  90296. * @returns the class name
  90297. */
  90298. getClassName(): string;
  90299. /** @hidden */
  90300. readonly _isCamera: boolean;
  90301. /**
  90302. * Gets a string representation of the camera useful for debug purpose.
  90303. * @param fullDetails Defines that a more verboe level of logging is required
  90304. * @returns the string representation
  90305. */
  90306. toString(fullDetails?: boolean): string;
  90307. /**
  90308. * Gets the current world space position of the camera.
  90309. */
  90310. readonly globalPosition: Vector3;
  90311. /**
  90312. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  90313. * @returns the active meshe list
  90314. */
  90315. getActiveMeshes(): SmartArray<AbstractMesh>;
  90316. /**
  90317. * Check wether a mesh is part of the current active mesh list of the camera
  90318. * @param mesh Defines the mesh to check
  90319. * @returns true if active, false otherwise
  90320. */
  90321. isActiveMesh(mesh: Mesh): boolean;
  90322. /**
  90323. * Is this camera ready to be used/rendered
  90324. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  90325. * @return true if the camera is ready
  90326. */
  90327. isReady(completeCheck?: boolean): boolean;
  90328. /** @hidden */
  90329. _initCache(): void;
  90330. /** @hidden */
  90331. _updateCache(ignoreParentClass?: boolean): void;
  90332. /** @hidden */
  90333. _isSynchronized(): boolean;
  90334. /** @hidden */
  90335. _isSynchronizedViewMatrix(): boolean;
  90336. /** @hidden */
  90337. _isSynchronizedProjectionMatrix(): boolean;
  90338. /**
  90339. * Attach the input controls to a specific dom element to get the input from.
  90340. * @param element Defines the element the controls should be listened from
  90341. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  90342. */
  90343. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  90344. /**
  90345. * Detach the current controls from the specified dom element.
  90346. * @param element Defines the element to stop listening the inputs from
  90347. */
  90348. detachControl(element: HTMLElement): void;
  90349. /**
  90350. * Update the camera state according to the different inputs gathered during the frame.
  90351. */
  90352. update(): void;
  90353. /** @hidden */
  90354. _checkInputs(): void;
  90355. /** @hidden */
  90356. readonly rigCameras: Camera[];
  90357. /**
  90358. * Gets the post process used by the rig cameras
  90359. */
  90360. readonly rigPostProcess: Nullable<PostProcess>;
  90361. /**
  90362. * Internal, gets the first post proces.
  90363. * @returns the first post process to be run on this camera.
  90364. */
  90365. _getFirstPostProcess(): Nullable<PostProcess>;
  90366. private _cascadePostProcessesToRigCams;
  90367. /**
  90368. * Attach a post process to the camera.
  90369. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  90370. * @param postProcess The post process to attach to the camera
  90371. * @param insertAt The position of the post process in case several of them are in use in the scene
  90372. * @returns the position the post process has been inserted at
  90373. */
  90374. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  90375. /**
  90376. * Detach a post process to the camera.
  90377. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  90378. * @param postProcess The post process to detach from the camera
  90379. */
  90380. detachPostProcess(postProcess: PostProcess): void;
  90381. /**
  90382. * Gets the current world matrix of the camera
  90383. */
  90384. getWorldMatrix(): Matrix;
  90385. /** @hidden */
  90386. _getViewMatrix(): Matrix;
  90387. /**
  90388. * Gets the current view matrix of the camera.
  90389. * @param force forces the camera to recompute the matrix without looking at the cached state
  90390. * @returns the view matrix
  90391. */
  90392. getViewMatrix(force?: boolean): Matrix;
  90393. /**
  90394. * Freeze the projection matrix.
  90395. * It will prevent the cache check of the camera projection compute and can speed up perf
  90396. * if no parameter of the camera are meant to change
  90397. * @param projection Defines manually a projection if necessary
  90398. */
  90399. freezeProjectionMatrix(projection?: Matrix): void;
  90400. /**
  90401. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  90402. */
  90403. unfreezeProjectionMatrix(): void;
  90404. /**
  90405. * Gets the current projection matrix of the camera.
  90406. * @param force forces the camera to recompute the matrix without looking at the cached state
  90407. * @returns the projection matrix
  90408. */
  90409. getProjectionMatrix(force?: boolean): Matrix;
  90410. /**
  90411. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  90412. * @returns a Matrix
  90413. */
  90414. getTransformationMatrix(): Matrix;
  90415. private _updateFrustumPlanes;
  90416. /**
  90417. * Checks if a cullable object (mesh...) is in the camera frustum
  90418. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  90419. * @param target The object to check
  90420. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  90421. * @returns true if the object is in frustum otherwise false
  90422. */
  90423. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  90424. /**
  90425. * Checks if a cullable object (mesh...) is in the camera frustum
  90426. * Unlike isInFrustum this cheks the full bounding box
  90427. * @param target The object to check
  90428. * @returns true if the object is in frustum otherwise false
  90429. */
  90430. isCompletelyInFrustum(target: ICullable): boolean;
  90431. /**
  90432. * Gets a ray in the forward direction from the camera.
  90433. * @param length Defines the length of the ray to create
  90434. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  90435. * @param origin Defines the start point of the ray which defaults to the camera position
  90436. * @returns the forward ray
  90437. */
  90438. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  90439. /**
  90440. * Releases resources associated with this node.
  90441. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  90442. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  90443. */
  90444. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  90445. /** @hidden */
  90446. _isLeftCamera: boolean;
  90447. /**
  90448. * Gets the left camera of a rig setup in case of Rigged Camera
  90449. */
  90450. readonly isLeftCamera: boolean;
  90451. /** @hidden */
  90452. _isRightCamera: boolean;
  90453. /**
  90454. * Gets the right camera of a rig setup in case of Rigged Camera
  90455. */
  90456. readonly isRightCamera: boolean;
  90457. /**
  90458. * Gets the left camera of a rig setup in case of Rigged Camera
  90459. */
  90460. readonly leftCamera: Nullable<FreeCamera>;
  90461. /**
  90462. * Gets the right camera of a rig setup in case of Rigged Camera
  90463. */
  90464. readonly rightCamera: Nullable<FreeCamera>;
  90465. /**
  90466. * Gets the left camera target of a rig setup in case of Rigged Camera
  90467. * @returns the target position
  90468. */
  90469. getLeftTarget(): Nullable<Vector3>;
  90470. /**
  90471. * Gets the right camera target of a rig setup in case of Rigged Camera
  90472. * @returns the target position
  90473. */
  90474. getRightTarget(): Nullable<Vector3>;
  90475. /**
  90476. * @hidden
  90477. */
  90478. setCameraRigMode(mode: number, rigParams: any): void;
  90479. /** @hidden */
  90480. static _setStereoscopicRigMode(camera: Camera): void;
  90481. /** @hidden */
  90482. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  90483. /** @hidden */
  90484. static _setVRRigMode(camera: Camera, rigParams: any): void;
  90485. /** @hidden */
  90486. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  90487. /** @hidden */
  90488. _getVRProjectionMatrix(): Matrix;
  90489. protected _updateCameraRotationMatrix(): void;
  90490. protected _updateWebVRCameraRotationMatrix(): void;
  90491. /**
  90492. * This function MUST be overwritten by the different WebVR cameras available.
  90493. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  90494. * @hidden
  90495. */
  90496. _getWebVRProjectionMatrix(): Matrix;
  90497. /**
  90498. * This function MUST be overwritten by the different WebVR cameras available.
  90499. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  90500. * @hidden
  90501. */
  90502. _getWebVRViewMatrix(): Matrix;
  90503. /** @hidden */
  90504. setCameraRigParameter(name: string, value: any): void;
  90505. /**
  90506. * needs to be overridden by children so sub has required properties to be copied
  90507. * @hidden
  90508. */
  90509. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  90510. /**
  90511. * May need to be overridden by children
  90512. * @hidden
  90513. */
  90514. _updateRigCameras(): void;
  90515. /** @hidden */
  90516. _setupInputs(): void;
  90517. /**
  90518. * Serialiaze the camera setup to a json represention
  90519. * @returns the JSON representation
  90520. */
  90521. serialize(): any;
  90522. /**
  90523. * Clones the current camera.
  90524. * @param name The cloned camera name
  90525. * @returns the cloned camera
  90526. */
  90527. clone(name: string): Camera;
  90528. /**
  90529. * Gets the direction of the camera relative to a given local axis.
  90530. * @param localAxis Defines the reference axis to provide a relative direction.
  90531. * @return the direction
  90532. */
  90533. getDirection(localAxis: Vector3): Vector3;
  90534. /**
  90535. * Returns the current camera absolute rotation
  90536. */
  90537. readonly absoluteRotation: Quaternion;
  90538. /**
  90539. * Gets the direction of the camera relative to a given local axis into a passed vector.
  90540. * @param localAxis Defines the reference axis to provide a relative direction.
  90541. * @param result Defines the vector to store the result in
  90542. */
  90543. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  90544. /**
  90545. * Gets a camera constructor for a given camera type
  90546. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  90547. * @param name The name of the camera the result will be able to instantiate
  90548. * @param scene The scene the result will construct the camera in
  90549. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  90550. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  90551. * @returns a factory method to construc the camera
  90552. */
  90553. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  90554. /**
  90555. * Compute the world matrix of the camera.
  90556. * @returns the camera workd matrix
  90557. */
  90558. computeWorldMatrix(): Matrix;
  90559. /**
  90560. * Parse a JSON and creates the camera from the parsed information
  90561. * @param parsedCamera The JSON to parse
  90562. * @param scene The scene to instantiate the camera in
  90563. * @returns the newly constructed camera
  90564. */
  90565. static Parse(parsedCamera: any, scene: Scene): Camera;
  90566. }
  90567. }
  90568. declare module BABYLON {
  90569. /**
  90570. * Class containing static functions to help procedurally build meshes
  90571. */
  90572. export class DiscBuilder {
  90573. /**
  90574. * Creates a plane polygonal mesh. By default, this is a disc
  90575. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  90576. * * 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
  90577. * * 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
  90578. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  90579. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  90580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  90581. * @param name defines the name of the mesh
  90582. * @param options defines the options used to create the mesh
  90583. * @param scene defines the hosting scene
  90584. * @returns the plane polygonal mesh
  90585. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  90586. */
  90587. static CreateDisc(name: string, options: {
  90588. radius?: number;
  90589. tessellation?: number;
  90590. arc?: number;
  90591. updatable?: boolean;
  90592. sideOrientation?: number;
  90593. frontUVs?: Vector4;
  90594. backUVs?: Vector4;
  90595. }, scene?: Nullable<Scene>): Mesh;
  90596. }
  90597. }
  90598. declare module BABYLON {
  90599. /**
  90600. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  90601. *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.
  90602. * The SPS is also a particle system. It provides some methods to manage the particles.
  90603. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  90604. *
  90605. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  90606. */
  90607. export class SolidParticleSystem implements IDisposable {
  90608. /**
  90609. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  90610. * Example : var p = SPS.particles[i];
  90611. */
  90612. particles: SolidParticle[];
  90613. /**
  90614. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  90615. */
  90616. nbParticles: number;
  90617. /**
  90618. * If the particles must ever face the camera (default false). Useful for planar particles.
  90619. */
  90620. billboard: boolean;
  90621. /**
  90622. * Recompute normals when adding a shape
  90623. */
  90624. recomputeNormals: boolean;
  90625. /**
  90626. * This a counter ofr your own usage. It's not set by any SPS functions.
  90627. */
  90628. counter: number;
  90629. /**
  90630. * The SPS name. This name is also given to the underlying mesh.
  90631. */
  90632. name: string;
  90633. /**
  90634. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  90635. */
  90636. mesh: Mesh;
  90637. /**
  90638. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  90639. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  90640. */
  90641. vars: any;
  90642. /**
  90643. * This array is populated when the SPS is set as 'pickable'.
  90644. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  90645. * Each element of this array is an object `{idx: int, faceId: int}`.
  90646. * `idx` is the picked particle index in the `SPS.particles` array
  90647. * `faceId` is the picked face index counted within this particle.
  90648. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  90649. */
  90650. pickedParticles: {
  90651. idx: number;
  90652. faceId: number;
  90653. }[];
  90654. /**
  90655. * This array is populated when `enableDepthSort` is set to true.
  90656. * Each element of this array is an instance of the class DepthSortedParticle.
  90657. */
  90658. depthSortedParticles: DepthSortedParticle[];
  90659. /**
  90660. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  90661. * @hidden
  90662. */
  90663. _bSphereOnly: boolean;
  90664. /**
  90665. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  90666. * @hidden
  90667. */
  90668. _bSphereRadiusFactor: number;
  90669. private _scene;
  90670. private _positions;
  90671. private _indices;
  90672. private _normals;
  90673. private _colors;
  90674. private _uvs;
  90675. private _indices32;
  90676. private _positions32;
  90677. private _normals32;
  90678. private _fixedNormal32;
  90679. private _colors32;
  90680. private _uvs32;
  90681. private _index;
  90682. private _updatable;
  90683. private _pickable;
  90684. private _isVisibilityBoxLocked;
  90685. private _alwaysVisible;
  90686. private _depthSort;
  90687. private _shapeCounter;
  90688. private _copy;
  90689. private _color;
  90690. private _computeParticleColor;
  90691. private _computeParticleTexture;
  90692. private _computeParticleRotation;
  90693. private _computeParticleVertex;
  90694. private _computeBoundingBox;
  90695. private _depthSortParticles;
  90696. private _camera;
  90697. private _mustUnrotateFixedNormals;
  90698. private _particlesIntersect;
  90699. private _needs32Bits;
  90700. /**
  90701. * Creates a SPS (Solid Particle System) object.
  90702. * @param name (String) is the SPS name, this will be the underlying mesh name.
  90703. * @param scene (Scene) is the scene in which the SPS is added.
  90704. * @param options defines the options of the sps e.g.
  90705. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  90706. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  90707. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  90708. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  90709. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  90710. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  90711. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  90712. */
  90713. constructor(name: string, scene: Scene, options?: {
  90714. updatable?: boolean;
  90715. isPickable?: boolean;
  90716. enableDepthSort?: boolean;
  90717. particleIntersection?: boolean;
  90718. boundingSphereOnly?: boolean;
  90719. bSphereRadiusFactor?: number;
  90720. });
  90721. /**
  90722. * Builds the SPS underlying mesh. Returns a standard Mesh.
  90723. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  90724. * @returns the created mesh
  90725. */
  90726. buildMesh(): Mesh;
  90727. /**
  90728. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  90729. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  90730. * Thus the particles generated from `digest()` have their property `position` set yet.
  90731. * @param mesh ( Mesh ) is the mesh to be digested
  90732. * @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
  90733. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  90734. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  90735. * @returns the current SPS
  90736. */
  90737. digest(mesh: Mesh, options?: {
  90738. facetNb?: number;
  90739. number?: number;
  90740. delta?: number;
  90741. }): SolidParticleSystem;
  90742. private _unrotateFixedNormals;
  90743. private _resetCopy;
  90744. private _meshBuilder;
  90745. private _posToShape;
  90746. private _uvsToShapeUV;
  90747. private _addParticle;
  90748. /**
  90749. * Adds some particles to the SPS from the model shape. Returns the shape id.
  90750. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  90751. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  90752. * @param nb (positive integer) the number of particles to be created from this model
  90753. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  90754. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  90755. * @returns the number of shapes in the system
  90756. */
  90757. addShape(mesh: Mesh, nb: number, options?: {
  90758. positionFunction?: any;
  90759. vertexFunction?: any;
  90760. }): number;
  90761. private _rebuildParticle;
  90762. /**
  90763. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  90764. * @returns the SPS.
  90765. */
  90766. rebuildMesh(): SolidParticleSystem;
  90767. /**
  90768. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  90769. * This method calls `updateParticle()` for each particle of the SPS.
  90770. * For an animated SPS, it is usually called within the render loop.
  90771. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  90772. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  90773. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  90774. * @returns the SPS.
  90775. */
  90776. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  90777. /**
  90778. * Disposes the SPS.
  90779. */
  90780. dispose(): void;
  90781. /**
  90782. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  90783. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90784. * @returns the SPS.
  90785. */
  90786. refreshVisibleSize(): SolidParticleSystem;
  90787. /**
  90788. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  90789. * @param size the size (float) of the visibility box
  90790. * note : this doesn't lock the SPS mesh bounding box.
  90791. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90792. */
  90793. setVisibilityBox(size: number): void;
  90794. /**
  90795. * Gets whether the SPS as always visible or not
  90796. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90797. */
  90798. /**
  90799. * Sets the SPS as always visible or not
  90800. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90801. */
  90802. isAlwaysVisible: boolean;
  90803. /**
  90804. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  90805. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90806. */
  90807. /**
  90808. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  90809. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  90810. */
  90811. isVisibilityBoxLocked: boolean;
  90812. /**
  90813. * Tells to `setParticles()` to compute the particle rotations or not.
  90814. * Default value : true. The SPS is faster when it's set to false.
  90815. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  90816. */
  90817. /**
  90818. * Gets if `setParticles()` computes the particle rotations or not.
  90819. * Default value : true. The SPS is faster when it's set to false.
  90820. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  90821. */
  90822. computeParticleRotation: boolean;
  90823. /**
  90824. * Tells to `setParticles()` to compute the particle colors or not.
  90825. * Default value : true. The SPS is faster when it's set to false.
  90826. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  90827. */
  90828. /**
  90829. * Gets if `setParticles()` computes the particle colors or not.
  90830. * Default value : true. The SPS is faster when it's set to false.
  90831. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  90832. */
  90833. computeParticleColor: boolean;
  90834. /**
  90835. * Gets if `setParticles()` computes the particle textures or not.
  90836. * Default value : true. The SPS is faster when it's set to false.
  90837. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  90838. */
  90839. computeParticleTexture: boolean;
  90840. /**
  90841. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  90842. * Default value : false. The SPS is faster when it's set to false.
  90843. * Note : the particle custom vertex positions aren't stored values.
  90844. */
  90845. /**
  90846. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  90847. * Default value : false. The SPS is faster when it's set to false.
  90848. * Note : the particle custom vertex positions aren't stored values.
  90849. */
  90850. computeParticleVertex: boolean;
  90851. /**
  90852. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  90853. */
  90854. /**
  90855. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  90856. */
  90857. computeBoundingBox: boolean;
  90858. /**
  90859. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  90860. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  90861. * Default : `true`
  90862. */
  90863. /**
  90864. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  90865. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  90866. * Default : `true`
  90867. */
  90868. depthSortParticles: boolean;
  90869. /**
  90870. * This function does nothing. It may be overwritten to set all the particle first values.
  90871. * The SPS doesn't call this function, you may have to call it by your own.
  90872. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  90873. */
  90874. initParticles(): void;
  90875. /**
  90876. * This function does nothing. It may be overwritten to recycle a particle.
  90877. * The SPS doesn't call this function, you may have to call it by your own.
  90878. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  90879. * @param particle The particle to recycle
  90880. * @returns the recycled particle
  90881. */
  90882. recycleParticle(particle: SolidParticle): SolidParticle;
  90883. /**
  90884. * Updates a particle : this function should be overwritten by the user.
  90885. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  90886. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  90887. * @example : just set a particle position or velocity and recycle conditions
  90888. * @param particle The particle to update
  90889. * @returns the updated particle
  90890. */
  90891. updateParticle(particle: SolidParticle): SolidParticle;
  90892. /**
  90893. * Updates a vertex of a particle : it can be overwritten by the user.
  90894. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  90895. * @param particle the current particle
  90896. * @param vertex the current index of the current particle
  90897. * @param pt the index of the current vertex in the particle shape
  90898. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  90899. * @example : just set a vertex particle position
  90900. * @returns the updated vertex
  90901. */
  90902. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  90903. /**
  90904. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  90905. * This does nothing and may be overwritten by the user.
  90906. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  90907. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  90908. * @param update the boolean update value actually passed to setParticles()
  90909. */
  90910. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  90911. /**
  90912. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  90913. * This will be passed three parameters.
  90914. * This does nothing and may be overwritten by the user.
  90915. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  90916. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  90917. * @param update the boolean update value actually passed to setParticles()
  90918. */
  90919. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  90920. }
  90921. }
  90922. declare module BABYLON {
  90923. /**
  90924. * Represents one particle of a solid particle system.
  90925. */
  90926. export class SolidParticle {
  90927. /**
  90928. * particle global index
  90929. */
  90930. idx: number;
  90931. /**
  90932. * The color of the particle
  90933. */
  90934. color: Nullable<Color4>;
  90935. /**
  90936. * The world space position of the particle.
  90937. */
  90938. position: Vector3;
  90939. /**
  90940. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  90941. */
  90942. rotation: Vector3;
  90943. /**
  90944. * The world space rotation quaternion of the particle.
  90945. */
  90946. rotationQuaternion: Nullable<Quaternion>;
  90947. /**
  90948. * The scaling of the particle.
  90949. */
  90950. scaling: Vector3;
  90951. /**
  90952. * The uvs of the particle.
  90953. */
  90954. uvs: Vector4;
  90955. /**
  90956. * The current speed of the particle.
  90957. */
  90958. velocity: Vector3;
  90959. /**
  90960. * The pivot point in the particle local space.
  90961. */
  90962. pivot: Vector3;
  90963. /**
  90964. * Must the particle be translated from its pivot point in its local space ?
  90965. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  90966. * Default : false
  90967. */
  90968. translateFromPivot: boolean;
  90969. /**
  90970. * Is the particle active or not ?
  90971. */
  90972. alive: boolean;
  90973. /**
  90974. * Is the particle visible or not ?
  90975. */
  90976. isVisible: boolean;
  90977. /**
  90978. * Index of this particle in the global "positions" array (Internal use)
  90979. * @hidden
  90980. */
  90981. _pos: number;
  90982. /**
  90983. * @hidden Index of this particle in the global "indices" array (Internal use)
  90984. */
  90985. _ind: number;
  90986. /**
  90987. * @hidden ModelShape of this particle (Internal use)
  90988. */
  90989. _model: ModelShape;
  90990. /**
  90991. * ModelShape id of this particle
  90992. */
  90993. shapeId: number;
  90994. /**
  90995. * Index of the particle in its shape id
  90996. */
  90997. idxInShape: number;
  90998. /**
  90999. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  91000. */
  91001. _modelBoundingInfo: BoundingInfo;
  91002. /**
  91003. * @hidden Particle BoundingInfo object (Internal use)
  91004. */
  91005. _boundingInfo: BoundingInfo;
  91006. /**
  91007. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  91008. */
  91009. _sps: SolidParticleSystem;
  91010. /**
  91011. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  91012. */
  91013. _stillInvisible: boolean;
  91014. /**
  91015. * @hidden Last computed particle rotation matrix
  91016. */
  91017. _rotationMatrix: number[];
  91018. /**
  91019. * Parent particle Id, if any.
  91020. * Default null.
  91021. */
  91022. parentId: Nullable<number>;
  91023. /**
  91024. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  91025. * The possible values are :
  91026. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  91027. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  91028. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  91029. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  91030. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  91031. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  91032. * */
  91033. cullingStrategy: number;
  91034. /**
  91035. * @hidden Internal global position in the SPS.
  91036. */
  91037. _globalPosition: Vector3;
  91038. /**
  91039. * Creates a Solid Particle object.
  91040. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  91041. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  91042. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  91043. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  91044. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  91045. * @param shapeId (integer) is the model shape identifier in the SPS.
  91046. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  91047. * @param sps defines the sps it is associated to
  91048. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  91049. */
  91050. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  91051. /**
  91052. * Legacy support, changed scale to scaling
  91053. */
  91054. /**
  91055. * Legacy support, changed scale to scaling
  91056. */
  91057. scale: Vector3;
  91058. /**
  91059. * Legacy support, changed quaternion to rotationQuaternion
  91060. */
  91061. /**
  91062. * Legacy support, changed quaternion to rotationQuaternion
  91063. */
  91064. quaternion: Nullable<Quaternion>;
  91065. /**
  91066. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  91067. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  91068. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  91069. * @returns true if it intersects
  91070. */
  91071. intersectsMesh(target: Mesh | SolidParticle): boolean;
  91072. /**
  91073. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  91074. * A particle is in the frustum if its bounding box intersects the frustum
  91075. * @param frustumPlanes defines the frustum to test
  91076. * @returns true if the particle is in the frustum planes
  91077. */
  91078. isInFrustum(frustumPlanes: Plane[]): boolean;
  91079. /**
  91080. * get the rotation matrix of the particle
  91081. * @hidden
  91082. */
  91083. getRotationMatrix(m: Matrix): void;
  91084. }
  91085. /**
  91086. * Represents the shape of the model used by one particle of a solid particle system.
  91087. * SPS internal tool, don't use it manually.
  91088. */
  91089. export class ModelShape {
  91090. /**
  91091. * The shape id
  91092. * @hidden
  91093. */
  91094. shapeID: number;
  91095. /**
  91096. * flat array of model positions (internal use)
  91097. * @hidden
  91098. */
  91099. _shape: Vector3[];
  91100. /**
  91101. * flat array of model UVs (internal use)
  91102. * @hidden
  91103. */
  91104. _shapeUV: number[];
  91105. /**
  91106. * length of the shape in the model indices array (internal use)
  91107. * @hidden
  91108. */
  91109. _indicesLength: number;
  91110. /**
  91111. * Custom position function (internal use)
  91112. * @hidden
  91113. */
  91114. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  91115. /**
  91116. * Custom vertex function (internal use)
  91117. * @hidden
  91118. */
  91119. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  91120. /**
  91121. * 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.
  91122. * SPS internal tool, don't use it manually.
  91123. * @hidden
  91124. */
  91125. constructor(id: number, shape: Vector3[], indicesLength: number, shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  91126. }
  91127. /**
  91128. * Represents a Depth Sorted Particle in the solid particle system.
  91129. */
  91130. export class DepthSortedParticle {
  91131. /**
  91132. * Index of the particle in the "indices" array
  91133. */
  91134. ind: number;
  91135. /**
  91136. * Length of the particle shape in the "indices" array
  91137. */
  91138. indicesLength: number;
  91139. /**
  91140. * Squared distance from the particle to the camera
  91141. */
  91142. sqDistance: number;
  91143. }
  91144. }
  91145. declare module BABYLON {
  91146. /**
  91147. * @hidden
  91148. */
  91149. export class _MeshCollisionData {
  91150. _checkCollisions: boolean;
  91151. _collisionMask: number;
  91152. _collisionGroup: number;
  91153. _collider: Nullable<Collider>;
  91154. _oldPositionForCollisions: Vector3;
  91155. _diffPositionForCollisions: Vector3;
  91156. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  91157. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  91158. }
  91159. }
  91160. declare module BABYLON {
  91161. /** @hidden */
  91162. class _FacetDataStorage {
  91163. facetPositions: Vector3[];
  91164. facetNormals: Vector3[];
  91165. facetPartitioning: number[][];
  91166. facetNb: number;
  91167. partitioningSubdivisions: number;
  91168. partitioningBBoxRatio: number;
  91169. facetDataEnabled: boolean;
  91170. facetParameters: any;
  91171. bbSize: Vector3;
  91172. subDiv: {
  91173. max: number;
  91174. X: number;
  91175. Y: number;
  91176. Z: number;
  91177. };
  91178. facetDepthSort: boolean;
  91179. facetDepthSortEnabled: boolean;
  91180. depthSortedIndices: IndicesArray;
  91181. depthSortedFacets: {
  91182. ind: number;
  91183. sqDistance: number;
  91184. }[];
  91185. facetDepthSortFunction: (f1: {
  91186. ind: number;
  91187. sqDistance: number;
  91188. }, f2: {
  91189. ind: number;
  91190. sqDistance: number;
  91191. }) => number;
  91192. facetDepthSortFrom: Vector3;
  91193. facetDepthSortOrigin: Vector3;
  91194. invertedMatrix: Matrix;
  91195. }
  91196. /**
  91197. * @hidden
  91198. **/
  91199. class _InternalAbstractMeshDataInfo {
  91200. _hasVertexAlpha: boolean;
  91201. _useVertexColors: boolean;
  91202. _numBoneInfluencers: number;
  91203. _applyFog: boolean;
  91204. _receiveShadows: boolean;
  91205. _facetData: _FacetDataStorage;
  91206. _visibility: number;
  91207. _skeleton: Nullable<Skeleton>;
  91208. _layerMask: number;
  91209. _computeBonesUsingShaders: boolean;
  91210. _isActive: boolean;
  91211. _onlyForInstances: boolean;
  91212. _isActiveIntermediate: boolean;
  91213. _onlyForInstancesIntermediate: boolean;
  91214. }
  91215. /**
  91216. * Class used to store all common mesh properties
  91217. */
  91218. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  91219. /** No occlusion */
  91220. static OCCLUSION_TYPE_NONE: number;
  91221. /** Occlusion set to optimisitic */
  91222. static OCCLUSION_TYPE_OPTIMISTIC: number;
  91223. /** Occlusion set to strict */
  91224. static OCCLUSION_TYPE_STRICT: number;
  91225. /** Use an accurante occlusion algorithm */
  91226. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  91227. /** Use a conservative occlusion algorithm */
  91228. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  91229. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  91230. * Test order :
  91231. * Is the bounding sphere outside the frustum ?
  91232. * If not, are the bounding box vertices outside the frustum ?
  91233. * It not, then the cullable object is in the frustum.
  91234. */
  91235. static readonly CULLINGSTRATEGY_STANDARD: number;
  91236. /** Culling strategy : Bounding Sphere Only.
  91237. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  91238. * It's also less accurate than the standard because some not visible objects can still be selected.
  91239. * Test : is the bounding sphere outside the frustum ?
  91240. * If not, then the cullable object is in the frustum.
  91241. */
  91242. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  91243. /** Culling strategy : Optimistic Inclusion.
  91244. * This in an inclusion test first, then the standard exclusion test.
  91245. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  91246. * 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.
  91247. * Anyway, it's as accurate as the standard strategy.
  91248. * Test :
  91249. * Is the cullable object bounding sphere center in the frustum ?
  91250. * If not, apply the default culling strategy.
  91251. */
  91252. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  91253. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  91254. * This in an inclusion test first, then the bounding sphere only exclusion test.
  91255. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  91256. * 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.
  91257. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  91258. * Test :
  91259. * Is the cullable object bounding sphere center in the frustum ?
  91260. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  91261. */
  91262. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  91263. /**
  91264. * No billboard
  91265. */
  91266. static readonly BILLBOARDMODE_NONE: number;
  91267. /** Billboard on X axis */
  91268. static readonly BILLBOARDMODE_X: number;
  91269. /** Billboard on Y axis */
  91270. static readonly BILLBOARDMODE_Y: number;
  91271. /** Billboard on Z axis */
  91272. static readonly BILLBOARDMODE_Z: number;
  91273. /** Billboard on all axes */
  91274. static readonly BILLBOARDMODE_ALL: number;
  91275. /** Billboard on using position instead of orientation */
  91276. static readonly BILLBOARDMODE_USE_POSITION: number;
  91277. /** @hidden */
  91278. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  91279. /**
  91280. * The culling strategy to use to check whether the mesh must be rendered or not.
  91281. * This value can be changed at any time and will be used on the next render mesh selection.
  91282. * The possible values are :
  91283. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  91284. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  91285. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  91286. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  91287. * Please read each static variable documentation to get details about the culling process.
  91288. * */
  91289. cullingStrategy: number;
  91290. /**
  91291. * Gets the number of facets in the mesh
  91292. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  91293. */
  91294. readonly facetNb: number;
  91295. /**
  91296. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  91297. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  91298. */
  91299. partitioningSubdivisions: number;
  91300. /**
  91301. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  91302. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  91303. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  91304. */
  91305. partitioningBBoxRatio: number;
  91306. /**
  91307. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  91308. * Works only for updatable meshes.
  91309. * Doesn't work with multi-materials
  91310. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  91311. */
  91312. mustDepthSortFacets: boolean;
  91313. /**
  91314. * The location (Vector3) where the facet depth sort must be computed from.
  91315. * By default, the active camera position.
  91316. * Used only when facet depth sort is enabled
  91317. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  91318. */
  91319. facetDepthSortFrom: Vector3;
  91320. /**
  91321. * gets a boolean indicating if facetData is enabled
  91322. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  91323. */
  91324. readonly isFacetDataEnabled: boolean;
  91325. /** @hidden */
  91326. _updateNonUniformScalingState(value: boolean): boolean;
  91327. /**
  91328. * An event triggered when this mesh collides with another one
  91329. */
  91330. onCollideObservable: Observable<AbstractMesh>;
  91331. /** Set a function to call when this mesh collides with another one */
  91332. onCollide: () => void;
  91333. /**
  91334. * An event triggered when the collision's position changes
  91335. */
  91336. onCollisionPositionChangeObservable: Observable<Vector3>;
  91337. /** Set a function to call when the collision's position changes */
  91338. onCollisionPositionChange: () => void;
  91339. /**
  91340. * An event triggered when material is changed
  91341. */
  91342. onMaterialChangedObservable: Observable<AbstractMesh>;
  91343. /**
  91344. * Gets or sets the orientation for POV movement & rotation
  91345. */
  91346. definedFacingForward: boolean;
  91347. /** @hidden */
  91348. _occlusionQuery: Nullable<WebGLQuery>;
  91349. /** @hidden */
  91350. _renderingGroup: Nullable<RenderingGroup>;
  91351. /**
  91352. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  91353. */
  91354. /**
  91355. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  91356. */
  91357. visibility: number;
  91358. /** Gets or sets the alpha index used to sort transparent meshes
  91359. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  91360. */
  91361. alphaIndex: number;
  91362. /**
  91363. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  91364. */
  91365. isVisible: boolean;
  91366. /**
  91367. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  91368. */
  91369. isPickable: boolean;
  91370. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  91371. showSubMeshesBoundingBox: boolean;
  91372. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  91373. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  91374. */
  91375. isBlocker: boolean;
  91376. /**
  91377. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  91378. */
  91379. enablePointerMoveEvents: boolean;
  91380. /**
  91381. * Specifies the rendering group id for this mesh (0 by default)
  91382. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  91383. */
  91384. renderingGroupId: number;
  91385. private _material;
  91386. /** Gets or sets current material */
  91387. material: Nullable<Material>;
  91388. /**
  91389. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  91390. * @see http://doc.babylonjs.com/babylon101/shadows
  91391. */
  91392. receiveShadows: boolean;
  91393. /** Defines color to use when rendering outline */
  91394. outlineColor: Color3;
  91395. /** Define width to use when rendering outline */
  91396. outlineWidth: number;
  91397. /** Defines color to use when rendering overlay */
  91398. overlayColor: Color3;
  91399. /** Defines alpha to use when rendering overlay */
  91400. overlayAlpha: number;
  91401. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  91402. hasVertexAlpha: boolean;
  91403. /** 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) */
  91404. useVertexColors: boolean;
  91405. /**
  91406. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  91407. */
  91408. computeBonesUsingShaders: boolean;
  91409. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  91410. numBoneInfluencers: number;
  91411. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  91412. applyFog: boolean;
  91413. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  91414. useOctreeForRenderingSelection: boolean;
  91415. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  91416. useOctreeForPicking: boolean;
  91417. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  91418. useOctreeForCollisions: boolean;
  91419. /**
  91420. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  91421. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  91422. */
  91423. layerMask: number;
  91424. /**
  91425. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  91426. */
  91427. alwaysSelectAsActiveMesh: boolean;
  91428. /**
  91429. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  91430. */
  91431. doNotSyncBoundingInfo: boolean;
  91432. /**
  91433. * Gets or sets the current action manager
  91434. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  91435. */
  91436. actionManager: Nullable<AbstractActionManager>;
  91437. private _meshCollisionData;
  91438. /**
  91439. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  91440. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  91441. */
  91442. ellipsoid: Vector3;
  91443. /**
  91444. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  91445. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  91446. */
  91447. ellipsoidOffset: Vector3;
  91448. /**
  91449. * Gets or sets a collision mask used to mask collisions (default is -1).
  91450. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  91451. */
  91452. collisionMask: number;
  91453. /**
  91454. * Gets or sets the current collision group mask (-1 by default).
  91455. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  91456. */
  91457. collisionGroup: number;
  91458. /**
  91459. * Defines edge width used when edgesRenderer is enabled
  91460. * @see https://www.babylonjs-playground.com/#10OJSG#13
  91461. */
  91462. edgesWidth: number;
  91463. /**
  91464. * Defines edge color used when edgesRenderer is enabled
  91465. * @see https://www.babylonjs-playground.com/#10OJSG#13
  91466. */
  91467. edgesColor: Color4;
  91468. /** @hidden */
  91469. _edgesRenderer: Nullable<IEdgesRenderer>;
  91470. /** @hidden */
  91471. _masterMesh: Nullable<AbstractMesh>;
  91472. /** @hidden */
  91473. _boundingInfo: Nullable<BoundingInfo>;
  91474. /** @hidden */
  91475. _renderId: number;
  91476. /**
  91477. * Gets or sets the list of subMeshes
  91478. * @see http://doc.babylonjs.com/how_to/multi_materials
  91479. */
  91480. subMeshes: SubMesh[];
  91481. /** @hidden */
  91482. _intersectionsInProgress: AbstractMesh[];
  91483. /** @hidden */
  91484. _unIndexed: boolean;
  91485. /** @hidden */
  91486. _lightSources: Light[];
  91487. /** Gets the list of lights affecting that mesh */
  91488. readonly lightSources: Light[];
  91489. /** @hidden */
  91490. readonly _positions: Nullable<Vector3[]>;
  91491. /** @hidden */
  91492. _waitingData: {
  91493. lods: Nullable<any>;
  91494. actions: Nullable<any>;
  91495. freezeWorldMatrix: Nullable<boolean>;
  91496. };
  91497. /** @hidden */
  91498. _bonesTransformMatrices: Nullable<Float32Array>;
  91499. /** @hidden */
  91500. _transformMatrixTexture: Nullable<RawTexture>;
  91501. /**
  91502. * Gets or sets a skeleton to apply skining transformations
  91503. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  91504. */
  91505. skeleton: Nullable<Skeleton>;
  91506. /**
  91507. * An event triggered when the mesh is rebuilt.
  91508. */
  91509. onRebuildObservable: Observable<AbstractMesh>;
  91510. /**
  91511. * Creates a new AbstractMesh
  91512. * @param name defines the name of the mesh
  91513. * @param scene defines the hosting scene
  91514. */
  91515. constructor(name: string, scene?: Nullable<Scene>);
  91516. /**
  91517. * Returns the string "AbstractMesh"
  91518. * @returns "AbstractMesh"
  91519. */
  91520. getClassName(): string;
  91521. /**
  91522. * Gets a string representation of the current mesh
  91523. * @param fullDetails defines a boolean indicating if full details must be included
  91524. * @returns a string representation of the current mesh
  91525. */
  91526. toString(fullDetails?: boolean): string;
  91527. /**
  91528. * @hidden
  91529. */
  91530. protected _getEffectiveParent(): Nullable<Node>;
  91531. /** @hidden */
  91532. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  91533. /** @hidden */
  91534. _rebuild(): void;
  91535. /** @hidden */
  91536. _resyncLightSources(): void;
  91537. /** @hidden */
  91538. _resyncLighSource(light: Light): void;
  91539. /** @hidden */
  91540. _unBindEffect(): void;
  91541. /** @hidden */
  91542. _removeLightSource(light: Light, dispose: boolean): void;
  91543. private _markSubMeshesAsDirty;
  91544. /** @hidden */
  91545. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  91546. /** @hidden */
  91547. _markSubMeshesAsAttributesDirty(): void;
  91548. /** @hidden */
  91549. _markSubMeshesAsMiscDirty(): void;
  91550. /**
  91551. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  91552. */
  91553. scaling: Vector3;
  91554. /**
  91555. * Returns true if the mesh is blocked. Implemented by child classes
  91556. */
  91557. readonly isBlocked: boolean;
  91558. /**
  91559. * Returns the mesh itself by default. Implemented by child classes
  91560. * @param camera defines the camera to use to pick the right LOD level
  91561. * @returns the currentAbstractMesh
  91562. */
  91563. getLOD(camera: Camera): Nullable<AbstractMesh>;
  91564. /**
  91565. * Returns 0 by default. Implemented by child classes
  91566. * @returns an integer
  91567. */
  91568. getTotalVertices(): number;
  91569. /**
  91570. * Returns a positive integer : the total number of indices in this mesh geometry.
  91571. * @returns the numner of indices or zero if the mesh has no geometry.
  91572. */
  91573. getTotalIndices(): number;
  91574. /**
  91575. * Returns null by default. Implemented by child classes
  91576. * @returns null
  91577. */
  91578. getIndices(): Nullable<IndicesArray>;
  91579. /**
  91580. * Returns the array of the requested vertex data kind. Implemented by child classes
  91581. * @param kind defines the vertex data kind to use
  91582. * @returns null
  91583. */
  91584. getVerticesData(kind: string): Nullable<FloatArray>;
  91585. /**
  91586. * Sets the vertex data of the mesh geometry for the requested `kind`.
  91587. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  91588. * Note that a new underlying VertexBuffer object is created each call.
  91589. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  91590. * @param kind defines vertex data kind:
  91591. * * VertexBuffer.PositionKind
  91592. * * VertexBuffer.UVKind
  91593. * * VertexBuffer.UV2Kind
  91594. * * VertexBuffer.UV3Kind
  91595. * * VertexBuffer.UV4Kind
  91596. * * VertexBuffer.UV5Kind
  91597. * * VertexBuffer.UV6Kind
  91598. * * VertexBuffer.ColorKind
  91599. * * VertexBuffer.MatricesIndicesKind
  91600. * * VertexBuffer.MatricesIndicesExtraKind
  91601. * * VertexBuffer.MatricesWeightsKind
  91602. * * VertexBuffer.MatricesWeightsExtraKind
  91603. * @param data defines the data source
  91604. * @param updatable defines if the data must be flagged as updatable (or static)
  91605. * @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
  91606. * @returns the current mesh
  91607. */
  91608. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  91609. /**
  91610. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  91611. * If the mesh has no geometry, it is simply returned as it is.
  91612. * @param kind defines vertex data kind:
  91613. * * VertexBuffer.PositionKind
  91614. * * VertexBuffer.UVKind
  91615. * * VertexBuffer.UV2Kind
  91616. * * VertexBuffer.UV3Kind
  91617. * * VertexBuffer.UV4Kind
  91618. * * VertexBuffer.UV5Kind
  91619. * * VertexBuffer.UV6Kind
  91620. * * VertexBuffer.ColorKind
  91621. * * VertexBuffer.MatricesIndicesKind
  91622. * * VertexBuffer.MatricesIndicesExtraKind
  91623. * * VertexBuffer.MatricesWeightsKind
  91624. * * VertexBuffer.MatricesWeightsExtraKind
  91625. * @param data defines the data source
  91626. * @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
  91627. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  91628. * @returns the current mesh
  91629. */
  91630. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  91631. /**
  91632. * Sets the mesh indices,
  91633. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  91634. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  91635. * @param totalVertices Defines the total number of vertices
  91636. * @returns the current mesh
  91637. */
  91638. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  91639. /**
  91640. * Gets a boolean indicating if specific vertex data is present
  91641. * @param kind defines the vertex data kind to use
  91642. * @returns true is data kind is present
  91643. */
  91644. isVerticesDataPresent(kind: string): boolean;
  91645. /**
  91646. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  91647. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  91648. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  91649. * @returns a BoundingInfo
  91650. */
  91651. getBoundingInfo(): BoundingInfo;
  91652. /**
  91653. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  91654. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  91655. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  91656. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  91657. * @returns the current mesh
  91658. */
  91659. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  91660. /**
  91661. * Overwrite the current bounding info
  91662. * @param boundingInfo defines the new bounding info
  91663. * @returns the current mesh
  91664. */
  91665. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  91666. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  91667. readonly useBones: boolean;
  91668. /** @hidden */
  91669. _preActivate(): void;
  91670. /** @hidden */
  91671. _preActivateForIntermediateRendering(renderId: number): void;
  91672. /** @hidden */
  91673. _activate(renderId: number, intermediateRendering: boolean): boolean;
  91674. /** @hidden */
  91675. _postActivate(): void;
  91676. /** @hidden */
  91677. _freeze(): void;
  91678. /** @hidden */
  91679. _unFreeze(): void;
  91680. /**
  91681. * Gets the current world matrix
  91682. * @returns a Matrix
  91683. */
  91684. getWorldMatrix(): Matrix;
  91685. /** @hidden */
  91686. _getWorldMatrixDeterminant(): number;
  91687. /**
  91688. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  91689. */
  91690. readonly isAnInstance: boolean;
  91691. /**
  91692. * Gets a boolean indicating if this mesh has instances
  91693. */
  91694. readonly hasInstances: boolean;
  91695. /**
  91696. * Perform relative position change from the point of view of behind the front of the mesh.
  91697. * This is performed taking into account the meshes current rotation, so you do not have to care.
  91698. * Supports definition of mesh facing forward or backward
  91699. * @param amountRight defines the distance on the right axis
  91700. * @param amountUp defines the distance on the up axis
  91701. * @param amountForward defines the distance on the forward axis
  91702. * @returns the current mesh
  91703. */
  91704. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  91705. /**
  91706. * Calculate relative position change from the point of view of behind the front of the mesh.
  91707. * This is performed taking into account the meshes current rotation, so you do not have to care.
  91708. * Supports definition of mesh facing forward or backward
  91709. * @param amountRight defines the distance on the right axis
  91710. * @param amountUp defines the distance on the up axis
  91711. * @param amountForward defines the distance on the forward axis
  91712. * @returns the new displacement vector
  91713. */
  91714. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  91715. /**
  91716. * Perform relative rotation change from the point of view of behind the front of the mesh.
  91717. * Supports definition of mesh facing forward or backward
  91718. * @param flipBack defines the flip
  91719. * @param twirlClockwise defines the twirl
  91720. * @param tiltRight defines the tilt
  91721. * @returns the current mesh
  91722. */
  91723. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  91724. /**
  91725. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  91726. * Supports definition of mesh facing forward or backward.
  91727. * @param flipBack defines the flip
  91728. * @param twirlClockwise defines the twirl
  91729. * @param tiltRight defines the tilt
  91730. * @returns the new rotation vector
  91731. */
  91732. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  91733. /**
  91734. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  91735. * This means the mesh underlying bounding box and sphere are recomputed.
  91736. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  91737. * @returns the current mesh
  91738. */
  91739. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  91740. /** @hidden */
  91741. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  91742. /** @hidden */
  91743. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  91744. /** @hidden */
  91745. _updateBoundingInfo(): AbstractMesh;
  91746. /** @hidden */
  91747. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  91748. /** @hidden */
  91749. protected _afterComputeWorldMatrix(): void;
  91750. /** @hidden */
  91751. readonly _effectiveMesh: AbstractMesh;
  91752. /**
  91753. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  91754. * A mesh is in the frustum if its bounding box intersects the frustum
  91755. * @param frustumPlanes defines the frustum to test
  91756. * @returns true if the mesh is in the frustum planes
  91757. */
  91758. isInFrustum(frustumPlanes: Plane[]): boolean;
  91759. /**
  91760. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  91761. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  91762. * @param frustumPlanes defines the frustum to test
  91763. * @returns true if the mesh is completely in the frustum planes
  91764. */
  91765. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  91766. /**
  91767. * True if the mesh intersects another mesh or a SolidParticle object
  91768. * @param mesh defines a target mesh or SolidParticle to test
  91769. * @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)
  91770. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  91771. * @returns true if there is an intersection
  91772. */
  91773. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  91774. /**
  91775. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  91776. * @param point defines the point to test
  91777. * @returns true if there is an intersection
  91778. */
  91779. intersectsPoint(point: Vector3): boolean;
  91780. /**
  91781. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  91782. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  91783. */
  91784. checkCollisions: boolean;
  91785. /**
  91786. * Gets Collider object used to compute collisions (not physics)
  91787. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  91788. */
  91789. readonly collider: Nullable<Collider>;
  91790. /**
  91791. * Move the mesh using collision engine
  91792. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  91793. * @param displacement defines the requested displacement vector
  91794. * @returns the current mesh
  91795. */
  91796. moveWithCollisions(displacement: Vector3): AbstractMesh;
  91797. private _onCollisionPositionChange;
  91798. /** @hidden */
  91799. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  91800. /** @hidden */
  91801. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  91802. /** @hidden */
  91803. _checkCollision(collider: Collider): AbstractMesh;
  91804. /** @hidden */
  91805. _generatePointsArray(): boolean;
  91806. /**
  91807. * Checks if the passed Ray intersects with the mesh
  91808. * @param ray defines the ray to use
  91809. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  91810. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  91811. * @returns the picking info
  91812. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  91813. */
  91814. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  91815. /**
  91816. * Clones the current mesh
  91817. * @param name defines the mesh name
  91818. * @param newParent defines the new mesh parent
  91819. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  91820. * @returns the new mesh
  91821. */
  91822. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  91823. /**
  91824. * Disposes all the submeshes of the current meshnp
  91825. * @returns the current mesh
  91826. */
  91827. releaseSubMeshes(): AbstractMesh;
  91828. /**
  91829. * Releases resources associated with this abstract mesh.
  91830. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  91831. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  91832. */
  91833. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  91834. /**
  91835. * Adds the passed mesh as a child to the current mesh
  91836. * @param mesh defines the child mesh
  91837. * @returns the current mesh
  91838. */
  91839. addChild(mesh: AbstractMesh): AbstractMesh;
  91840. /**
  91841. * Removes the passed mesh from the current mesh children list
  91842. * @param mesh defines the child mesh
  91843. * @returns the current mesh
  91844. */
  91845. removeChild(mesh: AbstractMesh): AbstractMesh;
  91846. /** @hidden */
  91847. private _initFacetData;
  91848. /**
  91849. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  91850. * This method can be called within the render loop.
  91851. * 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
  91852. * @returns the current mesh
  91853. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91854. */
  91855. updateFacetData(): AbstractMesh;
  91856. /**
  91857. * Returns the facetLocalNormals array.
  91858. * The normals are expressed in the mesh local spac
  91859. * @returns an array of Vector3
  91860. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91861. */
  91862. getFacetLocalNormals(): Vector3[];
  91863. /**
  91864. * Returns the facetLocalPositions array.
  91865. * The facet positions are expressed in the mesh local space
  91866. * @returns an array of Vector3
  91867. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91868. */
  91869. getFacetLocalPositions(): Vector3[];
  91870. /**
  91871. * Returns the facetLocalPartioning array
  91872. * @returns an array of array of numbers
  91873. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91874. */
  91875. getFacetLocalPartitioning(): number[][];
  91876. /**
  91877. * Returns the i-th facet position in the world system.
  91878. * This method allocates a new Vector3 per call
  91879. * @param i defines the facet index
  91880. * @returns a new Vector3
  91881. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91882. */
  91883. getFacetPosition(i: number): Vector3;
  91884. /**
  91885. * Sets the reference Vector3 with the i-th facet position in the world system
  91886. * @param i defines the facet index
  91887. * @param ref defines the target vector
  91888. * @returns the current mesh
  91889. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91890. */
  91891. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  91892. /**
  91893. * Returns the i-th facet normal in the world system.
  91894. * This method allocates a new Vector3 per call
  91895. * @param i defines the facet index
  91896. * @returns a new Vector3
  91897. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91898. */
  91899. getFacetNormal(i: number): Vector3;
  91900. /**
  91901. * Sets the reference Vector3 with the i-th facet normal in the world system
  91902. * @param i defines the facet index
  91903. * @param ref defines the target vector
  91904. * @returns the current mesh
  91905. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91906. */
  91907. getFacetNormalToRef(i: number, ref: Vector3): this;
  91908. /**
  91909. * 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)
  91910. * @param x defines x coordinate
  91911. * @param y defines y coordinate
  91912. * @param z defines z coordinate
  91913. * @returns the array of facet indexes
  91914. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91915. */
  91916. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  91917. /**
  91918. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  91919. * @param projected sets as the (x,y,z) world projection on the facet
  91920. * @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
  91921. * @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
  91922. * @param x defines x coordinate
  91923. * @param y defines y coordinate
  91924. * @param z defines z coordinate
  91925. * @returns the face index if found (or null instead)
  91926. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91927. */
  91928. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  91929. /**
  91930. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  91931. * @param projected sets as the (x,y,z) local projection on the facet
  91932. * @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
  91933. * @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
  91934. * @param x defines x coordinate
  91935. * @param y defines y coordinate
  91936. * @param z defines z coordinate
  91937. * @returns the face index if found (or null instead)
  91938. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91939. */
  91940. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  91941. /**
  91942. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  91943. * @returns the parameters
  91944. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91945. */
  91946. getFacetDataParameters(): any;
  91947. /**
  91948. * Disables the feature FacetData and frees the related memory
  91949. * @returns the current mesh
  91950. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  91951. */
  91952. disableFacetData(): AbstractMesh;
  91953. /**
  91954. * Updates the AbstractMesh indices array
  91955. * @param indices defines the data source
  91956. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  91957. * @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)
  91958. * @returns the current mesh
  91959. */
  91960. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  91961. /**
  91962. * Creates new normals data for the mesh
  91963. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  91964. * @returns the current mesh
  91965. */
  91966. createNormals(updatable: boolean): AbstractMesh;
  91967. /**
  91968. * Align the mesh with a normal
  91969. * @param normal defines the normal to use
  91970. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  91971. * @returns the current mesh
  91972. */
  91973. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  91974. /** @hidden */
  91975. _checkOcclusionQuery(): boolean;
  91976. /**
  91977. * Disables the mesh edge rendering mode
  91978. * @returns the currentAbstractMesh
  91979. */
  91980. disableEdgesRendering(): AbstractMesh;
  91981. /**
  91982. * Enables the edge rendering mode on the mesh.
  91983. * This mode makes the mesh edges visible
  91984. * @param epsilon defines the maximal distance between two angles to detect a face
  91985. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  91986. * @returns the currentAbstractMesh
  91987. * @see https://www.babylonjs-playground.com/#19O9TU#0
  91988. */
  91989. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  91990. }
  91991. }
  91992. declare module BABYLON {
  91993. /**
  91994. * Interface used to define ActionEvent
  91995. */
  91996. export interface IActionEvent {
  91997. /** The mesh or sprite that triggered the action */
  91998. source: any;
  91999. /** The X mouse cursor position at the time of the event */
  92000. pointerX: number;
  92001. /** The Y mouse cursor position at the time of the event */
  92002. pointerY: number;
  92003. /** The mesh that is currently pointed at (can be null) */
  92004. meshUnderPointer: Nullable<AbstractMesh>;
  92005. /** the original (browser) event that triggered the ActionEvent */
  92006. sourceEvent?: any;
  92007. /** additional data for the event */
  92008. additionalData?: any;
  92009. }
  92010. /**
  92011. * ActionEvent is the event being sent when an action is triggered.
  92012. */
  92013. export class ActionEvent implements IActionEvent {
  92014. /** The mesh or sprite that triggered the action */
  92015. source: any;
  92016. /** The X mouse cursor position at the time of the event */
  92017. pointerX: number;
  92018. /** The Y mouse cursor position at the time of the event */
  92019. pointerY: number;
  92020. /** The mesh that is currently pointed at (can be null) */
  92021. meshUnderPointer: Nullable<AbstractMesh>;
  92022. /** the original (browser) event that triggered the ActionEvent */
  92023. sourceEvent?: any;
  92024. /** additional data for the event */
  92025. additionalData?: any;
  92026. /**
  92027. * Creates a new ActionEvent
  92028. * @param source The mesh or sprite that triggered the action
  92029. * @param pointerX The X mouse cursor position at the time of the event
  92030. * @param pointerY The Y mouse cursor position at the time of the event
  92031. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  92032. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  92033. * @param additionalData additional data for the event
  92034. */
  92035. constructor(
  92036. /** The mesh or sprite that triggered the action */
  92037. source: any,
  92038. /** The X mouse cursor position at the time of the event */
  92039. pointerX: number,
  92040. /** The Y mouse cursor position at the time of the event */
  92041. pointerY: number,
  92042. /** The mesh that is currently pointed at (can be null) */
  92043. meshUnderPointer: Nullable<AbstractMesh>,
  92044. /** the original (browser) event that triggered the ActionEvent */
  92045. sourceEvent?: any,
  92046. /** additional data for the event */
  92047. additionalData?: any);
  92048. /**
  92049. * Helper function to auto-create an ActionEvent from a source mesh.
  92050. * @param source The source mesh that triggered the event
  92051. * @param evt The original (browser) event
  92052. * @param additionalData additional data for the event
  92053. * @returns the new ActionEvent
  92054. */
  92055. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  92056. /**
  92057. * Helper function to auto-create an ActionEvent from a source sprite
  92058. * @param source The source sprite that triggered the event
  92059. * @param scene Scene associated with the sprite
  92060. * @param evt The original (browser) event
  92061. * @param additionalData additional data for the event
  92062. * @returns the new ActionEvent
  92063. */
  92064. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  92065. /**
  92066. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  92067. * @param scene the scene where the event occurred
  92068. * @param evt The original (browser) event
  92069. * @returns the new ActionEvent
  92070. */
  92071. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  92072. /**
  92073. * Helper function to auto-create an ActionEvent from a primitive
  92074. * @param prim defines the target primitive
  92075. * @param pointerPos defines the pointer position
  92076. * @param evt The original (browser) event
  92077. * @param additionalData additional data for the event
  92078. * @returns the new ActionEvent
  92079. */
  92080. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  92081. }
  92082. }
  92083. declare module BABYLON {
  92084. /**
  92085. * Abstract class used to decouple action Manager from scene and meshes.
  92086. * Do not instantiate.
  92087. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  92088. */
  92089. export abstract class AbstractActionManager implements IDisposable {
  92090. /** Gets the list of active triggers */
  92091. static Triggers: {
  92092. [key: string]: number;
  92093. };
  92094. /** Gets the cursor to use when hovering items */
  92095. hoverCursor: string;
  92096. /** Gets the list of actions */
  92097. actions: IAction[];
  92098. /**
  92099. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  92100. */
  92101. isRecursive: boolean;
  92102. /**
  92103. * Releases all associated resources
  92104. */
  92105. abstract dispose(): void;
  92106. /**
  92107. * Does this action manager has pointer triggers
  92108. */
  92109. abstract readonly hasPointerTriggers: boolean;
  92110. /**
  92111. * Does this action manager has pick triggers
  92112. */
  92113. abstract readonly hasPickTriggers: boolean;
  92114. /**
  92115. * Process a specific trigger
  92116. * @param trigger defines the trigger to process
  92117. * @param evt defines the event details to be processed
  92118. */
  92119. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  92120. /**
  92121. * Does this action manager handles actions of any of the given triggers
  92122. * @param triggers defines the triggers to be tested
  92123. * @return a boolean indicating whether one (or more) of the triggers is handled
  92124. */
  92125. abstract hasSpecificTriggers(triggers: number[]): boolean;
  92126. /**
  92127. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  92128. * speed.
  92129. * @param triggerA defines the trigger to be tested
  92130. * @param triggerB defines the trigger to be tested
  92131. * @return a boolean indicating whether one (or more) of the triggers is handled
  92132. */
  92133. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  92134. /**
  92135. * Does this action manager handles actions of a given trigger
  92136. * @param trigger defines the trigger to be tested
  92137. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  92138. * @return whether the trigger is handled
  92139. */
  92140. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  92141. /**
  92142. * Serialize this manager to a JSON object
  92143. * @param name defines the property name to store this manager
  92144. * @returns a JSON representation of this manager
  92145. */
  92146. abstract serialize(name: string): any;
  92147. /**
  92148. * Registers an action to this action manager
  92149. * @param action defines the action to be registered
  92150. * @return the action amended (prepared) after registration
  92151. */
  92152. abstract registerAction(action: IAction): Nullable<IAction>;
  92153. /**
  92154. * Unregisters an action to this action manager
  92155. * @param action defines the action to be unregistered
  92156. * @return a boolean indicating whether the action has been unregistered
  92157. */
  92158. abstract unregisterAction(action: IAction): Boolean;
  92159. /**
  92160. * Does exist one action manager with at least one trigger
  92161. **/
  92162. static readonly HasTriggers: boolean;
  92163. /**
  92164. * Does exist one action manager with at least one pick trigger
  92165. **/
  92166. static readonly HasPickTriggers: boolean;
  92167. /**
  92168. * Does exist one action manager that handles actions of a given trigger
  92169. * @param trigger defines the trigger to be tested
  92170. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  92171. **/
  92172. static HasSpecificTrigger(trigger: number): boolean;
  92173. }
  92174. }
  92175. declare module BABYLON {
  92176. /**
  92177. * Defines how a node can be built from a string name.
  92178. */
  92179. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  92180. /**
  92181. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  92182. */
  92183. export class Node implements IBehaviorAware<Node> {
  92184. /** @hidden */
  92185. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  92186. private static _NodeConstructors;
  92187. /**
  92188. * Add a new node constructor
  92189. * @param type defines the type name of the node to construct
  92190. * @param constructorFunc defines the constructor function
  92191. */
  92192. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  92193. /**
  92194. * Returns a node constructor based on type name
  92195. * @param type defines the type name
  92196. * @param name defines the new node name
  92197. * @param scene defines the hosting scene
  92198. * @param options defines optional options to transmit to constructors
  92199. * @returns the new constructor or null
  92200. */
  92201. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  92202. /**
  92203. * Gets or sets the name of the node
  92204. */
  92205. name: string;
  92206. /**
  92207. * Gets or sets the id of the node
  92208. */
  92209. id: string;
  92210. /**
  92211. * Gets or sets the unique id of the node
  92212. */
  92213. uniqueId: number;
  92214. /**
  92215. * Gets or sets a string used to store user defined state for the node
  92216. */
  92217. state: string;
  92218. /**
  92219. * Gets or sets an object used to store user defined information for the node
  92220. */
  92221. metadata: any;
  92222. /**
  92223. * For internal use only. Please do not use.
  92224. */
  92225. reservedDataStore: any;
  92226. /**
  92227. * List of inspectable custom properties (used by the Inspector)
  92228. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  92229. */
  92230. inspectableCustomProperties: IInspectable[];
  92231. /**
  92232. * Gets or sets a boolean used to define if the node must be serialized
  92233. */
  92234. doNotSerialize: boolean;
  92235. /** @hidden */
  92236. _isDisposed: boolean;
  92237. /**
  92238. * Gets a list of Animations associated with the node
  92239. */
  92240. animations: Animation[];
  92241. protected _ranges: {
  92242. [name: string]: Nullable<AnimationRange>;
  92243. };
  92244. /**
  92245. * Callback raised when the node is ready to be used
  92246. */
  92247. onReady: Nullable<(node: Node) => void>;
  92248. private _isEnabled;
  92249. private _isParentEnabled;
  92250. private _isReady;
  92251. /** @hidden */
  92252. _currentRenderId: number;
  92253. private _parentUpdateId;
  92254. /** @hidden */
  92255. _childUpdateId: number;
  92256. /** @hidden */
  92257. _waitingParentId: Nullable<string>;
  92258. /** @hidden */
  92259. _scene: Scene;
  92260. /** @hidden */
  92261. _cache: any;
  92262. private _parentNode;
  92263. private _children;
  92264. /** @hidden */
  92265. _worldMatrix: Matrix;
  92266. /** @hidden */
  92267. _worldMatrixDeterminant: number;
  92268. /** @hidden */
  92269. _worldMatrixDeterminantIsDirty: boolean;
  92270. /** @hidden */
  92271. private _sceneRootNodesIndex;
  92272. /**
  92273. * Gets a boolean indicating if the node has been disposed
  92274. * @returns true if the node was disposed
  92275. */
  92276. isDisposed(): boolean;
  92277. /**
  92278. * Gets or sets the parent of the node (without keeping the current position in the scene)
  92279. * @see https://doc.babylonjs.com/how_to/parenting
  92280. */
  92281. parent: Nullable<Node>;
  92282. private addToSceneRootNodes;
  92283. private removeFromSceneRootNodes;
  92284. private _animationPropertiesOverride;
  92285. /**
  92286. * Gets or sets the animation properties override
  92287. */
  92288. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  92289. /**
  92290. * Gets a string idenfifying the name of the class
  92291. * @returns "Node" string
  92292. */
  92293. getClassName(): string;
  92294. /** @hidden */
  92295. readonly _isNode: boolean;
  92296. /**
  92297. * An event triggered when the mesh is disposed
  92298. */
  92299. onDisposeObservable: Observable<Node>;
  92300. private _onDisposeObserver;
  92301. /**
  92302. * Sets a callback that will be raised when the node will be disposed
  92303. */
  92304. onDispose: () => void;
  92305. /**
  92306. * Creates a new Node
  92307. * @param name the name and id to be given to this node
  92308. * @param scene the scene this node will be added to
  92309. * @param addToRootNodes the node will be added to scene.rootNodes
  92310. */
  92311. constructor(name: string, scene?: Nullable<Scene>, addToRootNodes?: boolean);
  92312. /**
  92313. * Gets the scene of the node
  92314. * @returns a scene
  92315. */
  92316. getScene(): Scene;
  92317. /**
  92318. * Gets the engine of the node
  92319. * @returns a Engine
  92320. */
  92321. getEngine(): Engine;
  92322. private _behaviors;
  92323. /**
  92324. * Attach a behavior to the node
  92325. * @see http://doc.babylonjs.com/features/behaviour
  92326. * @param behavior defines the behavior to attach
  92327. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  92328. * @returns the current Node
  92329. */
  92330. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  92331. /**
  92332. * Remove an attached behavior
  92333. * @see http://doc.babylonjs.com/features/behaviour
  92334. * @param behavior defines the behavior to attach
  92335. * @returns the current Node
  92336. */
  92337. removeBehavior(behavior: Behavior<Node>): Node;
  92338. /**
  92339. * Gets the list of attached behaviors
  92340. * @see http://doc.babylonjs.com/features/behaviour
  92341. */
  92342. readonly behaviors: Behavior<Node>[];
  92343. /**
  92344. * Gets an attached behavior by name
  92345. * @param name defines the name of the behavior to look for
  92346. * @see http://doc.babylonjs.com/features/behaviour
  92347. * @returns null if behavior was not found else the requested behavior
  92348. */
  92349. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  92350. /**
  92351. * Returns the latest update of the World matrix
  92352. * @returns a Matrix
  92353. */
  92354. getWorldMatrix(): Matrix;
  92355. /** @hidden */
  92356. _getWorldMatrixDeterminant(): number;
  92357. /**
  92358. * Returns directly the latest state of the mesh World matrix.
  92359. * A Matrix is returned.
  92360. */
  92361. readonly worldMatrixFromCache: Matrix;
  92362. /** @hidden */
  92363. _initCache(): void;
  92364. /** @hidden */
  92365. updateCache(force?: boolean): void;
  92366. /** @hidden */
  92367. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  92368. /** @hidden */
  92369. _updateCache(ignoreParentClass?: boolean): void;
  92370. /** @hidden */
  92371. _isSynchronized(): boolean;
  92372. /** @hidden */
  92373. _markSyncedWithParent(): void;
  92374. /** @hidden */
  92375. isSynchronizedWithParent(): boolean;
  92376. /** @hidden */
  92377. isSynchronized(): boolean;
  92378. /**
  92379. * Is this node ready to be used/rendered
  92380. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  92381. * @return true if the node is ready
  92382. */
  92383. isReady(completeCheck?: boolean): boolean;
  92384. /**
  92385. * Is this node enabled?
  92386. * 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
  92387. * @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
  92388. * @return whether this node (and its parent) is enabled
  92389. */
  92390. isEnabled(checkAncestors?: boolean): boolean;
  92391. /** @hidden */
  92392. protected _syncParentEnabledState(): void;
  92393. /**
  92394. * Set the enabled state of this node
  92395. * @param value defines the new enabled state
  92396. */
  92397. setEnabled(value: boolean): void;
  92398. /**
  92399. * Is this node a descendant of the given node?
  92400. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  92401. * @param ancestor defines the parent node to inspect
  92402. * @returns a boolean indicating if this node is a descendant of the given node
  92403. */
  92404. isDescendantOf(ancestor: Node): boolean;
  92405. /** @hidden */
  92406. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  92407. /**
  92408. * Will return all nodes that have this node as ascendant
  92409. * @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
  92410. * @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
  92411. * @return all children nodes of all types
  92412. */
  92413. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  92414. /**
  92415. * Get all child-meshes of this node
  92416. * @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)
  92417. * @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
  92418. * @returns an array of AbstractMesh
  92419. */
  92420. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  92421. /**
  92422. * Get all direct children of this node
  92423. * @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
  92424. * @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)
  92425. * @returns an array of Node
  92426. */
  92427. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  92428. /** @hidden */
  92429. _setReady(state: boolean): void;
  92430. /**
  92431. * Get an animation by name
  92432. * @param name defines the name of the animation to look for
  92433. * @returns null if not found else the requested animation
  92434. */
  92435. getAnimationByName(name: string): Nullable<Animation>;
  92436. /**
  92437. * Creates an animation range for this node
  92438. * @param name defines the name of the range
  92439. * @param from defines the starting key
  92440. * @param to defines the end key
  92441. */
  92442. createAnimationRange(name: string, from: number, to: number): void;
  92443. /**
  92444. * Delete a specific animation range
  92445. * @param name defines the name of the range to delete
  92446. * @param deleteFrames defines if animation frames from the range must be deleted as well
  92447. */
  92448. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  92449. /**
  92450. * Get an animation range by name
  92451. * @param name defines the name of the animation range to look for
  92452. * @returns null if not found else the requested animation range
  92453. */
  92454. getAnimationRange(name: string): Nullable<AnimationRange>;
  92455. /**
  92456. * Gets the list of all animation ranges defined on this node
  92457. * @returns an array
  92458. */
  92459. getAnimationRanges(): Nullable<AnimationRange>[];
  92460. /**
  92461. * Will start the animation sequence
  92462. * @param name defines the range frames for animation sequence
  92463. * @param loop defines if the animation should loop (false by default)
  92464. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  92465. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  92466. * @returns the object created for this animation. If range does not exist, it will return null
  92467. */
  92468. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  92469. /**
  92470. * Serialize animation ranges into a JSON compatible object
  92471. * @returns serialization object
  92472. */
  92473. serializeAnimationRanges(): any;
  92474. /**
  92475. * Computes the world matrix of the node
  92476. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  92477. * @returns the world matrix
  92478. */
  92479. computeWorldMatrix(force?: boolean): Matrix;
  92480. /**
  92481. * Releases resources associated with this node.
  92482. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92483. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92484. */
  92485. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92486. /**
  92487. * Parse animation range data from a serialization object and store them into a given node
  92488. * @param node defines where to store the animation ranges
  92489. * @param parsedNode defines the serialization object to read data from
  92490. * @param scene defines the hosting scene
  92491. */
  92492. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  92493. /**
  92494. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  92495. * @param includeDescendants Include bounding info from descendants as well (true by default)
  92496. * @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
  92497. * @returns the new bounding vectors
  92498. */
  92499. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  92500. min: Vector3;
  92501. max: Vector3;
  92502. };
  92503. }
  92504. }
  92505. declare module BABYLON {
  92506. /**
  92507. * @hidden
  92508. */
  92509. export class _IAnimationState {
  92510. key: number;
  92511. repeatCount: number;
  92512. workValue?: any;
  92513. loopMode?: number;
  92514. offsetValue?: any;
  92515. highLimitValue?: any;
  92516. }
  92517. /**
  92518. * Class used to store any kind of animation
  92519. */
  92520. export class Animation {
  92521. /**Name of the animation */
  92522. name: string;
  92523. /**Property to animate */
  92524. targetProperty: string;
  92525. /**The frames per second of the animation */
  92526. framePerSecond: number;
  92527. /**The data type of the animation */
  92528. dataType: number;
  92529. /**The loop mode of the animation */
  92530. loopMode?: number | undefined;
  92531. /**Specifies if blending should be enabled */
  92532. enableBlending?: boolean | undefined;
  92533. /**
  92534. * Use matrix interpolation instead of using direct key value when animating matrices
  92535. */
  92536. static AllowMatricesInterpolation: boolean;
  92537. /**
  92538. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  92539. */
  92540. static AllowMatrixDecomposeForInterpolation: boolean;
  92541. /**
  92542. * Stores the key frames of the animation
  92543. */
  92544. private _keys;
  92545. /**
  92546. * Stores the easing function of the animation
  92547. */
  92548. private _easingFunction;
  92549. /**
  92550. * @hidden Internal use only
  92551. */
  92552. _runtimeAnimations: RuntimeAnimation[];
  92553. /**
  92554. * The set of event that will be linked to this animation
  92555. */
  92556. private _events;
  92557. /**
  92558. * Stores an array of target property paths
  92559. */
  92560. targetPropertyPath: string[];
  92561. /**
  92562. * Stores the blending speed of the animation
  92563. */
  92564. blendingSpeed: number;
  92565. /**
  92566. * Stores the animation ranges for the animation
  92567. */
  92568. private _ranges;
  92569. /**
  92570. * @hidden Internal use
  92571. */
  92572. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  92573. /**
  92574. * Sets up an animation
  92575. * @param property The property to animate
  92576. * @param animationType The animation type to apply
  92577. * @param framePerSecond The frames per second of the animation
  92578. * @param easingFunction The easing function used in the animation
  92579. * @returns The created animation
  92580. */
  92581. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  92582. /**
  92583. * Create and start an animation on a node
  92584. * @param name defines the name of the global animation that will be run on all nodes
  92585. * @param node defines the root node where the animation will take place
  92586. * @param targetProperty defines property to animate
  92587. * @param framePerSecond defines the number of frame per second yo use
  92588. * @param totalFrame defines the number of frames in total
  92589. * @param from defines the initial value
  92590. * @param to defines the final value
  92591. * @param loopMode defines which loop mode you want to use (off by default)
  92592. * @param easingFunction defines the easing function to use (linear by default)
  92593. * @param onAnimationEnd defines the callback to call when animation end
  92594. * @returns the animatable created for this animation
  92595. */
  92596. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  92597. /**
  92598. * Create and start an animation on a node and its descendants
  92599. * @param name defines the name of the global animation that will be run on all nodes
  92600. * @param node defines the root node where the animation will take place
  92601. * @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
  92602. * @param targetProperty defines property to animate
  92603. * @param framePerSecond defines the number of frame per second to use
  92604. * @param totalFrame defines the number of frames in total
  92605. * @param from defines the initial value
  92606. * @param to defines the final value
  92607. * @param loopMode defines which loop mode you want to use (off by default)
  92608. * @param easingFunction defines the easing function to use (linear by default)
  92609. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  92610. * @returns the list of animatables created for all nodes
  92611. * @example https://www.babylonjs-playground.com/#MH0VLI
  92612. */
  92613. 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[]>;
  92614. /**
  92615. * Creates a new animation, merges it with the existing animations and starts it
  92616. * @param name Name of the animation
  92617. * @param node Node which contains the scene that begins the animations
  92618. * @param targetProperty Specifies which property to animate
  92619. * @param framePerSecond The frames per second of the animation
  92620. * @param totalFrame The total number of frames
  92621. * @param from The frame at the beginning of the animation
  92622. * @param to The frame at the end of the animation
  92623. * @param loopMode Specifies the loop mode of the animation
  92624. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  92625. * @param onAnimationEnd Callback to run once the animation is complete
  92626. * @returns Nullable animation
  92627. */
  92628. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  92629. /**
  92630. * Transition property of an host to the target Value
  92631. * @param property The property to transition
  92632. * @param targetValue The target Value of the property
  92633. * @param host The object where the property to animate belongs
  92634. * @param scene Scene used to run the animation
  92635. * @param frameRate Framerate (in frame/s) to use
  92636. * @param transition The transition type we want to use
  92637. * @param duration The duration of the animation, in milliseconds
  92638. * @param onAnimationEnd Callback trigger at the end of the animation
  92639. * @returns Nullable animation
  92640. */
  92641. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  92642. /**
  92643. * Return the array of runtime animations currently using this animation
  92644. */
  92645. readonly runtimeAnimations: RuntimeAnimation[];
  92646. /**
  92647. * Specifies if any of the runtime animations are currently running
  92648. */
  92649. readonly hasRunningRuntimeAnimations: boolean;
  92650. /**
  92651. * Initializes the animation
  92652. * @param name Name of the animation
  92653. * @param targetProperty Property to animate
  92654. * @param framePerSecond The frames per second of the animation
  92655. * @param dataType The data type of the animation
  92656. * @param loopMode The loop mode of the animation
  92657. * @param enableBlending Specifies if blending should be enabled
  92658. */
  92659. constructor(
  92660. /**Name of the animation */
  92661. name: string,
  92662. /**Property to animate */
  92663. targetProperty: string,
  92664. /**The frames per second of the animation */
  92665. framePerSecond: number,
  92666. /**The data type of the animation */
  92667. dataType: number,
  92668. /**The loop mode of the animation */
  92669. loopMode?: number | undefined,
  92670. /**Specifies if blending should be enabled */
  92671. enableBlending?: boolean | undefined);
  92672. /**
  92673. * Converts the animation to a string
  92674. * @param fullDetails support for multiple levels of logging within scene loading
  92675. * @returns String form of the animation
  92676. */
  92677. toString(fullDetails?: boolean): string;
  92678. /**
  92679. * Add an event to this animation
  92680. * @param event Event to add
  92681. */
  92682. addEvent(event: AnimationEvent): void;
  92683. /**
  92684. * Remove all events found at the given frame
  92685. * @param frame The frame to remove events from
  92686. */
  92687. removeEvents(frame: number): void;
  92688. /**
  92689. * Retrieves all the events from the animation
  92690. * @returns Events from the animation
  92691. */
  92692. getEvents(): AnimationEvent[];
  92693. /**
  92694. * Creates an animation range
  92695. * @param name Name of the animation range
  92696. * @param from Starting frame of the animation range
  92697. * @param to Ending frame of the animation
  92698. */
  92699. createRange(name: string, from: number, to: number): void;
  92700. /**
  92701. * Deletes an animation range by name
  92702. * @param name Name of the animation range to delete
  92703. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  92704. */
  92705. deleteRange(name: string, deleteFrames?: boolean): void;
  92706. /**
  92707. * Gets the animation range by name, or null if not defined
  92708. * @param name Name of the animation range
  92709. * @returns Nullable animation range
  92710. */
  92711. getRange(name: string): Nullable<AnimationRange>;
  92712. /**
  92713. * Gets the key frames from the animation
  92714. * @returns The key frames of the animation
  92715. */
  92716. getKeys(): Array<IAnimationKey>;
  92717. /**
  92718. * Gets the highest frame rate of the animation
  92719. * @returns Highest frame rate of the animation
  92720. */
  92721. getHighestFrame(): number;
  92722. /**
  92723. * Gets the easing function of the animation
  92724. * @returns Easing function of the animation
  92725. */
  92726. getEasingFunction(): IEasingFunction;
  92727. /**
  92728. * Sets the easing function of the animation
  92729. * @param easingFunction A custom mathematical formula for animation
  92730. */
  92731. setEasingFunction(easingFunction: EasingFunction): void;
  92732. /**
  92733. * Interpolates a scalar linearly
  92734. * @param startValue Start value of the animation curve
  92735. * @param endValue End value of the animation curve
  92736. * @param gradient Scalar amount to interpolate
  92737. * @returns Interpolated scalar value
  92738. */
  92739. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  92740. /**
  92741. * Interpolates a scalar cubically
  92742. * @param startValue Start value of the animation curve
  92743. * @param outTangent End tangent of the animation
  92744. * @param endValue End value of the animation curve
  92745. * @param inTangent Start tangent of the animation curve
  92746. * @param gradient Scalar amount to interpolate
  92747. * @returns Interpolated scalar value
  92748. */
  92749. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  92750. /**
  92751. * Interpolates a quaternion using a spherical linear interpolation
  92752. * @param startValue Start value of the animation curve
  92753. * @param endValue End value of the animation curve
  92754. * @param gradient Scalar amount to interpolate
  92755. * @returns Interpolated quaternion value
  92756. */
  92757. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  92758. /**
  92759. * Interpolates a quaternion cubically
  92760. * @param startValue Start value of the animation curve
  92761. * @param outTangent End tangent of the animation curve
  92762. * @param endValue End value of the animation curve
  92763. * @param inTangent Start tangent of the animation curve
  92764. * @param gradient Scalar amount to interpolate
  92765. * @returns Interpolated quaternion value
  92766. */
  92767. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  92768. /**
  92769. * Interpolates a Vector3 linearl
  92770. * @param startValue Start value of the animation curve
  92771. * @param endValue End value of the animation curve
  92772. * @param gradient Scalar amount to interpolate
  92773. * @returns Interpolated scalar value
  92774. */
  92775. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  92776. /**
  92777. * Interpolates a Vector3 cubically
  92778. * @param startValue Start value of the animation curve
  92779. * @param outTangent End tangent of the animation
  92780. * @param endValue End value of the animation curve
  92781. * @param inTangent Start tangent of the animation curve
  92782. * @param gradient Scalar amount to interpolate
  92783. * @returns InterpolatedVector3 value
  92784. */
  92785. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  92786. /**
  92787. * Interpolates a Vector2 linearly
  92788. * @param startValue Start value of the animation curve
  92789. * @param endValue End value of the animation curve
  92790. * @param gradient Scalar amount to interpolate
  92791. * @returns Interpolated Vector2 value
  92792. */
  92793. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  92794. /**
  92795. * Interpolates a Vector2 cubically
  92796. * @param startValue Start value of the animation curve
  92797. * @param outTangent End tangent of the animation
  92798. * @param endValue End value of the animation curve
  92799. * @param inTangent Start tangent of the animation curve
  92800. * @param gradient Scalar amount to interpolate
  92801. * @returns Interpolated Vector2 value
  92802. */
  92803. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  92804. /**
  92805. * Interpolates a size linearly
  92806. * @param startValue Start value of the animation curve
  92807. * @param endValue End value of the animation curve
  92808. * @param gradient Scalar amount to interpolate
  92809. * @returns Interpolated Size value
  92810. */
  92811. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  92812. /**
  92813. * Interpolates a Color3 linearly
  92814. * @param startValue Start value of the animation curve
  92815. * @param endValue End value of the animation curve
  92816. * @param gradient Scalar amount to interpolate
  92817. * @returns Interpolated Color3 value
  92818. */
  92819. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  92820. /**
  92821. * @hidden Internal use only
  92822. */
  92823. _getKeyValue(value: any): any;
  92824. /**
  92825. * @hidden Internal use only
  92826. */
  92827. _interpolate(currentFrame: number, state: _IAnimationState): any;
  92828. /**
  92829. * Defines the function to use to interpolate matrices
  92830. * @param startValue defines the start matrix
  92831. * @param endValue defines the end matrix
  92832. * @param gradient defines the gradient between both matrices
  92833. * @param result defines an optional target matrix where to store the interpolation
  92834. * @returns the interpolated matrix
  92835. */
  92836. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  92837. /**
  92838. * Makes a copy of the animation
  92839. * @returns Cloned animation
  92840. */
  92841. clone(): Animation;
  92842. /**
  92843. * Sets the key frames of the animation
  92844. * @param values The animation key frames to set
  92845. */
  92846. setKeys(values: Array<IAnimationKey>): void;
  92847. /**
  92848. * Serializes the animation to an object
  92849. * @returns Serialized object
  92850. */
  92851. serialize(): any;
  92852. /**
  92853. * Float animation type
  92854. */
  92855. private static _ANIMATIONTYPE_FLOAT;
  92856. /**
  92857. * Vector3 animation type
  92858. */
  92859. private static _ANIMATIONTYPE_VECTOR3;
  92860. /**
  92861. * Quaternion animation type
  92862. */
  92863. private static _ANIMATIONTYPE_QUATERNION;
  92864. /**
  92865. * Matrix animation type
  92866. */
  92867. private static _ANIMATIONTYPE_MATRIX;
  92868. /**
  92869. * Color3 animation type
  92870. */
  92871. private static _ANIMATIONTYPE_COLOR3;
  92872. /**
  92873. * Vector2 animation type
  92874. */
  92875. private static _ANIMATIONTYPE_VECTOR2;
  92876. /**
  92877. * Size animation type
  92878. */
  92879. private static _ANIMATIONTYPE_SIZE;
  92880. /**
  92881. * Relative Loop Mode
  92882. */
  92883. private static _ANIMATIONLOOPMODE_RELATIVE;
  92884. /**
  92885. * Cycle Loop Mode
  92886. */
  92887. private static _ANIMATIONLOOPMODE_CYCLE;
  92888. /**
  92889. * Constant Loop Mode
  92890. */
  92891. private static _ANIMATIONLOOPMODE_CONSTANT;
  92892. /**
  92893. * Get the float animation type
  92894. */
  92895. static readonly ANIMATIONTYPE_FLOAT: number;
  92896. /**
  92897. * Get the Vector3 animation type
  92898. */
  92899. static readonly ANIMATIONTYPE_VECTOR3: number;
  92900. /**
  92901. * Get the Vector2 animation type
  92902. */
  92903. static readonly ANIMATIONTYPE_VECTOR2: number;
  92904. /**
  92905. * Get the Size animation type
  92906. */
  92907. static readonly ANIMATIONTYPE_SIZE: number;
  92908. /**
  92909. * Get the Quaternion animation type
  92910. */
  92911. static readonly ANIMATIONTYPE_QUATERNION: number;
  92912. /**
  92913. * Get the Matrix animation type
  92914. */
  92915. static readonly ANIMATIONTYPE_MATRIX: number;
  92916. /**
  92917. * Get the Color3 animation type
  92918. */
  92919. static readonly ANIMATIONTYPE_COLOR3: number;
  92920. /**
  92921. * Get the Relative Loop Mode
  92922. */
  92923. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  92924. /**
  92925. * Get the Cycle Loop Mode
  92926. */
  92927. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  92928. /**
  92929. * Get the Constant Loop Mode
  92930. */
  92931. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  92932. /** @hidden */
  92933. static _UniversalLerp(left: any, right: any, amount: number): any;
  92934. /**
  92935. * Parses an animation object and creates an animation
  92936. * @param parsedAnimation Parsed animation object
  92937. * @returns Animation object
  92938. */
  92939. static Parse(parsedAnimation: any): Animation;
  92940. /**
  92941. * Appends the serialized animations from the source animations
  92942. * @param source Source containing the animations
  92943. * @param destination Target to store the animations
  92944. */
  92945. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  92946. }
  92947. }
  92948. declare module BABYLON {
  92949. /**
  92950. * Interface containing an array of animations
  92951. */
  92952. export interface IAnimatable {
  92953. /**
  92954. * Array of animations
  92955. */
  92956. animations: Nullable<Array<Animation>>;
  92957. }
  92958. }
  92959. declare module BABYLON {
  92960. /**
  92961. * This represents all the required information to add a fresnel effect on a material:
  92962. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  92963. */
  92964. export class FresnelParameters {
  92965. private _isEnabled;
  92966. /**
  92967. * Define if the fresnel effect is enable or not.
  92968. */
  92969. isEnabled: boolean;
  92970. /**
  92971. * Define the color used on edges (grazing angle)
  92972. */
  92973. leftColor: Color3;
  92974. /**
  92975. * Define the color used on center
  92976. */
  92977. rightColor: Color3;
  92978. /**
  92979. * Define bias applied to computed fresnel term
  92980. */
  92981. bias: number;
  92982. /**
  92983. * Defined the power exponent applied to fresnel term
  92984. */
  92985. power: number;
  92986. /**
  92987. * Clones the current fresnel and its valuues
  92988. * @returns a clone fresnel configuration
  92989. */
  92990. clone(): FresnelParameters;
  92991. /**
  92992. * Serializes the current fresnel parameters to a JSON representation.
  92993. * @return the JSON serialization
  92994. */
  92995. serialize(): any;
  92996. /**
  92997. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  92998. * @param parsedFresnelParameters Define the JSON representation
  92999. * @returns the parsed parameters
  93000. */
  93001. static Parse(parsedFresnelParameters: any): FresnelParameters;
  93002. }
  93003. }
  93004. declare module BABYLON {
  93005. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  93006. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93007. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93008. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93009. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93010. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93011. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93012. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93013. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93014. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93015. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93016. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93017. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93018. /**
  93019. * Decorator used to define property that can be serialized as reference to a camera
  93020. * @param sourceName defines the name of the property to decorate
  93021. */
  93022. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  93023. /**
  93024. * Class used to help serialization objects
  93025. */
  93026. export class SerializationHelper {
  93027. /** @hidden */
  93028. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  93029. /** @hidden */
  93030. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  93031. /** @hidden */
  93032. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  93033. /** @hidden */
  93034. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  93035. /**
  93036. * Appends the serialized animations from the source animations
  93037. * @param source Source containing the animations
  93038. * @param destination Target to store the animations
  93039. */
  93040. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  93041. /**
  93042. * Static function used to serialized a specific entity
  93043. * @param entity defines the entity to serialize
  93044. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  93045. * @returns a JSON compatible object representing the serialization of the entity
  93046. */
  93047. static Serialize<T>(entity: T, serializationObject?: any): any;
  93048. /**
  93049. * Creates a new entity from a serialization data object
  93050. * @param creationFunction defines a function used to instanciated the new entity
  93051. * @param source defines the source serialization data
  93052. * @param scene defines the hosting scene
  93053. * @param rootUrl defines the root url for resources
  93054. * @returns a new entity
  93055. */
  93056. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  93057. /**
  93058. * Clones an object
  93059. * @param creationFunction defines the function used to instanciate the new object
  93060. * @param source defines the source object
  93061. * @returns the cloned object
  93062. */
  93063. static Clone<T>(creationFunction: () => T, source: T): T;
  93064. /**
  93065. * Instanciates a new object based on a source one (some data will be shared between both object)
  93066. * @param creationFunction defines the function used to instanciate the new object
  93067. * @param source defines the source object
  93068. * @returns the new object
  93069. */
  93070. static Instanciate<T>(creationFunction: () => T, source: T): T;
  93071. }
  93072. }
  93073. declare module BABYLON {
  93074. /**
  93075. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  93076. */
  93077. export interface CubeMapInfo {
  93078. /**
  93079. * The pixel array for the front face.
  93080. * This is stored in format, left to right, up to down format.
  93081. */
  93082. front: Nullable<ArrayBufferView>;
  93083. /**
  93084. * The pixel array for the back face.
  93085. * This is stored in format, left to right, up to down format.
  93086. */
  93087. back: Nullable<ArrayBufferView>;
  93088. /**
  93089. * The pixel array for the left face.
  93090. * This is stored in format, left to right, up to down format.
  93091. */
  93092. left: Nullable<ArrayBufferView>;
  93093. /**
  93094. * The pixel array for the right face.
  93095. * This is stored in format, left to right, up to down format.
  93096. */
  93097. right: Nullable<ArrayBufferView>;
  93098. /**
  93099. * The pixel array for the up face.
  93100. * This is stored in format, left to right, up to down format.
  93101. */
  93102. up: Nullable<ArrayBufferView>;
  93103. /**
  93104. * The pixel array for the down face.
  93105. * This is stored in format, left to right, up to down format.
  93106. */
  93107. down: Nullable<ArrayBufferView>;
  93108. /**
  93109. * The size of the cubemap stored.
  93110. *
  93111. * Each faces will be size * size pixels.
  93112. */
  93113. size: number;
  93114. /**
  93115. * The format of the texture.
  93116. *
  93117. * RGBA, RGB.
  93118. */
  93119. format: number;
  93120. /**
  93121. * The type of the texture data.
  93122. *
  93123. * UNSIGNED_INT, FLOAT.
  93124. */
  93125. type: number;
  93126. /**
  93127. * Specifies whether the texture is in gamma space.
  93128. */
  93129. gammaSpace: boolean;
  93130. }
  93131. /**
  93132. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  93133. */
  93134. export class PanoramaToCubeMapTools {
  93135. private static FACE_FRONT;
  93136. private static FACE_BACK;
  93137. private static FACE_RIGHT;
  93138. private static FACE_LEFT;
  93139. private static FACE_DOWN;
  93140. private static FACE_UP;
  93141. /**
  93142. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  93143. *
  93144. * @param float32Array The source data.
  93145. * @param inputWidth The width of the input panorama.
  93146. * @param inputHeight The height of the input panorama.
  93147. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  93148. * @return The cubemap data
  93149. */
  93150. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  93151. private static CreateCubemapTexture;
  93152. private static CalcProjectionSpherical;
  93153. }
  93154. }
  93155. declare module BABYLON {
  93156. /**
  93157. * Helper class dealing with the extraction of spherical polynomial dataArray
  93158. * from a cube map.
  93159. */
  93160. export class CubeMapToSphericalPolynomialTools {
  93161. private static FileFaces;
  93162. /**
  93163. * Converts a texture to the according Spherical Polynomial data.
  93164. * This extracts the first 3 orders only as they are the only one used in the lighting.
  93165. *
  93166. * @param texture The texture to extract the information from.
  93167. * @return The Spherical Polynomial data.
  93168. */
  93169. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  93170. /**
  93171. * Converts a cubemap to the according Spherical Polynomial data.
  93172. * This extracts the first 3 orders only as they are the only one used in the lighting.
  93173. *
  93174. * @param cubeInfo The Cube map to extract the information from.
  93175. * @return The Spherical Polynomial data.
  93176. */
  93177. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  93178. }
  93179. }
  93180. declare module BABYLON {
  93181. /**
  93182. * Class used to manipulate GUIDs
  93183. */
  93184. export class GUID {
  93185. /**
  93186. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  93187. * Be aware Math.random() could cause collisions, but:
  93188. * "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"
  93189. * @returns a pseudo random id
  93190. */
  93191. static RandomId(): string;
  93192. }
  93193. }
  93194. declare module BABYLON {
  93195. /**
  93196. * Base class of all the textures in babylon.
  93197. * It groups all the common properties the materials, post process, lights... might need
  93198. * in order to make a correct use of the texture.
  93199. */
  93200. export class BaseTexture implements IAnimatable {
  93201. /**
  93202. * Default anisotropic filtering level for the application.
  93203. * It is set to 4 as a good tradeoff between perf and quality.
  93204. */
  93205. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  93206. /**
  93207. * Gets or sets the unique id of the texture
  93208. */
  93209. uniqueId: number;
  93210. /**
  93211. * Define the name of the texture.
  93212. */
  93213. name: string;
  93214. /**
  93215. * Gets or sets an object used to store user defined information.
  93216. */
  93217. metadata: any;
  93218. /**
  93219. * For internal use only. Please do not use.
  93220. */
  93221. reservedDataStore: any;
  93222. private _hasAlpha;
  93223. /**
  93224. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  93225. */
  93226. hasAlpha: boolean;
  93227. /**
  93228. * Defines if the alpha value should be determined via the rgb values.
  93229. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  93230. */
  93231. getAlphaFromRGB: boolean;
  93232. /**
  93233. * Intensity or strength of the texture.
  93234. * It is commonly used by materials to fine tune the intensity of the texture
  93235. */
  93236. level: number;
  93237. /**
  93238. * Define the UV chanel to use starting from 0 and defaulting to 0.
  93239. * This is part of the texture as textures usually maps to one uv set.
  93240. */
  93241. coordinatesIndex: number;
  93242. private _coordinatesMode;
  93243. /**
  93244. * How a texture is mapped.
  93245. *
  93246. * | Value | Type | Description |
  93247. * | ----- | ----------------------------------- | ----------- |
  93248. * | 0 | EXPLICIT_MODE | |
  93249. * | 1 | SPHERICAL_MODE | |
  93250. * | 2 | PLANAR_MODE | |
  93251. * | 3 | CUBIC_MODE | |
  93252. * | 4 | PROJECTION_MODE | |
  93253. * | 5 | SKYBOX_MODE | |
  93254. * | 6 | INVCUBIC_MODE | |
  93255. * | 7 | EQUIRECTANGULAR_MODE | |
  93256. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  93257. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  93258. */
  93259. coordinatesMode: number;
  93260. /**
  93261. * | Value | Type | Description |
  93262. * | ----- | ------------------ | ----------- |
  93263. * | 0 | CLAMP_ADDRESSMODE | |
  93264. * | 1 | WRAP_ADDRESSMODE | |
  93265. * | 2 | MIRROR_ADDRESSMODE | |
  93266. */
  93267. wrapU: number;
  93268. /**
  93269. * | Value | Type | Description |
  93270. * | ----- | ------------------ | ----------- |
  93271. * | 0 | CLAMP_ADDRESSMODE | |
  93272. * | 1 | WRAP_ADDRESSMODE | |
  93273. * | 2 | MIRROR_ADDRESSMODE | |
  93274. */
  93275. wrapV: number;
  93276. /**
  93277. * | Value | Type | Description |
  93278. * | ----- | ------------------ | ----------- |
  93279. * | 0 | CLAMP_ADDRESSMODE | |
  93280. * | 1 | WRAP_ADDRESSMODE | |
  93281. * | 2 | MIRROR_ADDRESSMODE | |
  93282. */
  93283. wrapR: number;
  93284. /**
  93285. * With compliant hardware and browser (supporting anisotropic filtering)
  93286. * this defines the level of anisotropic filtering in the texture.
  93287. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  93288. */
  93289. anisotropicFilteringLevel: number;
  93290. /**
  93291. * Define if the texture is a cube texture or if false a 2d texture.
  93292. */
  93293. isCube: boolean;
  93294. /**
  93295. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  93296. */
  93297. is3D: boolean;
  93298. /**
  93299. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  93300. * HDR texture are usually stored in linear space.
  93301. * This only impacts the PBR and Background materials
  93302. */
  93303. gammaSpace: boolean;
  93304. /**
  93305. * Gets or sets whether or not the texture contains RGBD data.
  93306. */
  93307. isRGBD: boolean;
  93308. /**
  93309. * Is Z inverted in the texture (useful in a cube texture).
  93310. */
  93311. invertZ: boolean;
  93312. /**
  93313. * Are mip maps generated for this texture or not.
  93314. */
  93315. readonly noMipmap: boolean;
  93316. /**
  93317. * @hidden
  93318. */
  93319. lodLevelInAlpha: boolean;
  93320. /**
  93321. * With prefiltered texture, defined the offset used during the prefiltering steps.
  93322. */
  93323. lodGenerationOffset: number;
  93324. /**
  93325. * With prefiltered texture, defined the scale used during the prefiltering steps.
  93326. */
  93327. lodGenerationScale: number;
  93328. /**
  93329. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  93330. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  93331. * average roughness values.
  93332. */
  93333. linearSpecularLOD: boolean;
  93334. /**
  93335. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  93336. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  93337. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  93338. */
  93339. irradianceTexture: Nullable<BaseTexture>;
  93340. /**
  93341. * Define if the texture is a render target.
  93342. */
  93343. isRenderTarget: boolean;
  93344. /**
  93345. * Define the unique id of the texture in the scene.
  93346. */
  93347. readonly uid: string;
  93348. /**
  93349. * Return a string representation of the texture.
  93350. * @returns the texture as a string
  93351. */
  93352. toString(): string;
  93353. /**
  93354. * Get the class name of the texture.
  93355. * @returns "BaseTexture"
  93356. */
  93357. getClassName(): string;
  93358. /**
  93359. * Define the list of animation attached to the texture.
  93360. */
  93361. animations: Animation[];
  93362. /**
  93363. * An event triggered when the texture is disposed.
  93364. */
  93365. onDisposeObservable: Observable<BaseTexture>;
  93366. private _onDisposeObserver;
  93367. /**
  93368. * Callback triggered when the texture has been disposed.
  93369. * Kept for back compatibility, you can use the onDisposeObservable instead.
  93370. */
  93371. onDispose: () => void;
  93372. /**
  93373. * Define the current state of the loading sequence when in delayed load mode.
  93374. */
  93375. delayLoadState: number;
  93376. private _scene;
  93377. /** @hidden */
  93378. _texture: Nullable<InternalTexture>;
  93379. private _uid;
  93380. /**
  93381. * Define if the texture is preventinga material to render or not.
  93382. * If not and the texture is not ready, the engine will use a default black texture instead.
  93383. */
  93384. readonly isBlocking: boolean;
  93385. /**
  93386. * Instantiates a new BaseTexture.
  93387. * Base class of all the textures in babylon.
  93388. * It groups all the common properties the materials, post process, lights... might need
  93389. * in order to make a correct use of the texture.
  93390. * @param scene Define the scene the texture blongs to
  93391. */
  93392. constructor(scene: Nullable<Scene>);
  93393. /**
  93394. * Get the scene the texture belongs to.
  93395. * @returns the scene or null if undefined
  93396. */
  93397. getScene(): Nullable<Scene>;
  93398. /**
  93399. * Get the texture transform matrix used to offset tile the texture for istance.
  93400. * @returns the transformation matrix
  93401. */
  93402. getTextureMatrix(): Matrix;
  93403. /**
  93404. * Get the texture reflection matrix used to rotate/transform the reflection.
  93405. * @returns the reflection matrix
  93406. */
  93407. getReflectionTextureMatrix(): Matrix;
  93408. /**
  93409. * Get the underlying lower level texture from Babylon.
  93410. * @returns the insternal texture
  93411. */
  93412. getInternalTexture(): Nullable<InternalTexture>;
  93413. /**
  93414. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  93415. * @returns true if ready or not blocking
  93416. */
  93417. isReadyOrNotBlocking(): boolean;
  93418. /**
  93419. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  93420. * @returns true if fully ready
  93421. */
  93422. isReady(): boolean;
  93423. private _cachedSize;
  93424. /**
  93425. * Get the size of the texture.
  93426. * @returns the texture size.
  93427. */
  93428. getSize(): ISize;
  93429. /**
  93430. * Get the base size of the texture.
  93431. * It can be different from the size if the texture has been resized for POT for instance
  93432. * @returns the base size
  93433. */
  93434. getBaseSize(): ISize;
  93435. /**
  93436. * Update the sampling mode of the texture.
  93437. * Default is Trilinear mode.
  93438. *
  93439. * | Value | Type | Description |
  93440. * | ----- | ------------------ | ----------- |
  93441. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  93442. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  93443. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  93444. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  93445. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  93446. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  93447. * | 7 | NEAREST_LINEAR | |
  93448. * | 8 | NEAREST_NEAREST | |
  93449. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  93450. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  93451. * | 11 | LINEAR_LINEAR | |
  93452. * | 12 | LINEAR_NEAREST | |
  93453. *
  93454. * > _mag_: magnification filter (close to the viewer)
  93455. * > _min_: minification filter (far from the viewer)
  93456. * > _mip_: filter used between mip map levels
  93457. *@param samplingMode Define the new sampling mode of the texture
  93458. */
  93459. updateSamplingMode(samplingMode: number): void;
  93460. /**
  93461. * Scales the texture if is `canRescale()`
  93462. * @param ratio the resize factor we want to use to rescale
  93463. */
  93464. scale(ratio: number): void;
  93465. /**
  93466. * Get if the texture can rescale.
  93467. */
  93468. readonly canRescale: boolean;
  93469. /** @hidden */
  93470. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  93471. /** @hidden */
  93472. _rebuild(): void;
  93473. /**
  93474. * Triggers the load sequence in delayed load mode.
  93475. */
  93476. delayLoad(): void;
  93477. /**
  93478. * Clones the texture.
  93479. * @returns the cloned texture
  93480. */
  93481. clone(): Nullable<BaseTexture>;
  93482. /**
  93483. * Get the texture underlying type (INT, FLOAT...)
  93484. */
  93485. readonly textureType: number;
  93486. /**
  93487. * Get the texture underlying format (RGB, RGBA...)
  93488. */
  93489. readonly textureFormat: number;
  93490. /**
  93491. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  93492. * This will returns an RGBA array buffer containing either in values (0-255) or
  93493. * float values (0-1) depending of the underlying buffer type.
  93494. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  93495. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  93496. * @param buffer defines a user defined buffer to fill with data (can be null)
  93497. * @returns The Array buffer containing the pixels data.
  93498. */
  93499. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  93500. /**
  93501. * Release and destroy the underlying lower level texture aka internalTexture.
  93502. */
  93503. releaseInternalTexture(): void;
  93504. /**
  93505. * Get the polynomial representation of the texture data.
  93506. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  93507. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  93508. */
  93509. sphericalPolynomial: Nullable<SphericalPolynomial>;
  93510. /** @hidden */
  93511. readonly _lodTextureHigh: Nullable<BaseTexture>;
  93512. /** @hidden */
  93513. readonly _lodTextureMid: Nullable<BaseTexture>;
  93514. /** @hidden */
  93515. readonly _lodTextureLow: Nullable<BaseTexture>;
  93516. /**
  93517. * Dispose the texture and release its associated resources.
  93518. */
  93519. dispose(): void;
  93520. /**
  93521. * Serialize the texture into a JSON representation that can be parsed later on.
  93522. * @returns the JSON representation of the texture
  93523. */
  93524. serialize(): any;
  93525. /**
  93526. * Helper function to be called back once a list of texture contains only ready textures.
  93527. * @param textures Define the list of textures to wait for
  93528. * @param callback Define the callback triggered once the entire list will be ready
  93529. */
  93530. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  93531. }
  93532. }
  93533. declare module BABYLON {
  93534. /**
  93535. * Class used to store data associated with WebGL texture data for the engine
  93536. * This class should not be used directly
  93537. */
  93538. export class InternalTexture {
  93539. /** @hidden */
  93540. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  93541. /**
  93542. * The source of the texture data is unknown
  93543. */
  93544. static DATASOURCE_UNKNOWN: number;
  93545. /**
  93546. * Texture data comes from an URL
  93547. */
  93548. static DATASOURCE_URL: number;
  93549. /**
  93550. * Texture data is only used for temporary storage
  93551. */
  93552. static DATASOURCE_TEMP: number;
  93553. /**
  93554. * Texture data comes from raw data (ArrayBuffer)
  93555. */
  93556. static DATASOURCE_RAW: number;
  93557. /**
  93558. * Texture content is dynamic (video or dynamic texture)
  93559. */
  93560. static DATASOURCE_DYNAMIC: number;
  93561. /**
  93562. * Texture content is generated by rendering to it
  93563. */
  93564. static DATASOURCE_RENDERTARGET: number;
  93565. /**
  93566. * Texture content is part of a multi render target process
  93567. */
  93568. static DATASOURCE_MULTIRENDERTARGET: number;
  93569. /**
  93570. * Texture data comes from a cube data file
  93571. */
  93572. static DATASOURCE_CUBE: number;
  93573. /**
  93574. * Texture data comes from a raw cube data
  93575. */
  93576. static DATASOURCE_CUBERAW: number;
  93577. /**
  93578. * Texture data come from a prefiltered cube data file
  93579. */
  93580. static DATASOURCE_CUBEPREFILTERED: number;
  93581. /**
  93582. * Texture content is raw 3D data
  93583. */
  93584. static DATASOURCE_RAW3D: number;
  93585. /**
  93586. * Texture content is a depth texture
  93587. */
  93588. static DATASOURCE_DEPTHTEXTURE: number;
  93589. /**
  93590. * Texture data comes from a raw cube data encoded with RGBD
  93591. */
  93592. static DATASOURCE_CUBERAW_RGBD: number;
  93593. /**
  93594. * Defines if the texture is ready
  93595. */
  93596. isReady: boolean;
  93597. /**
  93598. * Defines if the texture is a cube texture
  93599. */
  93600. isCube: boolean;
  93601. /**
  93602. * Defines if the texture contains 3D data
  93603. */
  93604. is3D: boolean;
  93605. /**
  93606. * Defines if the texture contains multiview data
  93607. */
  93608. isMultiview: boolean;
  93609. /**
  93610. * Gets the URL used to load this texture
  93611. */
  93612. url: string;
  93613. /**
  93614. * Gets the sampling mode of the texture
  93615. */
  93616. samplingMode: number;
  93617. /**
  93618. * Gets a boolean indicating if the texture needs mipmaps generation
  93619. */
  93620. generateMipMaps: boolean;
  93621. /**
  93622. * Gets the number of samples used by the texture (WebGL2+ only)
  93623. */
  93624. samples: number;
  93625. /**
  93626. * Gets the type of the texture (int, float...)
  93627. */
  93628. type: number;
  93629. /**
  93630. * Gets the format of the texture (RGB, RGBA...)
  93631. */
  93632. format: number;
  93633. /**
  93634. * Observable called when the texture is loaded
  93635. */
  93636. onLoadedObservable: Observable<InternalTexture>;
  93637. /**
  93638. * Gets the width of the texture
  93639. */
  93640. width: number;
  93641. /**
  93642. * Gets the height of the texture
  93643. */
  93644. height: number;
  93645. /**
  93646. * Gets the depth of the texture
  93647. */
  93648. depth: number;
  93649. /**
  93650. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  93651. */
  93652. baseWidth: number;
  93653. /**
  93654. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  93655. */
  93656. baseHeight: number;
  93657. /**
  93658. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  93659. */
  93660. baseDepth: number;
  93661. /**
  93662. * Gets a boolean indicating if the texture is inverted on Y axis
  93663. */
  93664. invertY: boolean;
  93665. /** @hidden */
  93666. _invertVScale: boolean;
  93667. /** @hidden */
  93668. _associatedChannel: number;
  93669. /** @hidden */
  93670. _dataSource: number;
  93671. /** @hidden */
  93672. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>;
  93673. /** @hidden */
  93674. _bufferView: Nullable<ArrayBufferView>;
  93675. /** @hidden */
  93676. _bufferViewArray: Nullable<ArrayBufferView[]>;
  93677. /** @hidden */
  93678. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  93679. /** @hidden */
  93680. _size: number;
  93681. /** @hidden */
  93682. _extension: string;
  93683. /** @hidden */
  93684. _files: Nullable<string[]>;
  93685. /** @hidden */
  93686. _workingCanvas: Nullable<HTMLCanvasElement>;
  93687. /** @hidden */
  93688. _workingContext: Nullable<CanvasRenderingContext2D>;
  93689. /** @hidden */
  93690. _framebuffer: Nullable<WebGLFramebuffer>;
  93691. /** @hidden */
  93692. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  93693. /** @hidden */
  93694. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  93695. /** @hidden */
  93696. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  93697. /** @hidden */
  93698. _attachments: Nullable<number[]>;
  93699. /** @hidden */
  93700. _cachedCoordinatesMode: Nullable<number>;
  93701. /** @hidden */
  93702. _cachedWrapU: Nullable<number>;
  93703. /** @hidden */
  93704. _cachedWrapV: Nullable<number>;
  93705. /** @hidden */
  93706. _cachedWrapR: Nullable<number>;
  93707. /** @hidden */
  93708. _cachedAnisotropicFilteringLevel: Nullable<number>;
  93709. /** @hidden */
  93710. _isDisabled: boolean;
  93711. /** @hidden */
  93712. _compression: Nullable<string>;
  93713. /** @hidden */
  93714. _generateStencilBuffer: boolean;
  93715. /** @hidden */
  93716. _generateDepthBuffer: boolean;
  93717. /** @hidden */
  93718. _comparisonFunction: number;
  93719. /** @hidden */
  93720. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  93721. /** @hidden */
  93722. _lodGenerationScale: number;
  93723. /** @hidden */
  93724. _lodGenerationOffset: number;
  93725. /** @hidden */
  93726. _colorTextureArray: Nullable<WebGLTexture>;
  93727. /** @hidden */
  93728. _depthStencilTextureArray: Nullable<WebGLTexture>;
  93729. /** @hidden */
  93730. _lodTextureHigh: Nullable<BaseTexture>;
  93731. /** @hidden */
  93732. _lodTextureMid: Nullable<BaseTexture>;
  93733. /** @hidden */
  93734. _lodTextureLow: Nullable<BaseTexture>;
  93735. /** @hidden */
  93736. _isRGBD: boolean;
  93737. /** @hidden */
  93738. _linearSpecularLOD: boolean;
  93739. /** @hidden */
  93740. _irradianceTexture: Nullable<BaseTexture>;
  93741. /** @hidden */
  93742. _webGLTexture: Nullable<WebGLTexture>;
  93743. /** @hidden */
  93744. _references: number;
  93745. private _engine;
  93746. /**
  93747. * Gets the Engine the texture belongs to.
  93748. * @returns The babylon engine
  93749. */
  93750. getEngine(): Engine;
  93751. /**
  93752. * Gets the data source type of the texture (can be one of the InternalTexture.DATASOURCE_XXXX)
  93753. */
  93754. readonly dataSource: number;
  93755. /**
  93756. * Creates a new InternalTexture
  93757. * @param engine defines the engine to use
  93758. * @param dataSource defines the type of data that will be used
  93759. * @param delayAllocation if the texture allocation should be delayed (default: false)
  93760. */
  93761. constructor(engine: Engine, dataSource: number, delayAllocation?: boolean);
  93762. /**
  93763. * Increments the number of references (ie. the number of Texture that point to it)
  93764. */
  93765. incrementReferences(): void;
  93766. /**
  93767. * Change the size of the texture (not the size of the content)
  93768. * @param width defines the new width
  93769. * @param height defines the new height
  93770. * @param depth defines the new depth (1 by default)
  93771. */
  93772. updateSize(width: int, height: int, depth?: int): void;
  93773. /** @hidden */
  93774. _rebuild(): void;
  93775. /** @hidden */
  93776. _swapAndDie(target: InternalTexture): void;
  93777. /**
  93778. * Dispose the current allocated resources
  93779. */
  93780. dispose(): void;
  93781. }
  93782. }
  93783. declare module BABYLON {
  93784. /**
  93785. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  93786. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  93787. */
  93788. export class EffectFallbacks {
  93789. private _defines;
  93790. private _currentRank;
  93791. private _maxRank;
  93792. private _mesh;
  93793. /**
  93794. * Removes the fallback from the bound mesh.
  93795. */
  93796. unBindMesh(): void;
  93797. /**
  93798. * Adds a fallback on the specified property.
  93799. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  93800. * @param define The name of the define in the shader
  93801. */
  93802. addFallback(rank: number, define: string): void;
  93803. /**
  93804. * Sets the mesh to use CPU skinning when needing to fallback.
  93805. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  93806. * @param mesh The mesh to use the fallbacks.
  93807. */
  93808. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  93809. /**
  93810. * Checks to see if more fallbacks are still availible.
  93811. */
  93812. readonly hasMoreFallbacks: boolean;
  93813. /**
  93814. * Removes the defines that should be removed when falling back.
  93815. * @param currentDefines defines the current define statements for the shader.
  93816. * @param effect defines the current effect we try to compile
  93817. * @returns The resulting defines with defines of the current rank removed.
  93818. */
  93819. reduce(currentDefines: string, effect: Effect): string;
  93820. }
  93821. /**
  93822. * Options to be used when creating an effect.
  93823. */
  93824. export class EffectCreationOptions {
  93825. /**
  93826. * Atrributes that will be used in the shader.
  93827. */
  93828. attributes: string[];
  93829. /**
  93830. * Uniform varible names that will be set in the shader.
  93831. */
  93832. uniformsNames: string[];
  93833. /**
  93834. * Uniform buffer varible names that will be set in the shader.
  93835. */
  93836. uniformBuffersNames: string[];
  93837. /**
  93838. * Sampler texture variable names that will be set in the shader.
  93839. */
  93840. samplers: string[];
  93841. /**
  93842. * Define statements that will be set in the shader.
  93843. */
  93844. defines: any;
  93845. /**
  93846. * Possible fallbacks for this effect to improve performance when needed.
  93847. */
  93848. fallbacks: Nullable<EffectFallbacks>;
  93849. /**
  93850. * Callback that will be called when the shader is compiled.
  93851. */
  93852. onCompiled: Nullable<(effect: Effect) => void>;
  93853. /**
  93854. * Callback that will be called if an error occurs during shader compilation.
  93855. */
  93856. onError: Nullable<(effect: Effect, errors: string) => void>;
  93857. /**
  93858. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  93859. */
  93860. indexParameters: any;
  93861. /**
  93862. * Max number of lights that can be used in the shader.
  93863. */
  93864. maxSimultaneousLights: number;
  93865. /**
  93866. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  93867. */
  93868. transformFeedbackVaryings: Nullable<string[]>;
  93869. }
  93870. /**
  93871. * Effect containing vertex and fragment shader that can be executed on an object.
  93872. */
  93873. export class Effect implements IDisposable {
  93874. /**
  93875. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  93876. */
  93877. static ShadersRepository: string;
  93878. /**
  93879. * Name of the effect.
  93880. */
  93881. name: any;
  93882. /**
  93883. * String container all the define statements that should be set on the shader.
  93884. */
  93885. defines: string;
  93886. /**
  93887. * Callback that will be called when the shader is compiled.
  93888. */
  93889. onCompiled: Nullable<(effect: Effect) => void>;
  93890. /**
  93891. * Callback that will be called if an error occurs during shader compilation.
  93892. */
  93893. onError: Nullable<(effect: Effect, errors: string) => void>;
  93894. /**
  93895. * Callback that will be called when effect is bound.
  93896. */
  93897. onBind: Nullable<(effect: Effect) => void>;
  93898. /**
  93899. * Unique ID of the effect.
  93900. */
  93901. uniqueId: number;
  93902. /**
  93903. * Observable that will be called when the shader is compiled.
  93904. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  93905. */
  93906. onCompileObservable: Observable<Effect>;
  93907. /**
  93908. * Observable that will be called if an error occurs during shader compilation.
  93909. */
  93910. onErrorObservable: Observable<Effect>;
  93911. /** @hidden */
  93912. _onBindObservable: Nullable<Observable<Effect>>;
  93913. /**
  93914. * Observable that will be called when effect is bound.
  93915. */
  93916. readonly onBindObservable: Observable<Effect>;
  93917. /** @hidden */
  93918. _bonesComputationForcedToCPU: boolean;
  93919. private static _uniqueIdSeed;
  93920. private _engine;
  93921. private _uniformBuffersNames;
  93922. private _uniformsNames;
  93923. private _samplerList;
  93924. private _samplers;
  93925. private _isReady;
  93926. private _compilationError;
  93927. private _attributesNames;
  93928. private _attributes;
  93929. private _uniforms;
  93930. /**
  93931. * Key for the effect.
  93932. * @hidden
  93933. */
  93934. _key: string;
  93935. private _indexParameters;
  93936. private _fallbacks;
  93937. private _vertexSourceCode;
  93938. private _fragmentSourceCode;
  93939. private _vertexSourceCodeOverride;
  93940. private _fragmentSourceCodeOverride;
  93941. private _transformFeedbackVaryings;
  93942. /**
  93943. * Compiled shader to webGL program.
  93944. * @hidden
  93945. */
  93946. _pipelineContext: Nullable<IPipelineContext>;
  93947. private _valueCache;
  93948. private static _baseCache;
  93949. /**
  93950. * Instantiates an effect.
  93951. * An effect can be used to create/manage/execute vertex and fragment shaders.
  93952. * @param baseName Name of the effect.
  93953. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  93954. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  93955. * @param samplers List of sampler variables that will be passed to the shader.
  93956. * @param engine Engine to be used to render the effect
  93957. * @param defines Define statements to be added to the shader.
  93958. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  93959. * @param onCompiled Callback that will be called when the shader is compiled.
  93960. * @param onError Callback that will be called if an error occurs during shader compilation.
  93961. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  93962. */
  93963. constructor(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: Nullable<string[]>, engine?: Engine, defines?: Nullable<string>, fallbacks?: Nullable<EffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  93964. private _useFinalCode;
  93965. /**
  93966. * Unique key for this effect
  93967. */
  93968. readonly key: string;
  93969. /**
  93970. * If the effect has been compiled and prepared.
  93971. * @returns if the effect is compiled and prepared.
  93972. */
  93973. isReady(): boolean;
  93974. private _isReadyInternal;
  93975. /**
  93976. * The engine the effect was initialized with.
  93977. * @returns the engine.
  93978. */
  93979. getEngine(): Engine;
  93980. /**
  93981. * The pipeline context for this effect
  93982. * @returns the associated pipeline context
  93983. */
  93984. getPipelineContext(): Nullable<IPipelineContext>;
  93985. /**
  93986. * The set of names of attribute variables for the shader.
  93987. * @returns An array of attribute names.
  93988. */
  93989. getAttributesNames(): string[];
  93990. /**
  93991. * Returns the attribute at the given index.
  93992. * @param index The index of the attribute.
  93993. * @returns The location of the attribute.
  93994. */
  93995. getAttributeLocation(index: number): number;
  93996. /**
  93997. * Returns the attribute based on the name of the variable.
  93998. * @param name of the attribute to look up.
  93999. * @returns the attribute location.
  94000. */
  94001. getAttributeLocationByName(name: string): number;
  94002. /**
  94003. * The number of attributes.
  94004. * @returns the numnber of attributes.
  94005. */
  94006. getAttributesCount(): number;
  94007. /**
  94008. * Gets the index of a uniform variable.
  94009. * @param uniformName of the uniform to look up.
  94010. * @returns the index.
  94011. */
  94012. getUniformIndex(uniformName: string): number;
  94013. /**
  94014. * Returns the attribute based on the name of the variable.
  94015. * @param uniformName of the uniform to look up.
  94016. * @returns the location of the uniform.
  94017. */
  94018. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  94019. /**
  94020. * Returns an array of sampler variable names
  94021. * @returns The array of sampler variable neames.
  94022. */
  94023. getSamplers(): string[];
  94024. /**
  94025. * The error from the last compilation.
  94026. * @returns the error string.
  94027. */
  94028. getCompilationError(): string;
  94029. /**
  94030. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  94031. * @param func The callback to be used.
  94032. */
  94033. executeWhenCompiled(func: (effect: Effect) => void): void;
  94034. private _checkIsReady;
  94035. /** @hidden */
  94036. _loadVertexShader(vertex: any, callback: (data: any) => void): void;
  94037. /** @hidden */
  94038. _loadFragmentShader(fragment: any, callback: (data: any) => void): void;
  94039. /** @hidden */
  94040. _dumpShadersSource(vertexCode: string, fragmentCode: string, defines: string): void;
  94041. /**
  94042. * Recompiles the webGL program
  94043. * @param vertexSourceCode The source code for the vertex shader.
  94044. * @param fragmentSourceCode The source code for the fragment shader.
  94045. * @param onCompiled Callback called when completed.
  94046. * @param onError Callback called on error.
  94047. * @hidden
  94048. */
  94049. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  94050. /**
  94051. * Prepares the effect
  94052. * @hidden
  94053. */
  94054. _prepareEffect(): void;
  94055. private _processCompilationErrors;
  94056. /**
  94057. * Checks if the effect is supported. (Must be called after compilation)
  94058. */
  94059. readonly isSupported: boolean;
  94060. /**
  94061. * Binds a texture to the engine to be used as output of the shader.
  94062. * @param channel Name of the output variable.
  94063. * @param texture Texture to bind.
  94064. * @hidden
  94065. */
  94066. _bindTexture(channel: string, texture: InternalTexture): void;
  94067. /**
  94068. * Sets a texture on the engine to be used in the shader.
  94069. * @param channel Name of the sampler variable.
  94070. * @param texture Texture to set.
  94071. */
  94072. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  94073. /**
  94074. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  94075. * @param channel Name of the sampler variable.
  94076. * @param texture Texture to set.
  94077. */
  94078. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  94079. /**
  94080. * Sets an array of textures on the engine to be used in the shader.
  94081. * @param channel Name of the variable.
  94082. * @param textures Textures to set.
  94083. */
  94084. setTextureArray(channel: string, textures: BaseTexture[]): void;
  94085. /**
  94086. * 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)
  94087. * @param channel Name of the sampler variable.
  94088. * @param postProcess Post process to get the input texture from.
  94089. */
  94090. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  94091. /**
  94092. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  94093. * 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)
  94094. * @param channel Name of the sampler variable.
  94095. * @param postProcess Post process to get the output texture from.
  94096. */
  94097. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  94098. /** @hidden */
  94099. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  94100. /** @hidden */
  94101. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  94102. /** @hidden */
  94103. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  94104. /** @hidden */
  94105. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  94106. /**
  94107. * Binds a buffer to a uniform.
  94108. * @param buffer Buffer to bind.
  94109. * @param name Name of the uniform variable to bind to.
  94110. */
  94111. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  94112. /**
  94113. * Binds block to a uniform.
  94114. * @param blockName Name of the block to bind.
  94115. * @param index Index to bind.
  94116. */
  94117. bindUniformBlock(blockName: string, index: number): void;
  94118. /**
  94119. * Sets an interger value on a uniform variable.
  94120. * @param uniformName Name of the variable.
  94121. * @param value Value to be set.
  94122. * @returns this effect.
  94123. */
  94124. setInt(uniformName: string, value: number): Effect;
  94125. /**
  94126. * Sets an int array on a uniform variable.
  94127. * @param uniformName Name of the variable.
  94128. * @param array array to be set.
  94129. * @returns this effect.
  94130. */
  94131. setIntArray(uniformName: string, array: Int32Array): Effect;
  94132. /**
  94133. * 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)
  94134. * @param uniformName Name of the variable.
  94135. * @param array array to be set.
  94136. * @returns this effect.
  94137. */
  94138. setIntArray2(uniformName: string, array: Int32Array): Effect;
  94139. /**
  94140. * 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)
  94141. * @param uniformName Name of the variable.
  94142. * @param array array to be set.
  94143. * @returns this effect.
  94144. */
  94145. setIntArray3(uniformName: string, array: Int32Array): Effect;
  94146. /**
  94147. * 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)
  94148. * @param uniformName Name of the variable.
  94149. * @param array array to be set.
  94150. * @returns this effect.
  94151. */
  94152. setIntArray4(uniformName: string, array: Int32Array): Effect;
  94153. /**
  94154. * Sets an float array on a uniform variable.
  94155. * @param uniformName Name of the variable.
  94156. * @param array array to be set.
  94157. * @returns this effect.
  94158. */
  94159. setFloatArray(uniformName: string, array: Float32Array): Effect;
  94160. /**
  94161. * 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)
  94162. * @param uniformName Name of the variable.
  94163. * @param array array to be set.
  94164. * @returns this effect.
  94165. */
  94166. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  94167. /**
  94168. * 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)
  94169. * @param uniformName Name of the variable.
  94170. * @param array array to be set.
  94171. * @returns this effect.
  94172. */
  94173. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  94174. /**
  94175. * 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)
  94176. * @param uniformName Name of the variable.
  94177. * @param array array to be set.
  94178. * @returns this effect.
  94179. */
  94180. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  94181. /**
  94182. * Sets an array on a uniform variable.
  94183. * @param uniformName Name of the variable.
  94184. * @param array array to be set.
  94185. * @returns this effect.
  94186. */
  94187. setArray(uniformName: string, array: number[]): Effect;
  94188. /**
  94189. * 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)
  94190. * @param uniformName Name of the variable.
  94191. * @param array array to be set.
  94192. * @returns this effect.
  94193. */
  94194. setArray2(uniformName: string, array: number[]): Effect;
  94195. /**
  94196. * 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)
  94197. * @param uniformName Name of the variable.
  94198. * @param array array to be set.
  94199. * @returns this effect.
  94200. */
  94201. setArray3(uniformName: string, array: number[]): Effect;
  94202. /**
  94203. * 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)
  94204. * @param uniformName Name of the variable.
  94205. * @param array array to be set.
  94206. * @returns this effect.
  94207. */
  94208. setArray4(uniformName: string, array: number[]): Effect;
  94209. /**
  94210. * Sets matrices on a uniform variable.
  94211. * @param uniformName Name of the variable.
  94212. * @param matrices matrices to be set.
  94213. * @returns this effect.
  94214. */
  94215. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  94216. /**
  94217. * Sets matrix on a uniform variable.
  94218. * @param uniformName Name of the variable.
  94219. * @param matrix matrix to be set.
  94220. * @returns this effect.
  94221. */
  94222. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  94223. /**
  94224. * 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)
  94225. * @param uniformName Name of the variable.
  94226. * @param matrix matrix to be set.
  94227. * @returns this effect.
  94228. */
  94229. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  94230. /**
  94231. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  94232. * @param uniformName Name of the variable.
  94233. * @param matrix matrix to be set.
  94234. * @returns this effect.
  94235. */
  94236. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  94237. /**
  94238. * Sets a float on a uniform variable.
  94239. * @param uniformName Name of the variable.
  94240. * @param value value to be set.
  94241. * @returns this effect.
  94242. */
  94243. setFloat(uniformName: string, value: number): Effect;
  94244. /**
  94245. * Sets a boolean on a uniform variable.
  94246. * @param uniformName Name of the variable.
  94247. * @param bool value to be set.
  94248. * @returns this effect.
  94249. */
  94250. setBool(uniformName: string, bool: boolean): Effect;
  94251. /**
  94252. * Sets a Vector2 on a uniform variable.
  94253. * @param uniformName Name of the variable.
  94254. * @param vector2 vector2 to be set.
  94255. * @returns this effect.
  94256. */
  94257. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  94258. /**
  94259. * Sets a float2 on a uniform variable.
  94260. * @param uniformName Name of the variable.
  94261. * @param x First float in float2.
  94262. * @param y Second float in float2.
  94263. * @returns this effect.
  94264. */
  94265. setFloat2(uniformName: string, x: number, y: number): Effect;
  94266. /**
  94267. * Sets a Vector3 on a uniform variable.
  94268. * @param uniformName Name of the variable.
  94269. * @param vector3 Value to be set.
  94270. * @returns this effect.
  94271. */
  94272. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  94273. /**
  94274. * Sets a float3 on a uniform variable.
  94275. * @param uniformName Name of the variable.
  94276. * @param x First float in float3.
  94277. * @param y Second float in float3.
  94278. * @param z Third float in float3.
  94279. * @returns this effect.
  94280. */
  94281. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  94282. /**
  94283. * Sets a Vector4 on a uniform variable.
  94284. * @param uniformName Name of the variable.
  94285. * @param vector4 Value to be set.
  94286. * @returns this effect.
  94287. */
  94288. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  94289. /**
  94290. * Sets a float4 on a uniform variable.
  94291. * @param uniformName Name of the variable.
  94292. * @param x First float in float4.
  94293. * @param y Second float in float4.
  94294. * @param z Third float in float4.
  94295. * @param w Fourth float in float4.
  94296. * @returns this effect.
  94297. */
  94298. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  94299. /**
  94300. * Sets a Color3 on a uniform variable.
  94301. * @param uniformName Name of the variable.
  94302. * @param color3 Value to be set.
  94303. * @returns this effect.
  94304. */
  94305. setColor3(uniformName: string, color3: IColor3Like): Effect;
  94306. /**
  94307. * Sets a Color4 on a uniform variable.
  94308. * @param uniformName Name of the variable.
  94309. * @param color3 Value to be set.
  94310. * @param alpha Alpha value to be set.
  94311. * @returns this effect.
  94312. */
  94313. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  94314. /**
  94315. * Sets a Color4 on a uniform variable
  94316. * @param uniformName defines the name of the variable
  94317. * @param color4 defines the value to be set
  94318. * @returns this effect.
  94319. */
  94320. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  94321. /** Release all associated resources */
  94322. dispose(): void;
  94323. /**
  94324. * This function will add a new shader to the shader store
  94325. * @param name the name of the shader
  94326. * @param pixelShader optional pixel shader content
  94327. * @param vertexShader optional vertex shader content
  94328. */
  94329. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  94330. /**
  94331. * Store of each shader (The can be looked up using effect.key)
  94332. */
  94333. static ShadersStore: {
  94334. [key: string]: string;
  94335. };
  94336. /**
  94337. * Store of each included file for a shader (The can be looked up using effect.key)
  94338. */
  94339. static IncludesShadersStore: {
  94340. [key: string]: string;
  94341. };
  94342. /**
  94343. * Resets the cache of effects.
  94344. */
  94345. static ResetCache(): void;
  94346. }
  94347. }
  94348. declare module BABYLON {
  94349. /**
  94350. * Uniform buffer objects.
  94351. *
  94352. * Handles blocks of uniform on the GPU.
  94353. *
  94354. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  94355. *
  94356. * For more information, please refer to :
  94357. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  94358. */
  94359. export class UniformBuffer {
  94360. private _engine;
  94361. private _buffer;
  94362. private _data;
  94363. private _bufferData;
  94364. private _dynamic?;
  94365. private _uniformLocations;
  94366. private _uniformSizes;
  94367. private _uniformLocationPointer;
  94368. private _needSync;
  94369. private _noUBO;
  94370. private _currentEffect;
  94371. private static _MAX_UNIFORM_SIZE;
  94372. private static _tempBuffer;
  94373. /**
  94374. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  94375. * This is dynamic to allow compat with webgl 1 and 2.
  94376. * You will need to pass the name of the uniform as well as the value.
  94377. */
  94378. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  94379. /**
  94380. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  94381. * This is dynamic to allow compat with webgl 1 and 2.
  94382. * You will need to pass the name of the uniform as well as the value.
  94383. */
  94384. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  94385. /**
  94386. * Lambda to Update a single float in a uniform buffer.
  94387. * This is dynamic to allow compat with webgl 1 and 2.
  94388. * You will need to pass the name of the uniform as well as the value.
  94389. */
  94390. updateFloat: (name: string, x: number) => void;
  94391. /**
  94392. * Lambda to Update a vec2 of float in a uniform buffer.
  94393. * This is dynamic to allow compat with webgl 1 and 2.
  94394. * You will need to pass the name of the uniform as well as the value.
  94395. */
  94396. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  94397. /**
  94398. * Lambda to Update a vec3 of float in a uniform buffer.
  94399. * This is dynamic to allow compat with webgl 1 and 2.
  94400. * You will need to pass the name of the uniform as well as the value.
  94401. */
  94402. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  94403. /**
  94404. * Lambda to Update a vec4 of float in a uniform buffer.
  94405. * This is dynamic to allow compat with webgl 1 and 2.
  94406. * You will need to pass the name of the uniform as well as the value.
  94407. */
  94408. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  94409. /**
  94410. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  94411. * This is dynamic to allow compat with webgl 1 and 2.
  94412. * You will need to pass the name of the uniform as well as the value.
  94413. */
  94414. updateMatrix: (name: string, mat: Matrix) => void;
  94415. /**
  94416. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  94417. * This is dynamic to allow compat with webgl 1 and 2.
  94418. * You will need to pass the name of the uniform as well as the value.
  94419. */
  94420. updateVector3: (name: string, vector: Vector3) => void;
  94421. /**
  94422. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  94423. * This is dynamic to allow compat with webgl 1 and 2.
  94424. * You will need to pass the name of the uniform as well as the value.
  94425. */
  94426. updateVector4: (name: string, vector: Vector4) => void;
  94427. /**
  94428. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  94429. * This is dynamic to allow compat with webgl 1 and 2.
  94430. * You will need to pass the name of the uniform as well as the value.
  94431. */
  94432. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  94433. /**
  94434. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  94435. * This is dynamic to allow compat with webgl 1 and 2.
  94436. * You will need to pass the name of the uniform as well as the value.
  94437. */
  94438. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  94439. /**
  94440. * Instantiates a new Uniform buffer objects.
  94441. *
  94442. * Handles blocks of uniform on the GPU.
  94443. *
  94444. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  94445. *
  94446. * For more information, please refer to :
  94447. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  94448. * @param engine Define the engine the buffer is associated with
  94449. * @param data Define the data contained in the buffer
  94450. * @param dynamic Define if the buffer is updatable
  94451. */
  94452. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  94453. /**
  94454. * Indicates if the buffer is using the WebGL2 UBO implementation,
  94455. * or just falling back on setUniformXXX calls.
  94456. */
  94457. readonly useUbo: boolean;
  94458. /**
  94459. * Indicates if the WebGL underlying uniform buffer is in sync
  94460. * with the javascript cache data.
  94461. */
  94462. readonly isSync: boolean;
  94463. /**
  94464. * Indicates if the WebGL underlying uniform buffer is dynamic.
  94465. * Also, a dynamic UniformBuffer will disable cache verification and always
  94466. * update the underlying WebGL uniform buffer to the GPU.
  94467. * @returns if Dynamic, otherwise false
  94468. */
  94469. isDynamic(): boolean;
  94470. /**
  94471. * The data cache on JS side.
  94472. * @returns the underlying data as a float array
  94473. */
  94474. getData(): Float32Array;
  94475. /**
  94476. * The underlying WebGL Uniform buffer.
  94477. * @returns the webgl buffer
  94478. */
  94479. getBuffer(): Nullable<DataBuffer>;
  94480. /**
  94481. * std140 layout specifies how to align data within an UBO structure.
  94482. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  94483. * for specs.
  94484. */
  94485. private _fillAlignment;
  94486. /**
  94487. * Adds an uniform in the buffer.
  94488. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  94489. * for the layout to be correct !
  94490. * @param name Name of the uniform, as used in the uniform block in the shader.
  94491. * @param size Data size, or data directly.
  94492. */
  94493. addUniform(name: string, size: number | number[]): void;
  94494. /**
  94495. * Adds a Matrix 4x4 to the uniform buffer.
  94496. * @param name Name of the uniform, as used in the uniform block in the shader.
  94497. * @param mat A 4x4 matrix.
  94498. */
  94499. addMatrix(name: string, mat: Matrix): void;
  94500. /**
  94501. * Adds a vec2 to the uniform buffer.
  94502. * @param name Name of the uniform, as used in the uniform block in the shader.
  94503. * @param x Define the x component value of the vec2
  94504. * @param y Define the y component value of the vec2
  94505. */
  94506. addFloat2(name: string, x: number, y: number): void;
  94507. /**
  94508. * Adds a vec3 to the uniform buffer.
  94509. * @param name Name of the uniform, as used in the uniform block in the shader.
  94510. * @param x Define the x component value of the vec3
  94511. * @param y Define the y component value of the vec3
  94512. * @param z Define the z component value of the vec3
  94513. */
  94514. addFloat3(name: string, x: number, y: number, z: number): void;
  94515. /**
  94516. * Adds a vec3 to the uniform buffer.
  94517. * @param name Name of the uniform, as used in the uniform block in the shader.
  94518. * @param color Define the vec3 from a Color
  94519. */
  94520. addColor3(name: string, color: Color3): void;
  94521. /**
  94522. * Adds a vec4 to the uniform buffer.
  94523. * @param name Name of the uniform, as used in the uniform block in the shader.
  94524. * @param color Define the rgb components from a Color
  94525. * @param alpha Define the a component of the vec4
  94526. */
  94527. addColor4(name: string, color: Color3, alpha: number): void;
  94528. /**
  94529. * Adds a vec3 to the uniform buffer.
  94530. * @param name Name of the uniform, as used in the uniform block in the shader.
  94531. * @param vector Define the vec3 components from a Vector
  94532. */
  94533. addVector3(name: string, vector: Vector3): void;
  94534. /**
  94535. * Adds a Matrix 3x3 to the uniform buffer.
  94536. * @param name Name of the uniform, as used in the uniform block in the shader.
  94537. */
  94538. addMatrix3x3(name: string): void;
  94539. /**
  94540. * Adds a Matrix 2x2 to the uniform buffer.
  94541. * @param name Name of the uniform, as used in the uniform block in the shader.
  94542. */
  94543. addMatrix2x2(name: string): void;
  94544. /**
  94545. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  94546. */
  94547. create(): void;
  94548. /** @hidden */
  94549. _rebuild(): void;
  94550. /**
  94551. * Updates the WebGL Uniform Buffer on the GPU.
  94552. * If the `dynamic` flag is set to true, no cache comparison is done.
  94553. * Otherwise, the buffer will be updated only if the cache differs.
  94554. */
  94555. update(): void;
  94556. /**
  94557. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  94558. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  94559. * @param data Define the flattened data
  94560. * @param size Define the size of the data.
  94561. */
  94562. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  94563. private _valueCache;
  94564. private _cacheMatrix;
  94565. private _updateMatrix3x3ForUniform;
  94566. private _updateMatrix3x3ForEffect;
  94567. private _updateMatrix2x2ForEffect;
  94568. private _updateMatrix2x2ForUniform;
  94569. private _updateFloatForEffect;
  94570. private _updateFloatForUniform;
  94571. private _updateFloat2ForEffect;
  94572. private _updateFloat2ForUniform;
  94573. private _updateFloat3ForEffect;
  94574. private _updateFloat3ForUniform;
  94575. private _updateFloat4ForEffect;
  94576. private _updateFloat4ForUniform;
  94577. private _updateMatrixForEffect;
  94578. private _updateMatrixForUniform;
  94579. private _updateVector3ForEffect;
  94580. private _updateVector3ForUniform;
  94581. private _updateVector4ForEffect;
  94582. private _updateVector4ForUniform;
  94583. private _updateColor3ForEffect;
  94584. private _updateColor3ForUniform;
  94585. private _updateColor4ForEffect;
  94586. private _updateColor4ForUniform;
  94587. /**
  94588. * Sets a sampler uniform on the effect.
  94589. * @param name Define the name of the sampler.
  94590. * @param texture Define the texture to set in the sampler
  94591. */
  94592. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  94593. /**
  94594. * Directly updates the value of the uniform in the cache AND on the GPU.
  94595. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  94596. * @param data Define the flattened data
  94597. */
  94598. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  94599. /**
  94600. * Binds this uniform buffer to an effect.
  94601. * @param effect Define the effect to bind the buffer to
  94602. * @param name Name of the uniform block in the shader.
  94603. */
  94604. bindToEffect(effect: Effect, name: string): void;
  94605. /**
  94606. * Disposes the uniform buffer.
  94607. */
  94608. dispose(): void;
  94609. }
  94610. }
  94611. declare module BABYLON {
  94612. /**
  94613. * Class used to work with sound analyzer using fast fourier transform (FFT)
  94614. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  94615. */
  94616. export class Analyser {
  94617. /**
  94618. * Gets or sets the smoothing
  94619. * @ignorenaming
  94620. */
  94621. SMOOTHING: number;
  94622. /**
  94623. * Gets or sets the FFT table size
  94624. * @ignorenaming
  94625. */
  94626. FFT_SIZE: number;
  94627. /**
  94628. * Gets or sets the bar graph amplitude
  94629. * @ignorenaming
  94630. */
  94631. BARGRAPHAMPLITUDE: number;
  94632. /**
  94633. * Gets or sets the position of the debug canvas
  94634. * @ignorenaming
  94635. */
  94636. DEBUGCANVASPOS: {
  94637. x: number;
  94638. y: number;
  94639. };
  94640. /**
  94641. * Gets or sets the debug canvas size
  94642. * @ignorenaming
  94643. */
  94644. DEBUGCANVASSIZE: {
  94645. width: number;
  94646. height: number;
  94647. };
  94648. private _byteFreqs;
  94649. private _byteTime;
  94650. private _floatFreqs;
  94651. private _webAudioAnalyser;
  94652. private _debugCanvas;
  94653. private _debugCanvasContext;
  94654. private _scene;
  94655. private _registerFunc;
  94656. private _audioEngine;
  94657. /**
  94658. * Creates a new analyser
  94659. * @param scene defines hosting scene
  94660. */
  94661. constructor(scene: Scene);
  94662. /**
  94663. * Get the number of data values you will have to play with for the visualization
  94664. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  94665. * @returns a number
  94666. */
  94667. getFrequencyBinCount(): number;
  94668. /**
  94669. * Gets the current frequency data as a byte array
  94670. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  94671. * @returns a Uint8Array
  94672. */
  94673. getByteFrequencyData(): Uint8Array;
  94674. /**
  94675. * Gets the current waveform as a byte array
  94676. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  94677. * @returns a Uint8Array
  94678. */
  94679. getByteTimeDomainData(): Uint8Array;
  94680. /**
  94681. * Gets the current frequency data as a float array
  94682. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  94683. * @returns a Float32Array
  94684. */
  94685. getFloatFrequencyData(): Float32Array;
  94686. /**
  94687. * Renders the debug canvas
  94688. */
  94689. drawDebugCanvas(): void;
  94690. /**
  94691. * Stops rendering the debug canvas and removes it
  94692. */
  94693. stopDebugCanvas(): void;
  94694. /**
  94695. * Connects two audio nodes
  94696. * @param inputAudioNode defines first node to connect
  94697. * @param outputAudioNode defines second node to connect
  94698. */
  94699. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  94700. /**
  94701. * Releases all associated resources
  94702. */
  94703. dispose(): void;
  94704. }
  94705. }
  94706. declare module BABYLON {
  94707. /**
  94708. * This represents an audio engine and it is responsible
  94709. * to play, synchronize and analyse sounds throughout the application.
  94710. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  94711. */
  94712. export interface IAudioEngine extends IDisposable {
  94713. /**
  94714. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  94715. */
  94716. readonly canUseWebAudio: boolean;
  94717. /**
  94718. * Gets the current AudioContext if available.
  94719. */
  94720. readonly audioContext: Nullable<AudioContext>;
  94721. /**
  94722. * The master gain node defines the global audio volume of your audio engine.
  94723. */
  94724. readonly masterGain: GainNode;
  94725. /**
  94726. * Gets whether or not mp3 are supported by your browser.
  94727. */
  94728. readonly isMP3supported: boolean;
  94729. /**
  94730. * Gets whether or not ogg are supported by your browser.
  94731. */
  94732. readonly isOGGsupported: boolean;
  94733. /**
  94734. * Defines if Babylon should emit a warning if WebAudio is not supported.
  94735. * @ignoreNaming
  94736. */
  94737. WarnedWebAudioUnsupported: boolean;
  94738. /**
  94739. * Defines if the audio engine relies on a custom unlocked button.
  94740. * In this case, the embedded button will not be displayed.
  94741. */
  94742. useCustomUnlockedButton: boolean;
  94743. /**
  94744. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  94745. */
  94746. readonly unlocked: boolean;
  94747. /**
  94748. * Event raised when audio has been unlocked on the browser.
  94749. */
  94750. onAudioUnlockedObservable: Observable<AudioEngine>;
  94751. /**
  94752. * Event raised when audio has been locked on the browser.
  94753. */
  94754. onAudioLockedObservable: Observable<AudioEngine>;
  94755. /**
  94756. * Flags the audio engine in Locked state.
  94757. * This happens due to new browser policies preventing audio to autoplay.
  94758. */
  94759. lock(): void;
  94760. /**
  94761. * Unlocks the audio engine once a user action has been done on the dom.
  94762. * This is helpful to resume play once browser policies have been satisfied.
  94763. */
  94764. unlock(): void;
  94765. }
  94766. /**
  94767. * This represents the default audio engine used in babylon.
  94768. * It is responsible to play, synchronize and analyse sounds throughout the application.
  94769. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  94770. */
  94771. export class AudioEngine implements IAudioEngine {
  94772. private _audioContext;
  94773. private _audioContextInitialized;
  94774. private _muteButton;
  94775. private _hostElement;
  94776. /**
  94777. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  94778. */
  94779. canUseWebAudio: boolean;
  94780. /**
  94781. * The master gain node defines the global audio volume of your audio engine.
  94782. */
  94783. masterGain: GainNode;
  94784. /**
  94785. * Defines if Babylon should emit a warning if WebAudio is not supported.
  94786. * @ignoreNaming
  94787. */
  94788. WarnedWebAudioUnsupported: boolean;
  94789. /**
  94790. * Gets whether or not mp3 are supported by your browser.
  94791. */
  94792. isMP3supported: boolean;
  94793. /**
  94794. * Gets whether or not ogg are supported by your browser.
  94795. */
  94796. isOGGsupported: boolean;
  94797. /**
  94798. * Gets whether audio has been unlocked on the device.
  94799. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  94800. * a user interaction has happened.
  94801. */
  94802. unlocked: boolean;
  94803. /**
  94804. * Defines if the audio engine relies on a custom unlocked button.
  94805. * In this case, the embedded button will not be displayed.
  94806. */
  94807. useCustomUnlockedButton: boolean;
  94808. /**
  94809. * Event raised when audio has been unlocked on the browser.
  94810. */
  94811. onAudioUnlockedObservable: Observable<AudioEngine>;
  94812. /**
  94813. * Event raised when audio has been locked on the browser.
  94814. */
  94815. onAudioLockedObservable: Observable<AudioEngine>;
  94816. /**
  94817. * Gets the current AudioContext if available.
  94818. */
  94819. readonly audioContext: Nullable<AudioContext>;
  94820. private _connectedAnalyser;
  94821. /**
  94822. * Instantiates a new audio engine.
  94823. *
  94824. * There should be only one per page as some browsers restrict the number
  94825. * of audio contexts you can create.
  94826. * @param hostElement defines the host element where to display the mute icon if necessary
  94827. */
  94828. constructor(hostElement?: Nullable<HTMLElement>);
  94829. /**
  94830. * Flags the audio engine in Locked state.
  94831. * This happens due to new browser policies preventing audio to autoplay.
  94832. */
  94833. lock(): void;
  94834. /**
  94835. * Unlocks the audio engine once a user action has been done on the dom.
  94836. * This is helpful to resume play once browser policies have been satisfied.
  94837. */
  94838. unlock(): void;
  94839. private _resumeAudioContext;
  94840. private _initializeAudioContext;
  94841. private _tryToRun;
  94842. private _triggerRunningState;
  94843. private _triggerSuspendedState;
  94844. private _displayMuteButton;
  94845. private _moveButtonToTopLeft;
  94846. private _onResize;
  94847. private _hideMuteButton;
  94848. /**
  94849. * Destroy and release the resources associated with the audio ccontext.
  94850. */
  94851. dispose(): void;
  94852. /**
  94853. * Gets the global volume sets on the master gain.
  94854. * @returns the global volume if set or -1 otherwise
  94855. */
  94856. getGlobalVolume(): number;
  94857. /**
  94858. * Sets the global volume of your experience (sets on the master gain).
  94859. * @param newVolume Defines the new global volume of the application
  94860. */
  94861. setGlobalVolume(newVolume: number): void;
  94862. /**
  94863. * Connect the audio engine to an audio analyser allowing some amazing
  94864. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  94865. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  94866. * @param analyser The analyser to connect to the engine
  94867. */
  94868. connectToAnalyser(analyser: Analyser): void;
  94869. }
  94870. }
  94871. declare module BABYLON {
  94872. /**
  94873. * Interface used to present a loading screen while loading a scene
  94874. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  94875. */
  94876. export interface ILoadingScreen {
  94877. /**
  94878. * Function called to display the loading screen
  94879. */
  94880. displayLoadingUI: () => void;
  94881. /**
  94882. * Function called to hide the loading screen
  94883. */
  94884. hideLoadingUI: () => void;
  94885. /**
  94886. * Gets or sets the color to use for the background
  94887. */
  94888. loadingUIBackgroundColor: string;
  94889. /**
  94890. * Gets or sets the text to display while loading
  94891. */
  94892. loadingUIText: string;
  94893. }
  94894. /**
  94895. * Class used for the default loading screen
  94896. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  94897. */
  94898. export class DefaultLoadingScreen implements ILoadingScreen {
  94899. private _renderingCanvas;
  94900. private _loadingText;
  94901. private _loadingDivBackgroundColor;
  94902. private _loadingDiv;
  94903. private _loadingTextDiv;
  94904. /** Gets or sets the logo url to use for the default loading screen */
  94905. static DefaultLogoUrl: string;
  94906. /** Gets or sets the spinner url to use for the default loading screen */
  94907. static DefaultSpinnerUrl: string;
  94908. /**
  94909. * Creates a new default loading screen
  94910. * @param _renderingCanvas defines the canvas used to render the scene
  94911. * @param _loadingText defines the default text to display
  94912. * @param _loadingDivBackgroundColor defines the default background color
  94913. */
  94914. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  94915. /**
  94916. * Function called to display the loading screen
  94917. */
  94918. displayLoadingUI(): void;
  94919. /**
  94920. * Function called to hide the loading screen
  94921. */
  94922. hideLoadingUI(): void;
  94923. /**
  94924. * Gets or sets the text to display while loading
  94925. */
  94926. loadingUIText: string;
  94927. /**
  94928. * Gets or sets the color to use for the background
  94929. */
  94930. loadingUIBackgroundColor: string;
  94931. private _resizeLoadingUI;
  94932. }
  94933. }
  94934. declare module BABYLON {
  94935. /** @hidden */
  94936. export class WebGLPipelineContext implements IPipelineContext {
  94937. engine: Engine;
  94938. program: Nullable<WebGLProgram>;
  94939. context?: WebGLRenderingContext;
  94940. vertexShader?: WebGLShader;
  94941. fragmentShader?: WebGLShader;
  94942. isParallelCompiled: boolean;
  94943. onCompiled?: () => void;
  94944. transformFeedback?: WebGLTransformFeedback | null;
  94945. readonly isAsync: boolean;
  94946. readonly isReady: boolean;
  94947. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  94948. }
  94949. }
  94950. declare module BABYLON {
  94951. /** @hidden */
  94952. export class WebGLDataBuffer extends DataBuffer {
  94953. private _buffer;
  94954. constructor(resource: WebGLBuffer);
  94955. readonly underlyingResource: any;
  94956. }
  94957. }
  94958. declare module BABYLON {
  94959. /** @hidden */
  94960. export class WebGL2ShaderProcessor implements IShaderProcessor {
  94961. attributeProcessor(attribute: string): string;
  94962. varyingProcessor(varying: string, isFragment: boolean): string;
  94963. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  94964. }
  94965. }
  94966. declare module BABYLON {
  94967. /**
  94968. * This class is used to track a performance counter which is number based.
  94969. * The user has access to many properties which give statistics of different nature.
  94970. *
  94971. * The implementer can track two kinds of Performance Counter: time and count.
  94972. * 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.
  94973. * 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.
  94974. */
  94975. export class PerfCounter {
  94976. /**
  94977. * Gets or sets a global boolean to turn on and off all the counters
  94978. */
  94979. static Enabled: boolean;
  94980. /**
  94981. * Returns the smallest value ever
  94982. */
  94983. readonly min: number;
  94984. /**
  94985. * Returns the biggest value ever
  94986. */
  94987. readonly max: number;
  94988. /**
  94989. * Returns the average value since the performance counter is running
  94990. */
  94991. readonly average: number;
  94992. /**
  94993. * Returns the average value of the last second the counter was monitored
  94994. */
  94995. readonly lastSecAverage: number;
  94996. /**
  94997. * Returns the current value
  94998. */
  94999. readonly current: number;
  95000. /**
  95001. * Gets the accumulated total
  95002. */
  95003. readonly total: number;
  95004. /**
  95005. * Gets the total value count
  95006. */
  95007. readonly count: number;
  95008. /**
  95009. * Creates a new counter
  95010. */
  95011. constructor();
  95012. /**
  95013. * Call this method to start monitoring a new frame.
  95014. * 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.
  95015. */
  95016. fetchNewFrame(): void;
  95017. /**
  95018. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  95019. * @param newCount the count value to add to the monitored count
  95020. * @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.
  95021. */
  95022. addCount(newCount: number, fetchResult: boolean): void;
  95023. /**
  95024. * Start monitoring this performance counter
  95025. */
  95026. beginMonitoring(): void;
  95027. /**
  95028. * Compute the time lapsed since the previous beginMonitoring() call.
  95029. * @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
  95030. */
  95031. endMonitoring(newFrame?: boolean): void;
  95032. private _fetchResult;
  95033. private _startMonitoringTime;
  95034. private _min;
  95035. private _max;
  95036. private _average;
  95037. private _current;
  95038. private _totalValueCount;
  95039. private _totalAccumulated;
  95040. private _lastSecAverage;
  95041. private _lastSecAccumulated;
  95042. private _lastSecTime;
  95043. private _lastSecValueCount;
  95044. }
  95045. }
  95046. declare module BABYLON {
  95047. /**
  95048. * Interface for any object that can request an animation frame
  95049. */
  95050. export interface ICustomAnimationFrameRequester {
  95051. /**
  95052. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  95053. */
  95054. renderFunction?: Function;
  95055. /**
  95056. * Called to request the next frame to render to
  95057. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  95058. */
  95059. requestAnimationFrame: Function;
  95060. /**
  95061. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  95062. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  95063. */
  95064. requestID?: number;
  95065. }
  95066. }
  95067. declare module BABYLON {
  95068. /**
  95069. * Settings for finer control over video usage
  95070. */
  95071. export interface VideoTextureSettings {
  95072. /**
  95073. * Applies `autoplay` to video, if specified
  95074. */
  95075. autoPlay?: boolean;
  95076. /**
  95077. * Applies `loop` to video, if specified
  95078. */
  95079. loop?: boolean;
  95080. /**
  95081. * Automatically updates internal texture from video at every frame in the render loop
  95082. */
  95083. autoUpdateTexture: boolean;
  95084. /**
  95085. * Image src displayed during the video loading or until the user interacts with the video.
  95086. */
  95087. poster?: string;
  95088. }
  95089. /**
  95090. * If you want to display a video in your scene, this is the special texture for that.
  95091. * This special texture works similar to other textures, with the exception of a few parameters.
  95092. * @see https://doc.babylonjs.com/how_to/video_texture
  95093. */
  95094. export class VideoTexture extends Texture {
  95095. /**
  95096. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  95097. */
  95098. readonly autoUpdateTexture: boolean;
  95099. /**
  95100. * The video instance used by the texture internally
  95101. */
  95102. readonly video: HTMLVideoElement;
  95103. private _onUserActionRequestedObservable;
  95104. /**
  95105. * Event triggerd when a dom action is required by the user to play the video.
  95106. * This happens due to recent changes in browser policies preventing video to auto start.
  95107. */
  95108. readonly onUserActionRequestedObservable: Observable<Texture>;
  95109. private _generateMipMaps;
  95110. private _engine;
  95111. private _stillImageCaptured;
  95112. private _displayingPosterTexture;
  95113. private _settings;
  95114. private _createInternalTextureOnEvent;
  95115. private _frameId;
  95116. /**
  95117. * Creates a video texture.
  95118. * If you want to display a video in your scene, this is the special texture for that.
  95119. * This special texture works similar to other textures, with the exception of a few parameters.
  95120. * @see https://doc.babylonjs.com/how_to/video_texture
  95121. * @param name optional name, will detect from video source, if not defined
  95122. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  95123. * @param scene is obviously the current scene.
  95124. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  95125. * @param invertY is false by default but can be used to invert video on Y axis
  95126. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  95127. * @param settings allows finer control over video usage
  95128. */
  95129. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  95130. private _getName;
  95131. private _getVideo;
  95132. private _createInternalTexture;
  95133. private reset;
  95134. /**
  95135. * @hidden Internal method to initiate `update`.
  95136. */
  95137. _rebuild(): void;
  95138. /**
  95139. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  95140. */
  95141. update(): void;
  95142. /**
  95143. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  95144. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  95145. */
  95146. updateTexture(isVisible: boolean): void;
  95147. protected _updateInternalTexture: () => void;
  95148. /**
  95149. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  95150. * @param url New url.
  95151. */
  95152. updateURL(url: string): void;
  95153. /**
  95154. * Dispose the texture and release its associated resources.
  95155. */
  95156. dispose(): void;
  95157. /**
  95158. * Creates a video texture straight from a stream.
  95159. * @param scene Define the scene the texture should be created in
  95160. * @param stream Define the stream the texture should be created from
  95161. * @returns The created video texture as a promise
  95162. */
  95163. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  95164. /**
  95165. * Creates a video texture straight from your WebCam video feed.
  95166. * @param scene Define the scene the texture should be created in
  95167. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  95168. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  95169. * @returns The created video texture as a promise
  95170. */
  95171. static CreateFromWebCamAsync(scene: Scene, constraints: {
  95172. minWidth: number;
  95173. maxWidth: number;
  95174. minHeight: number;
  95175. maxHeight: number;
  95176. deviceId: string;
  95177. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  95178. /**
  95179. * Creates a video texture straight from your WebCam video feed.
  95180. * @param scene Define the scene the texture should be created in
  95181. * @param onReady Define a callback to triggered once the texture will be ready
  95182. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  95183. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  95184. */
  95185. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  95186. minWidth: number;
  95187. maxWidth: number;
  95188. minHeight: number;
  95189. maxHeight: number;
  95190. deviceId: string;
  95191. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  95192. }
  95193. }
  95194. declare module BABYLON {
  95195. /**
  95196. * Defines the interface used by objects containing a viewport (like a camera)
  95197. */
  95198. interface IViewportOwnerLike {
  95199. /**
  95200. * Gets or sets the viewport
  95201. */
  95202. viewport: IViewportLike;
  95203. }
  95204. /**
  95205. * Interface for attribute information associated with buffer instanciation
  95206. */
  95207. export class InstancingAttributeInfo {
  95208. /**
  95209. * Index/offset of the attribute in the vertex shader
  95210. */
  95211. index: number;
  95212. /**
  95213. * size of the attribute, 1, 2, 3 or 4
  95214. */
  95215. attributeSize: number;
  95216. /**
  95217. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  95218. * default is FLOAT
  95219. */
  95220. attribyteType: number;
  95221. /**
  95222. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  95223. */
  95224. normalized: boolean;
  95225. /**
  95226. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  95227. */
  95228. offset: number;
  95229. /**
  95230. * Name of the GLSL attribute, for debugging purpose only
  95231. */
  95232. attributeName: string;
  95233. }
  95234. /**
  95235. * Define options used to create a depth texture
  95236. */
  95237. export class DepthTextureCreationOptions {
  95238. /** Specifies whether or not a stencil should be allocated in the texture */
  95239. generateStencil?: boolean;
  95240. /** Specifies whether or not bilinear filtering is enable on the texture */
  95241. bilinearFiltering?: boolean;
  95242. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  95243. comparisonFunction?: number;
  95244. /** Specifies if the created texture is a cube texture */
  95245. isCube?: boolean;
  95246. }
  95247. /**
  95248. * Class used to describe the capabilities of the engine relatively to the current browser
  95249. */
  95250. export class EngineCapabilities {
  95251. /** Maximum textures units per fragment shader */
  95252. maxTexturesImageUnits: number;
  95253. /** Maximum texture units per vertex shader */
  95254. maxVertexTextureImageUnits: number;
  95255. /** Maximum textures units in the entire pipeline */
  95256. maxCombinedTexturesImageUnits: number;
  95257. /** Maximum texture size */
  95258. maxTextureSize: number;
  95259. /** Maximum cube texture size */
  95260. maxCubemapTextureSize: number;
  95261. /** Maximum render texture size */
  95262. maxRenderTextureSize: number;
  95263. /** Maximum number of vertex attributes */
  95264. maxVertexAttribs: number;
  95265. /** Maximum number of varyings */
  95266. maxVaryingVectors: number;
  95267. /** Maximum number of uniforms per vertex shader */
  95268. maxVertexUniformVectors: number;
  95269. /** Maximum number of uniforms per fragment shader */
  95270. maxFragmentUniformVectors: number;
  95271. /** Defines if standard derivates (dx/dy) are supported */
  95272. standardDerivatives: boolean;
  95273. /** Defines if s3tc texture compression is supported */
  95274. s3tc: Nullable<WEBGL_compressed_texture_s3tc>;
  95275. /** Defines if pvrtc texture compression is supported */
  95276. pvrtc: any;
  95277. /** Defines if etc1 texture compression is supported */
  95278. etc1: any;
  95279. /** Defines if etc2 texture compression is supported */
  95280. etc2: any;
  95281. /** Defines if astc texture compression is supported */
  95282. astc: any;
  95283. /** Defines if float textures are supported */
  95284. textureFloat: boolean;
  95285. /** Defines if vertex array objects are supported */
  95286. vertexArrayObject: boolean;
  95287. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  95288. textureAnisotropicFilterExtension: Nullable<EXT_texture_filter_anisotropic>;
  95289. /** Gets the maximum level of anisotropy supported */
  95290. maxAnisotropy: number;
  95291. /** Defines if instancing is supported */
  95292. instancedArrays: boolean;
  95293. /** Defines if 32 bits indices are supported */
  95294. uintIndices: boolean;
  95295. /** Defines if high precision shaders are supported */
  95296. highPrecisionShaderSupported: boolean;
  95297. /** Defines if depth reading in the fragment shader is supported */
  95298. fragmentDepthSupported: boolean;
  95299. /** Defines if float texture linear filtering is supported*/
  95300. textureFloatLinearFiltering: boolean;
  95301. /** Defines if rendering to float textures is supported */
  95302. textureFloatRender: boolean;
  95303. /** Defines if half float textures are supported*/
  95304. textureHalfFloat: boolean;
  95305. /** Defines if half float texture linear filtering is supported*/
  95306. textureHalfFloatLinearFiltering: boolean;
  95307. /** Defines if rendering to half float textures is supported */
  95308. textureHalfFloatRender: boolean;
  95309. /** Defines if textureLOD shader command is supported */
  95310. textureLOD: boolean;
  95311. /** Defines if draw buffers extension is supported */
  95312. drawBuffersExtension: boolean;
  95313. /** Defines if depth textures are supported */
  95314. depthTextureExtension: boolean;
  95315. /** Defines if float color buffer are supported */
  95316. colorBufferFloat: boolean;
  95317. /** Gets disjoint timer query extension (null if not supported) */
  95318. timerQuery: EXT_disjoint_timer_query;
  95319. /** Defines if timestamp can be used with timer query */
  95320. canUseTimestampForTimerQuery: boolean;
  95321. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  95322. multiview: any;
  95323. /** Function used to let the system compiles shaders in background */
  95324. parallelShaderCompile: {
  95325. COMPLETION_STATUS_KHR: number;
  95326. };
  95327. /** Max number of texture samples for MSAA */
  95328. maxMSAASamples: number;
  95329. }
  95330. /** Interface defining initialization parameters for Engine class */
  95331. export interface EngineOptions extends WebGLContextAttributes {
  95332. /**
  95333. * Defines if the engine should no exceed a specified device ratio
  95334. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  95335. */
  95336. limitDeviceRatio?: number;
  95337. /**
  95338. * Defines if webvr should be enabled automatically
  95339. * @see http://doc.babylonjs.com/how_to/webvr_camera
  95340. */
  95341. autoEnableWebVR?: boolean;
  95342. /**
  95343. * Defines if webgl2 should be turned off even if supported
  95344. * @see http://doc.babylonjs.com/features/webgl2
  95345. */
  95346. disableWebGL2Support?: boolean;
  95347. /**
  95348. * Defines if webaudio should be initialized as well
  95349. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  95350. */
  95351. audioEngine?: boolean;
  95352. /**
  95353. * Defines if animations should run using a deterministic lock step
  95354. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  95355. */
  95356. deterministicLockstep?: boolean;
  95357. /** Defines the maximum steps to use with deterministic lock step mode */
  95358. lockstepMaxSteps?: number;
  95359. /**
  95360. * Defines that engine should ignore context lost events
  95361. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  95362. */
  95363. doNotHandleContextLost?: boolean;
  95364. /**
  95365. * Defines that engine should ignore modifying touch action attribute and style
  95366. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  95367. */
  95368. doNotHandleTouchAction?: boolean;
  95369. /**
  95370. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  95371. */
  95372. useHighPrecisionFloats?: boolean;
  95373. }
  95374. /**
  95375. * Defines the interface used by display changed events
  95376. */
  95377. export interface IDisplayChangedEventArgs {
  95378. /** Gets the vrDisplay object (if any) */
  95379. vrDisplay: Nullable<any>;
  95380. /** Gets a boolean indicating if webVR is supported */
  95381. vrSupported: boolean;
  95382. }
  95383. /**
  95384. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  95385. */
  95386. export class Engine {
  95387. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  95388. static ExceptionList: ({
  95389. key: string;
  95390. capture: string;
  95391. captureConstraint: number;
  95392. targets: string[];
  95393. } | {
  95394. key: string;
  95395. capture: null;
  95396. captureConstraint: null;
  95397. targets: string[];
  95398. })[];
  95399. /** Gets the list of created engines */
  95400. static readonly Instances: Engine[];
  95401. /**
  95402. * Gets the latest created engine
  95403. */
  95404. static readonly LastCreatedEngine: Nullable<Engine>;
  95405. /**
  95406. * Gets the latest created scene
  95407. */
  95408. static readonly LastCreatedScene: Nullable<Scene>;
  95409. /**
  95410. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  95411. * @param flag defines which part of the materials must be marked as dirty
  95412. * @param predicate defines a predicate used to filter which materials should be affected
  95413. */
  95414. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  95415. /** @hidden */
  95416. static _TextureLoaders: IInternalTextureLoader[];
  95417. /** Defines that alpha blending is disabled */
  95418. static readonly ALPHA_DISABLE: number;
  95419. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  95420. static readonly ALPHA_ADD: number;
  95421. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  95422. static readonly ALPHA_COMBINE: number;
  95423. /** Defines that alpha blending to DEST - SRC * DEST */
  95424. static readonly ALPHA_SUBTRACT: number;
  95425. /** Defines that alpha blending to SRC * DEST */
  95426. static readonly ALPHA_MULTIPLY: number;
  95427. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  95428. static readonly ALPHA_MAXIMIZED: number;
  95429. /** Defines that alpha blending to SRC + DEST */
  95430. static readonly ALPHA_ONEONE: number;
  95431. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  95432. static readonly ALPHA_PREMULTIPLIED: number;
  95433. /**
  95434. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  95435. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  95436. */
  95437. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  95438. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  95439. static readonly ALPHA_INTERPOLATE: number;
  95440. /**
  95441. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  95442. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  95443. */
  95444. static readonly ALPHA_SCREENMODE: number;
  95445. /** Defines that the ressource is not delayed*/
  95446. static readonly DELAYLOADSTATE_NONE: number;
  95447. /** Defines that the ressource was successfully delay loaded */
  95448. static readonly DELAYLOADSTATE_LOADED: number;
  95449. /** Defines that the ressource is currently delay loading */
  95450. static readonly DELAYLOADSTATE_LOADING: number;
  95451. /** Defines that the ressource is delayed and has not started loading */
  95452. static readonly DELAYLOADSTATE_NOTLOADED: number;
  95453. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  95454. static readonly NEVER: number;
  95455. /** 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 */
  95456. static readonly ALWAYS: number;
  95457. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  95458. static readonly LESS: number;
  95459. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  95460. static readonly EQUAL: number;
  95461. /** 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 */
  95462. static readonly LEQUAL: number;
  95463. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  95464. static readonly GREATER: number;
  95465. /** 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 */
  95466. static readonly GEQUAL: number;
  95467. /** 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 */
  95468. static readonly NOTEQUAL: number;
  95469. /** Passed to stencilOperation to specify that stencil value must be kept */
  95470. static readonly KEEP: number;
  95471. /** Passed to stencilOperation to specify that stencil value must be replaced */
  95472. static readonly REPLACE: number;
  95473. /** Passed to stencilOperation to specify that stencil value must be incremented */
  95474. static readonly INCR: number;
  95475. /** Passed to stencilOperation to specify that stencil value must be decremented */
  95476. static readonly DECR: number;
  95477. /** Passed to stencilOperation to specify that stencil value must be inverted */
  95478. static readonly INVERT: number;
  95479. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  95480. static readonly INCR_WRAP: number;
  95481. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  95482. static readonly DECR_WRAP: number;
  95483. /** Texture is not repeating outside of 0..1 UVs */
  95484. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  95485. /** Texture is repeating outside of 0..1 UVs */
  95486. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  95487. /** Texture is repeating and mirrored */
  95488. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  95489. /** ALPHA */
  95490. static readonly TEXTUREFORMAT_ALPHA: number;
  95491. /** LUMINANCE */
  95492. static readonly TEXTUREFORMAT_LUMINANCE: number;
  95493. /** LUMINANCE_ALPHA */
  95494. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  95495. /** RGB */
  95496. static readonly TEXTUREFORMAT_RGB: number;
  95497. /** RGBA */
  95498. static readonly TEXTUREFORMAT_RGBA: number;
  95499. /** RED */
  95500. static readonly TEXTUREFORMAT_RED: number;
  95501. /** RED (2nd reference) */
  95502. static readonly TEXTUREFORMAT_R: number;
  95503. /** RG */
  95504. static readonly TEXTUREFORMAT_RG: number;
  95505. /** RED_INTEGER */
  95506. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  95507. /** RED_INTEGER (2nd reference) */
  95508. static readonly TEXTUREFORMAT_R_INTEGER: number;
  95509. /** RG_INTEGER */
  95510. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  95511. /** RGB_INTEGER */
  95512. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  95513. /** RGBA_INTEGER */
  95514. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  95515. /** UNSIGNED_BYTE */
  95516. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  95517. /** UNSIGNED_BYTE (2nd reference) */
  95518. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  95519. /** FLOAT */
  95520. static readonly TEXTURETYPE_FLOAT: number;
  95521. /** HALF_FLOAT */
  95522. static readonly TEXTURETYPE_HALF_FLOAT: number;
  95523. /** BYTE */
  95524. static readonly TEXTURETYPE_BYTE: number;
  95525. /** SHORT */
  95526. static readonly TEXTURETYPE_SHORT: number;
  95527. /** UNSIGNED_SHORT */
  95528. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  95529. /** INT */
  95530. static readonly TEXTURETYPE_INT: number;
  95531. /** UNSIGNED_INT */
  95532. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  95533. /** UNSIGNED_SHORT_4_4_4_4 */
  95534. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  95535. /** UNSIGNED_SHORT_5_5_5_1 */
  95536. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  95537. /** UNSIGNED_SHORT_5_6_5 */
  95538. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  95539. /** UNSIGNED_INT_2_10_10_10_REV */
  95540. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  95541. /** UNSIGNED_INT_24_8 */
  95542. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  95543. /** UNSIGNED_INT_10F_11F_11F_REV */
  95544. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  95545. /** UNSIGNED_INT_5_9_9_9_REV */
  95546. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  95547. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  95548. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  95549. /** nearest is mag = nearest and min = nearest and mip = linear */
  95550. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  95551. /** Bilinear is mag = linear and min = linear and mip = nearest */
  95552. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  95553. /** Trilinear is mag = linear and min = linear and mip = linear */
  95554. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  95555. /** nearest is mag = nearest and min = nearest and mip = linear */
  95556. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  95557. /** Bilinear is mag = linear and min = linear and mip = nearest */
  95558. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  95559. /** Trilinear is mag = linear and min = linear and mip = linear */
  95560. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  95561. /** mag = nearest and min = nearest and mip = nearest */
  95562. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  95563. /** mag = nearest and min = linear and mip = nearest */
  95564. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  95565. /** mag = nearest and min = linear and mip = linear */
  95566. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  95567. /** mag = nearest and min = linear and mip = none */
  95568. static readonly TEXTURE_NEAREST_LINEAR: number;
  95569. /** mag = nearest and min = nearest and mip = none */
  95570. static readonly TEXTURE_NEAREST_NEAREST: number;
  95571. /** mag = linear and min = nearest and mip = nearest */
  95572. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  95573. /** mag = linear and min = nearest and mip = linear */
  95574. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  95575. /** mag = linear and min = linear and mip = none */
  95576. static readonly TEXTURE_LINEAR_LINEAR: number;
  95577. /** mag = linear and min = nearest and mip = none */
  95578. static readonly TEXTURE_LINEAR_NEAREST: number;
  95579. /** Explicit coordinates mode */
  95580. static readonly TEXTURE_EXPLICIT_MODE: number;
  95581. /** Spherical coordinates mode */
  95582. static readonly TEXTURE_SPHERICAL_MODE: number;
  95583. /** Planar coordinates mode */
  95584. static readonly TEXTURE_PLANAR_MODE: number;
  95585. /** Cubic coordinates mode */
  95586. static readonly TEXTURE_CUBIC_MODE: number;
  95587. /** Projection coordinates mode */
  95588. static readonly TEXTURE_PROJECTION_MODE: number;
  95589. /** Skybox coordinates mode */
  95590. static readonly TEXTURE_SKYBOX_MODE: number;
  95591. /** Inverse Cubic coordinates mode */
  95592. static readonly TEXTURE_INVCUBIC_MODE: number;
  95593. /** Equirectangular coordinates mode */
  95594. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  95595. /** Equirectangular Fixed coordinates mode */
  95596. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  95597. /** Equirectangular Fixed Mirrored coordinates mode */
  95598. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  95599. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  95600. static readonly SCALEMODE_FLOOR: number;
  95601. /** Defines that texture rescaling will look for the nearest power of 2 size */
  95602. static readonly SCALEMODE_NEAREST: number;
  95603. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  95604. static readonly SCALEMODE_CEILING: number;
  95605. /**
  95606. * Returns the current npm package of the sdk
  95607. */
  95608. static readonly NpmPackage: string;
  95609. /**
  95610. * Returns the current version of the framework
  95611. */
  95612. static readonly Version: string;
  95613. /**
  95614. * Returns a string describing the current engine
  95615. */
  95616. readonly description: string;
  95617. /**
  95618. * Gets or sets the epsilon value used by collision engine
  95619. */
  95620. static CollisionsEpsilon: number;
  95621. /**
  95622. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  95623. */
  95624. static ShadersRepository: string;
  95625. /**
  95626. * Method called to create the default loading screen.
  95627. * This can be overriden in your own app.
  95628. * @param canvas The rendering canvas element
  95629. * @returns The loading screen
  95630. */
  95631. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  95632. /**
  95633. * Method called to create the default rescale post process on each engine.
  95634. */
  95635. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  95636. /** @hidden */
  95637. _shaderProcessor: IShaderProcessor;
  95638. /**
  95639. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  95640. */
  95641. forcePOTTextures: boolean;
  95642. /**
  95643. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  95644. */
  95645. isFullscreen: boolean;
  95646. /**
  95647. * Gets a boolean indicating if the pointer is currently locked
  95648. */
  95649. isPointerLock: boolean;
  95650. /**
  95651. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  95652. */
  95653. cullBackFaces: boolean;
  95654. /**
  95655. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  95656. */
  95657. renderEvenInBackground: boolean;
  95658. /**
  95659. * Gets or sets a boolean indicating that cache can be kept between frames
  95660. */
  95661. preventCacheWipeBetweenFrames: boolean;
  95662. /**
  95663. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  95664. **/
  95665. enableOfflineSupport: boolean;
  95666. /**
  95667. * 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)
  95668. **/
  95669. disableManifestCheck: boolean;
  95670. /**
  95671. * Gets the list of created scenes
  95672. */
  95673. scenes: Scene[];
  95674. /**
  95675. * Event raised when a new scene is created
  95676. */
  95677. onNewSceneAddedObservable: Observable<Scene>;
  95678. /**
  95679. * Gets the list of created postprocesses
  95680. */
  95681. postProcesses: PostProcess[];
  95682. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  95683. validateShaderPrograms: boolean;
  95684. /**
  95685. * Observable event triggered each time the rendering canvas is resized
  95686. */
  95687. onResizeObservable: Observable<Engine>;
  95688. /**
  95689. * Observable event triggered each time the canvas loses focus
  95690. */
  95691. onCanvasBlurObservable: Observable<Engine>;
  95692. /**
  95693. * Observable event triggered each time the canvas gains focus
  95694. */
  95695. onCanvasFocusObservable: Observable<Engine>;
  95696. /**
  95697. * Observable event triggered each time the canvas receives pointerout event
  95698. */
  95699. onCanvasPointerOutObservable: Observable<PointerEvent>;
  95700. /**
  95701. * Observable event triggered before each texture is initialized
  95702. */
  95703. onBeforeTextureInitObservable: Observable<Texture>;
  95704. /**
  95705. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  95706. */
  95707. disableUniformBuffers: boolean;
  95708. /** @hidden */
  95709. _uniformBuffers: UniformBuffer[];
  95710. /**
  95711. * Gets a boolean indicating that the engine supports uniform buffers
  95712. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  95713. */
  95714. readonly supportsUniformBuffers: boolean;
  95715. /**
  95716. * Observable raised when the engine begins a new frame
  95717. */
  95718. onBeginFrameObservable: Observable<Engine>;
  95719. /**
  95720. * If set, will be used to request the next animation frame for the render loop
  95721. */
  95722. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  95723. /**
  95724. * Observable raised when the engine ends the current frame
  95725. */
  95726. onEndFrameObservable: Observable<Engine>;
  95727. /**
  95728. * Observable raised when the engine is about to compile a shader
  95729. */
  95730. onBeforeShaderCompilationObservable: Observable<Engine>;
  95731. /**
  95732. * Observable raised when the engine has jsut compiled a shader
  95733. */
  95734. onAfterShaderCompilationObservable: Observable<Engine>;
  95735. /** @hidden */
  95736. _gl: WebGLRenderingContext;
  95737. private _renderingCanvas;
  95738. private _windowIsBackground;
  95739. protected _webGLVersion: number;
  95740. protected _highPrecisionShadersAllowed: boolean;
  95741. /** @hidden */
  95742. readonly _shouldUseHighPrecisionShader: boolean;
  95743. /**
  95744. * Gets a boolean indicating that only power of 2 textures are supported
  95745. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  95746. */
  95747. readonly needPOTTextures: boolean;
  95748. /** @hidden */
  95749. _badOS: boolean;
  95750. /** @hidden */
  95751. _badDesktopOS: boolean;
  95752. /**
  95753. * Gets the audio engine
  95754. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  95755. * @ignorenaming
  95756. */
  95757. static audioEngine: IAudioEngine;
  95758. /**
  95759. * Default AudioEngine factory responsible of creating the Audio Engine.
  95760. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  95761. */
  95762. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  95763. /**
  95764. * Default offline support factory responsible of creating a tool used to store data locally.
  95765. * By default, this will create a Database object if the workload has been embedded.
  95766. */
  95767. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  95768. private _onFocus;
  95769. private _onBlur;
  95770. private _onCanvasPointerOut;
  95771. private _onCanvasBlur;
  95772. private _onCanvasFocus;
  95773. private _onFullscreenChange;
  95774. private _onPointerLockChange;
  95775. private _hardwareScalingLevel;
  95776. /** @hidden */
  95777. _caps: EngineCapabilities;
  95778. private _pointerLockRequested;
  95779. private _isStencilEnable;
  95780. protected _colorWrite: boolean;
  95781. private _loadingScreen;
  95782. /** @hidden */
  95783. _drawCalls: PerfCounter;
  95784. private _glVersion;
  95785. private _glRenderer;
  95786. private _glVendor;
  95787. private _videoTextureSupported;
  95788. private _renderingQueueLaunched;
  95789. private _activeRenderLoops;
  95790. private _deterministicLockstep;
  95791. private _lockstepMaxSteps;
  95792. /**
  95793. * Observable signaled when a context lost event is raised
  95794. */
  95795. onContextLostObservable: Observable<Engine>;
  95796. /**
  95797. * Observable signaled when a context restored event is raised
  95798. */
  95799. onContextRestoredObservable: Observable<Engine>;
  95800. private _onContextLost;
  95801. private _onContextRestored;
  95802. private _contextWasLost;
  95803. /** @hidden */
  95804. _doNotHandleContextLost: boolean;
  95805. /**
  95806. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  95807. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  95808. */
  95809. doNotHandleContextLost: boolean;
  95810. private _performanceMonitor;
  95811. private _fps;
  95812. private _deltaTime;
  95813. /**
  95814. * Turn this value on if you want to pause FPS computation when in background
  95815. */
  95816. disablePerformanceMonitorInBackground: boolean;
  95817. /**
  95818. * Gets the performance monitor attached to this engine
  95819. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  95820. */
  95821. readonly performanceMonitor: PerformanceMonitor;
  95822. /**
  95823. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  95824. */
  95825. disableVertexArrayObjects: boolean;
  95826. /** @hidden */
  95827. protected _depthCullingState: _DepthCullingState;
  95828. /** @hidden */
  95829. protected _stencilState: _StencilState;
  95830. /** @hidden */
  95831. protected _alphaState: _AlphaState;
  95832. /** @hidden */
  95833. protected _alphaMode: number;
  95834. /** @hidden */
  95835. _internalTexturesCache: InternalTexture[];
  95836. /** @hidden */
  95837. protected _activeChannel: number;
  95838. private _currentTextureChannel;
  95839. /** @hidden */
  95840. protected _boundTexturesCache: {
  95841. [key: string]: Nullable<InternalTexture>;
  95842. };
  95843. /** @hidden */
  95844. protected _currentEffect: Nullable<Effect>;
  95845. /** @hidden */
  95846. protected _currentProgram: Nullable<WebGLProgram>;
  95847. private _compiledEffects;
  95848. private _vertexAttribArraysEnabled;
  95849. /** @hidden */
  95850. protected _cachedViewport: Nullable<IViewportLike>;
  95851. private _cachedVertexArrayObject;
  95852. /** @hidden */
  95853. protected _cachedVertexBuffers: any;
  95854. /** @hidden */
  95855. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  95856. /** @hidden */
  95857. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  95858. /** @hidden */
  95859. _currentRenderTarget: Nullable<InternalTexture>;
  95860. private _uintIndicesCurrentlySet;
  95861. private _currentBoundBuffer;
  95862. /** @hidden */
  95863. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  95864. private _currentBufferPointers;
  95865. private _currentInstanceLocations;
  95866. private _currentInstanceBuffers;
  95867. private _textureUnits;
  95868. /** @hidden */
  95869. _workingCanvas: Nullable<HTMLCanvasElement>;
  95870. /** @hidden */
  95871. _workingContext: Nullable<CanvasRenderingContext2D>;
  95872. private _rescalePostProcess;
  95873. private _dummyFramebuffer;
  95874. private _externalData;
  95875. /** @hidden */
  95876. _bindedRenderFunction: any;
  95877. private _vaoRecordInProgress;
  95878. private _mustWipeVertexAttributes;
  95879. private _emptyTexture;
  95880. private _emptyCubeTexture;
  95881. private _emptyTexture3D;
  95882. /** @hidden */
  95883. _frameHandler: number;
  95884. private _nextFreeTextureSlots;
  95885. private _maxSimultaneousTextures;
  95886. private _activeRequests;
  95887. private _texturesSupported;
  95888. /** @hidden */
  95889. _textureFormatInUse: Nullable<string>;
  95890. /**
  95891. * Gets the list of texture formats supported
  95892. */
  95893. readonly texturesSupported: Array<string>;
  95894. /**
  95895. * Gets the list of texture formats in use
  95896. */
  95897. readonly textureFormatInUse: Nullable<string>;
  95898. /**
  95899. * Gets the current viewport
  95900. */
  95901. readonly currentViewport: Nullable<IViewportLike>;
  95902. /**
  95903. * Gets the default empty texture
  95904. */
  95905. readonly emptyTexture: InternalTexture;
  95906. /**
  95907. * Gets the default empty 3D texture
  95908. */
  95909. readonly emptyTexture3D: InternalTexture;
  95910. /**
  95911. * Gets the default empty cube texture
  95912. */
  95913. readonly emptyCubeTexture: InternalTexture;
  95914. /**
  95915. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  95916. */
  95917. readonly premultipliedAlpha: boolean;
  95918. /**
  95919. * Creates a new engine
  95920. * @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
  95921. * @param antialias defines enable antialiasing (default: false)
  95922. * @param options defines further options to be sent to the getContext() function
  95923. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  95924. */
  95925. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  95926. /**
  95927. * Initializes a webVR display and starts listening to display change events
  95928. * The onVRDisplayChangedObservable will be notified upon these changes
  95929. * @returns The onVRDisplayChangedObservable
  95930. */
  95931. initWebVR(): Observable<IDisplayChangedEventArgs>;
  95932. /** @hidden */
  95933. _prepareVRComponent(): void;
  95934. /** @hidden */
  95935. _connectVREvents(canvas: HTMLCanvasElement, document: any): void;
  95936. /** @hidden */
  95937. _submitVRFrame(): void;
  95938. /**
  95939. * Call this function to leave webVR mode
  95940. * Will do nothing if webVR is not supported or if there is no webVR device
  95941. * @see http://doc.babylonjs.com/how_to/webvr_camera
  95942. */
  95943. disableVR(): void;
  95944. /**
  95945. * Gets a boolean indicating that the system is in VR mode and is presenting
  95946. * @returns true if VR mode is engaged
  95947. */
  95948. isVRPresenting(): boolean;
  95949. /** @hidden */
  95950. _requestVRFrame(): void;
  95951. private _disableTouchAction;
  95952. private _rebuildInternalTextures;
  95953. private _rebuildEffects;
  95954. /**
  95955. * Gets a boolean indicating if all created effects are ready
  95956. * @returns true if all effects are ready
  95957. */
  95958. areAllEffectsReady(): boolean;
  95959. private _rebuildBuffers;
  95960. private _initGLContext;
  95961. /**
  95962. * Gets version of the current webGL context
  95963. */
  95964. readonly webGLVersion: number;
  95965. /**
  95966. * Gets a string idenfifying the name of the class
  95967. * @returns "Engine" string
  95968. */
  95969. getClassName(): string;
  95970. /**
  95971. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  95972. */
  95973. readonly isStencilEnable: boolean;
  95974. /** @hidden */
  95975. _prepareWorkingCanvas(): void;
  95976. /**
  95977. * Reset the texture cache to empty state
  95978. */
  95979. resetTextureCache(): void;
  95980. /**
  95981. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  95982. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  95983. * @returns true if engine is in deterministic lock step mode
  95984. */
  95985. isDeterministicLockStep(): boolean;
  95986. /**
  95987. * Gets the max steps when engine is running in deterministic lock step
  95988. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  95989. * @returns the max steps
  95990. */
  95991. getLockstepMaxSteps(): number;
  95992. /**
  95993. * Gets an object containing information about the current webGL context
  95994. * @returns an object containing the vender, the renderer and the version of the current webGL context
  95995. */
  95996. getGlInfo(): {
  95997. vendor: string;
  95998. renderer: string;
  95999. version: string;
  96000. };
  96001. /**
  96002. * Gets current aspect ratio
  96003. * @param viewportOwner defines the camera to use to get the aspect ratio
  96004. * @param useScreen defines if screen size must be used (or the current render target if any)
  96005. * @returns a number defining the aspect ratio
  96006. */
  96007. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  96008. /**
  96009. * Gets current screen aspect ratio
  96010. * @returns a number defining the aspect ratio
  96011. */
  96012. getScreenAspectRatio(): number;
  96013. /**
  96014. * Gets the current render width
  96015. * @param useScreen defines if screen size must be used (or the current render target if any)
  96016. * @returns a number defining the current render width
  96017. */
  96018. getRenderWidth(useScreen?: boolean): number;
  96019. /**
  96020. * Gets the current render height
  96021. * @param useScreen defines if screen size must be used (or the current render target if any)
  96022. * @returns a number defining the current render height
  96023. */
  96024. getRenderHeight(useScreen?: boolean): number;
  96025. /**
  96026. * Gets the HTML canvas attached with the current webGL context
  96027. * @returns a HTML canvas
  96028. */
  96029. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  96030. /**
  96031. * Gets host window
  96032. * @returns the host window object
  96033. */
  96034. getHostWindow(): Window;
  96035. /**
  96036. * Gets host document
  96037. * @returns the host document object
  96038. */
  96039. getHostDocument(): Document;
  96040. /**
  96041. * Gets the client rect of the HTML canvas attached with the current webGL context
  96042. * @returns a client rectanglee
  96043. */
  96044. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  96045. /**
  96046. * Defines the hardware scaling level.
  96047. * By default the hardware scaling level is computed from the window device ratio.
  96048. * 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.
  96049. * @param level defines the level to use
  96050. */
  96051. setHardwareScalingLevel(level: number): void;
  96052. /**
  96053. * Gets the current hardware scaling level.
  96054. * By default the hardware scaling level is computed from the window device ratio.
  96055. * 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.
  96056. * @returns a number indicating the current hardware scaling level
  96057. */
  96058. getHardwareScalingLevel(): number;
  96059. /**
  96060. * Gets the list of loaded textures
  96061. * @returns an array containing all loaded textures
  96062. */
  96063. getLoadedTexturesCache(): InternalTexture[];
  96064. /**
  96065. * Gets the object containing all engine capabilities
  96066. * @returns the EngineCapabilities object
  96067. */
  96068. getCaps(): EngineCapabilities;
  96069. /**
  96070. * Gets the current depth function
  96071. * @returns a number defining the depth function
  96072. */
  96073. getDepthFunction(): Nullable<number>;
  96074. /**
  96075. * Sets the current depth function
  96076. * @param depthFunc defines the function to use
  96077. */
  96078. setDepthFunction(depthFunc: number): void;
  96079. /**
  96080. * Sets the current depth function to GREATER
  96081. */
  96082. setDepthFunctionToGreater(): void;
  96083. /**
  96084. * Sets the current depth function to GEQUAL
  96085. */
  96086. setDepthFunctionToGreaterOrEqual(): void;
  96087. /**
  96088. * Sets the current depth function to LESS
  96089. */
  96090. setDepthFunctionToLess(): void;
  96091. private _cachedStencilBuffer;
  96092. private _cachedStencilFunction;
  96093. private _cachedStencilMask;
  96094. private _cachedStencilOperationPass;
  96095. private _cachedStencilOperationFail;
  96096. private _cachedStencilOperationDepthFail;
  96097. private _cachedStencilReference;
  96098. /**
  96099. * Caches the the state of the stencil buffer
  96100. */
  96101. cacheStencilState(): void;
  96102. /**
  96103. * Restores the state of the stencil buffer
  96104. */
  96105. restoreStencilState(): void;
  96106. /**
  96107. * Sets the current depth function to LEQUAL
  96108. */
  96109. setDepthFunctionToLessOrEqual(): void;
  96110. /**
  96111. * Gets a boolean indicating if stencil buffer is enabled
  96112. * @returns the current stencil buffer state
  96113. */
  96114. getStencilBuffer(): boolean;
  96115. /**
  96116. * Enable or disable the stencil buffer
  96117. * @param enable defines if the stencil buffer must be enabled or disabled
  96118. */
  96119. setStencilBuffer(enable: boolean): void;
  96120. /**
  96121. * Gets the current stencil mask
  96122. * @returns a number defining the new stencil mask to use
  96123. */
  96124. getStencilMask(): number;
  96125. /**
  96126. * Sets the current stencil mask
  96127. * @param mask defines the new stencil mask to use
  96128. */
  96129. setStencilMask(mask: number): void;
  96130. /**
  96131. * Gets the current stencil function
  96132. * @returns a number defining the stencil function to use
  96133. */
  96134. getStencilFunction(): number;
  96135. /**
  96136. * Gets the current stencil reference value
  96137. * @returns a number defining the stencil reference value to use
  96138. */
  96139. getStencilFunctionReference(): number;
  96140. /**
  96141. * Gets the current stencil mask
  96142. * @returns a number defining the stencil mask to use
  96143. */
  96144. getStencilFunctionMask(): number;
  96145. /**
  96146. * Sets the current stencil function
  96147. * @param stencilFunc defines the new stencil function to use
  96148. */
  96149. setStencilFunction(stencilFunc: number): void;
  96150. /**
  96151. * Sets the current stencil reference
  96152. * @param reference defines the new stencil reference to use
  96153. */
  96154. setStencilFunctionReference(reference: number): void;
  96155. /**
  96156. * Sets the current stencil mask
  96157. * @param mask defines the new stencil mask to use
  96158. */
  96159. setStencilFunctionMask(mask: number): void;
  96160. /**
  96161. * Gets the current stencil operation when stencil fails
  96162. * @returns a number defining stencil operation to use when stencil fails
  96163. */
  96164. getStencilOperationFail(): number;
  96165. /**
  96166. * Gets the current stencil operation when depth fails
  96167. * @returns a number defining stencil operation to use when depth fails
  96168. */
  96169. getStencilOperationDepthFail(): number;
  96170. /**
  96171. * Gets the current stencil operation when stencil passes
  96172. * @returns a number defining stencil operation to use when stencil passes
  96173. */
  96174. getStencilOperationPass(): number;
  96175. /**
  96176. * Sets the stencil operation to use when stencil fails
  96177. * @param operation defines the stencil operation to use when stencil fails
  96178. */
  96179. setStencilOperationFail(operation: number): void;
  96180. /**
  96181. * Sets the stencil operation to use when depth fails
  96182. * @param operation defines the stencil operation to use when depth fails
  96183. */
  96184. setStencilOperationDepthFail(operation: number): void;
  96185. /**
  96186. * Sets the stencil operation to use when stencil passes
  96187. * @param operation defines the stencil operation to use when stencil passes
  96188. */
  96189. setStencilOperationPass(operation: number): void;
  96190. /**
  96191. * Sets a boolean indicating if the dithering state is enabled or disabled
  96192. * @param value defines the dithering state
  96193. */
  96194. setDitheringState(value: boolean): void;
  96195. /**
  96196. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  96197. * @param value defines the rasterizer state
  96198. */
  96199. setRasterizerState(value: boolean): void;
  96200. /**
  96201. * stop executing a render loop function and remove it from the execution array
  96202. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  96203. */
  96204. stopRenderLoop(renderFunction?: () => void): void;
  96205. /** @hidden */
  96206. _renderLoop(): void;
  96207. /**
  96208. * Can be used to override the current requestAnimationFrame requester.
  96209. * @hidden
  96210. */
  96211. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  96212. /**
  96213. * Register and execute a render loop. The engine can have more than one render function
  96214. * @param renderFunction defines the function to continuously execute
  96215. */
  96216. runRenderLoop(renderFunction: () => void): void;
  96217. /**
  96218. * Toggle full screen mode
  96219. * @param requestPointerLock defines if a pointer lock should be requested from the user
  96220. */
  96221. switchFullscreen(requestPointerLock: boolean): void;
  96222. /**
  96223. * Enters full screen mode
  96224. * @param requestPointerLock defines if a pointer lock should be requested from the user
  96225. */
  96226. enterFullscreen(requestPointerLock: boolean): void;
  96227. /**
  96228. * Exits full screen mode
  96229. */
  96230. exitFullscreen(): void;
  96231. /**
  96232. * Enters Pointerlock mode
  96233. */
  96234. enterPointerlock(): void;
  96235. /**
  96236. * Exits Pointerlock mode
  96237. */
  96238. exitPointerlock(): void;
  96239. /**
  96240. * Clear the current render buffer or the current render target (if any is set up)
  96241. * @param color defines the color to use
  96242. * @param backBuffer defines if the back buffer must be cleared
  96243. * @param depth defines if the depth buffer must be cleared
  96244. * @param stencil defines if the stencil buffer must be cleared
  96245. */
  96246. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  96247. /**
  96248. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  96249. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  96250. * @param y defines the y-coordinate of the corner of the clear rectangle
  96251. * @param width defines the width of the clear rectangle
  96252. * @param height defines the height of the clear rectangle
  96253. * @param clearColor defines the clear color
  96254. */
  96255. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  96256. /**
  96257. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  96258. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  96259. * @param y defines the y-coordinate of the corner of the clear rectangle
  96260. * @param width defines the width of the clear rectangle
  96261. * @param height defines the height of the clear rectangle
  96262. */
  96263. enableScissor(x: number, y: number, width: number, height: number): void;
  96264. /**
  96265. * Disable previously set scissor test rectangle
  96266. */
  96267. disableScissor(): void;
  96268. private _viewportCached;
  96269. /** @hidden */
  96270. _viewport(x: number, y: number, width: number, height: number): void;
  96271. /**
  96272. * Set the WebGL's viewport
  96273. * @param viewport defines the viewport element to be used
  96274. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  96275. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  96276. */
  96277. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  96278. /**
  96279. * Directly set the WebGL Viewport
  96280. * @param x defines the x coordinate of the viewport (in screen space)
  96281. * @param y defines the y coordinate of the viewport (in screen space)
  96282. * @param width defines the width of the viewport (in screen space)
  96283. * @param height defines the height of the viewport (in screen space)
  96284. * @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
  96285. */
  96286. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  96287. /**
  96288. * Begin a new frame
  96289. */
  96290. beginFrame(): void;
  96291. /**
  96292. * Enf the current frame
  96293. */
  96294. endFrame(): void;
  96295. /**
  96296. * Resize the view according to the canvas' size
  96297. */
  96298. resize(): void;
  96299. /**
  96300. * Force a specific size of the canvas
  96301. * @param width defines the new canvas' width
  96302. * @param height defines the new canvas' height
  96303. */
  96304. setSize(width: number, height: number): void;
  96305. /**
  96306. * Binds the frame buffer to the specified texture.
  96307. * @param texture The texture to render to or null for the default canvas
  96308. * @param faceIndex The face of the texture to render to in case of cube texture
  96309. * @param requiredWidth The width of the target to render to
  96310. * @param requiredHeight The height of the target to render to
  96311. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  96312. * @param depthStencilTexture The depth stencil texture to use to render
  96313. * @param lodLevel defines le lod level to bind to the frame buffer
  96314. */
  96315. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  96316. /** @hidden */
  96317. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  96318. /**
  96319. * Unbind the current render target texture from the webGL context
  96320. * @param texture defines the render target texture to unbind
  96321. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  96322. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  96323. */
  96324. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  96325. /**
  96326. * Force the mipmap generation for the given render target texture
  96327. * @param texture defines the render target texture to use
  96328. */
  96329. generateMipMapsForCubemap(texture: InternalTexture): void;
  96330. /**
  96331. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  96332. */
  96333. flushFramebuffer(): void;
  96334. /**
  96335. * Unbind the current render target and bind the default framebuffer
  96336. */
  96337. restoreDefaultFramebuffer(): void;
  96338. /**
  96339. * Create an uniform buffer
  96340. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  96341. * @param elements defines the content of the uniform buffer
  96342. * @returns the webGL uniform buffer
  96343. */
  96344. createUniformBuffer(elements: FloatArray): DataBuffer;
  96345. /**
  96346. * Create a dynamic uniform buffer
  96347. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  96348. * @param elements defines the content of the uniform buffer
  96349. * @returns the webGL uniform buffer
  96350. */
  96351. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  96352. /**
  96353. * Update an existing uniform buffer
  96354. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  96355. * @param uniformBuffer defines the target uniform buffer
  96356. * @param elements defines the content to update
  96357. * @param offset defines the offset in the uniform buffer where update should start
  96358. * @param count defines the size of the data to update
  96359. */
  96360. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  96361. private _resetVertexBufferBinding;
  96362. /**
  96363. * Creates a vertex buffer
  96364. * @param data the data for the vertex buffer
  96365. * @returns the new WebGL static buffer
  96366. */
  96367. createVertexBuffer(data: DataArray): DataBuffer;
  96368. /**
  96369. * Creates a dynamic vertex buffer
  96370. * @param data the data for the dynamic vertex buffer
  96371. * @returns the new WebGL dynamic buffer
  96372. */
  96373. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  96374. /**
  96375. * Update a dynamic index buffer
  96376. * @param indexBuffer defines the target index buffer
  96377. * @param indices defines the data to update
  96378. * @param offset defines the offset in the target index buffer where update should start
  96379. */
  96380. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  96381. /**
  96382. * Updates a dynamic vertex buffer.
  96383. * @param vertexBuffer the vertex buffer to update
  96384. * @param data the data used to update the vertex buffer
  96385. * @param byteOffset the byte offset of the data
  96386. * @param byteLength the byte length of the data
  96387. */
  96388. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  96389. private _resetIndexBufferBinding;
  96390. /**
  96391. * Creates a new index buffer
  96392. * @param indices defines the content of the index buffer
  96393. * @param updatable defines if the index buffer must be updatable
  96394. * @returns a new webGL buffer
  96395. */
  96396. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  96397. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  96398. /**
  96399. * Bind a webGL buffer to the webGL context
  96400. * @param buffer defines the buffer to bind
  96401. */
  96402. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  96403. /**
  96404. * Bind an uniform buffer to the current webGL context
  96405. * @param buffer defines the buffer to bind
  96406. */
  96407. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  96408. /**
  96409. * Bind a buffer to the current webGL context at a given location
  96410. * @param buffer defines the buffer to bind
  96411. * @param location defines the index where to bind the buffer
  96412. */
  96413. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  96414. /**
  96415. * Bind a specific block at a given index in a specific shader program
  96416. * @param pipelineContext defines the pipeline context to use
  96417. * @param blockName defines the block name
  96418. * @param index defines the index where to bind the block
  96419. */
  96420. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  96421. private bindIndexBuffer;
  96422. private bindBuffer;
  96423. /**
  96424. * update the bound buffer with the given data
  96425. * @param data defines the data to update
  96426. */
  96427. updateArrayBuffer(data: Float32Array): void;
  96428. private _vertexAttribPointer;
  96429. private _bindIndexBufferWithCache;
  96430. private _bindVertexBuffersAttributes;
  96431. /**
  96432. * Records a vertex array object
  96433. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  96434. * @param vertexBuffers defines the list of vertex buffers to store
  96435. * @param indexBuffer defines the index buffer to store
  96436. * @param effect defines the effect to store
  96437. * @returns the new vertex array object
  96438. */
  96439. recordVertexArrayObject(vertexBuffers: {
  96440. [key: string]: VertexBuffer;
  96441. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  96442. /**
  96443. * Bind a specific vertex array object
  96444. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  96445. * @param vertexArrayObject defines the vertex array object to bind
  96446. * @param indexBuffer defines the index buffer to bind
  96447. */
  96448. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  96449. /**
  96450. * Bind webGl buffers directly to the webGL context
  96451. * @param vertexBuffer defines the vertex buffer to bind
  96452. * @param indexBuffer defines the index buffer to bind
  96453. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  96454. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  96455. * @param effect defines the effect associated with the vertex buffer
  96456. */
  96457. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  96458. private _unbindVertexArrayObject;
  96459. /**
  96460. * Bind a list of vertex buffers to the webGL context
  96461. * @param vertexBuffers defines the list of vertex buffers to bind
  96462. * @param indexBuffer defines the index buffer to bind
  96463. * @param effect defines the effect associated with the vertex buffers
  96464. */
  96465. bindBuffers(vertexBuffers: {
  96466. [key: string]: Nullable<VertexBuffer>;
  96467. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  96468. /**
  96469. * Unbind all instance attributes
  96470. */
  96471. unbindInstanceAttributes(): void;
  96472. /**
  96473. * Release and free the memory of a vertex array object
  96474. * @param vao defines the vertex array object to delete
  96475. */
  96476. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  96477. /** @hidden */
  96478. _releaseBuffer(buffer: DataBuffer): boolean;
  96479. protected _deleteBuffer(buffer: DataBuffer): void;
  96480. /**
  96481. * Creates a webGL buffer to use with instanciation
  96482. * @param capacity defines the size of the buffer
  96483. * @returns the webGL buffer
  96484. */
  96485. createInstancesBuffer(capacity: number): DataBuffer;
  96486. /**
  96487. * Delete a webGL buffer used with instanciation
  96488. * @param buffer defines the webGL buffer to delete
  96489. */
  96490. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  96491. /**
  96492. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  96493. * @param instancesBuffer defines the webGL buffer to update and bind
  96494. * @param data defines the data to store in the buffer
  96495. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  96496. */
  96497. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  96498. /**
  96499. * Apply all cached states (depth, culling, stencil and alpha)
  96500. */
  96501. applyStates(): void;
  96502. /**
  96503. * Send a draw order
  96504. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  96505. * @param indexStart defines the starting index
  96506. * @param indexCount defines the number of index to draw
  96507. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  96508. */
  96509. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  96510. /**
  96511. * Draw a list of points
  96512. * @param verticesStart defines the index of first vertex to draw
  96513. * @param verticesCount defines the count of vertices to draw
  96514. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  96515. */
  96516. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  96517. /**
  96518. * Draw a list of unindexed primitives
  96519. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  96520. * @param verticesStart defines the index of first vertex to draw
  96521. * @param verticesCount defines the count of vertices to draw
  96522. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  96523. */
  96524. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  96525. /**
  96526. * Draw a list of indexed primitives
  96527. * @param fillMode defines the primitive to use
  96528. * @param indexStart defines the starting index
  96529. * @param indexCount defines the number of index to draw
  96530. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  96531. */
  96532. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  96533. /**
  96534. * Draw a list of unindexed primitives
  96535. * @param fillMode defines the primitive to use
  96536. * @param verticesStart defines the index of first vertex to draw
  96537. * @param verticesCount defines the count of vertices to draw
  96538. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  96539. */
  96540. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  96541. private _drawMode;
  96542. /** @hidden */
  96543. _releaseEffect(effect: Effect): void;
  96544. /** @hidden */
  96545. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  96546. /**
  96547. * Create a new effect (used to store vertex/fragment shaders)
  96548. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  96549. * @param attributesNamesOrOptions defines either a list of attribute names or an EffectCreationOptions object
  96550. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  96551. * @param samplers defines an array of string used to represent textures
  96552. * @param defines defines the string containing the defines to use to compile the shaders
  96553. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  96554. * @param onCompiled defines a function to call when the effect creation is successful
  96555. * @param onError defines a function to call when the effect creation has failed
  96556. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  96557. * @returns the new Effect
  96558. */
  96559. createEffect(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: string[], defines?: string, fallbacks?: EffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  96560. protected static _concatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  96561. private _compileShader;
  96562. private _compileRawShader;
  96563. /**
  96564. * Directly creates a webGL program
  96565. * @param pipelineContext defines the pipeline context to attach to
  96566. * @param vertexCode defines the vertex shader code to use
  96567. * @param fragmentCode defines the fragment shader code to use
  96568. * @param context defines the webGL context to use (if not set, the current one will be used)
  96569. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  96570. * @returns the new webGL program
  96571. */
  96572. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  96573. /**
  96574. * Creates a webGL program
  96575. * @param pipelineContext defines the pipeline context to attach to
  96576. * @param vertexCode defines the vertex shader code to use
  96577. * @param fragmentCode defines the fragment shader code to use
  96578. * @param defines defines the string containing the defines to use to compile the shaders
  96579. * @param context defines the webGL context to use (if not set, the current one will be used)
  96580. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  96581. * @returns the new webGL program
  96582. */
  96583. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  96584. /**
  96585. * Creates a new pipeline context
  96586. * @returns the new pipeline
  96587. */
  96588. createPipelineContext(): IPipelineContext;
  96589. private _createShaderProgram;
  96590. private _finalizePipelineContext;
  96591. /** @hidden */
  96592. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  96593. /** @hidden */
  96594. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  96595. /** @hidden */
  96596. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  96597. /**
  96598. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  96599. * @param pipelineContext defines the pipeline context to use
  96600. * @param uniformsNames defines the list of uniform names
  96601. * @returns an array of webGL uniform locations
  96602. */
  96603. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  96604. /**
  96605. * Gets the lsit of active attributes for a given webGL program
  96606. * @param pipelineContext defines the pipeline context to use
  96607. * @param attributesNames defines the list of attribute names to get
  96608. * @returns an array of indices indicating the offset of each attribute
  96609. */
  96610. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  96611. /**
  96612. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  96613. * @param effect defines the effect to activate
  96614. */
  96615. enableEffect(effect: Nullable<Effect>): void;
  96616. /**
  96617. * Set the value of an uniform to an array of int32
  96618. * @param uniform defines the webGL uniform location where to store the value
  96619. * @param array defines the array of int32 to store
  96620. */
  96621. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  96622. /**
  96623. * Set the value of an uniform to an array of int32 (stored as vec2)
  96624. * @param uniform defines the webGL uniform location where to store the value
  96625. * @param array defines the array of int32 to store
  96626. */
  96627. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  96628. /**
  96629. * Set the value of an uniform to an array of int32 (stored as vec3)
  96630. * @param uniform defines the webGL uniform location where to store the value
  96631. * @param array defines the array of int32 to store
  96632. */
  96633. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  96634. /**
  96635. * Set the value of an uniform to an array of int32 (stored as vec4)
  96636. * @param uniform defines the webGL uniform location where to store the value
  96637. * @param array defines the array of int32 to store
  96638. */
  96639. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  96640. /**
  96641. * Set the value of an uniform to an array of float32
  96642. * @param uniform defines the webGL uniform location where to store the value
  96643. * @param array defines the array of float32 to store
  96644. */
  96645. setFloatArray(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  96646. /**
  96647. * Set the value of an uniform to an array of float32 (stored as vec2)
  96648. * @param uniform defines the webGL uniform location where to store the value
  96649. * @param array defines the array of float32 to store
  96650. */
  96651. setFloatArray2(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  96652. /**
  96653. * Set the value of an uniform to an array of float32 (stored as vec3)
  96654. * @param uniform defines the webGL uniform location where to store the value
  96655. * @param array defines the array of float32 to store
  96656. */
  96657. setFloatArray3(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  96658. /**
  96659. * Set the value of an uniform to an array of float32 (stored as vec4)
  96660. * @param uniform defines the webGL uniform location where to store the value
  96661. * @param array defines the array of float32 to store
  96662. */
  96663. setFloatArray4(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  96664. /**
  96665. * Set the value of an uniform to an array of number
  96666. * @param uniform defines the webGL uniform location where to store the value
  96667. * @param array defines the array of number to store
  96668. */
  96669. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  96670. /**
  96671. * Set the value of an uniform to an array of number (stored as vec2)
  96672. * @param uniform defines the webGL uniform location where to store the value
  96673. * @param array defines the array of number to store
  96674. */
  96675. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  96676. /**
  96677. * Set the value of an uniform to an array of number (stored as vec3)
  96678. * @param uniform defines the webGL uniform location where to store the value
  96679. * @param array defines the array of number to store
  96680. */
  96681. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  96682. /**
  96683. * Set the value of an uniform to an array of number (stored as vec4)
  96684. * @param uniform defines the webGL uniform location where to store the value
  96685. * @param array defines the array of number to store
  96686. */
  96687. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  96688. /**
  96689. * Set the value of an uniform to an array of float32 (stored as matrices)
  96690. * @param uniform defines the webGL uniform location where to store the value
  96691. * @param matrices defines the array of float32 to store
  96692. */
  96693. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  96694. /**
  96695. * Set the value of an uniform to a matrix (3x3)
  96696. * @param uniform defines the webGL uniform location where to store the value
  96697. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  96698. */
  96699. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  96700. /**
  96701. * Set the value of an uniform to a matrix (2x2)
  96702. * @param uniform defines the webGL uniform location where to store the value
  96703. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  96704. */
  96705. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  96706. /**
  96707. * Set the value of an uniform to a number (int)
  96708. * @param uniform defines the webGL uniform location where to store the value
  96709. * @param value defines the int number to store
  96710. */
  96711. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  96712. /**
  96713. * Set the value of an uniform to a number (float)
  96714. * @param uniform defines the webGL uniform location where to store the value
  96715. * @param value defines the float number to store
  96716. */
  96717. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  96718. /**
  96719. * Set the value of an uniform to a vec2
  96720. * @param uniform defines the webGL uniform location where to store the value
  96721. * @param x defines the 1st component of the value
  96722. * @param y defines the 2nd component of the value
  96723. */
  96724. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  96725. /**
  96726. * Set the value of an uniform to a vec3
  96727. * @param uniform defines the webGL uniform location where to store the value
  96728. * @param x defines the 1st component of the value
  96729. * @param y defines the 2nd component of the value
  96730. * @param z defines the 3rd component of the value
  96731. */
  96732. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  96733. /**
  96734. * Set the value of an uniform to a boolean
  96735. * @param uniform defines the webGL uniform location where to store the value
  96736. * @param bool defines the boolean to store
  96737. */
  96738. setBool(uniform: Nullable<WebGLUniformLocation>, bool: number): void;
  96739. /**
  96740. * Set the value of an uniform to a vec4
  96741. * @param uniform defines the webGL uniform location where to store the value
  96742. * @param x defines the 1st component of the value
  96743. * @param y defines the 2nd component of the value
  96744. * @param z defines the 3rd component of the value
  96745. * @param w defines the 4th component of the value
  96746. */
  96747. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  96748. /**
  96749. * Sets a Color4 on a uniform variable
  96750. * @param uniform defines the uniform location
  96751. * @param color4 defines the value to be set
  96752. */
  96753. setDirectColor4(uniform: Nullable<WebGLUniformLocation>, color4: IColor4Like): void;
  96754. /**
  96755. * Set various states to the webGL context
  96756. * @param culling defines backface culling state
  96757. * @param zOffset defines the value to apply to zOffset (0 by default)
  96758. * @param force defines if states must be applied even if cache is up to date
  96759. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  96760. */
  96761. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  96762. /**
  96763. * Set the z offset to apply to current rendering
  96764. * @param value defines the offset to apply
  96765. */
  96766. setZOffset(value: number): void;
  96767. /**
  96768. * Gets the current value of the zOffset
  96769. * @returns the current zOffset state
  96770. */
  96771. getZOffset(): number;
  96772. /**
  96773. * Enable or disable depth buffering
  96774. * @param enable defines the state to set
  96775. */
  96776. setDepthBuffer(enable: boolean): void;
  96777. /**
  96778. * Gets a boolean indicating if depth writing is enabled
  96779. * @returns the current depth writing state
  96780. */
  96781. getDepthWrite(): boolean;
  96782. /**
  96783. * Enable or disable depth writing
  96784. * @param enable defines the state to set
  96785. */
  96786. setDepthWrite(enable: boolean): void;
  96787. /**
  96788. * Enable or disable color writing
  96789. * @param enable defines the state to set
  96790. */
  96791. setColorWrite(enable: boolean): void;
  96792. /**
  96793. * Gets a boolean indicating if color writing is enabled
  96794. * @returns the current color writing state
  96795. */
  96796. getColorWrite(): boolean;
  96797. /**
  96798. * Sets alpha constants used by some alpha blending modes
  96799. * @param r defines the red component
  96800. * @param g defines the green component
  96801. * @param b defines the blue component
  96802. * @param a defines the alpha component
  96803. */
  96804. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  96805. /**
  96806. * Sets the current alpha mode
  96807. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  96808. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  96809. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  96810. */
  96811. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  96812. /**
  96813. * Gets the current alpha mode
  96814. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  96815. * @returns the current alpha mode
  96816. */
  96817. getAlphaMode(): number;
  96818. /**
  96819. * Clears the list of texture accessible through engine.
  96820. * This can help preventing texture load conflict due to name collision.
  96821. */
  96822. clearInternalTexturesCache(): void;
  96823. /**
  96824. * Force the entire cache to be cleared
  96825. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  96826. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  96827. */
  96828. wipeCaches(bruteForce?: boolean): void;
  96829. /**
  96830. * Set the compressed texture format to use, based on the formats you have, and the formats
  96831. * supported by the hardware / browser.
  96832. *
  96833. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  96834. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  96835. * to API arguments needed to compressed textures. This puts the burden on the container
  96836. * generator to house the arcane code for determining these for current & future formats.
  96837. *
  96838. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  96839. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  96840. *
  96841. * Note: The result of this call is not taken into account when a texture is base64.
  96842. *
  96843. * @param formatsAvailable defines the list of those format families you have created
  96844. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  96845. *
  96846. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  96847. * @returns The extension selected.
  96848. */
  96849. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  96850. /** @hidden */
  96851. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  96852. min: number;
  96853. mag: number;
  96854. };
  96855. /** @hidden */
  96856. _createTexture(): WebGLTexture;
  96857. /**
  96858. * Usually called from Texture.ts.
  96859. * Passed information to create a WebGLTexture
  96860. * @param urlArg defines a value which contains one of the following:
  96861. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  96862. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  96863. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  96864. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  96865. * @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)
  96866. * @param scene needed for loading to the correct scene
  96867. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  96868. * @param onLoad optional callback to be called upon successful completion
  96869. * @param onError optional callback to be called upon failure
  96870. * @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
  96871. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  96872. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  96873. * @param forcedExtension defines the extension to use to pick the right loader
  96874. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  96875. * @returns a InternalTexture for assignment back into BABYLON.Texture
  96876. */
  96877. 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 | ArrayBufferView | HTMLImageElement | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>): InternalTexture;
  96878. /**
  96879. * @hidden
  96880. * Rescales a texture
  96881. * @param source input texutre
  96882. * @param destination destination texture
  96883. * @param scene scene to use to render the resize
  96884. * @param internalFormat format to use when resizing
  96885. * @param onComplete callback to be called when resize has completed
  96886. */
  96887. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<Scene>, internalFormat: number, onComplete: () => void): void;
  96888. private _unpackFlipYCached;
  96889. /**
  96890. * In case you are sharing the context with other applications, it might
  96891. * be interested to not cache the unpack flip y state to ensure a consistent
  96892. * value would be set.
  96893. */
  96894. enableUnpackFlipYCached: boolean;
  96895. /** @hidden */
  96896. _unpackFlipY(value: boolean): void;
  96897. /** @hidden */
  96898. _getUnpackAlignement(): number;
  96899. /**
  96900. * Creates a dynamic texture
  96901. * @param width defines the width of the texture
  96902. * @param height defines the height of the texture
  96903. * @param generateMipMaps defines if the engine should generate the mip levels
  96904. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  96905. * @returns the dynamic texture inside an InternalTexture
  96906. */
  96907. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  96908. /**
  96909. * Update the sampling mode of a given texture
  96910. * @param samplingMode defines the required sampling mode
  96911. * @param texture defines the texture to update
  96912. */
  96913. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  96914. /**
  96915. * Update the content of a dynamic texture
  96916. * @param texture defines the texture to update
  96917. * @param canvas defines the canvas containing the source
  96918. * @param invertY defines if data must be stored with Y axis inverted
  96919. * @param premulAlpha defines if alpha is stored as premultiplied
  96920. * @param format defines the format of the data
  96921. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  96922. */
  96923. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  96924. /**
  96925. * Update a video texture
  96926. * @param texture defines the texture to update
  96927. * @param video defines the video element to use
  96928. * @param invertY defines if data must be stored with Y axis inverted
  96929. */
  96930. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  96931. /**
  96932. * Updates a depth texture Comparison Mode and Function.
  96933. * If the comparison Function is equal to 0, the mode will be set to none.
  96934. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  96935. * @param texture The texture to set the comparison function for
  96936. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  96937. */
  96938. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  96939. /** @hidden */
  96940. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  96941. width: number;
  96942. height: number;
  96943. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  96944. /**
  96945. * Creates a depth stencil texture.
  96946. * This is only available in WebGL 2 or with the depth texture extension available.
  96947. * @param size The size of face edge in the texture.
  96948. * @param options The options defining the texture.
  96949. * @returns The texture
  96950. */
  96951. createDepthStencilTexture(size: number | {
  96952. width: number;
  96953. height: number;
  96954. }, options: DepthTextureCreationOptions): InternalTexture;
  96955. /**
  96956. * Creates a depth stencil texture.
  96957. * This is only available in WebGL 2 or with the depth texture extension available.
  96958. * @param size The size of face edge in the texture.
  96959. * @param options The options defining the texture.
  96960. * @returns The texture
  96961. */
  96962. private _createDepthStencilTexture;
  96963. /**
  96964. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  96965. * @param renderTarget The render target to set the frame buffer for
  96966. */
  96967. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  96968. /**
  96969. * Creates a new render target texture
  96970. * @param size defines the size of the texture
  96971. * @param options defines the options used to create the texture
  96972. * @returns a new render target texture stored in an InternalTexture
  96973. */
  96974. createRenderTargetTexture(size: number | {
  96975. width: number;
  96976. height: number;
  96977. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  96978. /** @hidden */
  96979. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  96980. /**
  96981. * Updates the sample count of a render target texture
  96982. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  96983. * @param texture defines the texture to update
  96984. * @param samples defines the sample count to set
  96985. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  96986. */
  96987. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  96988. /** @hidden */
  96989. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  96990. /** @hidden */
  96991. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  96992. /** @hidden */
  96993. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  96994. /** @hidden */
  96995. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  96996. /**
  96997. * @hidden
  96998. */
  96999. _setCubeMapTextureParams(loadMipmap: boolean): void;
  97000. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<Scene>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  97001. private _prepareWebGLTexture;
  97002. /** @hidden */
  97003. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  97004. /** @hidden */
  97005. _releaseFramebufferObjects(texture: InternalTexture): void;
  97006. /** @hidden */
  97007. _releaseTexture(texture: InternalTexture): void;
  97008. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  97009. protected _setProgram(program: WebGLProgram): void;
  97010. protected _boundUniforms: {
  97011. [key: number]: WebGLUniformLocation;
  97012. };
  97013. /**
  97014. * Binds an effect to the webGL context
  97015. * @param effect defines the effect to bind
  97016. */
  97017. bindSamplers(effect: Effect): void;
  97018. private _activateCurrentTexture;
  97019. /** @hidden */
  97020. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  97021. /** @hidden */
  97022. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  97023. /**
  97024. * Sets a texture to the webGL context from a postprocess
  97025. * @param channel defines the channel to use
  97026. * @param postProcess defines the source postprocess
  97027. */
  97028. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  97029. /**
  97030. * Binds the output of the passed in post process to the texture channel specified
  97031. * @param channel The channel the texture should be bound to
  97032. * @param postProcess The post process which's output should be bound
  97033. */
  97034. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  97035. /**
  97036. * Unbind all textures from the webGL context
  97037. */
  97038. unbindAllTextures(): void;
  97039. /**
  97040. * Sets a texture to the according uniform.
  97041. * @param channel The texture channel
  97042. * @param uniform The uniform to set
  97043. * @param texture The texture to apply
  97044. */
  97045. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  97046. /**
  97047. * Sets a depth stencil texture from a render target to the according uniform.
  97048. * @param channel The texture channel
  97049. * @param uniform The uniform to set
  97050. * @param texture The render target texture containing the depth stencil texture to apply
  97051. */
  97052. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  97053. private _bindSamplerUniformToChannel;
  97054. private _getTextureWrapMode;
  97055. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  97056. /**
  97057. * Sets an array of texture to the webGL context
  97058. * @param channel defines the channel where the texture array must be set
  97059. * @param uniform defines the associated uniform location
  97060. * @param textures defines the array of textures to bind
  97061. */
  97062. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  97063. /** @hidden */
  97064. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  97065. private _setTextureParameterFloat;
  97066. private _setTextureParameterInteger;
  97067. /**
  97068. * Reads pixels from the current frame buffer. Please note that this function can be slow
  97069. * @param x defines the x coordinate of the rectangle where pixels must be read
  97070. * @param y defines the y coordinate of the rectangle where pixels must be read
  97071. * @param width defines the width of the rectangle where pixels must be read
  97072. * @param height defines the height of the rectangle where pixels must be read
  97073. * @returns a Uint8Array containing RGBA colors
  97074. */
  97075. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  97076. /**
  97077. * Add an externaly attached data from its key.
  97078. * This method call will fail and return false, if such key already exists.
  97079. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  97080. * @param key the unique key that identifies the data
  97081. * @param data the data object to associate to the key for this Engine instance
  97082. * @return true if no such key were already present and the data was added successfully, false otherwise
  97083. */
  97084. addExternalData<T>(key: string, data: T): boolean;
  97085. /**
  97086. * Get an externaly attached data from its key
  97087. * @param key the unique key that identifies the data
  97088. * @return the associated data, if present (can be null), or undefined if not present
  97089. */
  97090. getExternalData<T>(key: string): T;
  97091. /**
  97092. * Get an externaly attached data from its key, create it using a factory if it's not already present
  97093. * @param key the unique key that identifies the data
  97094. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  97095. * @return the associated data, can be null if the factory returned null.
  97096. */
  97097. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  97098. /**
  97099. * Remove an externaly attached data from the Engine instance
  97100. * @param key the unique key that identifies the data
  97101. * @return true if the data was successfully removed, false if it doesn't exist
  97102. */
  97103. removeExternalData(key: string): boolean;
  97104. /**
  97105. * Unbind all vertex attributes from the webGL context
  97106. */
  97107. unbindAllAttributes(): void;
  97108. /**
  97109. * 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
  97110. */
  97111. releaseEffects(): void;
  97112. /**
  97113. * Dispose and release all associated resources
  97114. */
  97115. dispose(): void;
  97116. /**
  97117. * Display the loading screen
  97118. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97119. */
  97120. displayLoadingUI(): void;
  97121. /**
  97122. * Hide the loading screen
  97123. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97124. */
  97125. hideLoadingUI(): void;
  97126. /**
  97127. * Gets the current loading screen object
  97128. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97129. */
  97130. /**
  97131. * Sets the current loading screen object
  97132. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97133. */
  97134. loadingScreen: ILoadingScreen;
  97135. /**
  97136. * Sets the current loading screen text
  97137. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97138. */
  97139. loadingUIText: string;
  97140. /**
  97141. * Sets the current loading screen background color
  97142. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  97143. */
  97144. loadingUIBackgroundColor: string;
  97145. /**
  97146. * Attach a new callback raised when context lost event is fired
  97147. * @param callback defines the callback to call
  97148. */
  97149. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97150. /**
  97151. * Attach a new callback raised when context restored event is fired
  97152. * @param callback defines the callback to call
  97153. */
  97154. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97155. /**
  97156. * Gets the source code of the vertex shader associated with a specific webGL program
  97157. * @param program defines the program to use
  97158. * @returns a string containing the source code of the vertex shader associated with the program
  97159. */
  97160. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  97161. /**
  97162. * Gets the source code of the fragment shader associated with a specific webGL program
  97163. * @param program defines the program to use
  97164. * @returns a string containing the source code of the fragment shader associated with the program
  97165. */
  97166. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  97167. /**
  97168. * Get the current error code of the webGL context
  97169. * @returns the error code
  97170. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  97171. */
  97172. getError(): number;
  97173. /**
  97174. * Gets the current framerate
  97175. * @returns a number representing the framerate
  97176. */
  97177. getFps(): number;
  97178. /**
  97179. * Gets the time spent between current and previous frame
  97180. * @returns a number representing the delta time in ms
  97181. */
  97182. getDeltaTime(): number;
  97183. private _measureFps;
  97184. /** @hidden */
  97185. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  97186. private _canRenderToFloatFramebuffer;
  97187. private _canRenderToHalfFloatFramebuffer;
  97188. private _canRenderToFramebuffer;
  97189. /** @hidden */
  97190. _getWebGLTextureType(type: number): number;
  97191. /** @hidden */
  97192. _getInternalFormat(format: number): number;
  97193. /** @hidden */
  97194. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  97195. /** @hidden */
  97196. _getRGBAMultiSampleBufferFormat(type: number): number;
  97197. /** @hidden */
  97198. _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;
  97199. /** @hidden */
  97200. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  97201. /**
  97202. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  97203. * @returns true if the engine can be created
  97204. * @ignorenaming
  97205. */
  97206. static isSupported(): boolean;
  97207. /**
  97208. * Find the next highest power of two.
  97209. * @param x Number to start search from.
  97210. * @return Next highest power of two.
  97211. */
  97212. static CeilingPOT(x: number): number;
  97213. /**
  97214. * Find the next lowest power of two.
  97215. * @param x Number to start search from.
  97216. * @return Next lowest power of two.
  97217. */
  97218. static FloorPOT(x: number): number;
  97219. /**
  97220. * Find the nearest power of two.
  97221. * @param x Number to start search from.
  97222. * @return Next nearest power of two.
  97223. */
  97224. static NearestPOT(x: number): number;
  97225. /**
  97226. * Get the closest exponent of two
  97227. * @param value defines the value to approximate
  97228. * @param max defines the maximum value to return
  97229. * @param mode defines how to define the closest value
  97230. * @returns closest exponent of two of the given value
  97231. */
  97232. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  97233. /**
  97234. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  97235. * @param func - the function to be called
  97236. * @param requester - the object that will request the next frame. Falls back to window.
  97237. * @returns frame number
  97238. */
  97239. static QueueNewFrame(func: () => void, requester?: any): number;
  97240. /**
  97241. * Ask the browser to promote the current element to pointerlock mode
  97242. * @param element defines the DOM element to promote
  97243. */
  97244. static _RequestPointerlock(element: HTMLElement): void;
  97245. /**
  97246. * Asks the browser to exit pointerlock mode
  97247. */
  97248. static _ExitPointerlock(): void;
  97249. /**
  97250. * Ask the browser to promote the current element to fullscreen rendering mode
  97251. * @param element defines the DOM element to promote
  97252. */
  97253. static _RequestFullscreen(element: HTMLElement): void;
  97254. /**
  97255. * Asks the browser to exit fullscreen mode
  97256. */
  97257. static _ExitFullscreen(): void;
  97258. }
  97259. }
  97260. declare module BABYLON {
  97261. /**
  97262. * The engine store class is responsible to hold all the instances of Engine and Scene created
  97263. * during the life time of the application.
  97264. */
  97265. export class EngineStore {
  97266. /** Gets the list of created engines */
  97267. static Instances: Engine[];
  97268. /** @hidden */
  97269. static _LastCreatedScene: Nullable<Scene>;
  97270. /**
  97271. * Gets the latest created engine
  97272. */
  97273. static readonly LastCreatedEngine: Nullable<Engine>;
  97274. /**
  97275. * Gets the latest created scene
  97276. */
  97277. static readonly LastCreatedScene: Nullable<Scene>;
  97278. /**
  97279. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  97280. * @ignorenaming
  97281. */
  97282. static UseFallbackTexture: boolean;
  97283. /**
  97284. * Texture content used if a texture cannot loaded
  97285. * @ignorenaming
  97286. */
  97287. static FallbackTexture: string;
  97288. }
  97289. }
  97290. declare module BABYLON {
  97291. /**
  97292. * Helper class that provides a small promise polyfill
  97293. */
  97294. export class PromisePolyfill {
  97295. /**
  97296. * Static function used to check if the polyfill is required
  97297. * If this is the case then the function will inject the polyfill to window.Promise
  97298. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  97299. */
  97300. static Apply(force?: boolean): void;
  97301. }
  97302. }
  97303. declare module BABYLON {
  97304. /**
  97305. * Interface for screenshot methods with describe argument called `size` as object with options
  97306. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  97307. */
  97308. export interface IScreenshotSize {
  97309. /**
  97310. * number in pixels for canvas height
  97311. */
  97312. height?: number;
  97313. /**
  97314. * multiplier allowing render at a higher or lower resolution
  97315. * If value is defined then height and width will be ignored and taken from camera
  97316. */
  97317. precision?: number;
  97318. /**
  97319. * number in pixels for canvas width
  97320. */
  97321. width?: number;
  97322. }
  97323. }
  97324. declare module BABYLON {
  97325. interface IColor4Like {
  97326. r: float;
  97327. g: float;
  97328. b: float;
  97329. a: float;
  97330. }
  97331. /**
  97332. * Class containing a set of static utilities functions
  97333. */
  97334. export class Tools {
  97335. /**
  97336. * Gets or sets the base URL to use to load assets
  97337. */
  97338. static BaseUrl: string;
  97339. /**
  97340. * Enable/Disable Custom HTTP Request Headers globally.
  97341. * default = false
  97342. * @see CustomRequestHeaders
  97343. */
  97344. static UseCustomRequestHeaders: boolean;
  97345. /**
  97346. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  97347. * i.e. when loading files, where the server/service expects an Authorization header
  97348. */
  97349. static CustomRequestHeaders: {
  97350. [key: string]: string;
  97351. };
  97352. /**
  97353. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  97354. */
  97355. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  97356. /**
  97357. * Default behaviour for cors in the application.
  97358. * It can be a string if the expected behavior is identical in the entire app.
  97359. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  97360. */
  97361. static CorsBehavior: string | ((url: string | string[]) => string);
  97362. /**
  97363. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  97364. * @ignorenaming
  97365. */
  97366. static UseFallbackTexture: boolean;
  97367. /**
  97368. * Use this object to register external classes like custom textures or material
  97369. * to allow the laoders to instantiate them
  97370. */
  97371. static RegisteredExternalClasses: {
  97372. [key: string]: Object;
  97373. };
  97374. /**
  97375. * Texture content used if a texture cannot loaded
  97376. * @ignorenaming
  97377. */
  97378. static fallbackTexture: string;
  97379. /**
  97380. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  97381. * @param u defines the coordinate on X axis
  97382. * @param v defines the coordinate on Y axis
  97383. * @param width defines the width of the source data
  97384. * @param height defines the height of the source data
  97385. * @param pixels defines the source byte array
  97386. * @param color defines the output color
  97387. */
  97388. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  97389. /**
  97390. * Interpolates between a and b via alpha
  97391. * @param a The lower value (returned when alpha = 0)
  97392. * @param b The upper value (returned when alpha = 1)
  97393. * @param alpha The interpolation-factor
  97394. * @return The mixed value
  97395. */
  97396. static Mix(a: number, b: number, alpha: number): number;
  97397. /**
  97398. * Tries to instantiate a new object from a given class name
  97399. * @param className defines the class name to instantiate
  97400. * @returns the new object or null if the system was not able to do the instantiation
  97401. */
  97402. static Instantiate(className: string): any;
  97403. /**
  97404. * Provides a slice function that will work even on IE
  97405. * @param data defines the array to slice
  97406. * @param start defines the start of the data (optional)
  97407. * @param end defines the end of the data (optional)
  97408. * @returns the new sliced array
  97409. */
  97410. static Slice<T>(data: T, start?: number, end?: number): T;
  97411. /**
  97412. * Polyfill for setImmediate
  97413. * @param action defines the action to execute after the current execution block
  97414. */
  97415. static SetImmediate(action: () => void): void;
  97416. /**
  97417. * Function indicating if a number is an exponent of 2
  97418. * @param value defines the value to test
  97419. * @returns true if the value is an exponent of 2
  97420. */
  97421. static IsExponentOfTwo(value: number): boolean;
  97422. private static _tmpFloatArray;
  97423. /**
  97424. * Returns the nearest 32-bit single precision float representation of a Number
  97425. * @param value A Number. If the parameter is of a different type, it will get converted
  97426. * to a number or to NaN if it cannot be converted
  97427. * @returns number
  97428. */
  97429. static FloatRound(value: number): number;
  97430. /**
  97431. * Extracts the filename from a path
  97432. * @param path defines the path to use
  97433. * @returns the filename
  97434. */
  97435. static GetFilename(path: string): string;
  97436. /**
  97437. * Extracts the "folder" part of a path (everything before the filename).
  97438. * @param uri The URI to extract the info from
  97439. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  97440. * @returns The "folder" part of the path
  97441. */
  97442. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  97443. /**
  97444. * Extracts text content from a DOM element hierarchy
  97445. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  97446. */
  97447. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  97448. /**
  97449. * Convert an angle in radians to degrees
  97450. * @param angle defines the angle to convert
  97451. * @returns the angle in degrees
  97452. */
  97453. static ToDegrees(angle: number): number;
  97454. /**
  97455. * Convert an angle in degrees to radians
  97456. * @param angle defines the angle to convert
  97457. * @returns the angle in radians
  97458. */
  97459. static ToRadians(angle: number): number;
  97460. /**
  97461. * Encode a buffer to a base64 string
  97462. * @param buffer defines the buffer to encode
  97463. * @returns the encoded string
  97464. */
  97465. static EncodeArrayBufferTobase64(buffer: ArrayBuffer): string;
  97466. /**
  97467. * Returns an array if obj is not an array
  97468. * @param obj defines the object to evaluate as an array
  97469. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  97470. * @returns either obj directly if obj is an array or a new array containing obj
  97471. */
  97472. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  97473. /**
  97474. * Gets the pointer prefix to use
  97475. * @returns "pointer" if touch is enabled. Else returns "mouse"
  97476. */
  97477. static GetPointerPrefix(): string;
  97478. /**
  97479. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  97480. * @param url define the url we are trying
  97481. * @param element define the dom element where to configure the cors policy
  97482. */
  97483. static SetCorsBehavior(url: string | string[], element: {
  97484. crossOrigin: string | null;
  97485. }): void;
  97486. /**
  97487. * Removes unwanted characters from an url
  97488. * @param url defines the url to clean
  97489. * @returns the cleaned url
  97490. */
  97491. static CleanUrl(url: string): string;
  97492. /**
  97493. * Gets or sets a function used to pre-process url before using them to load assets
  97494. */
  97495. static PreprocessUrl: (url: string) => string;
  97496. /**
  97497. * Loads an image as an HTMLImageElement.
  97498. * @param input url string, ArrayBuffer, or Blob to load
  97499. * @param onLoad callback called when the image successfully loads
  97500. * @param onError callback called when the image fails to load
  97501. * @param offlineProvider offline provider for caching
  97502. * @returns the HTMLImageElement of the loaded image
  97503. */
  97504. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  97505. /**
  97506. * Loads a file
  97507. * @param url url string, ArrayBuffer, or Blob to load
  97508. * @param onSuccess callback called when the file successfully loads
  97509. * @param onProgress callback called while file is loading (if the server supports this mode)
  97510. * @param offlineProvider defines the offline provider for caching
  97511. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  97512. * @param onError callback called when the file fails to load
  97513. * @returns a file request object
  97514. */
  97515. 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;
  97516. /**
  97517. * Loads a file from a url
  97518. * @param url the file url to load
  97519. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  97520. */
  97521. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  97522. /**
  97523. * Load a script (identified by an url). When the url returns, the
  97524. * content of this file is added into a new script element, attached to the DOM (body element)
  97525. * @param scriptUrl defines the url of the script to laod
  97526. * @param onSuccess defines the callback called when the script is loaded
  97527. * @param onError defines the callback to call if an error occurs
  97528. * @param scriptId defines the id of the script element
  97529. */
  97530. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  97531. /**
  97532. * Load an asynchronous script (identified by an url). When the url returns, the
  97533. * content of this file is added into a new script element, attached to the DOM (body element)
  97534. * @param scriptUrl defines the url of the script to laod
  97535. * @param scriptId defines the id of the script element
  97536. * @returns a promise request object
  97537. */
  97538. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  97539. /**
  97540. * Loads a file from a blob
  97541. * @param fileToLoad defines the blob to use
  97542. * @param callback defines the callback to call when data is loaded
  97543. * @param progressCallback defines the callback to call during loading process
  97544. * @returns a file request object
  97545. */
  97546. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  97547. /**
  97548. * Loads a file
  97549. * @param fileToLoad defines the file to load
  97550. * @param callback defines the callback to call when data is loaded
  97551. * @param progressCallBack defines the callback to call during loading process
  97552. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  97553. * @returns a file request object
  97554. */
  97555. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  97556. /**
  97557. * Creates a data url from a given string content
  97558. * @param content defines the content to convert
  97559. * @returns the new data url link
  97560. */
  97561. static FileAsURL(content: string): string;
  97562. /**
  97563. * Format the given number to a specific decimal format
  97564. * @param value defines the number to format
  97565. * @param decimals defines the number of decimals to use
  97566. * @returns the formatted string
  97567. */
  97568. static Format(value: number, decimals?: number): string;
  97569. /**
  97570. * Tries to copy an object by duplicating every property
  97571. * @param source defines the source object
  97572. * @param destination defines the target object
  97573. * @param doNotCopyList defines a list of properties to avoid
  97574. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  97575. */
  97576. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  97577. /**
  97578. * Gets a boolean indicating if the given object has no own property
  97579. * @param obj defines the object to test
  97580. * @returns true if object has no own property
  97581. */
  97582. static IsEmpty(obj: any): boolean;
  97583. /**
  97584. * Function used to register events at window level
  97585. * @param windowElement defines the Window object to use
  97586. * @param events defines the events to register
  97587. */
  97588. static RegisterTopRootEvents(windowElement: Window, events: {
  97589. name: string;
  97590. handler: Nullable<(e: FocusEvent) => any>;
  97591. }[]): void;
  97592. /**
  97593. * Function used to unregister events from window level
  97594. * @param windowElement defines the Window object to use
  97595. * @param events defines the events to unregister
  97596. */
  97597. static UnregisterTopRootEvents(windowElement: Window, events: {
  97598. name: string;
  97599. handler: Nullable<(e: FocusEvent) => any>;
  97600. }[]): void;
  97601. /**
  97602. * @ignore
  97603. */
  97604. static _ScreenshotCanvas: HTMLCanvasElement;
  97605. /**
  97606. * Dumps the current bound framebuffer
  97607. * @param width defines the rendering width
  97608. * @param height defines the rendering height
  97609. * @param engine defines the hosting engine
  97610. * @param successCallback defines the callback triggered once the data are available
  97611. * @param mimeType defines the mime type of the result
  97612. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  97613. */
  97614. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  97615. /**
  97616. * Converts the canvas data to blob.
  97617. * This acts as a polyfill for browsers not supporting the to blob function.
  97618. * @param canvas Defines the canvas to extract the data from
  97619. * @param successCallback Defines the callback triggered once the data are available
  97620. * @param mimeType Defines the mime type of the result
  97621. */
  97622. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  97623. /**
  97624. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  97625. * @param successCallback defines the callback triggered once the data are available
  97626. * @param mimeType defines the mime type of the result
  97627. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  97628. */
  97629. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  97630. /**
  97631. * Downloads a blob in the browser
  97632. * @param blob defines the blob to download
  97633. * @param fileName defines the name of the downloaded file
  97634. */
  97635. static Download(blob: Blob, fileName: string): void;
  97636. /**
  97637. * Captures a screenshot of the current rendering
  97638. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  97639. * @param engine defines the rendering engine
  97640. * @param camera defines the source camera
  97641. * @param size This parameter can be set to a single number or to an object with the
  97642. * following (optional) properties: precision, width, height. If a single number is passed,
  97643. * it will be used for both width and height. If an object is passed, the screenshot size
  97644. * will be derived from the parameters. The precision property is a multiplier allowing
  97645. * rendering at a higher or lower resolution
  97646. * @param successCallback defines the callback receives a single parameter which contains the
  97647. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  97648. * src parameter of an <img> to display it
  97649. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  97650. * Check your browser for supported MIME types
  97651. */
  97652. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  97653. /**
  97654. * Captures a screenshot of the current rendering
  97655. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  97656. * @param engine defines the rendering engine
  97657. * @param camera defines the source camera
  97658. * @param size This parameter can be set to a single number or to an object with the
  97659. * following (optional) properties: precision, width, height. If a single number is passed,
  97660. * it will be used for both width and height. If an object is passed, the screenshot size
  97661. * will be derived from the parameters. The precision property is a multiplier allowing
  97662. * rendering at a higher or lower resolution
  97663. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  97664. * Check your browser for supported MIME types
  97665. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  97666. * to the src parameter of an <img> to display it
  97667. */
  97668. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  97669. /**
  97670. * Generates an image screenshot from the specified camera.
  97671. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  97672. * @param engine The engine to use for rendering
  97673. * @param camera The camera to use for rendering
  97674. * @param size This parameter can be set to a single number or to an object with the
  97675. * following (optional) properties: precision, width, height. If a single number is passed,
  97676. * it will be used for both width and height. If an object is passed, the screenshot size
  97677. * will be derived from the parameters. The precision property is a multiplier allowing
  97678. * rendering at a higher or lower resolution
  97679. * @param successCallback The callback receives a single parameter which contains the
  97680. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  97681. * src parameter of an <img> to display it
  97682. * @param mimeType The MIME type of the screenshot image (default: image/png).
  97683. * Check your browser for supported MIME types
  97684. * @param samples Texture samples (default: 1)
  97685. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  97686. * @param fileName A name for for the downloaded file.
  97687. */
  97688. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  97689. /**
  97690. * Generates an image screenshot from the specified camera.
  97691. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  97692. * @param engine The engine to use for rendering
  97693. * @param camera The camera to use for rendering
  97694. * @param size This parameter can be set to a single number or to an object with the
  97695. * following (optional) properties: precision, width, height. If a single number is passed,
  97696. * it will be used for both width and height. If an object is passed, the screenshot size
  97697. * will be derived from the parameters. The precision property is a multiplier allowing
  97698. * rendering at a higher or lower resolution
  97699. * @param mimeType The MIME type of the screenshot image (default: image/png).
  97700. * Check your browser for supported MIME types
  97701. * @param samples Texture samples (default: 1)
  97702. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  97703. * @param fileName A name for for the downloaded file.
  97704. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  97705. * to the src parameter of an <img> to display it
  97706. */
  97707. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  97708. /**
  97709. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  97710. * Be aware Math.random() could cause collisions, but:
  97711. * "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"
  97712. * @returns a pseudo random id
  97713. */
  97714. static RandomId(): string;
  97715. /**
  97716. * Test if the given uri is a base64 string
  97717. * @param uri The uri to test
  97718. * @return True if the uri is a base64 string or false otherwise
  97719. */
  97720. static IsBase64(uri: string): boolean;
  97721. /**
  97722. * Decode the given base64 uri.
  97723. * @param uri The uri to decode
  97724. * @return The decoded base64 data.
  97725. */
  97726. static DecodeBase64(uri: string): ArrayBuffer;
  97727. /**
  97728. * Gets the absolute url.
  97729. * @param url the input url
  97730. * @return the absolute url
  97731. */
  97732. static GetAbsoluteUrl(url: string): string;
  97733. /**
  97734. * No log
  97735. */
  97736. static readonly NoneLogLevel: number;
  97737. /**
  97738. * Only message logs
  97739. */
  97740. static readonly MessageLogLevel: number;
  97741. /**
  97742. * Only warning logs
  97743. */
  97744. static readonly WarningLogLevel: number;
  97745. /**
  97746. * Only error logs
  97747. */
  97748. static readonly ErrorLogLevel: number;
  97749. /**
  97750. * All logs
  97751. */
  97752. static readonly AllLogLevel: number;
  97753. /**
  97754. * Gets a value indicating the number of loading errors
  97755. * @ignorenaming
  97756. */
  97757. static readonly errorsCount: number;
  97758. /**
  97759. * Callback called when a new log is added
  97760. */
  97761. static OnNewCacheEntry: (entry: string) => void;
  97762. /**
  97763. * Log a message to the console
  97764. * @param message defines the message to log
  97765. */
  97766. static Log(message: string): void;
  97767. /**
  97768. * Write a warning message to the console
  97769. * @param message defines the message to log
  97770. */
  97771. static Warn(message: string): void;
  97772. /**
  97773. * Write an error message to the console
  97774. * @param message defines the message to log
  97775. */
  97776. static Error(message: string): void;
  97777. /**
  97778. * Gets current log cache (list of logs)
  97779. */
  97780. static readonly LogCache: string;
  97781. /**
  97782. * Clears the log cache
  97783. */
  97784. static ClearLogCache(): void;
  97785. /**
  97786. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  97787. */
  97788. static LogLevels: number;
  97789. /**
  97790. * Checks if the window object exists
  97791. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  97792. */
  97793. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  97794. /**
  97795. * No performance log
  97796. */
  97797. static readonly PerformanceNoneLogLevel: number;
  97798. /**
  97799. * Use user marks to log performance
  97800. */
  97801. static readonly PerformanceUserMarkLogLevel: number;
  97802. /**
  97803. * Log performance to the console
  97804. */
  97805. static readonly PerformanceConsoleLogLevel: number;
  97806. private static _performance;
  97807. /**
  97808. * Sets the current performance log level
  97809. */
  97810. static PerformanceLogLevel: number;
  97811. private static _StartPerformanceCounterDisabled;
  97812. private static _EndPerformanceCounterDisabled;
  97813. private static _StartUserMark;
  97814. private static _EndUserMark;
  97815. private static _StartPerformanceConsole;
  97816. private static _EndPerformanceConsole;
  97817. /**
  97818. * Starts a performance counter
  97819. */
  97820. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  97821. /**
  97822. * Ends a specific performance coutner
  97823. */
  97824. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  97825. /**
  97826. * Gets either window.performance.now() if supported or Date.now() else
  97827. */
  97828. static readonly Now: number;
  97829. /**
  97830. * This method will return the name of the class used to create the instance of the given object.
  97831. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  97832. * @param object the object to get the class name from
  97833. * @param isType defines if the object is actually a type
  97834. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  97835. */
  97836. static GetClassName(object: any, isType?: boolean): string;
  97837. /**
  97838. * Gets the first element of an array satisfying a given predicate
  97839. * @param array defines the array to browse
  97840. * @param predicate defines the predicate to use
  97841. * @returns null if not found or the element
  97842. */
  97843. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  97844. /**
  97845. * This method will return the name of the full name of the class, including its owning module (if any).
  97846. * 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).
  97847. * @param object the object to get the class name from
  97848. * @param isType defines if the object is actually a type
  97849. * @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.
  97850. * @ignorenaming
  97851. */
  97852. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  97853. /**
  97854. * Returns a promise that resolves after the given amount of time.
  97855. * @param delay Number of milliseconds to delay
  97856. * @returns Promise that resolves after the given amount of time
  97857. */
  97858. static DelayAsync(delay: number): Promise<void>;
  97859. }
  97860. /**
  97861. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  97862. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  97863. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  97864. * @param name The name of the class, case should be preserved
  97865. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  97866. */
  97867. export function className(name: string, module?: string): (target: Object) => void;
  97868. /**
  97869. * An implementation of a loop for asynchronous functions.
  97870. */
  97871. export class AsyncLoop {
  97872. /**
  97873. * Defines the number of iterations for the loop
  97874. */
  97875. iterations: number;
  97876. /**
  97877. * Defines the current index of the loop.
  97878. */
  97879. index: number;
  97880. private _done;
  97881. private _fn;
  97882. private _successCallback;
  97883. /**
  97884. * Constructor.
  97885. * @param iterations the number of iterations.
  97886. * @param func the function to run each iteration
  97887. * @param successCallback the callback that will be called upon succesful execution
  97888. * @param offset starting offset.
  97889. */
  97890. constructor(
  97891. /**
  97892. * Defines the number of iterations for the loop
  97893. */
  97894. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  97895. /**
  97896. * Execute the next iteration. Must be called after the last iteration was finished.
  97897. */
  97898. executeNext(): void;
  97899. /**
  97900. * Break the loop and run the success callback.
  97901. */
  97902. breakLoop(): void;
  97903. /**
  97904. * Create and run an async loop.
  97905. * @param iterations the number of iterations.
  97906. * @param fn the function to run each iteration
  97907. * @param successCallback the callback that will be called upon succesful execution
  97908. * @param offset starting offset.
  97909. * @returns the created async loop object
  97910. */
  97911. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  97912. /**
  97913. * A for-loop that will run a given number of iterations synchronous and the rest async.
  97914. * @param iterations total number of iterations
  97915. * @param syncedIterations number of synchronous iterations in each async iteration.
  97916. * @param fn the function to call each iteration.
  97917. * @param callback a success call back that will be called when iterating stops.
  97918. * @param breakFunction a break condition (optional)
  97919. * @param timeout timeout settings for the setTimeout function. default - 0.
  97920. * @returns the created async loop object
  97921. */
  97922. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  97923. }
  97924. }
  97925. declare module BABYLON {
  97926. /** @hidden */
  97927. export interface ICollisionCoordinator {
  97928. createCollider(): Collider;
  97929. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  97930. init(scene: Scene): void;
  97931. }
  97932. /** @hidden */
  97933. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  97934. private _scene;
  97935. private _scaledPosition;
  97936. private _scaledVelocity;
  97937. private _finalPosition;
  97938. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  97939. createCollider(): Collider;
  97940. init(scene: Scene): void;
  97941. private _collideWithWorld;
  97942. }
  97943. }
  97944. declare module BABYLON {
  97945. /**
  97946. * Class used to manage all inputs for the scene.
  97947. */
  97948. export class InputManager {
  97949. /** The distance in pixel that you have to move to prevent some events */
  97950. static DragMovementThreshold: number;
  97951. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  97952. static LongPressDelay: number;
  97953. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  97954. static DoubleClickDelay: number;
  97955. /** If you need to check double click without raising a single click at first click, enable this flag */
  97956. static ExclusiveDoubleClickMode: boolean;
  97957. private _wheelEventName;
  97958. private _onPointerMove;
  97959. private _onPointerDown;
  97960. private _onPointerUp;
  97961. private _initClickEvent;
  97962. private _initActionManager;
  97963. private _delayedSimpleClick;
  97964. private _delayedSimpleClickTimeout;
  97965. private _previousDelayedSimpleClickTimeout;
  97966. private _meshPickProceed;
  97967. private _previousButtonPressed;
  97968. private _currentPickResult;
  97969. private _previousPickResult;
  97970. private _totalPointersPressed;
  97971. private _doubleClickOccured;
  97972. private _pointerOverMesh;
  97973. private _pickedDownMesh;
  97974. private _pickedUpMesh;
  97975. private _pointerX;
  97976. private _pointerY;
  97977. private _unTranslatedPointerX;
  97978. private _unTranslatedPointerY;
  97979. private _startingPointerPosition;
  97980. private _previousStartingPointerPosition;
  97981. private _startingPointerTime;
  97982. private _previousStartingPointerTime;
  97983. private _pointerCaptures;
  97984. private _onKeyDown;
  97985. private _onKeyUp;
  97986. private _onCanvasFocusObserver;
  97987. private _onCanvasBlurObserver;
  97988. private _scene;
  97989. /**
  97990. * Creates a new InputManager
  97991. * @param scene defines the hosting scene
  97992. */
  97993. constructor(scene: Scene);
  97994. /**
  97995. * Gets the mesh that is currently under the pointer
  97996. */
  97997. readonly meshUnderPointer: Nullable<AbstractMesh>;
  97998. /**
  97999. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  98000. */
  98001. readonly unTranslatedPointer: Vector2;
  98002. /**
  98003. * Gets or sets the current on-screen X position of the pointer
  98004. */
  98005. pointerX: number;
  98006. /**
  98007. * Gets or sets the current on-screen Y position of the pointer
  98008. */
  98009. pointerY: number;
  98010. private _updatePointerPosition;
  98011. private _processPointerMove;
  98012. private _setRayOnPointerInfo;
  98013. private _checkPrePointerObservable;
  98014. /**
  98015. * Use this method to simulate a pointer move on a mesh
  98016. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  98017. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  98018. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  98019. */
  98020. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  98021. /**
  98022. * Use this method to simulate a pointer down on a mesh
  98023. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  98024. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  98025. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  98026. */
  98027. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  98028. private _processPointerDown;
  98029. /** @hidden */
  98030. _isPointerSwiping(): boolean;
  98031. /**
  98032. * Use this method to simulate a pointer up on a mesh
  98033. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  98034. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  98035. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  98036. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  98037. */
  98038. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  98039. private _processPointerUp;
  98040. /**
  98041. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  98042. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  98043. * @returns true if the pointer was captured
  98044. */
  98045. isPointerCaptured(pointerId?: number): boolean;
  98046. /**
  98047. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  98048. * @param attachUp defines if you want to attach events to pointerup
  98049. * @param attachDown defines if you want to attach events to pointerdown
  98050. * @param attachMove defines if you want to attach events to pointermove
  98051. */
  98052. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  98053. /**
  98054. * Detaches all event handlers
  98055. */
  98056. detachControl(): void;
  98057. /**
  98058. * Force the value of meshUnderPointer
  98059. * @param mesh defines the mesh to use
  98060. */
  98061. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  98062. /**
  98063. * Gets the mesh under the pointer
  98064. * @returns a Mesh or null if no mesh is under the pointer
  98065. */
  98066. getPointerOverMesh(): Nullable<AbstractMesh>;
  98067. }
  98068. }
  98069. declare module BABYLON {
  98070. /**
  98071. * Helper class used to generate session unique ID
  98072. */
  98073. export class UniqueIdGenerator {
  98074. private static _UniqueIdCounter;
  98075. /**
  98076. * Gets an unique (relatively to the current scene) Id
  98077. */
  98078. static readonly UniqueId: number;
  98079. }
  98080. }
  98081. declare module BABYLON {
  98082. /**
  98083. * This class defines the direct association between an animation and a target
  98084. */
  98085. export class TargetedAnimation {
  98086. /**
  98087. * Animation to perform
  98088. */
  98089. animation: Animation;
  98090. /**
  98091. * Target to animate
  98092. */
  98093. target: any;
  98094. /**
  98095. * Serialize the object
  98096. * @returns the JSON object representing the current entity
  98097. */
  98098. serialize(): any;
  98099. }
  98100. /**
  98101. * Use this class to create coordinated animations on multiple targets
  98102. */
  98103. export class AnimationGroup implements IDisposable {
  98104. /** The name of the animation group */
  98105. name: string;
  98106. private _scene;
  98107. private _targetedAnimations;
  98108. private _animatables;
  98109. private _from;
  98110. private _to;
  98111. private _isStarted;
  98112. private _isPaused;
  98113. private _speedRatio;
  98114. private _loopAnimation;
  98115. /**
  98116. * Gets or sets the unique id of the node
  98117. */
  98118. uniqueId: number;
  98119. /**
  98120. * This observable will notify when one animation have ended
  98121. */
  98122. onAnimationEndObservable: Observable<TargetedAnimation>;
  98123. /**
  98124. * Observer raised when one animation loops
  98125. */
  98126. onAnimationLoopObservable: Observable<TargetedAnimation>;
  98127. /**
  98128. * This observable will notify when all animations have ended.
  98129. */
  98130. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  98131. /**
  98132. * This observable will notify when all animations have paused.
  98133. */
  98134. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  98135. /**
  98136. * This observable will notify when all animations are playing.
  98137. */
  98138. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  98139. /**
  98140. * Gets the first frame
  98141. */
  98142. readonly from: number;
  98143. /**
  98144. * Gets the last frame
  98145. */
  98146. readonly to: number;
  98147. /**
  98148. * Define if the animations are started
  98149. */
  98150. readonly isStarted: boolean;
  98151. /**
  98152. * Gets a value indicating that the current group is playing
  98153. */
  98154. readonly isPlaying: boolean;
  98155. /**
  98156. * Gets or sets the speed ratio to use for all animations
  98157. */
  98158. /**
  98159. * Gets or sets the speed ratio to use for all animations
  98160. */
  98161. speedRatio: number;
  98162. /**
  98163. * Gets or sets if all animations should loop or not
  98164. */
  98165. loopAnimation: boolean;
  98166. /**
  98167. * Gets the targeted animations for this animation group
  98168. */
  98169. readonly targetedAnimations: Array<TargetedAnimation>;
  98170. /**
  98171. * returning the list of animatables controlled by this animation group.
  98172. */
  98173. readonly animatables: Array<Animatable>;
  98174. /**
  98175. * Instantiates a new Animation Group.
  98176. * This helps managing several animations at once.
  98177. * @see http://doc.babylonjs.com/how_to/group
  98178. * @param name Defines the name of the group
  98179. * @param scene Defines the scene the group belongs to
  98180. */
  98181. constructor(
  98182. /** The name of the animation group */
  98183. name: string, scene?: Nullable<Scene>);
  98184. /**
  98185. * Add an animation (with its target) in the group
  98186. * @param animation defines the animation we want to add
  98187. * @param target defines the target of the animation
  98188. * @returns the TargetedAnimation object
  98189. */
  98190. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  98191. /**
  98192. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  98193. * It can add constant keys at begin or end
  98194. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  98195. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  98196. * @returns the animation group
  98197. */
  98198. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  98199. /**
  98200. * Start all animations on given targets
  98201. * @param loop defines if animations must loop
  98202. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  98203. * @param from defines the from key (optional)
  98204. * @param to defines the to key (optional)
  98205. * @returns the current animation group
  98206. */
  98207. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  98208. /**
  98209. * Pause all animations
  98210. * @returns the animation group
  98211. */
  98212. pause(): AnimationGroup;
  98213. /**
  98214. * Play all animations to initial state
  98215. * This function will start() the animations if they were not started or will restart() them if they were paused
  98216. * @param loop defines if animations must loop
  98217. * @returns the animation group
  98218. */
  98219. play(loop?: boolean): AnimationGroup;
  98220. /**
  98221. * Reset all animations to initial state
  98222. * @returns the animation group
  98223. */
  98224. reset(): AnimationGroup;
  98225. /**
  98226. * Restart animations from key 0
  98227. * @returns the animation group
  98228. */
  98229. restart(): AnimationGroup;
  98230. /**
  98231. * Stop all animations
  98232. * @returns the animation group
  98233. */
  98234. stop(): AnimationGroup;
  98235. /**
  98236. * Set animation weight for all animatables
  98237. * @param weight defines the weight to use
  98238. * @return the animationGroup
  98239. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  98240. */
  98241. setWeightForAllAnimatables(weight: number): AnimationGroup;
  98242. /**
  98243. * Synchronize and normalize all animatables with a source animatable
  98244. * @param root defines the root animatable to synchronize with
  98245. * @return the animationGroup
  98246. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  98247. */
  98248. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  98249. /**
  98250. * Goes to a specific frame in this animation group
  98251. * @param frame the frame number to go to
  98252. * @return the animationGroup
  98253. */
  98254. goToFrame(frame: number): AnimationGroup;
  98255. /**
  98256. * Dispose all associated resources
  98257. */
  98258. dispose(): void;
  98259. private _checkAnimationGroupEnded;
  98260. /**
  98261. * Clone the current animation group and returns a copy
  98262. * @param newName defines the name of the new group
  98263. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  98264. * @returns the new aniamtion group
  98265. */
  98266. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  98267. /**
  98268. * Serializes the animationGroup to an object
  98269. * @returns Serialized object
  98270. */
  98271. serialize(): any;
  98272. /**
  98273. * Returns a new AnimationGroup object parsed from the source provided.
  98274. * @param parsedAnimationGroup defines the source
  98275. * @param scene defines the scene that will receive the animationGroup
  98276. * @returns a new AnimationGroup
  98277. */
  98278. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  98279. /**
  98280. * Returns the string "AnimationGroup"
  98281. * @returns "AnimationGroup"
  98282. */
  98283. getClassName(): string;
  98284. /**
  98285. * Creates a detailled string about the object
  98286. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  98287. * @returns a string representing the object
  98288. */
  98289. toString(fullDetails?: boolean): string;
  98290. }
  98291. }
  98292. declare module BABYLON {
  98293. /**
  98294. * Define an interface for all classes that will hold resources
  98295. */
  98296. export interface IDisposable {
  98297. /**
  98298. * Releases all held resources
  98299. */
  98300. dispose(): void;
  98301. }
  98302. /** Interface defining initialization parameters for Scene class */
  98303. export interface SceneOptions {
  98304. /**
  98305. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  98306. * It will improve performance when the number of geometries becomes important.
  98307. */
  98308. useGeometryUniqueIdsMap?: boolean;
  98309. /**
  98310. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  98311. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  98312. */
  98313. useMaterialMeshMap?: boolean;
  98314. /**
  98315. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  98316. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  98317. */
  98318. useClonedMeshhMap?: boolean;
  98319. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  98320. virtual?: boolean;
  98321. }
  98322. /**
  98323. * Represents a scene to be rendered by the engine.
  98324. * @see http://doc.babylonjs.com/features/scene
  98325. */
  98326. export class Scene extends AbstractScene implements IAnimatable {
  98327. /** The fog is deactivated */
  98328. static readonly FOGMODE_NONE: number;
  98329. /** The fog density is following an exponential function */
  98330. static readonly FOGMODE_EXP: number;
  98331. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  98332. static readonly FOGMODE_EXP2: number;
  98333. /** The fog density is following a linear function. */
  98334. static readonly FOGMODE_LINEAR: number;
  98335. /**
  98336. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  98337. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  98338. */
  98339. static MinDeltaTime: number;
  98340. /**
  98341. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  98342. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  98343. */
  98344. static MaxDeltaTime: number;
  98345. /**
  98346. * Factory used to create the default material.
  98347. * @param name The name of the material to create
  98348. * @param scene The scene to create the material for
  98349. * @returns The default material
  98350. */
  98351. static DefaultMaterialFactory(scene: Scene): Material;
  98352. /**
  98353. * Factory used to create the a collision coordinator.
  98354. * @returns The collision coordinator
  98355. */
  98356. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  98357. /** @hidden */
  98358. _inputManager: InputManager;
  98359. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  98360. cameraToUseForPointers: Nullable<Camera>;
  98361. /** @hidden */
  98362. readonly _isScene: boolean;
  98363. /**
  98364. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  98365. */
  98366. autoClear: boolean;
  98367. /**
  98368. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  98369. */
  98370. autoClearDepthAndStencil: boolean;
  98371. /**
  98372. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  98373. */
  98374. clearColor: Color4;
  98375. /**
  98376. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  98377. */
  98378. ambientColor: Color3;
  98379. /**
  98380. * This is use to store the default BRDF lookup for PBR materials in your scene.
  98381. * It should only be one of the following (if not the default embedded one):
  98382. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  98383. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  98384. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  98385. * The material properties need to be setup according to the type of texture in use.
  98386. */
  98387. environmentBRDFTexture: BaseTexture;
  98388. /** @hidden */
  98389. protected _environmentTexture: Nullable<BaseTexture>;
  98390. /**
  98391. * Texture used in all pbr material as the reflection texture.
  98392. * As in the majority of the scene they are the same (exception for multi room and so on),
  98393. * this is easier to reference from here than from all the materials.
  98394. */
  98395. /**
  98396. * Texture used in all pbr material as the reflection texture.
  98397. * As in the majority of the scene they are the same (exception for multi room and so on),
  98398. * this is easier to set here than in all the materials.
  98399. */
  98400. environmentTexture: Nullable<BaseTexture>;
  98401. /** @hidden */
  98402. protected _environmentIntensity: number;
  98403. /**
  98404. * Intensity of the environment in all pbr material.
  98405. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  98406. * As in the majority of the scene they are the same (exception for multi room and so on),
  98407. * this is easier to reference from here than from all the materials.
  98408. */
  98409. /**
  98410. * Intensity of the environment in all pbr material.
  98411. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  98412. * As in the majority of the scene they are the same (exception for multi room and so on),
  98413. * this is easier to set here than in all the materials.
  98414. */
  98415. environmentIntensity: number;
  98416. /** @hidden */
  98417. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  98418. /**
  98419. * Default image processing configuration used either in the rendering
  98420. * Forward main pass or through the imageProcessingPostProcess if present.
  98421. * As in the majority of the scene they are the same (exception for multi camera),
  98422. * this is easier to reference from here than from all the materials and post process.
  98423. *
  98424. * No setter as we it is a shared configuration, you can set the values instead.
  98425. */
  98426. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  98427. private _forceWireframe;
  98428. /**
  98429. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  98430. */
  98431. forceWireframe: boolean;
  98432. private _forcePointsCloud;
  98433. /**
  98434. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  98435. */
  98436. forcePointsCloud: boolean;
  98437. /**
  98438. * Gets or sets the active clipplane 1
  98439. */
  98440. clipPlane: Nullable<Plane>;
  98441. /**
  98442. * Gets or sets the active clipplane 2
  98443. */
  98444. clipPlane2: Nullable<Plane>;
  98445. /**
  98446. * Gets or sets the active clipplane 3
  98447. */
  98448. clipPlane3: Nullable<Plane>;
  98449. /**
  98450. * Gets or sets the active clipplane 4
  98451. */
  98452. clipPlane4: Nullable<Plane>;
  98453. /**
  98454. * Gets or sets a boolean indicating if animations are enabled
  98455. */
  98456. animationsEnabled: boolean;
  98457. private _animationPropertiesOverride;
  98458. /**
  98459. * Gets or sets the animation properties override
  98460. */
  98461. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  98462. /**
  98463. * Gets or sets a boolean indicating if a constant deltatime has to be used
  98464. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  98465. */
  98466. useConstantAnimationDeltaTime: boolean;
  98467. /**
  98468. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  98469. * Please note that it requires to run a ray cast through the scene on every frame
  98470. */
  98471. constantlyUpdateMeshUnderPointer: boolean;
  98472. /**
  98473. * Defines the HTML cursor to use when hovering over interactive elements
  98474. */
  98475. hoverCursor: string;
  98476. /**
  98477. * Defines the HTML default cursor to use (empty by default)
  98478. */
  98479. defaultCursor: string;
  98480. /**
  98481. * This is used to call preventDefault() on pointer down
  98482. * in order to block unwanted artifacts like system double clicks
  98483. */
  98484. preventDefaultOnPointerDown: boolean;
  98485. /**
  98486. * This is used to call preventDefault() on pointer up
  98487. * in order to block unwanted artifacts like system double clicks
  98488. */
  98489. preventDefaultOnPointerUp: boolean;
  98490. /**
  98491. * Gets or sets user defined metadata
  98492. */
  98493. metadata: any;
  98494. /**
  98495. * For internal use only. Please do not use.
  98496. */
  98497. reservedDataStore: any;
  98498. /**
  98499. * Gets the name of the plugin used to load this scene (null by default)
  98500. */
  98501. loadingPluginName: string;
  98502. /**
  98503. * Use this array to add regular expressions used to disable offline support for specific urls
  98504. */
  98505. disableOfflineSupportExceptionRules: RegExp[];
  98506. /**
  98507. * An event triggered when the scene is disposed.
  98508. */
  98509. onDisposeObservable: Observable<Scene>;
  98510. private _onDisposeObserver;
  98511. /** Sets a function to be executed when this scene is disposed. */
  98512. onDispose: () => void;
  98513. /**
  98514. * An event triggered before rendering the scene (right after animations and physics)
  98515. */
  98516. onBeforeRenderObservable: Observable<Scene>;
  98517. private _onBeforeRenderObserver;
  98518. /** Sets a function to be executed before rendering this scene */
  98519. beforeRender: Nullable<() => void>;
  98520. /**
  98521. * An event triggered after rendering the scene
  98522. */
  98523. onAfterRenderObservable: Observable<Scene>;
  98524. /**
  98525. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  98526. */
  98527. onAfterRenderCameraObservable: Observable<Camera>;
  98528. private _onAfterRenderObserver;
  98529. /** Sets a function to be executed after rendering this scene */
  98530. afterRender: Nullable<() => void>;
  98531. /**
  98532. * An event triggered before animating the scene
  98533. */
  98534. onBeforeAnimationsObservable: Observable<Scene>;
  98535. /**
  98536. * An event triggered after animations processing
  98537. */
  98538. onAfterAnimationsObservable: Observable<Scene>;
  98539. /**
  98540. * An event triggered before draw calls are ready to be sent
  98541. */
  98542. onBeforeDrawPhaseObservable: Observable<Scene>;
  98543. /**
  98544. * An event triggered after draw calls have been sent
  98545. */
  98546. onAfterDrawPhaseObservable: Observable<Scene>;
  98547. /**
  98548. * An event triggered when the scene is ready
  98549. */
  98550. onReadyObservable: Observable<Scene>;
  98551. /**
  98552. * An event triggered before rendering a camera
  98553. */
  98554. onBeforeCameraRenderObservable: Observable<Camera>;
  98555. private _onBeforeCameraRenderObserver;
  98556. /** Sets a function to be executed before rendering a camera*/
  98557. beforeCameraRender: () => void;
  98558. /**
  98559. * An event triggered after rendering a camera
  98560. */
  98561. onAfterCameraRenderObservable: Observable<Camera>;
  98562. private _onAfterCameraRenderObserver;
  98563. /** Sets a function to be executed after rendering a camera*/
  98564. afterCameraRender: () => void;
  98565. /**
  98566. * An event triggered when active meshes evaluation is about to start
  98567. */
  98568. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  98569. /**
  98570. * An event triggered when active meshes evaluation is done
  98571. */
  98572. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  98573. /**
  98574. * An event triggered when particles rendering is about to start
  98575. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  98576. */
  98577. onBeforeParticlesRenderingObservable: Observable<Scene>;
  98578. /**
  98579. * An event triggered when particles rendering is done
  98580. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  98581. */
  98582. onAfterParticlesRenderingObservable: Observable<Scene>;
  98583. /**
  98584. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  98585. */
  98586. onDataLoadedObservable: Observable<Scene>;
  98587. /**
  98588. * An event triggered when a camera is created
  98589. */
  98590. onNewCameraAddedObservable: Observable<Camera>;
  98591. /**
  98592. * An event triggered when a camera is removed
  98593. */
  98594. onCameraRemovedObservable: Observable<Camera>;
  98595. /**
  98596. * An event triggered when a light is created
  98597. */
  98598. onNewLightAddedObservable: Observable<Light>;
  98599. /**
  98600. * An event triggered when a light is removed
  98601. */
  98602. onLightRemovedObservable: Observable<Light>;
  98603. /**
  98604. * An event triggered when a geometry is created
  98605. */
  98606. onNewGeometryAddedObservable: Observable<Geometry>;
  98607. /**
  98608. * An event triggered when a geometry is removed
  98609. */
  98610. onGeometryRemovedObservable: Observable<Geometry>;
  98611. /**
  98612. * An event triggered when a transform node is created
  98613. */
  98614. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  98615. /**
  98616. * An event triggered when a transform node is removed
  98617. */
  98618. onTransformNodeRemovedObservable: Observable<TransformNode>;
  98619. /**
  98620. * An event triggered when a mesh is created
  98621. */
  98622. onNewMeshAddedObservable: Observable<AbstractMesh>;
  98623. /**
  98624. * An event triggered when a mesh is removed
  98625. */
  98626. onMeshRemovedObservable: Observable<AbstractMesh>;
  98627. /**
  98628. * An event triggered when a skeleton is created
  98629. */
  98630. onNewSkeletonAddedObservable: Observable<Skeleton>;
  98631. /**
  98632. * An event triggered when a skeleton is removed
  98633. */
  98634. onSkeletonRemovedObservable: Observable<Skeleton>;
  98635. /**
  98636. * An event triggered when a material is created
  98637. */
  98638. onNewMaterialAddedObservable: Observable<Material>;
  98639. /**
  98640. * An event triggered when a material is removed
  98641. */
  98642. onMaterialRemovedObservable: Observable<Material>;
  98643. /**
  98644. * An event triggered when a texture is created
  98645. */
  98646. onNewTextureAddedObservable: Observable<BaseTexture>;
  98647. /**
  98648. * An event triggered when a texture is removed
  98649. */
  98650. onTextureRemovedObservable: Observable<BaseTexture>;
  98651. /**
  98652. * An event triggered when render targets are about to be rendered
  98653. * Can happen multiple times per frame.
  98654. */
  98655. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  98656. /**
  98657. * An event triggered when render targets were rendered.
  98658. * Can happen multiple times per frame.
  98659. */
  98660. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  98661. /**
  98662. * An event triggered before calculating deterministic simulation step
  98663. */
  98664. onBeforeStepObservable: Observable<Scene>;
  98665. /**
  98666. * An event triggered after calculating deterministic simulation step
  98667. */
  98668. onAfterStepObservable: Observable<Scene>;
  98669. /**
  98670. * An event triggered when the activeCamera property is updated
  98671. */
  98672. onActiveCameraChanged: Observable<Scene>;
  98673. /**
  98674. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  98675. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  98676. * 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)
  98677. */
  98678. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  98679. /**
  98680. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  98681. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  98682. * 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)
  98683. */
  98684. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  98685. /**
  98686. * This Observable will when a mesh has been imported into the scene.
  98687. */
  98688. onMeshImportedObservable: Observable<AbstractMesh>;
  98689. /**
  98690. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  98691. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  98692. */
  98693. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  98694. /** @hidden */
  98695. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  98696. /**
  98697. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  98698. */
  98699. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  98700. /**
  98701. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  98702. */
  98703. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  98704. /**
  98705. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  98706. */
  98707. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  98708. /** Callback called when a pointer move is detected */
  98709. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  98710. /** Callback called when a pointer down is detected */
  98711. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  98712. /** Callback called when a pointer up is detected */
  98713. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  98714. /** Callback called when a pointer pick is detected */
  98715. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  98716. /**
  98717. * 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).
  98718. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  98719. */
  98720. onPrePointerObservable: Observable<PointerInfoPre>;
  98721. /**
  98722. * Observable event triggered each time an input event is received from the rendering canvas
  98723. */
  98724. onPointerObservable: Observable<PointerInfo>;
  98725. /**
  98726. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  98727. */
  98728. readonly unTranslatedPointer: Vector2;
  98729. /**
  98730. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  98731. */
  98732. static DragMovementThreshold: number;
  98733. /**
  98734. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  98735. */
  98736. static LongPressDelay: number;
  98737. /**
  98738. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  98739. */
  98740. static DoubleClickDelay: number;
  98741. /** If you need to check double click without raising a single click at first click, enable this flag */
  98742. static ExclusiveDoubleClickMode: boolean;
  98743. /** @hidden */
  98744. _mirroredCameraPosition: Nullable<Vector3>;
  98745. /**
  98746. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  98747. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  98748. */
  98749. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  98750. /**
  98751. * Observable event triggered each time an keyboard event is received from the hosting window
  98752. */
  98753. onKeyboardObservable: Observable<KeyboardInfo>;
  98754. private _useRightHandedSystem;
  98755. /**
  98756. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  98757. */
  98758. useRightHandedSystem: boolean;
  98759. private _timeAccumulator;
  98760. private _currentStepId;
  98761. private _currentInternalStep;
  98762. /**
  98763. * Sets the step Id used by deterministic lock step
  98764. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  98765. * @param newStepId defines the step Id
  98766. */
  98767. setStepId(newStepId: number): void;
  98768. /**
  98769. * Gets the step Id used by deterministic lock step
  98770. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  98771. * @returns the step Id
  98772. */
  98773. getStepId(): number;
  98774. /**
  98775. * Gets the internal step used by deterministic lock step
  98776. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  98777. * @returns the internal step
  98778. */
  98779. getInternalStep(): number;
  98780. private _fogEnabled;
  98781. /**
  98782. * Gets or sets a boolean indicating if fog is enabled on this scene
  98783. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98784. * (Default is true)
  98785. */
  98786. fogEnabled: boolean;
  98787. private _fogMode;
  98788. /**
  98789. * Gets or sets the fog mode to use
  98790. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98791. * | mode | value |
  98792. * | --- | --- |
  98793. * | FOGMODE_NONE | 0 |
  98794. * | FOGMODE_EXP | 1 |
  98795. * | FOGMODE_EXP2 | 2 |
  98796. * | FOGMODE_LINEAR | 3 |
  98797. */
  98798. fogMode: number;
  98799. /**
  98800. * Gets or sets the fog color to use
  98801. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98802. * (Default is Color3(0.2, 0.2, 0.3))
  98803. */
  98804. fogColor: Color3;
  98805. /**
  98806. * Gets or sets the fog density to use
  98807. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98808. * (Default is 0.1)
  98809. */
  98810. fogDensity: number;
  98811. /**
  98812. * Gets or sets the fog start distance to use
  98813. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98814. * (Default is 0)
  98815. */
  98816. fogStart: number;
  98817. /**
  98818. * Gets or sets the fog end distance to use
  98819. * @see http://doc.babylonjs.com/babylon101/environment#fog
  98820. * (Default is 1000)
  98821. */
  98822. fogEnd: number;
  98823. private _shadowsEnabled;
  98824. /**
  98825. * Gets or sets a boolean indicating if shadows are enabled on this scene
  98826. */
  98827. shadowsEnabled: boolean;
  98828. private _lightsEnabled;
  98829. /**
  98830. * Gets or sets a boolean indicating if lights are enabled on this scene
  98831. */
  98832. lightsEnabled: boolean;
  98833. /** All of the active cameras added to this scene. */
  98834. activeCameras: Camera[];
  98835. /** @hidden */
  98836. _activeCamera: Nullable<Camera>;
  98837. /** Gets or sets the current active camera */
  98838. activeCamera: Nullable<Camera>;
  98839. private _defaultMaterial;
  98840. /** The default material used on meshes when no material is affected */
  98841. /** The default material used on meshes when no material is affected */
  98842. defaultMaterial: Material;
  98843. private _texturesEnabled;
  98844. /**
  98845. * Gets or sets a boolean indicating if textures are enabled on this scene
  98846. */
  98847. texturesEnabled: boolean;
  98848. /**
  98849. * Gets or sets a boolean indicating if particles are enabled on this scene
  98850. */
  98851. particlesEnabled: boolean;
  98852. /**
  98853. * Gets or sets a boolean indicating if sprites are enabled on this scene
  98854. */
  98855. spritesEnabled: boolean;
  98856. private _skeletonsEnabled;
  98857. /**
  98858. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  98859. */
  98860. skeletonsEnabled: boolean;
  98861. /**
  98862. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  98863. */
  98864. lensFlaresEnabled: boolean;
  98865. /**
  98866. * Gets or sets a boolean indicating if collisions are enabled on this scene
  98867. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  98868. */
  98869. collisionsEnabled: boolean;
  98870. private _collisionCoordinator;
  98871. /** @hidden */
  98872. readonly collisionCoordinator: ICollisionCoordinator;
  98873. /**
  98874. * Defines the gravity applied to this scene (used only for collisions)
  98875. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  98876. */
  98877. gravity: Vector3;
  98878. /**
  98879. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  98880. */
  98881. postProcessesEnabled: boolean;
  98882. /**
  98883. * The list of postprocesses added to the scene
  98884. */
  98885. postProcesses: PostProcess[];
  98886. /**
  98887. * Gets the current postprocess manager
  98888. */
  98889. postProcessManager: PostProcessManager;
  98890. /**
  98891. * Gets or sets a boolean indicating if render targets are enabled on this scene
  98892. */
  98893. renderTargetsEnabled: boolean;
  98894. /**
  98895. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  98896. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  98897. */
  98898. dumpNextRenderTargets: boolean;
  98899. /**
  98900. * The list of user defined render targets added to the scene
  98901. */
  98902. customRenderTargets: RenderTargetTexture[];
  98903. /**
  98904. * Defines if texture loading must be delayed
  98905. * If true, textures will only be loaded when they need to be rendered
  98906. */
  98907. useDelayedTextureLoading: boolean;
  98908. /**
  98909. * Gets the list of meshes imported to the scene through SceneLoader
  98910. */
  98911. importedMeshesFiles: String[];
  98912. /**
  98913. * Gets or sets a boolean indicating if probes are enabled on this scene
  98914. */
  98915. probesEnabled: boolean;
  98916. /**
  98917. * Gets or sets the current offline provider to use to store scene data
  98918. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  98919. */
  98920. offlineProvider: IOfflineProvider;
  98921. /**
  98922. * Gets or sets the action manager associated with the scene
  98923. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  98924. */
  98925. actionManager: AbstractActionManager;
  98926. private _meshesForIntersections;
  98927. /**
  98928. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  98929. */
  98930. proceduralTexturesEnabled: boolean;
  98931. private _engine;
  98932. private _totalVertices;
  98933. /** @hidden */
  98934. _activeIndices: PerfCounter;
  98935. /** @hidden */
  98936. _activeParticles: PerfCounter;
  98937. /** @hidden */
  98938. _activeBones: PerfCounter;
  98939. private _animationRatio;
  98940. /** @hidden */
  98941. _animationTimeLast: number;
  98942. /** @hidden */
  98943. _animationTime: number;
  98944. /**
  98945. * Gets or sets a general scale for animation speed
  98946. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  98947. */
  98948. animationTimeScale: number;
  98949. /** @hidden */
  98950. _cachedMaterial: Nullable<Material>;
  98951. /** @hidden */
  98952. _cachedEffect: Nullable<Effect>;
  98953. /** @hidden */
  98954. _cachedVisibility: Nullable<number>;
  98955. private _renderId;
  98956. private _frameId;
  98957. private _executeWhenReadyTimeoutId;
  98958. private _intermediateRendering;
  98959. private _viewUpdateFlag;
  98960. private _projectionUpdateFlag;
  98961. /** @hidden */
  98962. _toBeDisposed: Nullable<IDisposable>[];
  98963. private _activeRequests;
  98964. /** @hidden */
  98965. _pendingData: any[];
  98966. private _isDisposed;
  98967. /**
  98968. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  98969. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  98970. */
  98971. dispatchAllSubMeshesOfActiveMeshes: boolean;
  98972. private _activeMeshes;
  98973. private _processedMaterials;
  98974. private _renderTargets;
  98975. /** @hidden */
  98976. _activeParticleSystems: SmartArray<IParticleSystem>;
  98977. private _activeSkeletons;
  98978. private _softwareSkinnedMeshes;
  98979. private _renderingManager;
  98980. /** @hidden */
  98981. _activeAnimatables: Animatable[];
  98982. private _transformMatrix;
  98983. private _sceneUbo;
  98984. /** @hidden */
  98985. _viewMatrix: Matrix;
  98986. private _projectionMatrix;
  98987. /** @hidden */
  98988. _forcedViewPosition: Nullable<Vector3>;
  98989. /** @hidden */
  98990. _frustumPlanes: Plane[];
  98991. /**
  98992. * Gets the list of frustum planes (built from the active camera)
  98993. */
  98994. readonly frustumPlanes: Plane[];
  98995. /**
  98996. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  98997. * This is useful if there are more lights that the maximum simulteanous authorized
  98998. */
  98999. requireLightSorting: boolean;
  99000. /** @hidden */
  99001. readonly useMaterialMeshMap: boolean;
  99002. /** @hidden */
  99003. readonly useClonedMeshhMap: boolean;
  99004. private _externalData;
  99005. private _uid;
  99006. /**
  99007. * @hidden
  99008. * Backing store of defined scene components.
  99009. */
  99010. _components: ISceneComponent[];
  99011. /**
  99012. * @hidden
  99013. * Backing store of defined scene components.
  99014. */
  99015. _serializableComponents: ISceneSerializableComponent[];
  99016. /**
  99017. * List of components to register on the next registration step.
  99018. */
  99019. private _transientComponents;
  99020. /**
  99021. * Registers the transient components if needed.
  99022. */
  99023. private _registerTransientComponents;
  99024. /**
  99025. * @hidden
  99026. * Add a component to the scene.
  99027. * Note that the ccomponent could be registered on th next frame if this is called after
  99028. * the register component stage.
  99029. * @param component Defines the component to add to the scene
  99030. */
  99031. _addComponent(component: ISceneComponent): void;
  99032. /**
  99033. * @hidden
  99034. * Gets a component from the scene.
  99035. * @param name defines the name of the component to retrieve
  99036. * @returns the component or null if not present
  99037. */
  99038. _getComponent(name: string): Nullable<ISceneComponent>;
  99039. /**
  99040. * @hidden
  99041. * Defines the actions happening before camera updates.
  99042. */
  99043. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  99044. /**
  99045. * @hidden
  99046. * Defines the actions happening before clear the canvas.
  99047. */
  99048. _beforeClearStage: Stage<SimpleStageAction>;
  99049. /**
  99050. * @hidden
  99051. * Defines the actions when collecting render targets for the frame.
  99052. */
  99053. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  99054. /**
  99055. * @hidden
  99056. * Defines the actions happening for one camera in the frame.
  99057. */
  99058. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  99059. /**
  99060. * @hidden
  99061. * Defines the actions happening during the per mesh ready checks.
  99062. */
  99063. _isReadyForMeshStage: Stage<MeshStageAction>;
  99064. /**
  99065. * @hidden
  99066. * Defines the actions happening before evaluate active mesh checks.
  99067. */
  99068. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  99069. /**
  99070. * @hidden
  99071. * Defines the actions happening during the evaluate sub mesh checks.
  99072. */
  99073. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  99074. /**
  99075. * @hidden
  99076. * Defines the actions happening during the active mesh stage.
  99077. */
  99078. _activeMeshStage: Stage<ActiveMeshStageAction>;
  99079. /**
  99080. * @hidden
  99081. * Defines the actions happening during the per camera render target step.
  99082. */
  99083. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  99084. /**
  99085. * @hidden
  99086. * Defines the actions happening just before the active camera is drawing.
  99087. */
  99088. _beforeCameraDrawStage: Stage<CameraStageAction>;
  99089. /**
  99090. * @hidden
  99091. * Defines the actions happening just before a render target is drawing.
  99092. */
  99093. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  99094. /**
  99095. * @hidden
  99096. * Defines the actions happening just before a rendering group is drawing.
  99097. */
  99098. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  99099. /**
  99100. * @hidden
  99101. * Defines the actions happening just before a mesh is drawing.
  99102. */
  99103. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  99104. /**
  99105. * @hidden
  99106. * Defines the actions happening just after a mesh has been drawn.
  99107. */
  99108. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  99109. /**
  99110. * @hidden
  99111. * Defines the actions happening just after a rendering group has been drawn.
  99112. */
  99113. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  99114. /**
  99115. * @hidden
  99116. * Defines the actions happening just after the active camera has been drawn.
  99117. */
  99118. _afterCameraDrawStage: Stage<CameraStageAction>;
  99119. /**
  99120. * @hidden
  99121. * Defines the actions happening just after a render target has been drawn.
  99122. */
  99123. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  99124. /**
  99125. * @hidden
  99126. * Defines the actions happening just after rendering all cameras and computing intersections.
  99127. */
  99128. _afterRenderStage: Stage<SimpleStageAction>;
  99129. /**
  99130. * @hidden
  99131. * Defines the actions happening when a pointer move event happens.
  99132. */
  99133. _pointerMoveStage: Stage<PointerMoveStageAction>;
  99134. /**
  99135. * @hidden
  99136. * Defines the actions happening when a pointer down event happens.
  99137. */
  99138. _pointerDownStage: Stage<PointerUpDownStageAction>;
  99139. /**
  99140. * @hidden
  99141. * Defines the actions happening when a pointer up event happens.
  99142. */
  99143. _pointerUpStage: Stage<PointerUpDownStageAction>;
  99144. /**
  99145. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  99146. */
  99147. private geometriesByUniqueId;
  99148. /**
  99149. * Creates a new Scene
  99150. * @param engine defines the engine to use to render this scene
  99151. * @param options defines the scene options
  99152. */
  99153. constructor(engine: Engine, options?: SceneOptions);
  99154. /**
  99155. * Gets a string idenfifying the name of the class
  99156. * @returns "Scene" string
  99157. */
  99158. getClassName(): string;
  99159. private _defaultMeshCandidates;
  99160. /**
  99161. * @hidden
  99162. */
  99163. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  99164. private _defaultSubMeshCandidates;
  99165. /**
  99166. * @hidden
  99167. */
  99168. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  99169. /**
  99170. * Sets the default candidate providers for the scene.
  99171. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  99172. * and getCollidingSubMeshCandidates to their default function
  99173. */
  99174. setDefaultCandidateProviders(): void;
  99175. /**
  99176. * Gets the mesh that is currently under the pointer
  99177. */
  99178. readonly meshUnderPointer: Nullable<AbstractMesh>;
  99179. /**
  99180. * Gets or sets the current on-screen X position of the pointer
  99181. */
  99182. pointerX: number;
  99183. /**
  99184. * Gets or sets the current on-screen Y position of the pointer
  99185. */
  99186. pointerY: number;
  99187. /**
  99188. * Gets the cached material (ie. the latest rendered one)
  99189. * @returns the cached material
  99190. */
  99191. getCachedMaterial(): Nullable<Material>;
  99192. /**
  99193. * Gets the cached effect (ie. the latest rendered one)
  99194. * @returns the cached effect
  99195. */
  99196. getCachedEffect(): Nullable<Effect>;
  99197. /**
  99198. * Gets the cached visibility state (ie. the latest rendered one)
  99199. * @returns the cached visibility state
  99200. */
  99201. getCachedVisibility(): Nullable<number>;
  99202. /**
  99203. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  99204. * @param material defines the current material
  99205. * @param effect defines the current effect
  99206. * @param visibility defines the current visibility state
  99207. * @returns true if one parameter is not cached
  99208. */
  99209. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  99210. /**
  99211. * Gets the engine associated with the scene
  99212. * @returns an Engine
  99213. */
  99214. getEngine(): Engine;
  99215. /**
  99216. * Gets the total number of vertices rendered per frame
  99217. * @returns the total number of vertices rendered per frame
  99218. */
  99219. getTotalVertices(): number;
  99220. /**
  99221. * Gets the performance counter for total vertices
  99222. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  99223. */
  99224. readonly totalVerticesPerfCounter: PerfCounter;
  99225. /**
  99226. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  99227. * @returns the total number of active indices rendered per frame
  99228. */
  99229. getActiveIndices(): number;
  99230. /**
  99231. * Gets the performance counter for active indices
  99232. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  99233. */
  99234. readonly totalActiveIndicesPerfCounter: PerfCounter;
  99235. /**
  99236. * Gets the total number of active particles rendered per frame
  99237. * @returns the total number of active particles rendered per frame
  99238. */
  99239. getActiveParticles(): number;
  99240. /**
  99241. * Gets the performance counter for active particles
  99242. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  99243. */
  99244. readonly activeParticlesPerfCounter: PerfCounter;
  99245. /**
  99246. * Gets the total number of active bones rendered per frame
  99247. * @returns the total number of active bones rendered per frame
  99248. */
  99249. getActiveBones(): number;
  99250. /**
  99251. * Gets the performance counter for active bones
  99252. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  99253. */
  99254. readonly activeBonesPerfCounter: PerfCounter;
  99255. /**
  99256. * Gets the array of active meshes
  99257. * @returns an array of AbstractMesh
  99258. */
  99259. getActiveMeshes(): SmartArray<AbstractMesh>;
  99260. /**
  99261. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  99262. * @returns a number
  99263. */
  99264. getAnimationRatio(): number;
  99265. /**
  99266. * Gets an unique Id for the current render phase
  99267. * @returns a number
  99268. */
  99269. getRenderId(): number;
  99270. /**
  99271. * Gets an unique Id for the current frame
  99272. * @returns a number
  99273. */
  99274. getFrameId(): number;
  99275. /** Call this function if you want to manually increment the render Id*/
  99276. incrementRenderId(): void;
  99277. private _createUbo;
  99278. /**
  99279. * Use this method to simulate a pointer move on a mesh
  99280. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  99281. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  99282. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  99283. * @returns the current scene
  99284. */
  99285. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  99286. /**
  99287. * Use this method to simulate a pointer down on a mesh
  99288. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  99289. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  99290. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  99291. * @returns the current scene
  99292. */
  99293. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  99294. /**
  99295. * Use this method to simulate a pointer up on a mesh
  99296. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  99297. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  99298. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  99299. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  99300. * @returns the current scene
  99301. */
  99302. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  99303. /**
  99304. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  99305. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  99306. * @returns true if the pointer was captured
  99307. */
  99308. isPointerCaptured(pointerId?: number): boolean;
  99309. /**
  99310. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  99311. * @param attachUp defines if you want to attach events to pointerup
  99312. * @param attachDown defines if you want to attach events to pointerdown
  99313. * @param attachMove defines if you want to attach events to pointermove
  99314. */
  99315. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  99316. /** Detaches all event handlers*/
  99317. detachControl(): void;
  99318. /**
  99319. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  99320. * Delay loaded resources are not taking in account
  99321. * @return true if all required resources are ready
  99322. */
  99323. isReady(): boolean;
  99324. /** Resets all cached information relative to material (including effect and visibility) */
  99325. resetCachedMaterial(): void;
  99326. /**
  99327. * Registers a function to be called before every frame render
  99328. * @param func defines the function to register
  99329. */
  99330. registerBeforeRender(func: () => void): void;
  99331. /**
  99332. * Unregisters a function called before every frame render
  99333. * @param func defines the function to unregister
  99334. */
  99335. unregisterBeforeRender(func: () => void): void;
  99336. /**
  99337. * Registers a function to be called after every frame render
  99338. * @param func defines the function to register
  99339. */
  99340. registerAfterRender(func: () => void): void;
  99341. /**
  99342. * Unregisters a function called after every frame render
  99343. * @param func defines the function to unregister
  99344. */
  99345. unregisterAfterRender(func: () => void): void;
  99346. private _executeOnceBeforeRender;
  99347. /**
  99348. * The provided function will run before render once and will be disposed afterwards.
  99349. * A timeout delay can be provided so that the function will be executed in N ms.
  99350. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  99351. * @param func The function to be executed.
  99352. * @param timeout optional delay in ms
  99353. */
  99354. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  99355. /** @hidden */
  99356. _addPendingData(data: any): void;
  99357. /** @hidden */
  99358. _removePendingData(data: any): void;
  99359. /**
  99360. * Returns the number of items waiting to be loaded
  99361. * @returns the number of items waiting to be loaded
  99362. */
  99363. getWaitingItemsCount(): number;
  99364. /**
  99365. * Returns a boolean indicating if the scene is still loading data
  99366. */
  99367. readonly isLoading: boolean;
  99368. /**
  99369. * Registers a function to be executed when the scene is ready
  99370. * @param {Function} func - the function to be executed
  99371. */
  99372. executeWhenReady(func: () => void): void;
  99373. /**
  99374. * Returns a promise that resolves when the scene is ready
  99375. * @returns A promise that resolves when the scene is ready
  99376. */
  99377. whenReadyAsync(): Promise<void>;
  99378. /** @hidden */
  99379. _checkIsReady(): void;
  99380. /**
  99381. * Gets all animatable attached to the scene
  99382. */
  99383. readonly animatables: Animatable[];
  99384. /**
  99385. * Resets the last animation time frame.
  99386. * Useful to override when animations start running when loading a scene for the first time.
  99387. */
  99388. resetLastAnimationTimeFrame(): void;
  99389. /**
  99390. * Gets the current view matrix
  99391. * @returns a Matrix
  99392. */
  99393. getViewMatrix(): Matrix;
  99394. /**
  99395. * Gets the current projection matrix
  99396. * @returns a Matrix
  99397. */
  99398. getProjectionMatrix(): Matrix;
  99399. /**
  99400. * Gets the current transform matrix
  99401. * @returns a Matrix made of View * Projection
  99402. */
  99403. getTransformMatrix(): Matrix;
  99404. /**
  99405. * Sets the current transform matrix
  99406. * @param viewL defines the View matrix to use
  99407. * @param projectionL defines the Projection matrix to use
  99408. * @param viewR defines the right View matrix to use (if provided)
  99409. * @param projectionR defines the right Projection matrix to use (if provided)
  99410. */
  99411. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  99412. /**
  99413. * Gets the uniform buffer used to store scene data
  99414. * @returns a UniformBuffer
  99415. */
  99416. getSceneUniformBuffer(): UniformBuffer;
  99417. /**
  99418. * Gets an unique (relatively to the current scene) Id
  99419. * @returns an unique number for the scene
  99420. */
  99421. getUniqueId(): number;
  99422. /**
  99423. * Add a mesh to the list of scene's meshes
  99424. * @param newMesh defines the mesh to add
  99425. * @param recursive if all child meshes should also be added to the scene
  99426. */
  99427. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  99428. /**
  99429. * Remove a mesh for the list of scene's meshes
  99430. * @param toRemove defines the mesh to remove
  99431. * @param recursive if all child meshes should also be removed from the scene
  99432. * @returns the index where the mesh was in the mesh list
  99433. */
  99434. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  99435. /**
  99436. * Add a transform node to the list of scene's transform nodes
  99437. * @param newTransformNode defines the transform node to add
  99438. */
  99439. addTransformNode(newTransformNode: TransformNode): void;
  99440. /**
  99441. * Remove a transform node for the list of scene's transform nodes
  99442. * @param toRemove defines the transform node to remove
  99443. * @returns the index where the transform node was in the transform node list
  99444. */
  99445. removeTransformNode(toRemove: TransformNode): number;
  99446. /**
  99447. * Remove a skeleton for the list of scene's skeletons
  99448. * @param toRemove defines the skeleton to remove
  99449. * @returns the index where the skeleton was in the skeleton list
  99450. */
  99451. removeSkeleton(toRemove: Skeleton): number;
  99452. /**
  99453. * Remove a morph target for the list of scene's morph targets
  99454. * @param toRemove defines the morph target to remove
  99455. * @returns the index where the morph target was in the morph target list
  99456. */
  99457. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  99458. /**
  99459. * Remove a light for the list of scene's lights
  99460. * @param toRemove defines the light to remove
  99461. * @returns the index where the light was in the light list
  99462. */
  99463. removeLight(toRemove: Light): number;
  99464. /**
  99465. * Remove a camera for the list of scene's cameras
  99466. * @param toRemove defines the camera to remove
  99467. * @returns the index where the camera was in the camera list
  99468. */
  99469. removeCamera(toRemove: Camera): number;
  99470. /**
  99471. * Remove a particle system for the list of scene's particle systems
  99472. * @param toRemove defines the particle system to remove
  99473. * @returns the index where the particle system was in the particle system list
  99474. */
  99475. removeParticleSystem(toRemove: IParticleSystem): number;
  99476. /**
  99477. * Remove a animation for the list of scene's animations
  99478. * @param toRemove defines the animation to remove
  99479. * @returns the index where the animation was in the animation list
  99480. */
  99481. removeAnimation(toRemove: Animation): number;
  99482. /**
  99483. * Will stop the animation of the given target
  99484. * @param target - the target
  99485. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  99486. * @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)
  99487. */
  99488. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  99489. /**
  99490. * Removes the given animation group from this scene.
  99491. * @param toRemove The animation group to remove
  99492. * @returns The index of the removed animation group
  99493. */
  99494. removeAnimationGroup(toRemove: AnimationGroup): number;
  99495. /**
  99496. * Removes the given multi-material from this scene.
  99497. * @param toRemove The multi-material to remove
  99498. * @returns The index of the removed multi-material
  99499. */
  99500. removeMultiMaterial(toRemove: MultiMaterial): number;
  99501. /**
  99502. * Removes the given material from this scene.
  99503. * @param toRemove The material to remove
  99504. * @returns The index of the removed material
  99505. */
  99506. removeMaterial(toRemove: Material): number;
  99507. /**
  99508. * Removes the given action manager from this scene.
  99509. * @param toRemove The action manager to remove
  99510. * @returns The index of the removed action manager
  99511. */
  99512. removeActionManager(toRemove: AbstractActionManager): number;
  99513. /**
  99514. * Removes the given texture from this scene.
  99515. * @param toRemove The texture to remove
  99516. * @returns The index of the removed texture
  99517. */
  99518. removeTexture(toRemove: BaseTexture): number;
  99519. /**
  99520. * Adds the given light to this scene
  99521. * @param newLight The light to add
  99522. */
  99523. addLight(newLight: Light): void;
  99524. /**
  99525. * Sorts the list list based on light priorities
  99526. */
  99527. sortLightsByPriority(): void;
  99528. /**
  99529. * Adds the given camera to this scene
  99530. * @param newCamera The camera to add
  99531. */
  99532. addCamera(newCamera: Camera): void;
  99533. /**
  99534. * Adds the given skeleton to this scene
  99535. * @param newSkeleton The skeleton to add
  99536. */
  99537. addSkeleton(newSkeleton: Skeleton): void;
  99538. /**
  99539. * Adds the given particle system to this scene
  99540. * @param newParticleSystem The particle system to add
  99541. */
  99542. addParticleSystem(newParticleSystem: IParticleSystem): void;
  99543. /**
  99544. * Adds the given animation to this scene
  99545. * @param newAnimation The animation to add
  99546. */
  99547. addAnimation(newAnimation: Animation): void;
  99548. /**
  99549. * Adds the given animation group to this scene.
  99550. * @param newAnimationGroup The animation group to add
  99551. */
  99552. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  99553. /**
  99554. * Adds the given multi-material to this scene
  99555. * @param newMultiMaterial The multi-material to add
  99556. */
  99557. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  99558. /**
  99559. * Adds the given material to this scene
  99560. * @param newMaterial The material to add
  99561. */
  99562. addMaterial(newMaterial: Material): void;
  99563. /**
  99564. * Adds the given morph target to this scene
  99565. * @param newMorphTargetManager The morph target to add
  99566. */
  99567. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  99568. /**
  99569. * Adds the given geometry to this scene
  99570. * @param newGeometry The geometry to add
  99571. */
  99572. addGeometry(newGeometry: Geometry): void;
  99573. /**
  99574. * Adds the given action manager to this scene
  99575. * @param newActionManager The action manager to add
  99576. */
  99577. addActionManager(newActionManager: AbstractActionManager): void;
  99578. /**
  99579. * Adds the given texture to this scene.
  99580. * @param newTexture The texture to add
  99581. */
  99582. addTexture(newTexture: BaseTexture): void;
  99583. /**
  99584. * Switch active camera
  99585. * @param newCamera defines the new active camera
  99586. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  99587. */
  99588. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  99589. /**
  99590. * sets the active camera of the scene using its ID
  99591. * @param id defines the camera's ID
  99592. * @return the new active camera or null if none found.
  99593. */
  99594. setActiveCameraByID(id: string): Nullable<Camera>;
  99595. /**
  99596. * sets the active camera of the scene using its name
  99597. * @param name defines the camera's name
  99598. * @returns the new active camera or null if none found.
  99599. */
  99600. setActiveCameraByName(name: string): Nullable<Camera>;
  99601. /**
  99602. * get an animation group using its name
  99603. * @param name defines the material's name
  99604. * @return the animation group or null if none found.
  99605. */
  99606. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  99607. /**
  99608. * Get a material using its unique id
  99609. * @param uniqueId defines the material's unique id
  99610. * @return the material or null if none found.
  99611. */
  99612. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  99613. /**
  99614. * get a material using its id
  99615. * @param id defines the material's ID
  99616. * @return the material or null if none found.
  99617. */
  99618. getMaterialByID(id: string): Nullable<Material>;
  99619. /**
  99620. * Gets a the last added material using a given id
  99621. * @param id defines the material's ID
  99622. * @return the last material with the given id or null if none found.
  99623. */
  99624. getLastMaterialByID(id: string): Nullable<Material>;
  99625. /**
  99626. * Gets a material using its name
  99627. * @param name defines the material's name
  99628. * @return the material or null if none found.
  99629. */
  99630. getMaterialByName(name: string): Nullable<Material>;
  99631. /**
  99632. * Get a texture using its unique id
  99633. * @param uniqueId defines the texture's unique id
  99634. * @return the texture or null if none found.
  99635. */
  99636. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  99637. /**
  99638. * Gets a camera using its id
  99639. * @param id defines the id to look for
  99640. * @returns the camera or null if not found
  99641. */
  99642. getCameraByID(id: string): Nullable<Camera>;
  99643. /**
  99644. * Gets a camera using its unique id
  99645. * @param uniqueId defines the unique id to look for
  99646. * @returns the camera or null if not found
  99647. */
  99648. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  99649. /**
  99650. * Gets a camera using its name
  99651. * @param name defines the camera's name
  99652. * @return the camera or null if none found.
  99653. */
  99654. getCameraByName(name: string): Nullable<Camera>;
  99655. /**
  99656. * Gets a bone using its id
  99657. * @param id defines the bone's id
  99658. * @return the bone or null if not found
  99659. */
  99660. getBoneByID(id: string): Nullable<Bone>;
  99661. /**
  99662. * Gets a bone using its id
  99663. * @param name defines the bone's name
  99664. * @return the bone or null if not found
  99665. */
  99666. getBoneByName(name: string): Nullable<Bone>;
  99667. /**
  99668. * Gets a light node using its name
  99669. * @param name defines the the light's name
  99670. * @return the light or null if none found.
  99671. */
  99672. getLightByName(name: string): Nullable<Light>;
  99673. /**
  99674. * Gets a light node using its id
  99675. * @param id defines the light's id
  99676. * @return the light or null if none found.
  99677. */
  99678. getLightByID(id: string): Nullable<Light>;
  99679. /**
  99680. * Gets a light node using its scene-generated unique ID
  99681. * @param uniqueId defines the light's unique id
  99682. * @return the light or null if none found.
  99683. */
  99684. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  99685. /**
  99686. * Gets a particle system by id
  99687. * @param id defines the particle system id
  99688. * @return the corresponding system or null if none found
  99689. */
  99690. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  99691. /**
  99692. * Gets a geometry using its ID
  99693. * @param id defines the geometry's id
  99694. * @return the geometry or null if none found.
  99695. */
  99696. getGeometryByID(id: string): Nullable<Geometry>;
  99697. private _getGeometryByUniqueID;
  99698. /**
  99699. * Add a new geometry to this scene
  99700. * @param geometry defines the geometry to be added to the scene.
  99701. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  99702. * @return a boolean defining if the geometry was added or not
  99703. */
  99704. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  99705. /**
  99706. * Removes an existing geometry
  99707. * @param geometry defines the geometry to be removed from the scene
  99708. * @return a boolean defining if the geometry was removed or not
  99709. */
  99710. removeGeometry(geometry: Geometry): boolean;
  99711. /**
  99712. * Gets the list of geometries attached to the scene
  99713. * @returns an array of Geometry
  99714. */
  99715. getGeometries(): Geometry[];
  99716. /**
  99717. * Gets the first added mesh found of a given ID
  99718. * @param id defines the id to search for
  99719. * @return the mesh found or null if not found at all
  99720. */
  99721. getMeshByID(id: string): Nullable<AbstractMesh>;
  99722. /**
  99723. * Gets a list of meshes using their id
  99724. * @param id defines the id to search for
  99725. * @returns a list of meshes
  99726. */
  99727. getMeshesByID(id: string): Array<AbstractMesh>;
  99728. /**
  99729. * Gets the first added transform node found of a given ID
  99730. * @param id defines the id to search for
  99731. * @return the found transform node or null if not found at all.
  99732. */
  99733. getTransformNodeByID(id: string): Nullable<TransformNode>;
  99734. /**
  99735. * Gets a transform node with its auto-generated unique id
  99736. * @param uniqueId efines the unique id to search for
  99737. * @return the found transform node or null if not found at all.
  99738. */
  99739. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  99740. /**
  99741. * Gets a list of transform nodes using their id
  99742. * @param id defines the id to search for
  99743. * @returns a list of transform nodes
  99744. */
  99745. getTransformNodesByID(id: string): Array<TransformNode>;
  99746. /**
  99747. * Gets a mesh with its auto-generated unique id
  99748. * @param uniqueId defines the unique id to search for
  99749. * @return the found mesh or null if not found at all.
  99750. */
  99751. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  99752. /**
  99753. * Gets a the last added mesh using a given id
  99754. * @param id defines the id to search for
  99755. * @return the found mesh or null if not found at all.
  99756. */
  99757. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  99758. /**
  99759. * Gets a the last added node (Mesh, Camera, Light) using a given id
  99760. * @param id defines the id to search for
  99761. * @return the found node or null if not found at all
  99762. */
  99763. getLastEntryByID(id: string): Nullable<Node>;
  99764. /**
  99765. * Gets a node (Mesh, Camera, Light) using a given id
  99766. * @param id defines the id to search for
  99767. * @return the found node or null if not found at all
  99768. */
  99769. getNodeByID(id: string): Nullable<Node>;
  99770. /**
  99771. * Gets a node (Mesh, Camera, Light) using a given name
  99772. * @param name defines the name to search for
  99773. * @return the found node or null if not found at all.
  99774. */
  99775. getNodeByName(name: string): Nullable<Node>;
  99776. /**
  99777. * Gets a mesh using a given name
  99778. * @param name defines the name to search for
  99779. * @return the found mesh or null if not found at all.
  99780. */
  99781. getMeshByName(name: string): Nullable<AbstractMesh>;
  99782. /**
  99783. * Gets a transform node using a given name
  99784. * @param name defines the name to search for
  99785. * @return the found transform node or null if not found at all.
  99786. */
  99787. getTransformNodeByName(name: string): Nullable<TransformNode>;
  99788. /**
  99789. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  99790. * @param id defines the id to search for
  99791. * @return the found skeleton or null if not found at all.
  99792. */
  99793. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  99794. /**
  99795. * Gets a skeleton using a given auto generated unique id
  99796. * @param uniqueId defines the unique id to search for
  99797. * @return the found skeleton or null if not found at all.
  99798. */
  99799. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  99800. /**
  99801. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  99802. * @param id defines the id to search for
  99803. * @return the found skeleton or null if not found at all.
  99804. */
  99805. getSkeletonById(id: string): Nullable<Skeleton>;
  99806. /**
  99807. * Gets a skeleton using a given name
  99808. * @param name defines the name to search for
  99809. * @return the found skeleton or null if not found at all.
  99810. */
  99811. getSkeletonByName(name: string): Nullable<Skeleton>;
  99812. /**
  99813. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  99814. * @param id defines the id to search for
  99815. * @return the found morph target manager or null if not found at all.
  99816. */
  99817. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  99818. /**
  99819. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  99820. * @param id defines the id to search for
  99821. * @return the found morph target or null if not found at all.
  99822. */
  99823. getMorphTargetById(id: string): Nullable<MorphTarget>;
  99824. /**
  99825. * Gets a boolean indicating if the given mesh is active
  99826. * @param mesh defines the mesh to look for
  99827. * @returns true if the mesh is in the active list
  99828. */
  99829. isActiveMesh(mesh: AbstractMesh): boolean;
  99830. /**
  99831. * Return a unique id as a string which can serve as an identifier for the scene
  99832. */
  99833. readonly uid: string;
  99834. /**
  99835. * Add an externaly attached data from its key.
  99836. * This method call will fail and return false, if such key already exists.
  99837. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  99838. * @param key the unique key that identifies the data
  99839. * @param data the data object to associate to the key for this Engine instance
  99840. * @return true if no such key were already present and the data was added successfully, false otherwise
  99841. */
  99842. addExternalData<T>(key: string, data: T): boolean;
  99843. /**
  99844. * Get an externaly attached data from its key
  99845. * @param key the unique key that identifies the data
  99846. * @return the associated data, if present (can be null), or undefined if not present
  99847. */
  99848. getExternalData<T>(key: string): Nullable<T>;
  99849. /**
  99850. * Get an externaly attached data from its key, create it using a factory if it's not already present
  99851. * @param key the unique key that identifies the data
  99852. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  99853. * @return the associated data, can be null if the factory returned null.
  99854. */
  99855. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  99856. /**
  99857. * Remove an externaly attached data from the Engine instance
  99858. * @param key the unique key that identifies the data
  99859. * @return true if the data was successfully removed, false if it doesn't exist
  99860. */
  99861. removeExternalData(key: string): boolean;
  99862. private _evaluateSubMesh;
  99863. /**
  99864. * Clear the processed materials smart array preventing retention point in material dispose.
  99865. */
  99866. freeProcessedMaterials(): void;
  99867. private _preventFreeActiveMeshesAndRenderingGroups;
  99868. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  99869. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  99870. * when disposing several meshes in a row or a hierarchy of meshes.
  99871. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  99872. */
  99873. blockfreeActiveMeshesAndRenderingGroups: boolean;
  99874. /**
  99875. * Clear the active meshes smart array preventing retention point in mesh dispose.
  99876. */
  99877. freeActiveMeshes(): void;
  99878. /**
  99879. * Clear the info related to rendering groups preventing retention points during dispose.
  99880. */
  99881. freeRenderingGroups(): void;
  99882. /** @hidden */
  99883. _isInIntermediateRendering(): boolean;
  99884. /**
  99885. * Lambda returning the list of potentially active meshes.
  99886. */
  99887. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  99888. /**
  99889. * Lambda returning the list of potentially active sub meshes.
  99890. */
  99891. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  99892. /**
  99893. * Lambda returning the list of potentially intersecting sub meshes.
  99894. */
  99895. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  99896. /**
  99897. * Lambda returning the list of potentially colliding sub meshes.
  99898. */
  99899. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  99900. private _activeMeshesFrozen;
  99901. /**
  99902. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  99903. * @returns the current scene
  99904. */
  99905. freezeActiveMeshes(): Scene;
  99906. /**
  99907. * Use this function to restart evaluating active meshes on every frame
  99908. * @returns the current scene
  99909. */
  99910. unfreezeActiveMeshes(): Scene;
  99911. private _evaluateActiveMeshes;
  99912. private _activeMesh;
  99913. /**
  99914. * Update the transform matrix to update from the current active camera
  99915. * @param force defines a boolean used to force the update even if cache is up to date
  99916. */
  99917. updateTransformMatrix(force?: boolean): void;
  99918. private _bindFrameBuffer;
  99919. /** @hidden */
  99920. _allowPostProcessClearColor: boolean;
  99921. /** @hidden */
  99922. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  99923. private _processSubCameras;
  99924. private _checkIntersections;
  99925. /** @hidden */
  99926. _advancePhysicsEngineStep(step: number): void;
  99927. /**
  99928. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  99929. */
  99930. getDeterministicFrameTime: () => number;
  99931. /** @hidden */
  99932. _animate(): void;
  99933. /** Execute all animations (for a frame) */
  99934. animate(): void;
  99935. /**
  99936. * Render the scene
  99937. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  99938. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  99939. */
  99940. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  99941. /**
  99942. * Freeze all materials
  99943. * A frozen material will not be updatable but should be faster to render
  99944. */
  99945. freezeMaterials(): void;
  99946. /**
  99947. * Unfreeze all materials
  99948. * A frozen material will not be updatable but should be faster to render
  99949. */
  99950. unfreezeMaterials(): void;
  99951. /**
  99952. * Releases all held ressources
  99953. */
  99954. dispose(): void;
  99955. /**
  99956. * Gets if the scene is already disposed
  99957. */
  99958. readonly isDisposed: boolean;
  99959. /**
  99960. * Call this function to reduce memory footprint of the scene.
  99961. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  99962. */
  99963. clearCachedVertexData(): void;
  99964. /**
  99965. * This function will remove the local cached buffer data from texture.
  99966. * It will save memory but will prevent the texture from being rebuilt
  99967. */
  99968. cleanCachedTextureBuffer(): void;
  99969. /**
  99970. * Get the world extend vectors with an optional filter
  99971. *
  99972. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  99973. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  99974. */
  99975. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  99976. min: Vector3;
  99977. max: Vector3;
  99978. };
  99979. /**
  99980. * Creates a ray that can be used to pick in the scene
  99981. * @param x defines the x coordinate of the origin (on-screen)
  99982. * @param y defines the y coordinate of the origin (on-screen)
  99983. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  99984. * @param camera defines the camera to use for the picking
  99985. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  99986. * @returns a Ray
  99987. */
  99988. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  99989. /**
  99990. * Creates a ray that can be used to pick in the scene
  99991. * @param x defines the x coordinate of the origin (on-screen)
  99992. * @param y defines the y coordinate of the origin (on-screen)
  99993. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  99994. * @param result defines the ray where to store the picking ray
  99995. * @param camera defines the camera to use for the picking
  99996. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  99997. * @returns the current scene
  99998. */
  99999. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  100000. /**
  100001. * Creates a ray that can be used to pick in the scene
  100002. * @param x defines the x coordinate of the origin (on-screen)
  100003. * @param y defines the y coordinate of the origin (on-screen)
  100004. * @param camera defines the camera to use for the picking
  100005. * @returns a Ray
  100006. */
  100007. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  100008. /**
  100009. * Creates a ray that can be used to pick in the scene
  100010. * @param x defines the x coordinate of the origin (on-screen)
  100011. * @param y defines the y coordinate of the origin (on-screen)
  100012. * @param result defines the ray where to store the picking ray
  100013. * @param camera defines the camera to use for the picking
  100014. * @returns the current scene
  100015. */
  100016. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  100017. /** Launch a ray to try to pick a mesh in the scene
  100018. * @param x position on screen
  100019. * @param y position on screen
  100020. * @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
  100021. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  100022. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  100023. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  100024. * @returns a PickingInfo
  100025. */
  100026. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  100027. /** Use the given ray to pick a mesh in the scene
  100028. * @param ray The ray to use to pick meshes
  100029. * @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
  100030. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  100031. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  100032. * @returns a PickingInfo
  100033. */
  100034. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  100035. /**
  100036. * Launch a ray to try to pick a mesh in the scene
  100037. * @param x X position on screen
  100038. * @param y Y position on screen
  100039. * @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
  100040. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  100041. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  100042. * @returns an array of PickingInfo
  100043. */
  100044. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  100045. /**
  100046. * Launch a ray to try to pick a mesh in the scene
  100047. * @param ray Ray to use
  100048. * @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
  100049. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  100050. * @returns an array of PickingInfo
  100051. */
  100052. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  100053. /**
  100054. * Force the value of meshUnderPointer
  100055. * @param mesh defines the mesh to use
  100056. */
  100057. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  100058. /**
  100059. * Gets the mesh under the pointer
  100060. * @returns a Mesh or null if no mesh is under the pointer
  100061. */
  100062. getPointerOverMesh(): Nullable<AbstractMesh>;
  100063. /** @hidden */
  100064. _rebuildGeometries(): void;
  100065. /** @hidden */
  100066. _rebuildTextures(): void;
  100067. private _getByTags;
  100068. /**
  100069. * Get a list of meshes by tags
  100070. * @param tagsQuery defines the tags query to use
  100071. * @param forEach defines a predicate used to filter results
  100072. * @returns an array of Mesh
  100073. */
  100074. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  100075. /**
  100076. * Get a list of cameras by tags
  100077. * @param tagsQuery defines the tags query to use
  100078. * @param forEach defines a predicate used to filter results
  100079. * @returns an array of Camera
  100080. */
  100081. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  100082. /**
  100083. * Get a list of lights by tags
  100084. * @param tagsQuery defines the tags query to use
  100085. * @param forEach defines a predicate used to filter results
  100086. * @returns an array of Light
  100087. */
  100088. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  100089. /**
  100090. * Get a list of materials by tags
  100091. * @param tagsQuery defines the tags query to use
  100092. * @param forEach defines a predicate used to filter results
  100093. * @returns an array of Material
  100094. */
  100095. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  100096. /**
  100097. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  100098. * This allowed control for front to back rendering or reversly depending of the special needs.
  100099. *
  100100. * @param renderingGroupId The rendering group id corresponding to its index
  100101. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  100102. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  100103. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  100104. */
  100105. 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;
  100106. /**
  100107. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  100108. *
  100109. * @param renderingGroupId The rendering group id corresponding to its index
  100110. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  100111. * @param depth Automatically clears depth between groups if true and autoClear is true.
  100112. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  100113. */
  100114. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  100115. /**
  100116. * Gets the current auto clear configuration for one rendering group of the rendering
  100117. * manager.
  100118. * @param index the rendering group index to get the information for
  100119. * @returns The auto clear setup for the requested rendering group
  100120. */
  100121. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  100122. private _blockMaterialDirtyMechanism;
  100123. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  100124. blockMaterialDirtyMechanism: boolean;
  100125. /**
  100126. * Will flag all materials as dirty to trigger new shader compilation
  100127. * @param flag defines the flag used to specify which material part must be marked as dirty
  100128. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  100129. */
  100130. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  100131. /** @hidden */
  100132. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  100133. /** @hidden */
  100134. _loadFileAsync(url: string, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  100135. }
  100136. }
  100137. declare module BABYLON {
  100138. /**
  100139. * Set of assets to keep when moving a scene into an asset container.
  100140. */
  100141. export class KeepAssets extends AbstractScene {
  100142. }
  100143. /**
  100144. * Container with a set of assets that can be added or removed from a scene.
  100145. */
  100146. export class AssetContainer extends AbstractScene {
  100147. /**
  100148. * The scene the AssetContainer belongs to.
  100149. */
  100150. scene: Scene;
  100151. /**
  100152. * Instantiates an AssetContainer.
  100153. * @param scene The scene the AssetContainer belongs to.
  100154. */
  100155. constructor(scene: Scene);
  100156. /**
  100157. * Adds all the assets from the container to the scene.
  100158. */
  100159. addAllToScene(): void;
  100160. /**
  100161. * Removes all the assets in the container from the scene
  100162. */
  100163. removeAllFromScene(): void;
  100164. /**
  100165. * Disposes all the assets in the container
  100166. */
  100167. dispose(): void;
  100168. private _moveAssets;
  100169. /**
  100170. * Removes all the assets contained in the scene and adds them to the container.
  100171. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  100172. */
  100173. moveAllFromScene(keepAssets?: KeepAssets): void;
  100174. /**
  100175. * 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.
  100176. * @returns the root mesh
  100177. */
  100178. createRootMesh(): Mesh;
  100179. }
  100180. }
  100181. declare module BABYLON {
  100182. /**
  100183. * Defines how the parser contract is defined.
  100184. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  100185. */
  100186. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  100187. /**
  100188. * Defines how the individual parser contract is defined.
  100189. * These parser can parse an individual asset
  100190. */
  100191. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  100192. /**
  100193. * Base class of the scene acting as a container for the different elements composing a scene.
  100194. * This class is dynamically extended by the different components of the scene increasing
  100195. * flexibility and reducing coupling
  100196. */
  100197. export abstract class AbstractScene {
  100198. /**
  100199. * Stores the list of available parsers in the application.
  100200. */
  100201. private static _BabylonFileParsers;
  100202. /**
  100203. * Stores the list of available individual parsers in the application.
  100204. */
  100205. private static _IndividualBabylonFileParsers;
  100206. /**
  100207. * Adds a parser in the list of available ones
  100208. * @param name Defines the name of the parser
  100209. * @param parser Defines the parser to add
  100210. */
  100211. static AddParser(name: string, parser: BabylonFileParser): void;
  100212. /**
  100213. * Gets a general parser from the list of avaialble ones
  100214. * @param name Defines the name of the parser
  100215. * @returns the requested parser or null
  100216. */
  100217. static GetParser(name: string): Nullable<BabylonFileParser>;
  100218. /**
  100219. * Adds n individual parser in the list of available ones
  100220. * @param name Defines the name of the parser
  100221. * @param parser Defines the parser to add
  100222. */
  100223. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  100224. /**
  100225. * Gets an individual parser from the list of avaialble ones
  100226. * @param name Defines the name of the parser
  100227. * @returns the requested parser or null
  100228. */
  100229. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  100230. /**
  100231. * Parser json data and populate both a scene and its associated container object
  100232. * @param jsonData Defines the data to parse
  100233. * @param scene Defines the scene to parse the data for
  100234. * @param container Defines the container attached to the parsing sequence
  100235. * @param rootUrl Defines the root url of the data
  100236. */
  100237. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  100238. /**
  100239. * Gets the list of root nodes (ie. nodes with no parent)
  100240. */
  100241. rootNodes: Node[];
  100242. /** All of the cameras added to this scene
  100243. * @see http://doc.babylonjs.com/babylon101/cameras
  100244. */
  100245. cameras: Camera[];
  100246. /**
  100247. * All of the lights added to this scene
  100248. * @see http://doc.babylonjs.com/babylon101/lights
  100249. */
  100250. lights: Light[];
  100251. /**
  100252. * All of the (abstract) meshes added to this scene
  100253. */
  100254. meshes: AbstractMesh[];
  100255. /**
  100256. * The list of skeletons added to the scene
  100257. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  100258. */
  100259. skeletons: Skeleton[];
  100260. /**
  100261. * All of the particle systems added to this scene
  100262. * @see http://doc.babylonjs.com/babylon101/particles
  100263. */
  100264. particleSystems: IParticleSystem[];
  100265. /**
  100266. * Gets a list of Animations associated with the scene
  100267. */
  100268. animations: Animation[];
  100269. /**
  100270. * All of the animation groups added to this scene
  100271. * @see http://doc.babylonjs.com/how_to/group
  100272. */
  100273. animationGroups: AnimationGroup[];
  100274. /**
  100275. * All of the multi-materials added to this scene
  100276. * @see http://doc.babylonjs.com/how_to/multi_materials
  100277. */
  100278. multiMaterials: MultiMaterial[];
  100279. /**
  100280. * All of the materials added to this scene
  100281. * In the context of a Scene, it is not supposed to be modified manually.
  100282. * Any addition or removal should be done using the addMaterial and removeMAterial Scene methods.
  100283. * Note also that the order of the Material wihin the array is not significant and might change.
  100284. * @see http://doc.babylonjs.com/babylon101/materials
  100285. */
  100286. materials: Material[];
  100287. /**
  100288. * The list of morph target managers added to the scene
  100289. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  100290. */
  100291. morphTargetManagers: MorphTargetManager[];
  100292. /**
  100293. * The list of geometries used in the scene.
  100294. */
  100295. geometries: Geometry[];
  100296. /**
  100297. * All of the tranform nodes added to this scene
  100298. * In the context of a Scene, it is not supposed to be modified manually.
  100299. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  100300. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  100301. * @see http://doc.babylonjs.com/how_to/transformnode
  100302. */
  100303. transformNodes: TransformNode[];
  100304. /**
  100305. * ActionManagers available on the scene.
  100306. */
  100307. actionManagers: AbstractActionManager[];
  100308. /**
  100309. * Textures to keep.
  100310. */
  100311. textures: BaseTexture[];
  100312. /**
  100313. * Environment texture for the scene
  100314. */
  100315. environmentTexture: Nullable<BaseTexture>;
  100316. }
  100317. }
  100318. declare module BABYLON {
  100319. /**
  100320. * Interface used to define options for Sound class
  100321. */
  100322. export interface ISoundOptions {
  100323. /**
  100324. * Does the sound autoplay once loaded.
  100325. */
  100326. autoplay?: boolean;
  100327. /**
  100328. * Does the sound loop after it finishes playing once.
  100329. */
  100330. loop?: boolean;
  100331. /**
  100332. * Sound's volume
  100333. */
  100334. volume?: number;
  100335. /**
  100336. * Is it a spatial sound?
  100337. */
  100338. spatialSound?: boolean;
  100339. /**
  100340. * Maximum distance to hear that sound
  100341. */
  100342. maxDistance?: number;
  100343. /**
  100344. * Uses user defined attenuation function
  100345. */
  100346. useCustomAttenuation?: boolean;
  100347. /**
  100348. * Define the roll off factor of spatial sounds.
  100349. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100350. */
  100351. rolloffFactor?: number;
  100352. /**
  100353. * Define the reference distance the sound should be heard perfectly.
  100354. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100355. */
  100356. refDistance?: number;
  100357. /**
  100358. * Define the distance attenuation model the sound will follow.
  100359. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100360. */
  100361. distanceModel?: string;
  100362. /**
  100363. * Defines the playback speed (1 by default)
  100364. */
  100365. playbackRate?: number;
  100366. /**
  100367. * Defines if the sound is from a streaming source
  100368. */
  100369. streaming?: boolean;
  100370. /**
  100371. * Defines an optional length (in seconds) inside the sound file
  100372. */
  100373. length?: number;
  100374. /**
  100375. * Defines an optional offset (in seconds) inside the sound file
  100376. */
  100377. offset?: number;
  100378. /**
  100379. * If true, URLs will not be required to state the audio file codec to use.
  100380. */
  100381. skipCodecCheck?: boolean;
  100382. }
  100383. /**
  100384. * Defines a sound that can be played in the application.
  100385. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  100386. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100387. */
  100388. export class Sound {
  100389. /**
  100390. * The name of the sound in the scene.
  100391. */
  100392. name: string;
  100393. /**
  100394. * Does the sound autoplay once loaded.
  100395. */
  100396. autoplay: boolean;
  100397. /**
  100398. * Does the sound loop after it finishes playing once.
  100399. */
  100400. loop: boolean;
  100401. /**
  100402. * Does the sound use a custom attenuation curve to simulate the falloff
  100403. * happening when the source gets further away from the camera.
  100404. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  100405. */
  100406. useCustomAttenuation: boolean;
  100407. /**
  100408. * The sound track id this sound belongs to.
  100409. */
  100410. soundTrackId: number;
  100411. /**
  100412. * Is this sound currently played.
  100413. */
  100414. isPlaying: boolean;
  100415. /**
  100416. * Is this sound currently paused.
  100417. */
  100418. isPaused: boolean;
  100419. /**
  100420. * Does this sound enables spatial sound.
  100421. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100422. */
  100423. spatialSound: boolean;
  100424. /**
  100425. * Define the reference distance the sound should be heard perfectly.
  100426. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100427. */
  100428. refDistance: number;
  100429. /**
  100430. * Define the roll off factor of spatial sounds.
  100431. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100432. */
  100433. rolloffFactor: number;
  100434. /**
  100435. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  100436. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100437. */
  100438. maxDistance: number;
  100439. /**
  100440. * Define the distance attenuation model the sound will follow.
  100441. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100442. */
  100443. distanceModel: string;
  100444. /**
  100445. * @hidden
  100446. * Back Compat
  100447. **/
  100448. onended: () => any;
  100449. /**
  100450. * Observable event when the current playing sound finishes.
  100451. */
  100452. onEndedObservable: Observable<Sound>;
  100453. private _panningModel;
  100454. private _playbackRate;
  100455. private _streaming;
  100456. private _startTime;
  100457. private _startOffset;
  100458. private _position;
  100459. /** @hidden */
  100460. _positionInEmitterSpace: boolean;
  100461. private _localDirection;
  100462. private _volume;
  100463. private _isReadyToPlay;
  100464. private _isDirectional;
  100465. private _readyToPlayCallback;
  100466. private _audioBuffer;
  100467. private _soundSource;
  100468. private _streamingSource;
  100469. private _soundPanner;
  100470. private _soundGain;
  100471. private _inputAudioNode;
  100472. private _outputAudioNode;
  100473. private _coneInnerAngle;
  100474. private _coneOuterAngle;
  100475. private _coneOuterGain;
  100476. private _scene;
  100477. private _connectedTransformNode;
  100478. private _customAttenuationFunction;
  100479. private _registerFunc;
  100480. private _isOutputConnected;
  100481. private _htmlAudioElement;
  100482. private _urlType;
  100483. private _length?;
  100484. private _offset?;
  100485. /** @hidden */
  100486. static _SceneComponentInitialization: (scene: Scene) => void;
  100487. /**
  100488. * Create a sound and attach it to a scene
  100489. * @param name Name of your sound
  100490. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  100491. * @param scene defines the scene the sound belongs to
  100492. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  100493. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  100494. */
  100495. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  100496. /**
  100497. * Release the sound and its associated resources
  100498. */
  100499. dispose(): void;
  100500. /**
  100501. * Gets if the sounds is ready to be played or not.
  100502. * @returns true if ready, otherwise false
  100503. */
  100504. isReady(): boolean;
  100505. private _soundLoaded;
  100506. /**
  100507. * Sets the data of the sound from an audiobuffer
  100508. * @param audioBuffer The audioBuffer containing the data
  100509. */
  100510. setAudioBuffer(audioBuffer: AudioBuffer): void;
  100511. /**
  100512. * Updates the current sounds options such as maxdistance, loop...
  100513. * @param options A JSON object containing values named as the object properties
  100514. */
  100515. updateOptions(options: ISoundOptions): void;
  100516. private _createSpatialParameters;
  100517. private _updateSpatialParameters;
  100518. /**
  100519. * Switch the panning model to HRTF:
  100520. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  100521. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100522. */
  100523. switchPanningModelToHRTF(): void;
  100524. /**
  100525. * Switch the panning model to Equal Power:
  100526. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  100527. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100528. */
  100529. switchPanningModelToEqualPower(): void;
  100530. private _switchPanningModel;
  100531. /**
  100532. * Connect this sound to a sound track audio node like gain...
  100533. * @param soundTrackAudioNode the sound track audio node to connect to
  100534. */
  100535. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  100536. /**
  100537. * Transform this sound into a directional source
  100538. * @param coneInnerAngle Size of the inner cone in degree
  100539. * @param coneOuterAngle Size of the outer cone in degree
  100540. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  100541. */
  100542. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  100543. /**
  100544. * Gets or sets the inner angle for the directional cone.
  100545. */
  100546. /**
  100547. * Gets or sets the inner angle for the directional cone.
  100548. */
  100549. directionalConeInnerAngle: number;
  100550. /**
  100551. * Gets or sets the outer angle for the directional cone.
  100552. */
  100553. /**
  100554. * Gets or sets the outer angle for the directional cone.
  100555. */
  100556. directionalConeOuterAngle: number;
  100557. /**
  100558. * Sets the position of the emitter if spatial sound is enabled
  100559. * @param newPosition Defines the new posisiton
  100560. */
  100561. setPosition(newPosition: Vector3): void;
  100562. /**
  100563. * Sets the local direction of the emitter if spatial sound is enabled
  100564. * @param newLocalDirection Defines the new local direction
  100565. */
  100566. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  100567. private _updateDirection;
  100568. /** @hidden */
  100569. updateDistanceFromListener(): void;
  100570. /**
  100571. * Sets a new custom attenuation function for the sound.
  100572. * @param callback Defines the function used for the attenuation
  100573. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  100574. */
  100575. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  100576. /**
  100577. * Play the sound
  100578. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  100579. * @param offset (optional) Start the sound at a specific time in seconds
  100580. * @param length (optional) Sound duration (in seconds)
  100581. */
  100582. play(time?: number, offset?: number, length?: number): void;
  100583. private _onended;
  100584. /**
  100585. * Stop the sound
  100586. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  100587. */
  100588. stop(time?: number): void;
  100589. /**
  100590. * Put the sound in pause
  100591. */
  100592. pause(): void;
  100593. /**
  100594. * Sets a dedicated volume for this sounds
  100595. * @param newVolume Define the new volume of the sound
  100596. * @param time Define time for gradual change to new volume
  100597. */
  100598. setVolume(newVolume: number, time?: number): void;
  100599. /**
  100600. * Set the sound play back rate
  100601. * @param newPlaybackRate Define the playback rate the sound should be played at
  100602. */
  100603. setPlaybackRate(newPlaybackRate: number): void;
  100604. /**
  100605. * Gets the volume of the sound.
  100606. * @returns the volume of the sound
  100607. */
  100608. getVolume(): number;
  100609. /**
  100610. * Attach the sound to a dedicated mesh
  100611. * @param transformNode The transform node to connect the sound with
  100612. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  100613. */
  100614. attachToMesh(transformNode: TransformNode): void;
  100615. /**
  100616. * Detach the sound from the previously attached mesh
  100617. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  100618. */
  100619. detachFromMesh(): void;
  100620. private _onRegisterAfterWorldMatrixUpdate;
  100621. /**
  100622. * Clone the current sound in the scene.
  100623. * @returns the new sound clone
  100624. */
  100625. clone(): Nullable<Sound>;
  100626. /**
  100627. * Gets the current underlying audio buffer containing the data
  100628. * @returns the audio buffer
  100629. */
  100630. getAudioBuffer(): Nullable<AudioBuffer>;
  100631. /**
  100632. * Serializes the Sound in a JSON representation
  100633. * @returns the JSON representation of the sound
  100634. */
  100635. serialize(): any;
  100636. /**
  100637. * Parse a JSON representation of a sound to innstantiate in a given scene
  100638. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  100639. * @param scene Define the scene the new parsed sound should be created in
  100640. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  100641. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  100642. * @returns the newly parsed sound
  100643. */
  100644. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  100645. }
  100646. }
  100647. declare module BABYLON {
  100648. /**
  100649. * This defines an action helpful to play a defined sound on a triggered action.
  100650. */
  100651. export class PlaySoundAction extends Action {
  100652. private _sound;
  100653. /**
  100654. * Instantiate the action
  100655. * @param triggerOptions defines the trigger options
  100656. * @param sound defines the sound to play
  100657. * @param condition defines the trigger related conditions
  100658. */
  100659. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  100660. /** @hidden */
  100661. _prepare(): void;
  100662. /**
  100663. * Execute the action and play the sound.
  100664. */
  100665. execute(): void;
  100666. /**
  100667. * Serializes the actions and its related information.
  100668. * @param parent defines the object to serialize in
  100669. * @returns the serialized object
  100670. */
  100671. serialize(parent: any): any;
  100672. }
  100673. /**
  100674. * This defines an action helpful to stop a defined sound on a triggered action.
  100675. */
  100676. export class StopSoundAction extends Action {
  100677. private _sound;
  100678. /**
  100679. * Instantiate the action
  100680. * @param triggerOptions defines the trigger options
  100681. * @param sound defines the sound to stop
  100682. * @param condition defines the trigger related conditions
  100683. */
  100684. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  100685. /** @hidden */
  100686. _prepare(): void;
  100687. /**
  100688. * Execute the action and stop the sound.
  100689. */
  100690. execute(): void;
  100691. /**
  100692. * Serializes the actions and its related information.
  100693. * @param parent defines the object to serialize in
  100694. * @returns the serialized object
  100695. */
  100696. serialize(parent: any): any;
  100697. }
  100698. }
  100699. declare module BABYLON {
  100700. /**
  100701. * This defines an action responsible to change the value of a property
  100702. * by interpolating between its current value and the newly set one once triggered.
  100703. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  100704. */
  100705. export class InterpolateValueAction extends Action {
  100706. /**
  100707. * Defines the path of the property where the value should be interpolated
  100708. */
  100709. propertyPath: string;
  100710. /**
  100711. * Defines the target value at the end of the interpolation.
  100712. */
  100713. value: any;
  100714. /**
  100715. * Defines the time it will take for the property to interpolate to the value.
  100716. */
  100717. duration: number;
  100718. /**
  100719. * Defines if the other scene animations should be stopped when the action has been triggered
  100720. */
  100721. stopOtherAnimations?: boolean;
  100722. /**
  100723. * Defines a callback raised once the interpolation animation has been done.
  100724. */
  100725. onInterpolationDone?: () => void;
  100726. /**
  100727. * Observable triggered once the interpolation animation has been done.
  100728. */
  100729. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  100730. private _target;
  100731. private _effectiveTarget;
  100732. private _property;
  100733. /**
  100734. * Instantiate the action
  100735. * @param triggerOptions defines the trigger options
  100736. * @param target defines the object containing the value to interpolate
  100737. * @param propertyPath defines the path to the property in the target object
  100738. * @param value defines the target value at the end of the interpolation
  100739. * @param duration deines the time it will take for the property to interpolate to the value.
  100740. * @param condition defines the trigger related conditions
  100741. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  100742. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  100743. */
  100744. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  100745. /** @hidden */
  100746. _prepare(): void;
  100747. /**
  100748. * Execute the action starts the value interpolation.
  100749. */
  100750. execute(): void;
  100751. /**
  100752. * Serializes the actions and its related information.
  100753. * @param parent defines the object to serialize in
  100754. * @returns the serialized object
  100755. */
  100756. serialize(parent: any): any;
  100757. }
  100758. }
  100759. declare module BABYLON {
  100760. /**
  100761. * Options allowed during the creation of a sound track.
  100762. */
  100763. export interface ISoundTrackOptions {
  100764. /**
  100765. * The volume the sound track should take during creation
  100766. */
  100767. volume?: number;
  100768. /**
  100769. * Define if the sound track is the main sound track of the scene
  100770. */
  100771. mainTrack?: boolean;
  100772. }
  100773. /**
  100774. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  100775. * It will be also used in a future release to apply effects on a specific track.
  100776. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  100777. */
  100778. export class SoundTrack {
  100779. /**
  100780. * The unique identifier of the sound track in the scene.
  100781. */
  100782. id: number;
  100783. /**
  100784. * The list of sounds included in the sound track.
  100785. */
  100786. soundCollection: Array<Sound>;
  100787. private _outputAudioNode;
  100788. private _scene;
  100789. private _isMainTrack;
  100790. private _connectedAnalyser;
  100791. private _options;
  100792. private _isInitialized;
  100793. /**
  100794. * Creates a new sound track.
  100795. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  100796. * @param scene Define the scene the sound track belongs to
  100797. * @param options
  100798. */
  100799. constructor(scene: Scene, options?: ISoundTrackOptions);
  100800. private _initializeSoundTrackAudioGraph;
  100801. /**
  100802. * Release the sound track and its associated resources
  100803. */
  100804. dispose(): void;
  100805. /**
  100806. * Adds a sound to this sound track
  100807. * @param sound define the cound to add
  100808. * @ignoreNaming
  100809. */
  100810. AddSound(sound: Sound): void;
  100811. /**
  100812. * Removes a sound to this sound track
  100813. * @param sound define the cound to remove
  100814. * @ignoreNaming
  100815. */
  100816. RemoveSound(sound: Sound): void;
  100817. /**
  100818. * Set a global volume for the full sound track.
  100819. * @param newVolume Define the new volume of the sound track
  100820. */
  100821. setVolume(newVolume: number): void;
  100822. /**
  100823. * Switch the panning model to HRTF:
  100824. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  100825. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100826. */
  100827. switchPanningModelToHRTF(): void;
  100828. /**
  100829. * Switch the panning model to Equal Power:
  100830. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  100831. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  100832. */
  100833. switchPanningModelToEqualPower(): void;
  100834. /**
  100835. * Connect the sound track to an audio analyser allowing some amazing
  100836. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  100837. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  100838. * @param analyser The analyser to connect to the engine
  100839. */
  100840. connectToAnalyser(analyser: Analyser): void;
  100841. }
  100842. }
  100843. declare module BABYLON {
  100844. interface AbstractScene {
  100845. /**
  100846. * The list of sounds used in the scene.
  100847. */
  100848. sounds: Nullable<Array<Sound>>;
  100849. }
  100850. interface Scene {
  100851. /**
  100852. * @hidden
  100853. * Backing field
  100854. */
  100855. _mainSoundTrack: SoundTrack;
  100856. /**
  100857. * The main sound track played by the scene.
  100858. * It cotains your primary collection of sounds.
  100859. */
  100860. mainSoundTrack: SoundTrack;
  100861. /**
  100862. * The list of sound tracks added to the scene
  100863. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100864. */
  100865. soundTracks: Nullable<Array<SoundTrack>>;
  100866. /**
  100867. * Gets a sound using a given name
  100868. * @param name defines the name to search for
  100869. * @return the found sound or null if not found at all.
  100870. */
  100871. getSoundByName(name: string): Nullable<Sound>;
  100872. /**
  100873. * Gets or sets if audio support is enabled
  100874. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100875. */
  100876. audioEnabled: boolean;
  100877. /**
  100878. * Gets or sets if audio will be output to headphones
  100879. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100880. */
  100881. headphone: boolean;
  100882. /**
  100883. * Gets or sets custom audio listener position provider
  100884. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100885. */
  100886. audioListenerPositionProvider: Nullable<() => Vector3>;
  100887. }
  100888. /**
  100889. * Defines the sound scene component responsible to manage any sounds
  100890. * in a given scene.
  100891. */
  100892. export class AudioSceneComponent implements ISceneSerializableComponent {
  100893. /**
  100894. * The component name helpfull to identify the component in the list of scene components.
  100895. */
  100896. readonly name: string;
  100897. /**
  100898. * The scene the component belongs to.
  100899. */
  100900. scene: Scene;
  100901. private _audioEnabled;
  100902. /**
  100903. * Gets whether audio is enabled or not.
  100904. * Please use related enable/disable method to switch state.
  100905. */
  100906. readonly audioEnabled: boolean;
  100907. private _headphone;
  100908. /**
  100909. * Gets whether audio is outputing to headphone or not.
  100910. * Please use the according Switch methods to change output.
  100911. */
  100912. readonly headphone: boolean;
  100913. private _audioListenerPositionProvider;
  100914. /**
  100915. * Gets the current audio listener position provider
  100916. */
  100917. /**
  100918. * Sets a custom listener position for all sounds in the scene
  100919. * By default, this is the position of the first active camera
  100920. */
  100921. audioListenerPositionProvider: Nullable<() => Vector3>;
  100922. /**
  100923. * Creates a new instance of the component for the given scene
  100924. * @param scene Defines the scene to register the component in
  100925. */
  100926. constructor(scene: Scene);
  100927. /**
  100928. * Registers the component in a given scene
  100929. */
  100930. register(): void;
  100931. /**
  100932. * Rebuilds the elements related to this component in case of
  100933. * context lost for instance.
  100934. */
  100935. rebuild(): void;
  100936. /**
  100937. * Serializes the component data to the specified json object
  100938. * @param serializationObject The object to serialize to
  100939. */
  100940. serialize(serializationObject: any): void;
  100941. /**
  100942. * Adds all the elements from the container to the scene
  100943. * @param container the container holding the elements
  100944. */
  100945. addFromContainer(container: AbstractScene): void;
  100946. /**
  100947. * Removes all the elements in the container from the scene
  100948. * @param container contains the elements to remove
  100949. * @param dispose if the removed element should be disposed (default: false)
  100950. */
  100951. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  100952. /**
  100953. * Disposes the component and the associated ressources.
  100954. */
  100955. dispose(): void;
  100956. /**
  100957. * Disables audio in the associated scene.
  100958. */
  100959. disableAudio(): void;
  100960. /**
  100961. * Enables audio in the associated scene.
  100962. */
  100963. enableAudio(): void;
  100964. /**
  100965. * Switch audio to headphone output.
  100966. */
  100967. switchAudioModeForHeadphones(): void;
  100968. /**
  100969. * Switch audio to normal speakers.
  100970. */
  100971. switchAudioModeForNormalSpeakers(): void;
  100972. private _afterRender;
  100973. }
  100974. }
  100975. declare module BABYLON {
  100976. /**
  100977. * Wraps one or more Sound objects and selects one with random weight for playback.
  100978. */
  100979. export class WeightedSound {
  100980. /** When true a Sound will be selected and played when the current playing Sound completes. */
  100981. loop: boolean;
  100982. private _coneInnerAngle;
  100983. private _coneOuterAngle;
  100984. private _volume;
  100985. /** A Sound is currently playing. */
  100986. isPlaying: boolean;
  100987. /** A Sound is currently paused. */
  100988. isPaused: boolean;
  100989. private _sounds;
  100990. private _weights;
  100991. private _currentIndex?;
  100992. /**
  100993. * Creates a new WeightedSound from the list of sounds given.
  100994. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  100995. * @param sounds Array of Sounds that will be selected from.
  100996. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  100997. */
  100998. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  100999. /**
  101000. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  101001. */
  101002. /**
  101003. * The size of cone in degress for a directional sound in which there will be no attenuation.
  101004. */
  101005. directionalConeInnerAngle: number;
  101006. /**
  101007. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  101008. * Listener angles between innerAngle and outerAngle will falloff linearly.
  101009. */
  101010. /**
  101011. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  101012. * Listener angles between innerAngle and outerAngle will falloff linearly.
  101013. */
  101014. directionalConeOuterAngle: number;
  101015. /**
  101016. * Playback volume.
  101017. */
  101018. /**
  101019. * Playback volume.
  101020. */
  101021. volume: number;
  101022. private _onended;
  101023. /**
  101024. * Suspend playback
  101025. */
  101026. pause(): void;
  101027. /**
  101028. * Stop playback
  101029. */
  101030. stop(): void;
  101031. /**
  101032. * Start playback.
  101033. * @param startOffset Position the clip head at a specific time in seconds.
  101034. */
  101035. play(startOffset?: number): void;
  101036. }
  101037. }
  101038. declare module BABYLON {
  101039. /**
  101040. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  101041. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  101042. */
  101043. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  101044. /**
  101045. * Gets the name of the behavior.
  101046. */
  101047. readonly name: string;
  101048. /**
  101049. * The easing function used by animations
  101050. */
  101051. static EasingFunction: BackEase;
  101052. /**
  101053. * The easing mode used by animations
  101054. */
  101055. static EasingMode: number;
  101056. /**
  101057. * The duration of the animation, in milliseconds
  101058. */
  101059. transitionDuration: number;
  101060. /**
  101061. * Length of the distance animated by the transition when lower radius is reached
  101062. */
  101063. lowerRadiusTransitionRange: number;
  101064. /**
  101065. * Length of the distance animated by the transition when upper radius is reached
  101066. */
  101067. upperRadiusTransitionRange: number;
  101068. private _autoTransitionRange;
  101069. /**
  101070. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  101071. */
  101072. /**
  101073. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  101074. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  101075. */
  101076. autoTransitionRange: boolean;
  101077. private _attachedCamera;
  101078. private _onAfterCheckInputsObserver;
  101079. private _onMeshTargetChangedObserver;
  101080. /**
  101081. * Initializes the behavior.
  101082. */
  101083. init(): void;
  101084. /**
  101085. * Attaches the behavior to its arc rotate camera.
  101086. * @param camera Defines the camera to attach the behavior to
  101087. */
  101088. attach(camera: ArcRotateCamera): void;
  101089. /**
  101090. * Detaches the behavior from its current arc rotate camera.
  101091. */
  101092. detach(): void;
  101093. private _radiusIsAnimating;
  101094. private _radiusBounceTransition;
  101095. private _animatables;
  101096. private _cachedWheelPrecision;
  101097. /**
  101098. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  101099. * @param radiusLimit The limit to check against.
  101100. * @return Bool to indicate if at limit.
  101101. */
  101102. private _isRadiusAtLimit;
  101103. /**
  101104. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  101105. * @param radiusDelta The delta by which to animate to. Can be negative.
  101106. */
  101107. private _applyBoundRadiusAnimation;
  101108. /**
  101109. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  101110. */
  101111. protected _clearAnimationLocks(): void;
  101112. /**
  101113. * Stops and removes all animations that have been applied to the camera
  101114. */
  101115. stopAllAnimations(): void;
  101116. }
  101117. }
  101118. declare module BABYLON {
  101119. /**
  101120. * 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.
  101121. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  101122. */
  101123. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  101124. /**
  101125. * Gets the name of the behavior.
  101126. */
  101127. readonly name: string;
  101128. private _mode;
  101129. private _radiusScale;
  101130. private _positionScale;
  101131. private _defaultElevation;
  101132. private _elevationReturnTime;
  101133. private _elevationReturnWaitTime;
  101134. private _zoomStopsAnimation;
  101135. private _framingTime;
  101136. /**
  101137. * The easing function used by animations
  101138. */
  101139. static EasingFunction: ExponentialEase;
  101140. /**
  101141. * The easing mode used by animations
  101142. */
  101143. static EasingMode: number;
  101144. /**
  101145. * Sets the current mode used by the behavior
  101146. */
  101147. /**
  101148. * Gets current mode used by the behavior.
  101149. */
  101150. mode: number;
  101151. /**
  101152. * Sets the scale applied to the radius (1 by default)
  101153. */
  101154. /**
  101155. * Gets the scale applied to the radius
  101156. */
  101157. radiusScale: number;
  101158. /**
  101159. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  101160. */
  101161. /**
  101162. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  101163. */
  101164. positionScale: number;
  101165. /**
  101166. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  101167. * behaviour is triggered, in radians.
  101168. */
  101169. /**
  101170. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  101171. * behaviour is triggered, in radians.
  101172. */
  101173. defaultElevation: number;
  101174. /**
  101175. * Sets the time (in milliseconds) taken to return to the default beta position.
  101176. * Negative value indicates camera should not return to default.
  101177. */
  101178. /**
  101179. * Gets the time (in milliseconds) taken to return to the default beta position.
  101180. * Negative value indicates camera should not return to default.
  101181. */
  101182. elevationReturnTime: number;
  101183. /**
  101184. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  101185. */
  101186. /**
  101187. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  101188. */
  101189. elevationReturnWaitTime: number;
  101190. /**
  101191. * Sets the flag that indicates if user zooming should stop animation.
  101192. */
  101193. /**
  101194. * Gets the flag that indicates if user zooming should stop animation.
  101195. */
  101196. zoomStopsAnimation: boolean;
  101197. /**
  101198. * Sets the transition time when framing the mesh, in milliseconds
  101199. */
  101200. /**
  101201. * Gets the transition time when framing the mesh, in milliseconds
  101202. */
  101203. framingTime: number;
  101204. /**
  101205. * Define if the behavior should automatically change the configured
  101206. * camera limits and sensibilities.
  101207. */
  101208. autoCorrectCameraLimitsAndSensibility: boolean;
  101209. private _onPrePointerObservableObserver;
  101210. private _onAfterCheckInputsObserver;
  101211. private _onMeshTargetChangedObserver;
  101212. private _attachedCamera;
  101213. private _isPointerDown;
  101214. private _lastInteractionTime;
  101215. /**
  101216. * Initializes the behavior.
  101217. */
  101218. init(): void;
  101219. /**
  101220. * Attaches the behavior to its arc rotate camera.
  101221. * @param camera Defines the camera to attach the behavior to
  101222. */
  101223. attach(camera: ArcRotateCamera): void;
  101224. /**
  101225. * Detaches the behavior from its current arc rotate camera.
  101226. */
  101227. detach(): void;
  101228. private _animatables;
  101229. private _betaIsAnimating;
  101230. private _betaTransition;
  101231. private _radiusTransition;
  101232. private _vectorTransition;
  101233. /**
  101234. * Targets the given mesh and updates zoom level accordingly.
  101235. * @param mesh The mesh to target.
  101236. * @param radius Optional. If a cached radius position already exists, overrides default.
  101237. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  101238. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  101239. * @param onAnimationEnd Callback triggered at the end of the framing animation
  101240. */
  101241. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  101242. /**
  101243. * Targets the given mesh with its children and updates zoom level accordingly.
  101244. * @param mesh The mesh to target.
  101245. * @param radius Optional. If a cached radius position already exists, overrides default.
  101246. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  101247. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  101248. * @param onAnimationEnd Callback triggered at the end of the framing animation
  101249. */
  101250. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  101251. /**
  101252. * Targets the given meshes with their children and updates zoom level accordingly.
  101253. * @param meshes The mesh to target.
  101254. * @param radius Optional. If a cached radius position already exists, overrides default.
  101255. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  101256. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  101257. * @param onAnimationEnd Callback triggered at the end of the framing animation
  101258. */
  101259. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  101260. /**
  101261. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  101262. * @param minimumWorld Determines the smaller position of the bounding box extend
  101263. * @param maximumWorld Determines the bigger position of the bounding box extend
  101264. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  101265. * @param onAnimationEnd Callback triggered at the end of the framing animation
  101266. */
  101267. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  101268. /**
  101269. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  101270. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  101271. * frustum width.
  101272. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  101273. * to fully enclose the mesh in the viewing frustum.
  101274. */
  101275. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  101276. /**
  101277. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  101278. * is automatically returned to its default position (expected to be above ground plane).
  101279. */
  101280. private _maintainCameraAboveGround;
  101281. /**
  101282. * Returns the frustum slope based on the canvas ratio and camera FOV
  101283. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  101284. */
  101285. private _getFrustumSlope;
  101286. /**
  101287. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  101288. */
  101289. private _clearAnimationLocks;
  101290. /**
  101291. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  101292. */
  101293. private _applyUserInteraction;
  101294. /**
  101295. * Stops and removes all animations that have been applied to the camera
  101296. */
  101297. stopAllAnimations(): void;
  101298. /**
  101299. * Gets a value indicating if the user is moving the camera
  101300. */
  101301. readonly isUserIsMoving: boolean;
  101302. /**
  101303. * The camera can move all the way towards the mesh.
  101304. */
  101305. static IgnoreBoundsSizeMode: number;
  101306. /**
  101307. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  101308. */
  101309. static FitFrustumSidesMode: number;
  101310. }
  101311. }
  101312. declare module BABYLON {
  101313. /**
  101314. * Base class for Camera Pointer Inputs.
  101315. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  101316. * for example usage.
  101317. */
  101318. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  101319. /**
  101320. * Defines the camera the input is attached to.
  101321. */
  101322. abstract camera: Camera;
  101323. /**
  101324. * Whether keyboard modifier keys are pressed at time of last mouse event.
  101325. */
  101326. protected _altKey: boolean;
  101327. protected _ctrlKey: boolean;
  101328. protected _metaKey: boolean;
  101329. protected _shiftKey: boolean;
  101330. /**
  101331. * Which mouse buttons were pressed at time of last mouse event.
  101332. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  101333. */
  101334. protected _buttonsPressed: number;
  101335. /**
  101336. * Defines the buttons associated with the input to handle camera move.
  101337. */
  101338. buttons: number[];
  101339. /**
  101340. * Attach the input controls to a specific dom element to get the input from.
  101341. * @param element Defines the element the controls should be listened from
  101342. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101343. */
  101344. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101345. /**
  101346. * Detach the current controls from the specified dom element.
  101347. * @param element Defines the element to stop listening the inputs from
  101348. */
  101349. detachControl(element: Nullable<HTMLElement>): void;
  101350. /**
  101351. * Gets the class name of the current input.
  101352. * @returns the class name
  101353. */
  101354. getClassName(): string;
  101355. /**
  101356. * Get the friendly name associated with the input class.
  101357. * @returns the input friendly name
  101358. */
  101359. getSimpleName(): string;
  101360. /**
  101361. * Called on pointer POINTERDOUBLETAP event.
  101362. * Override this method to provide functionality on POINTERDOUBLETAP event.
  101363. */
  101364. protected onDoubleTap(type: string): void;
  101365. /**
  101366. * Called on pointer POINTERMOVE event if only a single touch is active.
  101367. * Override this method to provide functionality.
  101368. */
  101369. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  101370. /**
  101371. * Called on pointer POINTERMOVE event if multiple touches are active.
  101372. * Override this method to provide functionality.
  101373. */
  101374. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  101375. /**
  101376. * Called on JS contextmenu event.
  101377. * Override this method to provide functionality.
  101378. */
  101379. protected onContextMenu(evt: PointerEvent): void;
  101380. /**
  101381. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  101382. * press.
  101383. * Override this method to provide functionality.
  101384. */
  101385. protected onButtonDown(evt: PointerEvent): void;
  101386. /**
  101387. * Called each time a new POINTERUP event occurs. Ie, for each button
  101388. * release.
  101389. * Override this method to provide functionality.
  101390. */
  101391. protected onButtonUp(evt: PointerEvent): void;
  101392. /**
  101393. * Called when window becomes inactive.
  101394. * Override this method to provide functionality.
  101395. */
  101396. protected onLostFocus(): void;
  101397. private _pointerInput;
  101398. private _observer;
  101399. private _onLostFocus;
  101400. private pointA;
  101401. private pointB;
  101402. }
  101403. }
  101404. declare module BABYLON {
  101405. /**
  101406. * Manage the pointers inputs to control an arc rotate camera.
  101407. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101408. */
  101409. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  101410. /**
  101411. * Defines the camera the input is attached to.
  101412. */
  101413. camera: ArcRotateCamera;
  101414. /**
  101415. * Gets the class name of the current input.
  101416. * @returns the class name
  101417. */
  101418. getClassName(): string;
  101419. /**
  101420. * Defines the buttons associated with the input to handle camera move.
  101421. */
  101422. buttons: number[];
  101423. /**
  101424. * Defines the pointer angular sensibility along the X axis or how fast is
  101425. * the camera rotating.
  101426. */
  101427. angularSensibilityX: number;
  101428. /**
  101429. * Defines the pointer angular sensibility along the Y axis or how fast is
  101430. * the camera rotating.
  101431. */
  101432. angularSensibilityY: number;
  101433. /**
  101434. * Defines the pointer pinch precision or how fast is the camera zooming.
  101435. */
  101436. pinchPrecision: number;
  101437. /**
  101438. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  101439. * from 0.
  101440. * It defines the percentage of current camera.radius to use as delta when
  101441. * pinch zoom is used.
  101442. */
  101443. pinchDeltaPercentage: number;
  101444. /**
  101445. * Defines the pointer panning sensibility or how fast is the camera moving.
  101446. */
  101447. panningSensibility: number;
  101448. /**
  101449. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  101450. */
  101451. multiTouchPanning: boolean;
  101452. /**
  101453. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  101454. * zoom (pinch) through multitouch.
  101455. */
  101456. multiTouchPanAndZoom: boolean;
  101457. /**
  101458. * Revers pinch action direction.
  101459. */
  101460. pinchInwards: boolean;
  101461. private _isPanClick;
  101462. private _twoFingerActivityCount;
  101463. private _isPinching;
  101464. /**
  101465. * Called on pointer POINTERMOVE event if only a single touch is active.
  101466. */
  101467. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  101468. /**
  101469. * Called on pointer POINTERDOUBLETAP event.
  101470. */
  101471. protected onDoubleTap(type: string): void;
  101472. /**
  101473. * Called on pointer POINTERMOVE event if multiple touches are active.
  101474. */
  101475. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  101476. /**
  101477. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  101478. * press.
  101479. */
  101480. protected onButtonDown(evt: PointerEvent): void;
  101481. /**
  101482. * Called each time a new POINTERUP event occurs. Ie, for each button
  101483. * release.
  101484. */
  101485. protected onButtonUp(evt: PointerEvent): void;
  101486. /**
  101487. * Called when window becomes inactive.
  101488. */
  101489. protected onLostFocus(): void;
  101490. }
  101491. }
  101492. declare module BABYLON {
  101493. /**
  101494. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  101495. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101496. */
  101497. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  101498. /**
  101499. * Defines the camera the input is attached to.
  101500. */
  101501. camera: ArcRotateCamera;
  101502. /**
  101503. * Defines the list of key codes associated with the up action (increase alpha)
  101504. */
  101505. keysUp: number[];
  101506. /**
  101507. * Defines the list of key codes associated with the down action (decrease alpha)
  101508. */
  101509. keysDown: number[];
  101510. /**
  101511. * Defines the list of key codes associated with the left action (increase beta)
  101512. */
  101513. keysLeft: number[];
  101514. /**
  101515. * Defines the list of key codes associated with the right action (decrease beta)
  101516. */
  101517. keysRight: number[];
  101518. /**
  101519. * Defines the list of key codes associated with the reset action.
  101520. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  101521. */
  101522. keysReset: number[];
  101523. /**
  101524. * Defines the panning sensibility of the inputs.
  101525. * (How fast is the camera paning)
  101526. */
  101527. panningSensibility: number;
  101528. /**
  101529. * Defines the zooming sensibility of the inputs.
  101530. * (How fast is the camera zooming)
  101531. */
  101532. zoomingSensibility: number;
  101533. /**
  101534. * Defines wether maintaining the alt key down switch the movement mode from
  101535. * orientation to zoom.
  101536. */
  101537. useAltToZoom: boolean;
  101538. /**
  101539. * Rotation speed of the camera
  101540. */
  101541. angularSpeed: number;
  101542. private _keys;
  101543. private _ctrlPressed;
  101544. private _altPressed;
  101545. private _onCanvasBlurObserver;
  101546. private _onKeyboardObserver;
  101547. private _engine;
  101548. private _scene;
  101549. /**
  101550. * Attach the input controls to a specific dom element to get the input from.
  101551. * @param element Defines the element the controls should be listened from
  101552. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101553. */
  101554. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101555. /**
  101556. * Detach the current controls from the specified dom element.
  101557. * @param element Defines the element to stop listening the inputs from
  101558. */
  101559. detachControl(element: Nullable<HTMLElement>): void;
  101560. /**
  101561. * Update the current camera state depending on the inputs that have been used this frame.
  101562. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  101563. */
  101564. checkInputs(): void;
  101565. /**
  101566. * Gets the class name of the current intput.
  101567. * @returns the class name
  101568. */
  101569. getClassName(): string;
  101570. /**
  101571. * Get the friendly name associated with the input class.
  101572. * @returns the input friendly name
  101573. */
  101574. getSimpleName(): string;
  101575. }
  101576. }
  101577. declare module BABYLON {
  101578. /**
  101579. * Manage the mouse wheel inputs to control an arc rotate camera.
  101580. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101581. */
  101582. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  101583. /**
  101584. * Defines the camera the input is attached to.
  101585. */
  101586. camera: ArcRotateCamera;
  101587. /**
  101588. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  101589. */
  101590. wheelPrecision: number;
  101591. /**
  101592. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  101593. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  101594. */
  101595. wheelDeltaPercentage: number;
  101596. private _wheel;
  101597. private _observer;
  101598. private computeDeltaFromMouseWheelLegacyEvent;
  101599. /**
  101600. * Attach the input controls to a specific dom element to get the input from.
  101601. * @param element Defines the element the controls should be listened from
  101602. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101603. */
  101604. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101605. /**
  101606. * Detach the current controls from the specified dom element.
  101607. * @param element Defines the element to stop listening the inputs from
  101608. */
  101609. detachControl(element: Nullable<HTMLElement>): void;
  101610. /**
  101611. * Gets the class name of the current intput.
  101612. * @returns the class name
  101613. */
  101614. getClassName(): string;
  101615. /**
  101616. * Get the friendly name associated with the input class.
  101617. * @returns the input friendly name
  101618. */
  101619. getSimpleName(): string;
  101620. }
  101621. }
  101622. declare module BABYLON {
  101623. /**
  101624. * Default Inputs manager for the ArcRotateCamera.
  101625. * It groups all the default supported inputs for ease of use.
  101626. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101627. */
  101628. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  101629. /**
  101630. * Instantiates a new ArcRotateCameraInputsManager.
  101631. * @param camera Defines the camera the inputs belong to
  101632. */
  101633. constructor(camera: ArcRotateCamera);
  101634. /**
  101635. * Add mouse wheel input support to the input manager.
  101636. * @returns the current input manager
  101637. */
  101638. addMouseWheel(): ArcRotateCameraInputsManager;
  101639. /**
  101640. * Add pointers input support to the input manager.
  101641. * @returns the current input manager
  101642. */
  101643. addPointers(): ArcRotateCameraInputsManager;
  101644. /**
  101645. * Add keyboard input support to the input manager.
  101646. * @returns the current input manager
  101647. */
  101648. addKeyboard(): ArcRotateCameraInputsManager;
  101649. }
  101650. }
  101651. declare module BABYLON {
  101652. /**
  101653. * This represents an orbital type of camera.
  101654. *
  101655. * 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.
  101656. * 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.
  101657. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  101658. */
  101659. export class ArcRotateCamera extends TargetCamera {
  101660. /**
  101661. * Defines the rotation angle of the camera along the longitudinal axis.
  101662. */
  101663. alpha: number;
  101664. /**
  101665. * Defines the rotation angle of the camera along the latitudinal axis.
  101666. */
  101667. beta: number;
  101668. /**
  101669. * Defines the radius of the camera from it s target point.
  101670. */
  101671. radius: number;
  101672. protected _target: Vector3;
  101673. protected _targetHost: Nullable<AbstractMesh>;
  101674. /**
  101675. * Defines the target point of the camera.
  101676. * The camera looks towards it form the radius distance.
  101677. */
  101678. target: Vector3;
  101679. /**
  101680. * Define the current local position of the camera in the scene
  101681. */
  101682. position: Vector3;
  101683. protected _upVector: Vector3;
  101684. protected _upToYMatrix: Matrix;
  101685. protected _YToUpMatrix: Matrix;
  101686. /**
  101687. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  101688. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  101689. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  101690. */
  101691. upVector: Vector3;
  101692. /**
  101693. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  101694. */
  101695. setMatUp(): void;
  101696. /**
  101697. * Current inertia value on the longitudinal axis.
  101698. * The bigger this number the longer it will take for the camera to stop.
  101699. */
  101700. inertialAlphaOffset: number;
  101701. /**
  101702. * Current inertia value on the latitudinal axis.
  101703. * The bigger this number the longer it will take for the camera to stop.
  101704. */
  101705. inertialBetaOffset: number;
  101706. /**
  101707. * Current inertia value on the radius axis.
  101708. * The bigger this number the longer it will take for the camera to stop.
  101709. */
  101710. inertialRadiusOffset: number;
  101711. /**
  101712. * Minimum allowed angle on the longitudinal axis.
  101713. * This can help limiting how the Camera is able to move in the scene.
  101714. */
  101715. lowerAlphaLimit: Nullable<number>;
  101716. /**
  101717. * Maximum allowed angle on the longitudinal axis.
  101718. * This can help limiting how the Camera is able to move in the scene.
  101719. */
  101720. upperAlphaLimit: Nullable<number>;
  101721. /**
  101722. * Minimum allowed angle on the latitudinal axis.
  101723. * This can help limiting how the Camera is able to move in the scene.
  101724. */
  101725. lowerBetaLimit: number;
  101726. /**
  101727. * Maximum allowed angle on the latitudinal axis.
  101728. * This can help limiting how the Camera is able to move in the scene.
  101729. */
  101730. upperBetaLimit: number;
  101731. /**
  101732. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  101733. * This can help limiting how the Camera is able to move in the scene.
  101734. */
  101735. lowerRadiusLimit: Nullable<number>;
  101736. /**
  101737. * Maximum allowed distance of the camera to the target (The camera can not get further).
  101738. * This can help limiting how the Camera is able to move in the scene.
  101739. */
  101740. upperRadiusLimit: Nullable<number>;
  101741. /**
  101742. * Defines the current inertia value used during panning of the camera along the X axis.
  101743. */
  101744. inertialPanningX: number;
  101745. /**
  101746. * Defines the current inertia value used during panning of the camera along the Y axis.
  101747. */
  101748. inertialPanningY: number;
  101749. /**
  101750. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  101751. * Basically if your fingers moves away from more than this distance you will be considered
  101752. * in pinch mode.
  101753. */
  101754. pinchToPanMaxDistance: number;
  101755. /**
  101756. * Defines the maximum distance the camera can pan.
  101757. * This could help keeping the cammera always in your scene.
  101758. */
  101759. panningDistanceLimit: Nullable<number>;
  101760. /**
  101761. * Defines the target of the camera before paning.
  101762. */
  101763. panningOriginTarget: Vector3;
  101764. /**
  101765. * Defines the value of the inertia used during panning.
  101766. * 0 would mean stop inertia and one would mean no decelleration at all.
  101767. */
  101768. panningInertia: number;
  101769. /**
  101770. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  101771. */
  101772. angularSensibilityX: number;
  101773. /**
  101774. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  101775. */
  101776. angularSensibilityY: number;
  101777. /**
  101778. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  101779. */
  101780. pinchPrecision: number;
  101781. /**
  101782. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  101783. * It will be used instead of pinchDeltaPrecision if different from 0.
  101784. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  101785. */
  101786. pinchDeltaPercentage: number;
  101787. /**
  101788. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  101789. */
  101790. panningSensibility: number;
  101791. /**
  101792. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  101793. */
  101794. keysUp: number[];
  101795. /**
  101796. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  101797. */
  101798. keysDown: number[];
  101799. /**
  101800. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  101801. */
  101802. keysLeft: number[];
  101803. /**
  101804. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  101805. */
  101806. keysRight: number[];
  101807. /**
  101808. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  101809. */
  101810. wheelPrecision: number;
  101811. /**
  101812. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  101813. * It will be used instead of pinchDeltaPrecision if different from 0.
  101814. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  101815. */
  101816. wheelDeltaPercentage: number;
  101817. /**
  101818. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  101819. */
  101820. zoomOnFactor: number;
  101821. /**
  101822. * Defines a screen offset for the camera position.
  101823. */
  101824. targetScreenOffset: Vector2;
  101825. /**
  101826. * Allows the camera to be completely reversed.
  101827. * If false the camera can not arrive upside down.
  101828. */
  101829. allowUpsideDown: boolean;
  101830. /**
  101831. * Define if double tap/click is used to restore the previously saved state of the camera.
  101832. */
  101833. useInputToRestoreState: boolean;
  101834. /** @hidden */
  101835. _viewMatrix: Matrix;
  101836. /** @hidden */
  101837. _useCtrlForPanning: boolean;
  101838. /** @hidden */
  101839. _panningMouseButton: number;
  101840. /**
  101841. * Defines the input associated to the camera.
  101842. */
  101843. inputs: ArcRotateCameraInputsManager;
  101844. /** @hidden */
  101845. _reset: () => void;
  101846. /**
  101847. * Defines the allowed panning axis.
  101848. */
  101849. panningAxis: Vector3;
  101850. protected _localDirection: Vector3;
  101851. protected _transformedDirection: Vector3;
  101852. private _bouncingBehavior;
  101853. /**
  101854. * Gets the bouncing behavior of the camera if it has been enabled.
  101855. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  101856. */
  101857. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  101858. /**
  101859. * Defines if the bouncing behavior of the camera is enabled on the camera.
  101860. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  101861. */
  101862. useBouncingBehavior: boolean;
  101863. private _framingBehavior;
  101864. /**
  101865. * Gets the framing behavior of the camera if it has been enabled.
  101866. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  101867. */
  101868. readonly framingBehavior: Nullable<FramingBehavior>;
  101869. /**
  101870. * Defines if the framing behavior of the camera is enabled on the camera.
  101871. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  101872. */
  101873. useFramingBehavior: boolean;
  101874. private _autoRotationBehavior;
  101875. /**
  101876. * Gets the auto rotation behavior of the camera if it has been enabled.
  101877. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  101878. */
  101879. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  101880. /**
  101881. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  101882. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  101883. */
  101884. useAutoRotationBehavior: boolean;
  101885. /**
  101886. * Observable triggered when the mesh target has been changed on the camera.
  101887. */
  101888. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  101889. /**
  101890. * Event raised when the camera is colliding with a mesh.
  101891. */
  101892. onCollide: (collidedMesh: AbstractMesh) => void;
  101893. /**
  101894. * Defines whether the camera should check collision with the objects oh the scene.
  101895. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  101896. */
  101897. checkCollisions: boolean;
  101898. /**
  101899. * Defines the collision radius of the camera.
  101900. * This simulates a sphere around the camera.
  101901. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  101902. */
  101903. collisionRadius: Vector3;
  101904. protected _collider: Collider;
  101905. protected _previousPosition: Vector3;
  101906. protected _collisionVelocity: Vector3;
  101907. protected _newPosition: Vector3;
  101908. protected _previousAlpha: number;
  101909. protected _previousBeta: number;
  101910. protected _previousRadius: number;
  101911. protected _collisionTriggered: boolean;
  101912. protected _targetBoundingCenter: Nullable<Vector3>;
  101913. private _computationVector;
  101914. /**
  101915. * Instantiates a new ArcRotateCamera in a given scene
  101916. * @param name Defines the name of the camera
  101917. * @param alpha Defines the camera rotation along the logitudinal axis
  101918. * @param beta Defines the camera rotation along the latitudinal axis
  101919. * @param radius Defines the camera distance from its target
  101920. * @param target Defines the camera target
  101921. * @param scene Defines the scene the camera belongs to
  101922. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  101923. */
  101924. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  101925. /** @hidden */
  101926. _initCache(): void;
  101927. /** @hidden */
  101928. _updateCache(ignoreParentClass?: boolean): void;
  101929. protected _getTargetPosition(): Vector3;
  101930. private _storedAlpha;
  101931. private _storedBeta;
  101932. private _storedRadius;
  101933. private _storedTarget;
  101934. private _storedTargetScreenOffset;
  101935. /**
  101936. * Stores the current state of the camera (alpha, beta, radius and target)
  101937. * @returns the camera itself
  101938. */
  101939. storeState(): Camera;
  101940. /**
  101941. * @hidden
  101942. * Restored camera state. You must call storeState() first
  101943. */
  101944. _restoreStateValues(): boolean;
  101945. /** @hidden */
  101946. _isSynchronizedViewMatrix(): boolean;
  101947. /**
  101948. * Attached controls to the current camera.
  101949. * @param element Defines the element the controls should be listened from
  101950. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101951. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  101952. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  101953. */
  101954. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  101955. /**
  101956. * Detach the current controls from the camera.
  101957. * The camera will stop reacting to inputs.
  101958. * @param element Defines the element to stop listening the inputs from
  101959. */
  101960. detachControl(element: HTMLElement): void;
  101961. /** @hidden */
  101962. _checkInputs(): void;
  101963. protected _checkLimits(): void;
  101964. /**
  101965. * Rebuilds angles (alpha, beta) and radius from the give position and target
  101966. */
  101967. rebuildAnglesAndRadius(): void;
  101968. /**
  101969. * Use a position to define the current camera related information like aplha, beta and radius
  101970. * @param position Defines the position to set the camera at
  101971. */
  101972. setPosition(position: Vector3): void;
  101973. /**
  101974. * Defines the target the camera should look at.
  101975. * This will automatically adapt alpha beta and radius to fit within the new target.
  101976. * @param target Defines the new target as a Vector or a mesh
  101977. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  101978. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  101979. */
  101980. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  101981. /** @hidden */
  101982. _getViewMatrix(): Matrix;
  101983. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  101984. /**
  101985. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  101986. * @param meshes Defines the mesh to zoom on
  101987. * @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)
  101988. */
  101989. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  101990. /**
  101991. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  101992. * The target will be changed but the radius
  101993. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  101994. * @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)
  101995. */
  101996. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  101997. min: Vector3;
  101998. max: Vector3;
  101999. distance: number;
  102000. }, doNotUpdateMaxZ?: boolean): void;
  102001. /**
  102002. * @override
  102003. * Override Camera.createRigCamera
  102004. */
  102005. createRigCamera(name: string, cameraIndex: number): Camera;
  102006. /**
  102007. * @hidden
  102008. * @override
  102009. * Override Camera._updateRigCameras
  102010. */
  102011. _updateRigCameras(): void;
  102012. /**
  102013. * Destroy the camera and release the current resources hold by it.
  102014. */
  102015. dispose(): void;
  102016. /**
  102017. * Gets the current object class name.
  102018. * @return the class name
  102019. */
  102020. getClassName(): string;
  102021. }
  102022. }
  102023. declare module BABYLON {
  102024. /**
  102025. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  102026. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  102027. */
  102028. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  102029. /**
  102030. * Gets the name of the behavior.
  102031. */
  102032. readonly name: string;
  102033. private _zoomStopsAnimation;
  102034. private _idleRotationSpeed;
  102035. private _idleRotationWaitTime;
  102036. private _idleRotationSpinupTime;
  102037. /**
  102038. * Sets the flag that indicates if user zooming should stop animation.
  102039. */
  102040. /**
  102041. * Gets the flag that indicates if user zooming should stop animation.
  102042. */
  102043. zoomStopsAnimation: boolean;
  102044. /**
  102045. * Sets the default speed at which the camera rotates around the model.
  102046. */
  102047. /**
  102048. * Gets the default speed at which the camera rotates around the model.
  102049. */
  102050. idleRotationSpeed: number;
  102051. /**
  102052. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  102053. */
  102054. /**
  102055. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  102056. */
  102057. idleRotationWaitTime: number;
  102058. /**
  102059. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  102060. */
  102061. /**
  102062. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  102063. */
  102064. idleRotationSpinupTime: number;
  102065. /**
  102066. * Gets a value indicating if the camera is currently rotating because of this behavior
  102067. */
  102068. readonly rotationInProgress: boolean;
  102069. private _onPrePointerObservableObserver;
  102070. private _onAfterCheckInputsObserver;
  102071. private _attachedCamera;
  102072. private _isPointerDown;
  102073. private _lastFrameTime;
  102074. private _lastInteractionTime;
  102075. private _cameraRotationSpeed;
  102076. /**
  102077. * Initializes the behavior.
  102078. */
  102079. init(): void;
  102080. /**
  102081. * Attaches the behavior to its arc rotate camera.
  102082. * @param camera Defines the camera to attach the behavior to
  102083. */
  102084. attach(camera: ArcRotateCamera): void;
  102085. /**
  102086. * Detaches the behavior from its current arc rotate camera.
  102087. */
  102088. detach(): void;
  102089. /**
  102090. * Returns true if user is scrolling.
  102091. * @return true if user is scrolling.
  102092. */
  102093. private _userIsZooming;
  102094. private _lastFrameRadius;
  102095. private _shouldAnimationStopForInteraction;
  102096. /**
  102097. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  102098. */
  102099. private _applyUserInteraction;
  102100. private _userIsMoving;
  102101. }
  102102. }
  102103. declare module BABYLON {
  102104. /**
  102105. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  102106. */
  102107. export class AttachToBoxBehavior implements Behavior<Mesh> {
  102108. private ui;
  102109. /**
  102110. * The name of the behavior
  102111. */
  102112. name: string;
  102113. /**
  102114. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  102115. */
  102116. distanceAwayFromFace: number;
  102117. /**
  102118. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  102119. */
  102120. distanceAwayFromBottomOfFace: number;
  102121. private _faceVectors;
  102122. private _target;
  102123. private _scene;
  102124. private _onRenderObserver;
  102125. private _tmpMatrix;
  102126. private _tmpVector;
  102127. /**
  102128. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  102129. * @param ui The transform node that should be attched to the mesh
  102130. */
  102131. constructor(ui: TransformNode);
  102132. /**
  102133. * Initializes the behavior
  102134. */
  102135. init(): void;
  102136. private _closestFace;
  102137. private _zeroVector;
  102138. private _lookAtTmpMatrix;
  102139. private _lookAtToRef;
  102140. /**
  102141. * Attaches the AttachToBoxBehavior to the passed in mesh
  102142. * @param target The mesh that the specified node will be attached to
  102143. */
  102144. attach(target: Mesh): void;
  102145. /**
  102146. * Detaches the behavior from the mesh
  102147. */
  102148. detach(): void;
  102149. }
  102150. }
  102151. declare module BABYLON {
  102152. /**
  102153. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  102154. */
  102155. export class FadeInOutBehavior implements Behavior<Mesh> {
  102156. /**
  102157. * Time in milliseconds to delay before fading in (Default: 0)
  102158. */
  102159. delay: number;
  102160. /**
  102161. * Time in milliseconds for the mesh to fade in (Default: 300)
  102162. */
  102163. fadeInTime: number;
  102164. private _millisecondsPerFrame;
  102165. private _hovered;
  102166. private _hoverValue;
  102167. private _ownerNode;
  102168. /**
  102169. * Instatiates the FadeInOutBehavior
  102170. */
  102171. constructor();
  102172. /**
  102173. * The name of the behavior
  102174. */
  102175. readonly name: string;
  102176. /**
  102177. * Initializes the behavior
  102178. */
  102179. init(): void;
  102180. /**
  102181. * Attaches the fade behavior on the passed in mesh
  102182. * @param ownerNode The mesh that will be faded in/out once attached
  102183. */
  102184. attach(ownerNode: Mesh): void;
  102185. /**
  102186. * Detaches the behavior from the mesh
  102187. */
  102188. detach(): void;
  102189. /**
  102190. * Triggers the mesh to begin fading in or out
  102191. * @param value if the object should fade in or out (true to fade in)
  102192. */
  102193. fadeIn(value: boolean): void;
  102194. private _update;
  102195. private _setAllVisibility;
  102196. }
  102197. }
  102198. declare module BABYLON {
  102199. /**
  102200. * Class containing a set of static utilities functions for managing Pivots
  102201. * @hidden
  102202. */
  102203. export class PivotTools {
  102204. private static _PivotCached;
  102205. private static _OldPivotPoint;
  102206. private static _PivotTranslation;
  102207. private static _PivotTmpVector;
  102208. /** @hidden */
  102209. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  102210. /** @hidden */
  102211. static _RestorePivotPoint(mesh: AbstractMesh): void;
  102212. }
  102213. }
  102214. declare module BABYLON {
  102215. /**
  102216. * Class containing static functions to help procedurally build meshes
  102217. */
  102218. export class PlaneBuilder {
  102219. /**
  102220. * Creates a plane mesh
  102221. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  102222. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  102223. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  102224. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  102225. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  102226. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  102227. * @param name defines the name of the mesh
  102228. * @param options defines the options used to create the mesh
  102229. * @param scene defines the hosting scene
  102230. * @returns the plane mesh
  102231. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  102232. */
  102233. static CreatePlane(name: string, options: {
  102234. size?: number;
  102235. width?: number;
  102236. height?: number;
  102237. sideOrientation?: number;
  102238. frontUVs?: Vector4;
  102239. backUVs?: Vector4;
  102240. updatable?: boolean;
  102241. sourcePlane?: Plane;
  102242. }, scene?: Nullable<Scene>): Mesh;
  102243. }
  102244. }
  102245. declare module BABYLON {
  102246. /**
  102247. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  102248. */
  102249. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  102250. private static _AnyMouseID;
  102251. /**
  102252. * Abstract mesh the behavior is set on
  102253. */
  102254. attachedNode: AbstractMesh;
  102255. private _dragPlane;
  102256. private _scene;
  102257. private _pointerObserver;
  102258. private _beforeRenderObserver;
  102259. private static _planeScene;
  102260. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  102261. /**
  102262. * 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)
  102263. */
  102264. maxDragAngle: number;
  102265. /**
  102266. * @hidden
  102267. */
  102268. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  102269. /**
  102270. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  102271. */
  102272. currentDraggingPointerID: number;
  102273. /**
  102274. * The last position where the pointer hit the drag plane in world space
  102275. */
  102276. lastDragPosition: Vector3;
  102277. /**
  102278. * If the behavior is currently in a dragging state
  102279. */
  102280. dragging: boolean;
  102281. /**
  102282. * 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)
  102283. */
  102284. dragDeltaRatio: number;
  102285. /**
  102286. * If the drag plane orientation should be updated during the dragging (Default: true)
  102287. */
  102288. updateDragPlane: boolean;
  102289. private _debugMode;
  102290. private _moving;
  102291. /**
  102292. * Fires each time the attached mesh is dragged with the pointer
  102293. * * delta between last drag position and current drag position in world space
  102294. * * dragDistance along the drag axis
  102295. * * dragPlaneNormal normal of the current drag plane used during the drag
  102296. * * dragPlanePoint in world space where the drag intersects the drag plane
  102297. */
  102298. onDragObservable: Observable<{
  102299. delta: Vector3;
  102300. dragPlanePoint: Vector3;
  102301. dragPlaneNormal: Vector3;
  102302. dragDistance: number;
  102303. pointerId: number;
  102304. }>;
  102305. /**
  102306. * Fires each time a drag begins (eg. mouse down on mesh)
  102307. */
  102308. onDragStartObservable: Observable<{
  102309. dragPlanePoint: Vector3;
  102310. pointerId: number;
  102311. }>;
  102312. /**
  102313. * Fires each time a drag ends (eg. mouse release after drag)
  102314. */
  102315. onDragEndObservable: Observable<{
  102316. dragPlanePoint: Vector3;
  102317. pointerId: number;
  102318. }>;
  102319. /**
  102320. * If the attached mesh should be moved when dragged
  102321. */
  102322. moveAttached: boolean;
  102323. /**
  102324. * If the drag behavior will react to drag events (Default: true)
  102325. */
  102326. enabled: boolean;
  102327. /**
  102328. * If pointer events should start and release the drag (Default: true)
  102329. */
  102330. startAndReleaseDragOnPointerEvents: boolean;
  102331. /**
  102332. * If camera controls should be detached during the drag
  102333. */
  102334. detachCameraControls: boolean;
  102335. /**
  102336. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  102337. */
  102338. useObjectOrienationForDragging: boolean;
  102339. private _options;
  102340. /**
  102341. * Creates a pointer drag behavior that can be attached to a mesh
  102342. * @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)
  102343. */
  102344. constructor(options?: {
  102345. dragAxis?: Vector3;
  102346. dragPlaneNormal?: Vector3;
  102347. });
  102348. /**
  102349. * Predicate to determine if it is valid to move the object to a new position when it is moved
  102350. */
  102351. validateDrag: (targetPosition: Vector3) => boolean;
  102352. /**
  102353. * The name of the behavior
  102354. */
  102355. readonly name: string;
  102356. /**
  102357. * Initializes the behavior
  102358. */
  102359. init(): void;
  102360. private _tmpVector;
  102361. private _alternatePickedPoint;
  102362. private _worldDragAxis;
  102363. private _targetPosition;
  102364. private _attachedElement;
  102365. /**
  102366. * Attaches the drag behavior the passed in mesh
  102367. * @param ownerNode The mesh that will be dragged around once attached
  102368. * @param predicate Predicate to use for pick filtering
  102369. */
  102370. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  102371. /**
  102372. * Force relase the drag action by code.
  102373. */
  102374. releaseDrag(): void;
  102375. private _startDragRay;
  102376. private _lastPointerRay;
  102377. /**
  102378. * Simulates the start of a pointer drag event on the behavior
  102379. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  102380. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  102381. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  102382. */
  102383. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  102384. private _startDrag;
  102385. private _dragDelta;
  102386. private _moveDrag;
  102387. private _pickWithRayOnDragPlane;
  102388. private _pointA;
  102389. private _pointB;
  102390. private _pointC;
  102391. private _lineA;
  102392. private _lineB;
  102393. private _localAxis;
  102394. private _lookAt;
  102395. private _updateDragPlanePosition;
  102396. /**
  102397. * Detaches the behavior from the mesh
  102398. */
  102399. detach(): void;
  102400. }
  102401. }
  102402. declare module BABYLON {
  102403. /**
  102404. * A behavior that when attached to a mesh will allow the mesh to be scaled
  102405. */
  102406. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  102407. private _dragBehaviorA;
  102408. private _dragBehaviorB;
  102409. private _startDistance;
  102410. private _initialScale;
  102411. private _targetScale;
  102412. private _ownerNode;
  102413. private _sceneRenderObserver;
  102414. /**
  102415. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  102416. */
  102417. constructor();
  102418. /**
  102419. * The name of the behavior
  102420. */
  102421. readonly name: string;
  102422. /**
  102423. * Initializes the behavior
  102424. */
  102425. init(): void;
  102426. private _getCurrentDistance;
  102427. /**
  102428. * Attaches the scale behavior the passed in mesh
  102429. * @param ownerNode The mesh that will be scaled around once attached
  102430. */
  102431. attach(ownerNode: Mesh): void;
  102432. /**
  102433. * Detaches the behavior from the mesh
  102434. */
  102435. detach(): void;
  102436. }
  102437. }
  102438. declare module BABYLON {
  102439. /**
  102440. * 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
  102441. */
  102442. export class SixDofDragBehavior implements Behavior<Mesh> {
  102443. private static _virtualScene;
  102444. private _ownerNode;
  102445. private _sceneRenderObserver;
  102446. private _scene;
  102447. private _targetPosition;
  102448. private _virtualOriginMesh;
  102449. private _virtualDragMesh;
  102450. private _pointerObserver;
  102451. private _moving;
  102452. private _startingOrientation;
  102453. /**
  102454. * 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)
  102455. */
  102456. private zDragFactor;
  102457. /**
  102458. * If the object should rotate to face the drag origin
  102459. */
  102460. rotateDraggedObject: boolean;
  102461. /**
  102462. * If the behavior is currently in a dragging state
  102463. */
  102464. dragging: boolean;
  102465. /**
  102466. * 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)
  102467. */
  102468. dragDeltaRatio: number;
  102469. /**
  102470. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  102471. */
  102472. currentDraggingPointerID: number;
  102473. /**
  102474. * If camera controls should be detached during the drag
  102475. */
  102476. detachCameraControls: boolean;
  102477. /**
  102478. * Fires each time a drag starts
  102479. */
  102480. onDragStartObservable: Observable<{}>;
  102481. /**
  102482. * Fires each time a drag ends (eg. mouse release after drag)
  102483. */
  102484. onDragEndObservable: Observable<{}>;
  102485. /**
  102486. * 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
  102487. */
  102488. constructor();
  102489. /**
  102490. * The name of the behavior
  102491. */
  102492. readonly name: string;
  102493. /**
  102494. * Initializes the behavior
  102495. */
  102496. init(): void;
  102497. /**
  102498. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  102499. */
  102500. private readonly _pointerCamera;
  102501. /**
  102502. * Attaches the scale behavior the passed in mesh
  102503. * @param ownerNode The mesh that will be scaled around once attached
  102504. */
  102505. attach(ownerNode: Mesh): void;
  102506. /**
  102507. * Detaches the behavior from the mesh
  102508. */
  102509. detach(): void;
  102510. }
  102511. }
  102512. declare module BABYLON {
  102513. /**
  102514. * Class used to apply inverse kinematics to bones
  102515. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  102516. */
  102517. export class BoneIKController {
  102518. private static _tmpVecs;
  102519. private static _tmpQuat;
  102520. private static _tmpMats;
  102521. /**
  102522. * Gets or sets the target mesh
  102523. */
  102524. targetMesh: AbstractMesh;
  102525. /** Gets or sets the mesh used as pole */
  102526. poleTargetMesh: AbstractMesh;
  102527. /**
  102528. * Gets or sets the bone used as pole
  102529. */
  102530. poleTargetBone: Nullable<Bone>;
  102531. /**
  102532. * Gets or sets the target position
  102533. */
  102534. targetPosition: Vector3;
  102535. /**
  102536. * Gets or sets the pole target position
  102537. */
  102538. poleTargetPosition: Vector3;
  102539. /**
  102540. * Gets or sets the pole target local offset
  102541. */
  102542. poleTargetLocalOffset: Vector3;
  102543. /**
  102544. * Gets or sets the pole angle
  102545. */
  102546. poleAngle: number;
  102547. /**
  102548. * Gets or sets the mesh associated with the controller
  102549. */
  102550. mesh: AbstractMesh;
  102551. /**
  102552. * 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)
  102553. */
  102554. slerpAmount: number;
  102555. private _bone1Quat;
  102556. private _bone1Mat;
  102557. private _bone2Ang;
  102558. private _bone1;
  102559. private _bone2;
  102560. private _bone1Length;
  102561. private _bone2Length;
  102562. private _maxAngle;
  102563. private _maxReach;
  102564. private _rightHandedSystem;
  102565. private _bendAxis;
  102566. private _slerping;
  102567. private _adjustRoll;
  102568. /**
  102569. * Gets or sets maximum allowed angle
  102570. */
  102571. maxAngle: number;
  102572. /**
  102573. * Creates a new BoneIKController
  102574. * @param mesh defines the mesh to control
  102575. * @param bone defines the bone to control
  102576. * @param options defines options to set up the controller
  102577. */
  102578. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  102579. targetMesh?: AbstractMesh;
  102580. poleTargetMesh?: AbstractMesh;
  102581. poleTargetBone?: Bone;
  102582. poleTargetLocalOffset?: Vector3;
  102583. poleAngle?: number;
  102584. bendAxis?: Vector3;
  102585. maxAngle?: number;
  102586. slerpAmount?: number;
  102587. });
  102588. private _setMaxAngle;
  102589. /**
  102590. * Force the controller to update the bones
  102591. */
  102592. update(): void;
  102593. }
  102594. }
  102595. declare module BABYLON {
  102596. /**
  102597. * Class used to make a bone look toward a point in space
  102598. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  102599. */
  102600. export class BoneLookController {
  102601. private static _tmpVecs;
  102602. private static _tmpQuat;
  102603. private static _tmpMats;
  102604. /**
  102605. * The target Vector3 that the bone will look at
  102606. */
  102607. target: Vector3;
  102608. /**
  102609. * The mesh that the bone is attached to
  102610. */
  102611. mesh: AbstractMesh;
  102612. /**
  102613. * The bone that will be looking to the target
  102614. */
  102615. bone: Bone;
  102616. /**
  102617. * The up axis of the coordinate system that is used when the bone is rotated
  102618. */
  102619. upAxis: Vector3;
  102620. /**
  102621. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  102622. */
  102623. upAxisSpace: Space;
  102624. /**
  102625. * Used to make an adjustment to the yaw of the bone
  102626. */
  102627. adjustYaw: number;
  102628. /**
  102629. * Used to make an adjustment to the pitch of the bone
  102630. */
  102631. adjustPitch: number;
  102632. /**
  102633. * Used to make an adjustment to the roll of the bone
  102634. */
  102635. adjustRoll: number;
  102636. /**
  102637. * 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)
  102638. */
  102639. slerpAmount: number;
  102640. private _minYaw;
  102641. private _maxYaw;
  102642. private _minPitch;
  102643. private _maxPitch;
  102644. private _minYawSin;
  102645. private _minYawCos;
  102646. private _maxYawSin;
  102647. private _maxYawCos;
  102648. private _midYawConstraint;
  102649. private _minPitchTan;
  102650. private _maxPitchTan;
  102651. private _boneQuat;
  102652. private _slerping;
  102653. private _transformYawPitch;
  102654. private _transformYawPitchInv;
  102655. private _firstFrameSkipped;
  102656. private _yawRange;
  102657. private _fowardAxis;
  102658. /**
  102659. * Gets or sets the minimum yaw angle that the bone can look to
  102660. */
  102661. minYaw: number;
  102662. /**
  102663. * Gets or sets the maximum yaw angle that the bone can look to
  102664. */
  102665. maxYaw: number;
  102666. /**
  102667. * Gets or sets the minimum pitch angle that the bone can look to
  102668. */
  102669. minPitch: number;
  102670. /**
  102671. * Gets or sets the maximum pitch angle that the bone can look to
  102672. */
  102673. maxPitch: number;
  102674. /**
  102675. * Create a BoneLookController
  102676. * @param mesh the mesh that the bone belongs to
  102677. * @param bone the bone that will be looking to the target
  102678. * @param target the target Vector3 to look at
  102679. * @param options optional settings:
  102680. * * maxYaw: the maximum angle the bone will yaw to
  102681. * * minYaw: the minimum angle the bone will yaw to
  102682. * * maxPitch: the maximum angle the bone will pitch to
  102683. * * minPitch: the minimum angle the bone will yaw to
  102684. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  102685. * * upAxis: the up axis of the coordinate system
  102686. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  102687. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  102688. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  102689. * * adjustYaw: used to make an adjustment to the yaw of the bone
  102690. * * adjustPitch: used to make an adjustment to the pitch of the bone
  102691. * * adjustRoll: used to make an adjustment to the roll of the bone
  102692. **/
  102693. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  102694. maxYaw?: number;
  102695. minYaw?: number;
  102696. maxPitch?: number;
  102697. minPitch?: number;
  102698. slerpAmount?: number;
  102699. upAxis?: Vector3;
  102700. upAxisSpace?: Space;
  102701. yawAxis?: Vector3;
  102702. pitchAxis?: Vector3;
  102703. adjustYaw?: number;
  102704. adjustPitch?: number;
  102705. adjustRoll?: number;
  102706. });
  102707. /**
  102708. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  102709. */
  102710. update(): void;
  102711. private _getAngleDiff;
  102712. private _getAngleBetween;
  102713. private _isAngleBetween;
  102714. }
  102715. }
  102716. declare module BABYLON {
  102717. /**
  102718. * Manage the gamepad inputs to control an arc rotate camera.
  102719. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102720. */
  102721. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  102722. /**
  102723. * Defines the camera the input is attached to.
  102724. */
  102725. camera: ArcRotateCamera;
  102726. /**
  102727. * Defines the gamepad the input is gathering event from.
  102728. */
  102729. gamepad: Nullable<Gamepad>;
  102730. /**
  102731. * Defines the gamepad rotation sensiblity.
  102732. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  102733. */
  102734. gamepadRotationSensibility: number;
  102735. /**
  102736. * Defines the gamepad move sensiblity.
  102737. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  102738. */
  102739. gamepadMoveSensibility: number;
  102740. private _onGamepadConnectedObserver;
  102741. private _onGamepadDisconnectedObserver;
  102742. /**
  102743. * Attach the input controls to a specific dom element to get the input from.
  102744. * @param element Defines the element the controls should be listened from
  102745. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102746. */
  102747. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102748. /**
  102749. * Detach the current controls from the specified dom element.
  102750. * @param element Defines the element to stop listening the inputs from
  102751. */
  102752. detachControl(element: Nullable<HTMLElement>): void;
  102753. /**
  102754. * Update the current camera state depending on the inputs that have been used this frame.
  102755. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102756. */
  102757. checkInputs(): void;
  102758. /**
  102759. * Gets the class name of the current intput.
  102760. * @returns the class name
  102761. */
  102762. getClassName(): string;
  102763. /**
  102764. * Get the friendly name associated with the input class.
  102765. * @returns the input friendly name
  102766. */
  102767. getSimpleName(): string;
  102768. }
  102769. }
  102770. declare module BABYLON {
  102771. interface ArcRotateCameraInputsManager {
  102772. /**
  102773. * Add orientation input support to the input manager.
  102774. * @returns the current input manager
  102775. */
  102776. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  102777. }
  102778. /**
  102779. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  102780. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102781. */
  102782. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  102783. /**
  102784. * Defines the camera the input is attached to.
  102785. */
  102786. camera: ArcRotateCamera;
  102787. /**
  102788. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  102789. */
  102790. alphaCorrection: number;
  102791. /**
  102792. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  102793. */
  102794. gammaCorrection: number;
  102795. private _alpha;
  102796. private _gamma;
  102797. private _dirty;
  102798. private _deviceOrientationHandler;
  102799. /**
  102800. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  102801. */
  102802. constructor();
  102803. /**
  102804. * Attach the input controls to a specific dom element to get the input from.
  102805. * @param element Defines the element the controls should be listened from
  102806. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102807. */
  102808. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102809. /** @hidden */
  102810. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  102811. /**
  102812. * Update the current camera state depending on the inputs that have been used this frame.
  102813. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102814. */
  102815. checkInputs(): void;
  102816. /**
  102817. * Detach the current controls from the specified dom element.
  102818. * @param element Defines the element to stop listening the inputs from
  102819. */
  102820. detachControl(element: Nullable<HTMLElement>): void;
  102821. /**
  102822. * Gets the class name of the current intput.
  102823. * @returns the class name
  102824. */
  102825. getClassName(): string;
  102826. /**
  102827. * Get the friendly name associated with the input class.
  102828. * @returns the input friendly name
  102829. */
  102830. getSimpleName(): string;
  102831. }
  102832. }
  102833. declare module BABYLON {
  102834. /**
  102835. * Listen to mouse events to control the camera.
  102836. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102837. */
  102838. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  102839. /**
  102840. * Defines the camera the input is attached to.
  102841. */
  102842. camera: FlyCamera;
  102843. /**
  102844. * Defines if touch is enabled. (Default is true.)
  102845. */
  102846. touchEnabled: boolean;
  102847. /**
  102848. * Defines the buttons associated with the input to handle camera rotation.
  102849. */
  102850. buttons: number[];
  102851. /**
  102852. * Assign buttons for Yaw control.
  102853. */
  102854. buttonsYaw: number[];
  102855. /**
  102856. * Assign buttons for Pitch control.
  102857. */
  102858. buttonsPitch: number[];
  102859. /**
  102860. * Assign buttons for Roll control.
  102861. */
  102862. buttonsRoll: number[];
  102863. /**
  102864. * Detect if any button is being pressed while mouse is moved.
  102865. * -1 = Mouse locked.
  102866. * 0 = Left button.
  102867. * 1 = Middle Button.
  102868. * 2 = Right Button.
  102869. */
  102870. activeButton: number;
  102871. /**
  102872. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  102873. * Higher values reduce its sensitivity.
  102874. */
  102875. angularSensibility: number;
  102876. private _mousemoveCallback;
  102877. private _observer;
  102878. private _rollObserver;
  102879. private previousPosition;
  102880. private noPreventDefault;
  102881. private element;
  102882. /**
  102883. * Listen to mouse events to control the camera.
  102884. * @param touchEnabled Define if touch is enabled. (Default is true.)
  102885. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102886. */
  102887. constructor(touchEnabled?: boolean);
  102888. /**
  102889. * Attach the mouse control to the HTML DOM element.
  102890. * @param element Defines the element that listens to the input events.
  102891. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  102892. */
  102893. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102894. /**
  102895. * Detach the current controls from the specified dom element.
  102896. * @param element Defines the element to stop listening the inputs from
  102897. */
  102898. detachControl(element: Nullable<HTMLElement>): void;
  102899. /**
  102900. * Gets the class name of the current input.
  102901. * @returns the class name.
  102902. */
  102903. getClassName(): string;
  102904. /**
  102905. * Get the friendly name associated with the input class.
  102906. * @returns the input's friendly name.
  102907. */
  102908. getSimpleName(): string;
  102909. private _pointerInput;
  102910. private _onMouseMove;
  102911. /**
  102912. * Rotate camera by mouse offset.
  102913. */
  102914. private rotateCamera;
  102915. }
  102916. }
  102917. declare module BABYLON {
  102918. /**
  102919. * Default Inputs manager for the FlyCamera.
  102920. * It groups all the default supported inputs for ease of use.
  102921. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102922. */
  102923. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  102924. /**
  102925. * Instantiates a new FlyCameraInputsManager.
  102926. * @param camera Defines the camera the inputs belong to.
  102927. */
  102928. constructor(camera: FlyCamera);
  102929. /**
  102930. * Add keyboard input support to the input manager.
  102931. * @returns the new FlyCameraKeyboardMoveInput().
  102932. */
  102933. addKeyboard(): FlyCameraInputsManager;
  102934. /**
  102935. * Add mouse input support to the input manager.
  102936. * @param touchEnabled Enable touch screen support.
  102937. * @returns the new FlyCameraMouseInput().
  102938. */
  102939. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  102940. }
  102941. }
  102942. declare module BABYLON {
  102943. /**
  102944. * This is a flying camera, designed for 3D movement and rotation in all directions,
  102945. * such as in a 3D Space Shooter or a Flight Simulator.
  102946. */
  102947. export class FlyCamera extends TargetCamera {
  102948. /**
  102949. * Define the collision ellipsoid of the camera.
  102950. * This is helpful for simulating a camera body, like a player's body.
  102951. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  102952. */
  102953. ellipsoid: Vector3;
  102954. /**
  102955. * Define an offset for the position of the ellipsoid around the camera.
  102956. * This can be helpful if the camera is attached away from the player's body center,
  102957. * such as at its head.
  102958. */
  102959. ellipsoidOffset: Vector3;
  102960. /**
  102961. * Enable or disable collisions of the camera with the rest of the scene objects.
  102962. */
  102963. checkCollisions: boolean;
  102964. /**
  102965. * Enable or disable gravity on the camera.
  102966. */
  102967. applyGravity: boolean;
  102968. /**
  102969. * Define the current direction the camera is moving to.
  102970. */
  102971. cameraDirection: Vector3;
  102972. /**
  102973. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  102974. * This overrides and empties cameraRotation.
  102975. */
  102976. rotationQuaternion: Quaternion;
  102977. /**
  102978. * Track Roll to maintain the wanted Rolling when looking around.
  102979. */
  102980. _trackRoll: number;
  102981. /**
  102982. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  102983. */
  102984. rollCorrect: number;
  102985. /**
  102986. * Mimic a banked turn, Rolling the camera when Yawing.
  102987. * It's recommended to use rollCorrect = 10 for faster banking correction.
  102988. */
  102989. bankedTurn: boolean;
  102990. /**
  102991. * Limit in radians for how much Roll banking will add. (Default: 90°)
  102992. */
  102993. bankedTurnLimit: number;
  102994. /**
  102995. * Value of 0 disables the banked Roll.
  102996. * Value of 1 is equal to the Yaw angle in radians.
  102997. */
  102998. bankedTurnMultiplier: number;
  102999. /**
  103000. * The inputs manager loads all the input sources, such as keyboard and mouse.
  103001. */
  103002. inputs: FlyCameraInputsManager;
  103003. /**
  103004. * Gets the input sensibility for mouse input.
  103005. * Higher values reduce sensitivity.
  103006. */
  103007. /**
  103008. * Sets the input sensibility for a mouse input.
  103009. * Higher values reduce sensitivity.
  103010. */
  103011. angularSensibility: number;
  103012. /**
  103013. * Get the keys for camera movement forward.
  103014. */
  103015. /**
  103016. * Set the keys for camera movement forward.
  103017. */
  103018. keysForward: number[];
  103019. /**
  103020. * Get the keys for camera movement backward.
  103021. */
  103022. keysBackward: number[];
  103023. /**
  103024. * Get the keys for camera movement up.
  103025. */
  103026. /**
  103027. * Set the keys for camera movement up.
  103028. */
  103029. keysUp: number[];
  103030. /**
  103031. * Get the keys for camera movement down.
  103032. */
  103033. /**
  103034. * Set the keys for camera movement down.
  103035. */
  103036. keysDown: number[];
  103037. /**
  103038. * Get the keys for camera movement left.
  103039. */
  103040. /**
  103041. * Set the keys for camera movement left.
  103042. */
  103043. keysLeft: number[];
  103044. /**
  103045. * Set the keys for camera movement right.
  103046. */
  103047. /**
  103048. * Set the keys for camera movement right.
  103049. */
  103050. keysRight: number[];
  103051. /**
  103052. * Event raised when the camera collides with a mesh in the scene.
  103053. */
  103054. onCollide: (collidedMesh: AbstractMesh) => void;
  103055. private _collider;
  103056. private _needMoveForGravity;
  103057. private _oldPosition;
  103058. private _diffPosition;
  103059. private _newPosition;
  103060. /** @hidden */
  103061. _localDirection: Vector3;
  103062. /** @hidden */
  103063. _transformedDirection: Vector3;
  103064. /**
  103065. * Instantiates a FlyCamera.
  103066. * This is a flying camera, designed for 3D movement and rotation in all directions,
  103067. * such as in a 3D Space Shooter or a Flight Simulator.
  103068. * @param name Define the name of the camera in the scene.
  103069. * @param position Define the starting position of the camera in the scene.
  103070. * @param scene Define the scene the camera belongs to.
  103071. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  103072. */
  103073. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  103074. /**
  103075. * Attach a control to the HTML DOM element.
  103076. * @param element Defines the element that listens to the input events.
  103077. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  103078. */
  103079. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103080. /**
  103081. * Detach a control from the HTML DOM element.
  103082. * The camera will stop reacting to that input.
  103083. * @param element Defines the element that listens to the input events.
  103084. */
  103085. detachControl(element: HTMLElement): void;
  103086. private _collisionMask;
  103087. /**
  103088. * Get the mask that the camera ignores in collision events.
  103089. */
  103090. /**
  103091. * Set the mask that the camera ignores in collision events.
  103092. */
  103093. collisionMask: number;
  103094. /** @hidden */
  103095. _collideWithWorld(displacement: Vector3): void;
  103096. /** @hidden */
  103097. private _onCollisionPositionChange;
  103098. /** @hidden */
  103099. _checkInputs(): void;
  103100. /** @hidden */
  103101. _decideIfNeedsToMove(): boolean;
  103102. /** @hidden */
  103103. _updatePosition(): void;
  103104. /**
  103105. * Restore the Roll to its target value at the rate specified.
  103106. * @param rate - Higher means slower restoring.
  103107. * @hidden
  103108. */
  103109. restoreRoll(rate: number): void;
  103110. /**
  103111. * Destroy the camera and release the current resources held by it.
  103112. */
  103113. dispose(): void;
  103114. /**
  103115. * Get the current object class name.
  103116. * @returns the class name.
  103117. */
  103118. getClassName(): string;
  103119. }
  103120. }
  103121. declare module BABYLON {
  103122. /**
  103123. * Listen to keyboard events to control the camera.
  103124. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103125. */
  103126. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  103127. /**
  103128. * Defines the camera the input is attached to.
  103129. */
  103130. camera: FlyCamera;
  103131. /**
  103132. * The list of keyboard keys used to control the forward move of the camera.
  103133. */
  103134. keysForward: number[];
  103135. /**
  103136. * The list of keyboard keys used to control the backward move of the camera.
  103137. */
  103138. keysBackward: number[];
  103139. /**
  103140. * The list of keyboard keys used to control the forward move of the camera.
  103141. */
  103142. keysUp: number[];
  103143. /**
  103144. * The list of keyboard keys used to control the backward move of the camera.
  103145. */
  103146. keysDown: number[];
  103147. /**
  103148. * The list of keyboard keys used to control the right strafe move of the camera.
  103149. */
  103150. keysRight: number[];
  103151. /**
  103152. * The list of keyboard keys used to control the left strafe move of the camera.
  103153. */
  103154. keysLeft: number[];
  103155. private _keys;
  103156. private _onCanvasBlurObserver;
  103157. private _onKeyboardObserver;
  103158. private _engine;
  103159. private _scene;
  103160. /**
  103161. * Attach the input controls to a specific dom element to get the input from.
  103162. * @param element Defines the element the controls should be listened from
  103163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103164. */
  103165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103166. /**
  103167. * Detach the current controls from the specified dom element.
  103168. * @param element Defines the element to stop listening the inputs from
  103169. */
  103170. detachControl(element: Nullable<HTMLElement>): void;
  103171. /**
  103172. * Gets the class name of the current intput.
  103173. * @returns the class name
  103174. */
  103175. getClassName(): string;
  103176. /** @hidden */
  103177. _onLostFocus(e: FocusEvent): void;
  103178. /**
  103179. * Get the friendly name associated with the input class.
  103180. * @returns the input friendly name
  103181. */
  103182. getSimpleName(): string;
  103183. /**
  103184. * Update the current camera state depending on the inputs that have been used this frame.
  103185. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  103186. */
  103187. checkInputs(): void;
  103188. }
  103189. }
  103190. declare module BABYLON {
  103191. /**
  103192. * Manage the mouse wheel inputs to control a follow camera.
  103193. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103194. */
  103195. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  103196. /**
  103197. * Defines the camera the input is attached to.
  103198. */
  103199. camera: FollowCamera;
  103200. /**
  103201. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  103202. */
  103203. axisControlRadius: boolean;
  103204. /**
  103205. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  103206. */
  103207. axisControlHeight: boolean;
  103208. /**
  103209. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  103210. */
  103211. axisControlRotation: boolean;
  103212. /**
  103213. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  103214. * relation to mouseWheel events.
  103215. */
  103216. wheelPrecision: number;
  103217. /**
  103218. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  103219. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  103220. */
  103221. wheelDeltaPercentage: number;
  103222. private _wheel;
  103223. private _observer;
  103224. /**
  103225. * Attach the input controls to a specific dom element to get the input from.
  103226. * @param element Defines the element the controls should be listened from
  103227. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103228. */
  103229. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103230. /**
  103231. * Detach the current controls from the specified dom element.
  103232. * @param element Defines the element to stop listening the inputs from
  103233. */
  103234. detachControl(element: Nullable<HTMLElement>): void;
  103235. /**
  103236. * Gets the class name of the current intput.
  103237. * @returns the class name
  103238. */
  103239. getClassName(): string;
  103240. /**
  103241. * Get the friendly name associated with the input class.
  103242. * @returns the input friendly name
  103243. */
  103244. getSimpleName(): string;
  103245. }
  103246. }
  103247. declare module BABYLON {
  103248. /**
  103249. * Manage the pointers inputs to control an follow camera.
  103250. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103251. */
  103252. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  103253. /**
  103254. * Defines the camera the input is attached to.
  103255. */
  103256. camera: FollowCamera;
  103257. /**
  103258. * Gets the class name of the current input.
  103259. * @returns the class name
  103260. */
  103261. getClassName(): string;
  103262. /**
  103263. * Defines the pointer angular sensibility along the X axis or how fast is
  103264. * the camera rotating.
  103265. * A negative number will reverse the axis direction.
  103266. */
  103267. angularSensibilityX: number;
  103268. /**
  103269. * Defines the pointer angular sensibility along the Y axis or how fast is
  103270. * the camera rotating.
  103271. * A negative number will reverse the axis direction.
  103272. */
  103273. angularSensibilityY: number;
  103274. /**
  103275. * Defines the pointer pinch precision or how fast is the camera zooming.
  103276. * A negative number will reverse the axis direction.
  103277. */
  103278. pinchPrecision: number;
  103279. /**
  103280. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  103281. * from 0.
  103282. * It defines the percentage of current camera.radius to use as delta when
  103283. * pinch zoom is used.
  103284. */
  103285. pinchDeltaPercentage: number;
  103286. /**
  103287. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  103288. */
  103289. axisXControlRadius: boolean;
  103290. /**
  103291. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  103292. */
  103293. axisXControlHeight: boolean;
  103294. /**
  103295. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  103296. */
  103297. axisXControlRotation: boolean;
  103298. /**
  103299. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  103300. */
  103301. axisYControlRadius: boolean;
  103302. /**
  103303. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  103304. */
  103305. axisYControlHeight: boolean;
  103306. /**
  103307. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  103308. */
  103309. axisYControlRotation: boolean;
  103310. /**
  103311. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  103312. */
  103313. axisPinchControlRadius: boolean;
  103314. /**
  103315. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  103316. */
  103317. axisPinchControlHeight: boolean;
  103318. /**
  103319. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  103320. */
  103321. axisPinchControlRotation: boolean;
  103322. /**
  103323. * Log error messages if basic misconfiguration has occurred.
  103324. */
  103325. warningEnable: boolean;
  103326. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  103327. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  103328. private _warningCounter;
  103329. private _warning;
  103330. }
  103331. }
  103332. declare module BABYLON {
  103333. /**
  103334. * Default Inputs manager for the FollowCamera.
  103335. * It groups all the default supported inputs for ease of use.
  103336. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103337. */
  103338. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  103339. /**
  103340. * Instantiates a new FollowCameraInputsManager.
  103341. * @param camera Defines the camera the inputs belong to
  103342. */
  103343. constructor(camera: FollowCamera);
  103344. /**
  103345. * Add keyboard input support to the input manager.
  103346. * @returns the current input manager
  103347. */
  103348. addKeyboard(): FollowCameraInputsManager;
  103349. /**
  103350. * Add mouse wheel input support to the input manager.
  103351. * @returns the current input manager
  103352. */
  103353. addMouseWheel(): FollowCameraInputsManager;
  103354. /**
  103355. * Add pointers input support to the input manager.
  103356. * @returns the current input manager
  103357. */
  103358. addPointers(): FollowCameraInputsManager;
  103359. /**
  103360. * Add orientation input support to the input manager.
  103361. * @returns the current input manager
  103362. */
  103363. addVRDeviceOrientation(): FollowCameraInputsManager;
  103364. }
  103365. }
  103366. declare module BABYLON {
  103367. /**
  103368. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  103369. * an arc rotate version arcFollowCamera are available.
  103370. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  103371. */
  103372. export class FollowCamera extends TargetCamera {
  103373. /**
  103374. * Distance the follow camera should follow an object at
  103375. */
  103376. radius: number;
  103377. /**
  103378. * Minimum allowed distance of the camera to the axis of rotation
  103379. * (The camera can not get closer).
  103380. * This can help limiting how the Camera is able to move in the scene.
  103381. */
  103382. lowerRadiusLimit: Nullable<number>;
  103383. /**
  103384. * Maximum allowed distance of the camera to the axis of rotation
  103385. * (The camera can not get further).
  103386. * This can help limiting how the Camera is able to move in the scene.
  103387. */
  103388. upperRadiusLimit: Nullable<number>;
  103389. /**
  103390. * Define a rotation offset between the camera and the object it follows
  103391. */
  103392. rotationOffset: number;
  103393. /**
  103394. * Minimum allowed angle to camera position relative to target object.
  103395. * This can help limiting how the Camera is able to move in the scene.
  103396. */
  103397. lowerRotationOffsetLimit: Nullable<number>;
  103398. /**
  103399. * Maximum allowed angle to camera position relative to target object.
  103400. * This can help limiting how the Camera is able to move in the scene.
  103401. */
  103402. upperRotationOffsetLimit: Nullable<number>;
  103403. /**
  103404. * Define a height offset between the camera and the object it follows.
  103405. * It can help following an object from the top (like a car chaing a plane)
  103406. */
  103407. heightOffset: number;
  103408. /**
  103409. * Minimum allowed height of camera position relative to target object.
  103410. * This can help limiting how the Camera is able to move in the scene.
  103411. */
  103412. lowerHeightOffsetLimit: Nullable<number>;
  103413. /**
  103414. * Maximum allowed height of camera position relative to target object.
  103415. * This can help limiting how the Camera is able to move in the scene.
  103416. */
  103417. upperHeightOffsetLimit: Nullable<number>;
  103418. /**
  103419. * Define how fast the camera can accelerate to follow it s target.
  103420. */
  103421. cameraAcceleration: number;
  103422. /**
  103423. * Define the speed limit of the camera following an object.
  103424. */
  103425. maxCameraSpeed: number;
  103426. /**
  103427. * Define the target of the camera.
  103428. */
  103429. lockedTarget: Nullable<AbstractMesh>;
  103430. /**
  103431. * Defines the input associated with the camera.
  103432. */
  103433. inputs: FollowCameraInputsManager;
  103434. /**
  103435. * Instantiates the follow camera.
  103436. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  103437. * @param name Define the name of the camera in the scene
  103438. * @param position Define the position of the camera
  103439. * @param scene Define the scene the camera belong to
  103440. * @param lockedTarget Define the target of the camera
  103441. */
  103442. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  103443. private _follow;
  103444. /**
  103445. * Attached controls to the current camera.
  103446. * @param element Defines the element the controls should be listened from
  103447. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103448. */
  103449. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103450. /**
  103451. * Detach the current controls from the camera.
  103452. * The camera will stop reacting to inputs.
  103453. * @param element Defines the element to stop listening the inputs from
  103454. */
  103455. detachControl(element: HTMLElement): void;
  103456. /** @hidden */
  103457. _checkInputs(): void;
  103458. private _checkLimits;
  103459. /**
  103460. * Gets the camera class name.
  103461. * @returns the class name
  103462. */
  103463. getClassName(): string;
  103464. }
  103465. /**
  103466. * Arc Rotate version of the follow camera.
  103467. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  103468. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  103469. */
  103470. export class ArcFollowCamera extends TargetCamera {
  103471. /** The longitudinal angle of the camera */
  103472. alpha: number;
  103473. /** The latitudinal angle of the camera */
  103474. beta: number;
  103475. /** The radius of the camera from its target */
  103476. radius: number;
  103477. /** Define the camera target (the messh it should follow) */
  103478. target: Nullable<AbstractMesh>;
  103479. private _cartesianCoordinates;
  103480. /**
  103481. * Instantiates a new ArcFollowCamera
  103482. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  103483. * @param name Define the name of the camera
  103484. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  103485. * @param beta Define the rotation angle of the camera around the elevation axis
  103486. * @param radius Define the radius of the camera from its target point
  103487. * @param target Define the target of the camera
  103488. * @param scene Define the scene the camera belongs to
  103489. */
  103490. constructor(name: string,
  103491. /** The longitudinal angle of the camera */
  103492. alpha: number,
  103493. /** The latitudinal angle of the camera */
  103494. beta: number,
  103495. /** The radius of the camera from its target */
  103496. radius: number,
  103497. /** Define the camera target (the messh it should follow) */
  103498. target: Nullable<AbstractMesh>, scene: Scene);
  103499. private _follow;
  103500. /** @hidden */
  103501. _checkInputs(): void;
  103502. /**
  103503. * Returns the class name of the object.
  103504. * It is mostly used internally for serialization purposes.
  103505. */
  103506. getClassName(): string;
  103507. }
  103508. }
  103509. declare module BABYLON {
  103510. /**
  103511. * Manage the keyboard inputs to control the movement of a follow camera.
  103512. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103513. */
  103514. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  103515. /**
  103516. * Defines the camera the input is attached to.
  103517. */
  103518. camera: FollowCamera;
  103519. /**
  103520. * Defines the list of key codes associated with the up action (increase heightOffset)
  103521. */
  103522. keysHeightOffsetIncr: number[];
  103523. /**
  103524. * Defines the list of key codes associated with the down action (decrease heightOffset)
  103525. */
  103526. keysHeightOffsetDecr: number[];
  103527. /**
  103528. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  103529. */
  103530. keysHeightOffsetModifierAlt: boolean;
  103531. /**
  103532. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  103533. */
  103534. keysHeightOffsetModifierCtrl: boolean;
  103535. /**
  103536. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  103537. */
  103538. keysHeightOffsetModifierShift: boolean;
  103539. /**
  103540. * Defines the list of key codes associated with the left action (increase rotationOffset)
  103541. */
  103542. keysRotationOffsetIncr: number[];
  103543. /**
  103544. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  103545. */
  103546. keysRotationOffsetDecr: number[];
  103547. /**
  103548. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  103549. */
  103550. keysRotationOffsetModifierAlt: boolean;
  103551. /**
  103552. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  103553. */
  103554. keysRotationOffsetModifierCtrl: boolean;
  103555. /**
  103556. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  103557. */
  103558. keysRotationOffsetModifierShift: boolean;
  103559. /**
  103560. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  103561. */
  103562. keysRadiusIncr: number[];
  103563. /**
  103564. * Defines the list of key codes associated with the zoom-out action (increase radius)
  103565. */
  103566. keysRadiusDecr: number[];
  103567. /**
  103568. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  103569. */
  103570. keysRadiusModifierAlt: boolean;
  103571. /**
  103572. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  103573. */
  103574. keysRadiusModifierCtrl: boolean;
  103575. /**
  103576. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  103577. */
  103578. keysRadiusModifierShift: boolean;
  103579. /**
  103580. * Defines the rate of change of heightOffset.
  103581. */
  103582. heightSensibility: number;
  103583. /**
  103584. * Defines the rate of change of rotationOffset.
  103585. */
  103586. rotationSensibility: number;
  103587. /**
  103588. * Defines the rate of change of radius.
  103589. */
  103590. radiusSensibility: number;
  103591. private _keys;
  103592. private _ctrlPressed;
  103593. private _altPressed;
  103594. private _shiftPressed;
  103595. private _onCanvasBlurObserver;
  103596. private _onKeyboardObserver;
  103597. private _engine;
  103598. private _scene;
  103599. /**
  103600. * Attach the input controls to a specific dom element to get the input from.
  103601. * @param element Defines the element the controls should be listened from
  103602. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103603. */
  103604. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103605. /**
  103606. * Detach the current controls from the specified dom element.
  103607. * @param element Defines the element to stop listening the inputs from
  103608. */
  103609. detachControl(element: Nullable<HTMLElement>): void;
  103610. /**
  103611. * Update the current camera state depending on the inputs that have been used this frame.
  103612. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  103613. */
  103614. checkInputs(): void;
  103615. /**
  103616. * Gets the class name of the current input.
  103617. * @returns the class name
  103618. */
  103619. getClassName(): string;
  103620. /**
  103621. * Get the friendly name associated with the input class.
  103622. * @returns the input friendly name
  103623. */
  103624. getSimpleName(): string;
  103625. /**
  103626. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  103627. * allow modification of the heightOffset value.
  103628. */
  103629. private _modifierHeightOffset;
  103630. /**
  103631. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  103632. * allow modification of the rotationOffset value.
  103633. */
  103634. private _modifierRotationOffset;
  103635. /**
  103636. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  103637. * allow modification of the radius value.
  103638. */
  103639. private _modifierRadius;
  103640. }
  103641. }
  103642. declare module BABYLON {
  103643. interface FreeCameraInputsManager {
  103644. /**
  103645. * @hidden
  103646. */
  103647. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  103648. /**
  103649. * Add orientation input support to the input manager.
  103650. * @returns the current input manager
  103651. */
  103652. addDeviceOrientation(): FreeCameraInputsManager;
  103653. }
  103654. /**
  103655. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  103656. * Screen rotation is taken into account.
  103657. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103658. */
  103659. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  103660. private _camera;
  103661. private _screenOrientationAngle;
  103662. private _constantTranform;
  103663. private _screenQuaternion;
  103664. private _alpha;
  103665. private _beta;
  103666. private _gamma;
  103667. /**
  103668. * Can be used to detect if a device orientation sensor is availible on a device
  103669. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  103670. * @returns a promise that will resolve on orientation change
  103671. */
  103672. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  103673. /**
  103674. * @hidden
  103675. */
  103676. _onDeviceOrientationChangedObservable: Observable<void>;
  103677. /**
  103678. * Instantiates a new input
  103679. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103680. */
  103681. constructor();
  103682. /**
  103683. * Define the camera controlled by the input.
  103684. */
  103685. camera: FreeCamera;
  103686. /**
  103687. * Attach the input controls to a specific dom element to get the input from.
  103688. * @param element Defines the element the controls should be listened from
  103689. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103690. */
  103691. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103692. private _orientationChanged;
  103693. private _deviceOrientation;
  103694. /**
  103695. * Detach the current controls from the specified dom element.
  103696. * @param element Defines the element to stop listening the inputs from
  103697. */
  103698. detachControl(element: Nullable<HTMLElement>): void;
  103699. /**
  103700. * Update the current camera state depending on the inputs that have been used this frame.
  103701. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  103702. */
  103703. checkInputs(): void;
  103704. /**
  103705. * Gets the class name of the current intput.
  103706. * @returns the class name
  103707. */
  103708. getClassName(): string;
  103709. /**
  103710. * Get the friendly name associated with the input class.
  103711. * @returns the input friendly name
  103712. */
  103713. getSimpleName(): string;
  103714. }
  103715. }
  103716. declare module BABYLON {
  103717. /**
  103718. * Manage the gamepad inputs to control a free camera.
  103719. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103720. */
  103721. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  103722. /**
  103723. * Define the camera the input is attached to.
  103724. */
  103725. camera: FreeCamera;
  103726. /**
  103727. * Define the Gamepad controlling the input
  103728. */
  103729. gamepad: Nullable<Gamepad>;
  103730. /**
  103731. * Defines the gamepad rotation sensiblity.
  103732. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  103733. */
  103734. gamepadAngularSensibility: number;
  103735. /**
  103736. * Defines the gamepad move sensiblity.
  103737. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  103738. */
  103739. gamepadMoveSensibility: number;
  103740. private _onGamepadConnectedObserver;
  103741. private _onGamepadDisconnectedObserver;
  103742. private _cameraTransform;
  103743. private _deltaTransform;
  103744. private _vector3;
  103745. private _vector2;
  103746. /**
  103747. * Attach the input controls to a specific dom element to get the input from.
  103748. * @param element Defines the element the controls should be listened from
  103749. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103750. */
  103751. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103752. /**
  103753. * Detach the current controls from the specified dom element.
  103754. * @param element Defines the element to stop listening the inputs from
  103755. */
  103756. detachControl(element: Nullable<HTMLElement>): void;
  103757. /**
  103758. * Update the current camera state depending on the inputs that have been used this frame.
  103759. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  103760. */
  103761. checkInputs(): void;
  103762. /**
  103763. * Gets the class name of the current intput.
  103764. * @returns the class name
  103765. */
  103766. getClassName(): string;
  103767. /**
  103768. * Get the friendly name associated with the input class.
  103769. * @returns the input friendly name
  103770. */
  103771. getSimpleName(): string;
  103772. }
  103773. }
  103774. declare module BABYLON {
  103775. /**
  103776. * Defines the potential axis of a Joystick
  103777. */
  103778. export enum JoystickAxis {
  103779. /** X axis */
  103780. X = 0,
  103781. /** Y axis */
  103782. Y = 1,
  103783. /** Z axis */
  103784. Z = 2
  103785. }
  103786. /**
  103787. * Class used to define virtual joystick (used in touch mode)
  103788. */
  103789. export class VirtualJoystick {
  103790. /**
  103791. * Gets or sets a boolean indicating that left and right values must be inverted
  103792. */
  103793. reverseLeftRight: boolean;
  103794. /**
  103795. * Gets or sets a boolean indicating that up and down values must be inverted
  103796. */
  103797. reverseUpDown: boolean;
  103798. /**
  103799. * Gets the offset value for the position (ie. the change of the position value)
  103800. */
  103801. deltaPosition: Vector3;
  103802. /**
  103803. * Gets a boolean indicating if the virtual joystick was pressed
  103804. */
  103805. pressed: boolean;
  103806. /**
  103807. * Canvas the virtual joystick will render onto, default z-index of this is 5
  103808. */
  103809. static Canvas: Nullable<HTMLCanvasElement>;
  103810. private static _globalJoystickIndex;
  103811. private static vjCanvasContext;
  103812. private static vjCanvasWidth;
  103813. private static vjCanvasHeight;
  103814. private static halfWidth;
  103815. private _action;
  103816. private _axisTargetedByLeftAndRight;
  103817. private _axisTargetedByUpAndDown;
  103818. private _joystickSensibility;
  103819. private _inversedSensibility;
  103820. private _joystickPointerID;
  103821. private _joystickColor;
  103822. private _joystickPointerPos;
  103823. private _joystickPreviousPointerPos;
  103824. private _joystickPointerStartPos;
  103825. private _deltaJoystickVector;
  103826. private _leftJoystick;
  103827. private _touches;
  103828. private _onPointerDownHandlerRef;
  103829. private _onPointerMoveHandlerRef;
  103830. private _onPointerUpHandlerRef;
  103831. private _onResize;
  103832. /**
  103833. * Creates a new virtual joystick
  103834. * @param leftJoystick defines that the joystick is for left hand (false by default)
  103835. */
  103836. constructor(leftJoystick?: boolean);
  103837. /**
  103838. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  103839. * @param newJoystickSensibility defines the new sensibility
  103840. */
  103841. setJoystickSensibility(newJoystickSensibility: number): void;
  103842. private _onPointerDown;
  103843. private _onPointerMove;
  103844. private _onPointerUp;
  103845. /**
  103846. * Change the color of the virtual joystick
  103847. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  103848. */
  103849. setJoystickColor(newColor: string): void;
  103850. /**
  103851. * Defines a callback to call when the joystick is touched
  103852. * @param action defines the callback
  103853. */
  103854. setActionOnTouch(action: () => any): void;
  103855. /**
  103856. * Defines which axis you'd like to control for left & right
  103857. * @param axis defines the axis to use
  103858. */
  103859. setAxisForLeftRight(axis: JoystickAxis): void;
  103860. /**
  103861. * Defines which axis you'd like to control for up & down
  103862. * @param axis defines the axis to use
  103863. */
  103864. setAxisForUpDown(axis: JoystickAxis): void;
  103865. private _drawVirtualJoystick;
  103866. /**
  103867. * Release internal HTML canvas
  103868. */
  103869. releaseCanvas(): void;
  103870. }
  103871. }
  103872. declare module BABYLON {
  103873. interface FreeCameraInputsManager {
  103874. /**
  103875. * Add virtual joystick input support to the input manager.
  103876. * @returns the current input manager
  103877. */
  103878. addVirtualJoystick(): FreeCameraInputsManager;
  103879. }
  103880. /**
  103881. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  103882. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103883. */
  103884. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  103885. /**
  103886. * Defines the camera the input is attached to.
  103887. */
  103888. camera: FreeCamera;
  103889. private _leftjoystick;
  103890. private _rightjoystick;
  103891. /**
  103892. * Gets the left stick of the virtual joystick.
  103893. * @returns The virtual Joystick
  103894. */
  103895. getLeftJoystick(): VirtualJoystick;
  103896. /**
  103897. * Gets the right stick of the virtual joystick.
  103898. * @returns The virtual Joystick
  103899. */
  103900. getRightJoystick(): VirtualJoystick;
  103901. /**
  103902. * Update the current camera state depending on the inputs that have been used this frame.
  103903. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  103904. */
  103905. checkInputs(): void;
  103906. /**
  103907. * Attach the input controls to a specific dom element to get the input from.
  103908. * @param element Defines the element the controls should be listened from
  103909. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103910. */
  103911. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103912. /**
  103913. * Detach the current controls from the specified dom element.
  103914. * @param element Defines the element to stop listening the inputs from
  103915. */
  103916. detachControl(element: Nullable<HTMLElement>): void;
  103917. /**
  103918. * Gets the class name of the current intput.
  103919. * @returns the class name
  103920. */
  103921. getClassName(): string;
  103922. /**
  103923. * Get the friendly name associated with the input class.
  103924. * @returns the input friendly name
  103925. */
  103926. getSimpleName(): string;
  103927. }
  103928. }
  103929. declare module BABYLON {
  103930. /**
  103931. * This represents a FPS type of camera controlled by touch.
  103932. * This is like a universal camera minus the Gamepad controls.
  103933. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103934. */
  103935. export class TouchCamera extends FreeCamera {
  103936. /**
  103937. * Defines the touch sensibility for rotation.
  103938. * The higher the faster.
  103939. */
  103940. touchAngularSensibility: number;
  103941. /**
  103942. * Defines the touch sensibility for move.
  103943. * The higher the faster.
  103944. */
  103945. touchMoveSensibility: number;
  103946. /**
  103947. * Instantiates a new touch camera.
  103948. * This represents a FPS type of camera controlled by touch.
  103949. * This is like a universal camera minus the Gamepad controls.
  103950. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103951. * @param name Define the name of the camera in the scene
  103952. * @param position Define the start position of the camera in the scene
  103953. * @param scene Define the scene the camera belongs to
  103954. */
  103955. constructor(name: string, position: Vector3, scene: Scene);
  103956. /**
  103957. * Gets the current object class name.
  103958. * @return the class name
  103959. */
  103960. getClassName(): string;
  103961. /** @hidden */
  103962. _setupInputs(): void;
  103963. }
  103964. }
  103965. declare module BABYLON {
  103966. /**
  103967. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  103968. * being tilted forward or back and left or right.
  103969. */
  103970. export class DeviceOrientationCamera extends FreeCamera {
  103971. private _initialQuaternion;
  103972. private _quaternionCache;
  103973. private _tmpDragQuaternion;
  103974. private _disablePointerInputWhenUsingDeviceOrientation;
  103975. /**
  103976. * Creates a new device orientation camera
  103977. * @param name The name of the camera
  103978. * @param position The start position camera
  103979. * @param scene The scene the camera belongs to
  103980. */
  103981. constructor(name: string, position: Vector3, scene: Scene);
  103982. /**
  103983. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  103984. */
  103985. disablePointerInputWhenUsingDeviceOrientation: boolean;
  103986. private _dragFactor;
  103987. /**
  103988. * Enabled turning on the y axis when the orientation sensor is active
  103989. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  103990. */
  103991. enableHorizontalDragging(dragFactor?: number): void;
  103992. /**
  103993. * Gets the current instance class name ("DeviceOrientationCamera").
  103994. * This helps avoiding instanceof at run time.
  103995. * @returns the class name
  103996. */
  103997. getClassName(): string;
  103998. /**
  103999. * @hidden
  104000. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  104001. */
  104002. _checkInputs(): void;
  104003. /**
  104004. * Reset the camera to its default orientation on the specified axis only.
  104005. * @param axis The axis to reset
  104006. */
  104007. resetToCurrentRotation(axis?: Axis): void;
  104008. }
  104009. }
  104010. declare module BABYLON {
  104011. /**
  104012. * Defines supported buttons for XBox360 compatible gamepads
  104013. */
  104014. export enum Xbox360Button {
  104015. /** A */
  104016. A = 0,
  104017. /** B */
  104018. B = 1,
  104019. /** X */
  104020. X = 2,
  104021. /** Y */
  104022. Y = 3,
  104023. /** Start */
  104024. Start = 4,
  104025. /** Back */
  104026. Back = 5,
  104027. /** Left button */
  104028. LB = 6,
  104029. /** Right button */
  104030. RB = 7,
  104031. /** Left stick */
  104032. LeftStick = 8,
  104033. /** Right stick */
  104034. RightStick = 9
  104035. }
  104036. /** Defines values for XBox360 DPad */
  104037. export enum Xbox360Dpad {
  104038. /** Up */
  104039. Up = 0,
  104040. /** Down */
  104041. Down = 1,
  104042. /** Left */
  104043. Left = 2,
  104044. /** Right */
  104045. Right = 3
  104046. }
  104047. /**
  104048. * Defines a XBox360 gamepad
  104049. */
  104050. export class Xbox360Pad extends Gamepad {
  104051. private _leftTrigger;
  104052. private _rightTrigger;
  104053. private _onlefttriggerchanged;
  104054. private _onrighttriggerchanged;
  104055. private _onbuttondown;
  104056. private _onbuttonup;
  104057. private _ondpaddown;
  104058. private _ondpadup;
  104059. /** Observable raised when a button is pressed */
  104060. onButtonDownObservable: Observable<Xbox360Button>;
  104061. /** Observable raised when a button is released */
  104062. onButtonUpObservable: Observable<Xbox360Button>;
  104063. /** Observable raised when a pad is pressed */
  104064. onPadDownObservable: Observable<Xbox360Dpad>;
  104065. /** Observable raised when a pad is released */
  104066. onPadUpObservable: Observable<Xbox360Dpad>;
  104067. private _buttonA;
  104068. private _buttonB;
  104069. private _buttonX;
  104070. private _buttonY;
  104071. private _buttonBack;
  104072. private _buttonStart;
  104073. private _buttonLB;
  104074. private _buttonRB;
  104075. private _buttonLeftStick;
  104076. private _buttonRightStick;
  104077. private _dPadUp;
  104078. private _dPadDown;
  104079. private _dPadLeft;
  104080. private _dPadRight;
  104081. private _isXboxOnePad;
  104082. /**
  104083. * Creates a new XBox360 gamepad object
  104084. * @param id defines the id of this gamepad
  104085. * @param index defines its index
  104086. * @param gamepad defines the internal HTML gamepad object
  104087. * @param xboxOne defines if it is a XBox One gamepad
  104088. */
  104089. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  104090. /**
  104091. * Defines the callback to call when left trigger is pressed
  104092. * @param callback defines the callback to use
  104093. */
  104094. onlefttriggerchanged(callback: (value: number) => void): void;
  104095. /**
  104096. * Defines the callback to call when right trigger is pressed
  104097. * @param callback defines the callback to use
  104098. */
  104099. onrighttriggerchanged(callback: (value: number) => void): void;
  104100. /**
  104101. * Gets the left trigger value
  104102. */
  104103. /**
  104104. * Sets the left trigger value
  104105. */
  104106. leftTrigger: number;
  104107. /**
  104108. * Gets the right trigger value
  104109. */
  104110. /**
  104111. * Sets the right trigger value
  104112. */
  104113. rightTrigger: number;
  104114. /**
  104115. * Defines the callback to call when a button is pressed
  104116. * @param callback defines the callback to use
  104117. */
  104118. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  104119. /**
  104120. * Defines the callback to call when a button is released
  104121. * @param callback defines the callback to use
  104122. */
  104123. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  104124. /**
  104125. * Defines the callback to call when a pad is pressed
  104126. * @param callback defines the callback to use
  104127. */
  104128. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  104129. /**
  104130. * Defines the callback to call when a pad is released
  104131. * @param callback defines the callback to use
  104132. */
  104133. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  104134. private _setButtonValue;
  104135. private _setDPadValue;
  104136. /**
  104137. * Gets the value of the `A` button
  104138. */
  104139. /**
  104140. * Sets the value of the `A` button
  104141. */
  104142. buttonA: number;
  104143. /**
  104144. * Gets the value of the `B` button
  104145. */
  104146. /**
  104147. * Sets the value of the `B` button
  104148. */
  104149. buttonB: number;
  104150. /**
  104151. * Gets the value of the `X` button
  104152. */
  104153. /**
  104154. * Sets the value of the `X` button
  104155. */
  104156. buttonX: number;
  104157. /**
  104158. * Gets the value of the `Y` button
  104159. */
  104160. /**
  104161. * Sets the value of the `Y` button
  104162. */
  104163. buttonY: number;
  104164. /**
  104165. * Gets the value of the `Start` button
  104166. */
  104167. /**
  104168. * Sets the value of the `Start` button
  104169. */
  104170. buttonStart: number;
  104171. /**
  104172. * Gets the value of the `Back` button
  104173. */
  104174. /**
  104175. * Sets the value of the `Back` button
  104176. */
  104177. buttonBack: number;
  104178. /**
  104179. * Gets the value of the `Left` button
  104180. */
  104181. /**
  104182. * Sets the value of the `Left` button
  104183. */
  104184. buttonLB: number;
  104185. /**
  104186. * Gets the value of the `Right` button
  104187. */
  104188. /**
  104189. * Sets the value of the `Right` button
  104190. */
  104191. buttonRB: number;
  104192. /**
  104193. * Gets the value of the Left joystick
  104194. */
  104195. /**
  104196. * Sets the value of the Left joystick
  104197. */
  104198. buttonLeftStick: number;
  104199. /**
  104200. * Gets the value of the Right joystick
  104201. */
  104202. /**
  104203. * Sets the value of the Right joystick
  104204. */
  104205. buttonRightStick: number;
  104206. /**
  104207. * Gets the value of D-pad up
  104208. */
  104209. /**
  104210. * Sets the value of D-pad up
  104211. */
  104212. dPadUp: number;
  104213. /**
  104214. * Gets the value of D-pad down
  104215. */
  104216. /**
  104217. * Sets the value of D-pad down
  104218. */
  104219. dPadDown: number;
  104220. /**
  104221. * Gets the value of D-pad left
  104222. */
  104223. /**
  104224. * Sets the value of D-pad left
  104225. */
  104226. dPadLeft: number;
  104227. /**
  104228. * Gets the value of D-pad right
  104229. */
  104230. /**
  104231. * Sets the value of D-pad right
  104232. */
  104233. dPadRight: number;
  104234. /**
  104235. * Force the gamepad to synchronize with device values
  104236. */
  104237. update(): void;
  104238. /**
  104239. * Disposes the gamepad
  104240. */
  104241. dispose(): void;
  104242. }
  104243. }
  104244. declare module BABYLON {
  104245. /**
  104246. * Defines supported buttons for DualShock compatible gamepads
  104247. */
  104248. export enum DualShockButton {
  104249. /** Cross */
  104250. Cross = 0,
  104251. /** Circle */
  104252. Circle = 1,
  104253. /** Square */
  104254. Square = 2,
  104255. /** Triangle */
  104256. Triangle = 3,
  104257. /** Options */
  104258. Options = 4,
  104259. /** Share */
  104260. Share = 5,
  104261. /** L1 */
  104262. L1 = 6,
  104263. /** R1 */
  104264. R1 = 7,
  104265. /** Left stick */
  104266. LeftStick = 8,
  104267. /** Right stick */
  104268. RightStick = 9
  104269. }
  104270. /** Defines values for DualShock DPad */
  104271. export enum DualShockDpad {
  104272. /** Up */
  104273. Up = 0,
  104274. /** Down */
  104275. Down = 1,
  104276. /** Left */
  104277. Left = 2,
  104278. /** Right */
  104279. Right = 3
  104280. }
  104281. /**
  104282. * Defines a DualShock gamepad
  104283. */
  104284. export class DualShockPad extends Gamepad {
  104285. private _leftTrigger;
  104286. private _rightTrigger;
  104287. private _onlefttriggerchanged;
  104288. private _onrighttriggerchanged;
  104289. private _onbuttondown;
  104290. private _onbuttonup;
  104291. private _ondpaddown;
  104292. private _ondpadup;
  104293. /** Observable raised when a button is pressed */
  104294. onButtonDownObservable: Observable<DualShockButton>;
  104295. /** Observable raised when a button is released */
  104296. onButtonUpObservable: Observable<DualShockButton>;
  104297. /** Observable raised when a pad is pressed */
  104298. onPadDownObservable: Observable<DualShockDpad>;
  104299. /** Observable raised when a pad is released */
  104300. onPadUpObservable: Observable<DualShockDpad>;
  104301. private _buttonCross;
  104302. private _buttonCircle;
  104303. private _buttonSquare;
  104304. private _buttonTriangle;
  104305. private _buttonShare;
  104306. private _buttonOptions;
  104307. private _buttonL1;
  104308. private _buttonR1;
  104309. private _buttonLeftStick;
  104310. private _buttonRightStick;
  104311. private _dPadUp;
  104312. private _dPadDown;
  104313. private _dPadLeft;
  104314. private _dPadRight;
  104315. /**
  104316. * Creates a new DualShock gamepad object
  104317. * @param id defines the id of this gamepad
  104318. * @param index defines its index
  104319. * @param gamepad defines the internal HTML gamepad object
  104320. */
  104321. constructor(id: string, index: number, gamepad: any);
  104322. /**
  104323. * Defines the callback to call when left trigger is pressed
  104324. * @param callback defines the callback to use
  104325. */
  104326. onlefttriggerchanged(callback: (value: number) => void): void;
  104327. /**
  104328. * Defines the callback to call when right trigger is pressed
  104329. * @param callback defines the callback to use
  104330. */
  104331. onrighttriggerchanged(callback: (value: number) => void): void;
  104332. /**
  104333. * Gets the left trigger value
  104334. */
  104335. /**
  104336. * Sets the left trigger value
  104337. */
  104338. leftTrigger: number;
  104339. /**
  104340. * Gets the right trigger value
  104341. */
  104342. /**
  104343. * Sets the right trigger value
  104344. */
  104345. rightTrigger: number;
  104346. /**
  104347. * Defines the callback to call when a button is pressed
  104348. * @param callback defines the callback to use
  104349. */
  104350. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  104351. /**
  104352. * Defines the callback to call when a button is released
  104353. * @param callback defines the callback to use
  104354. */
  104355. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  104356. /**
  104357. * Defines the callback to call when a pad is pressed
  104358. * @param callback defines the callback to use
  104359. */
  104360. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  104361. /**
  104362. * Defines the callback to call when a pad is released
  104363. * @param callback defines the callback to use
  104364. */
  104365. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  104366. private _setButtonValue;
  104367. private _setDPadValue;
  104368. /**
  104369. * Gets the value of the `Cross` button
  104370. */
  104371. /**
  104372. * Sets the value of the `Cross` button
  104373. */
  104374. buttonCross: number;
  104375. /**
  104376. * Gets the value of the `Circle` button
  104377. */
  104378. /**
  104379. * Sets the value of the `Circle` button
  104380. */
  104381. buttonCircle: number;
  104382. /**
  104383. * Gets the value of the `Square` button
  104384. */
  104385. /**
  104386. * Sets the value of the `Square` button
  104387. */
  104388. buttonSquare: number;
  104389. /**
  104390. * Gets the value of the `Triangle` button
  104391. */
  104392. /**
  104393. * Sets the value of the `Triangle` button
  104394. */
  104395. buttonTriangle: number;
  104396. /**
  104397. * Gets the value of the `Options` button
  104398. */
  104399. /**
  104400. * Sets the value of the `Options` button
  104401. */
  104402. buttonOptions: number;
  104403. /**
  104404. * Gets the value of the `Share` button
  104405. */
  104406. /**
  104407. * Sets the value of the `Share` button
  104408. */
  104409. buttonShare: number;
  104410. /**
  104411. * Gets the value of the `L1` button
  104412. */
  104413. /**
  104414. * Sets the value of the `L1` button
  104415. */
  104416. buttonL1: number;
  104417. /**
  104418. * Gets the value of the `R1` button
  104419. */
  104420. /**
  104421. * Sets the value of the `R1` button
  104422. */
  104423. buttonR1: number;
  104424. /**
  104425. * Gets the value of the Left joystick
  104426. */
  104427. /**
  104428. * Sets the value of the Left joystick
  104429. */
  104430. buttonLeftStick: number;
  104431. /**
  104432. * Gets the value of the Right joystick
  104433. */
  104434. /**
  104435. * Sets the value of the Right joystick
  104436. */
  104437. buttonRightStick: number;
  104438. /**
  104439. * Gets the value of D-pad up
  104440. */
  104441. /**
  104442. * Sets the value of D-pad up
  104443. */
  104444. dPadUp: number;
  104445. /**
  104446. * Gets the value of D-pad down
  104447. */
  104448. /**
  104449. * Sets the value of D-pad down
  104450. */
  104451. dPadDown: number;
  104452. /**
  104453. * Gets the value of D-pad left
  104454. */
  104455. /**
  104456. * Sets the value of D-pad left
  104457. */
  104458. dPadLeft: number;
  104459. /**
  104460. * Gets the value of D-pad right
  104461. */
  104462. /**
  104463. * Sets the value of D-pad right
  104464. */
  104465. dPadRight: number;
  104466. /**
  104467. * Force the gamepad to synchronize with device values
  104468. */
  104469. update(): void;
  104470. /**
  104471. * Disposes the gamepad
  104472. */
  104473. dispose(): void;
  104474. }
  104475. }
  104476. declare module BABYLON {
  104477. /**
  104478. * Manager for handling gamepads
  104479. */
  104480. export class GamepadManager {
  104481. private _scene?;
  104482. private _babylonGamepads;
  104483. private _oneGamepadConnected;
  104484. /** @hidden */
  104485. _isMonitoring: boolean;
  104486. private _gamepadEventSupported;
  104487. private _gamepadSupport;
  104488. /**
  104489. * observable to be triggered when the gamepad controller has been connected
  104490. */
  104491. onGamepadConnectedObservable: Observable<Gamepad>;
  104492. /**
  104493. * observable to be triggered when the gamepad controller has been disconnected
  104494. */
  104495. onGamepadDisconnectedObservable: Observable<Gamepad>;
  104496. private _onGamepadConnectedEvent;
  104497. private _onGamepadDisconnectedEvent;
  104498. /**
  104499. * Initializes the gamepad manager
  104500. * @param _scene BabylonJS scene
  104501. */
  104502. constructor(_scene?: Scene | undefined);
  104503. /**
  104504. * The gamepads in the game pad manager
  104505. */
  104506. readonly gamepads: Gamepad[];
  104507. /**
  104508. * Get the gamepad controllers based on type
  104509. * @param type The type of gamepad controller
  104510. * @returns Nullable gamepad
  104511. */
  104512. getGamepadByType(type?: number): Nullable<Gamepad>;
  104513. /**
  104514. * Disposes the gamepad manager
  104515. */
  104516. dispose(): void;
  104517. private _addNewGamepad;
  104518. private _startMonitoringGamepads;
  104519. private _stopMonitoringGamepads;
  104520. /** @hidden */
  104521. _checkGamepadsStatus(): void;
  104522. private _updateGamepadObjects;
  104523. }
  104524. }
  104525. declare module BABYLON {
  104526. interface Scene {
  104527. /** @hidden */
  104528. _gamepadManager: Nullable<GamepadManager>;
  104529. /**
  104530. * Gets the gamepad manager associated with the scene
  104531. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  104532. */
  104533. gamepadManager: GamepadManager;
  104534. }
  104535. /**
  104536. * Interface representing a free camera inputs manager
  104537. */
  104538. interface FreeCameraInputsManager {
  104539. /**
  104540. * Adds gamepad input support to the FreeCameraInputsManager.
  104541. * @returns the FreeCameraInputsManager
  104542. */
  104543. addGamepad(): FreeCameraInputsManager;
  104544. }
  104545. /**
  104546. * Interface representing an arc rotate camera inputs manager
  104547. */
  104548. interface ArcRotateCameraInputsManager {
  104549. /**
  104550. * Adds gamepad input support to the ArcRotateCamera InputManager.
  104551. * @returns the camera inputs manager
  104552. */
  104553. addGamepad(): ArcRotateCameraInputsManager;
  104554. }
  104555. /**
  104556. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  104557. */
  104558. export class GamepadSystemSceneComponent implements ISceneComponent {
  104559. /**
  104560. * The component name helpfull to identify the component in the list of scene components.
  104561. */
  104562. readonly name: string;
  104563. /**
  104564. * The scene the component belongs to.
  104565. */
  104566. scene: Scene;
  104567. /**
  104568. * Creates a new instance of the component for the given scene
  104569. * @param scene Defines the scene to register the component in
  104570. */
  104571. constructor(scene: Scene);
  104572. /**
  104573. * Registers the component in a given scene
  104574. */
  104575. register(): void;
  104576. /**
  104577. * Rebuilds the elements related to this component in case of
  104578. * context lost for instance.
  104579. */
  104580. rebuild(): void;
  104581. /**
  104582. * Disposes the component and the associated ressources
  104583. */
  104584. dispose(): void;
  104585. private _beforeCameraUpdate;
  104586. }
  104587. }
  104588. declare module BABYLON {
  104589. /**
  104590. * 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,
  104591. * which still works and will still be found in many Playgrounds.
  104592. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  104593. */
  104594. export class UniversalCamera extends TouchCamera {
  104595. /**
  104596. * Defines the gamepad rotation sensiblity.
  104597. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  104598. */
  104599. gamepadAngularSensibility: number;
  104600. /**
  104601. * Defines the gamepad move sensiblity.
  104602. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  104603. */
  104604. gamepadMoveSensibility: number;
  104605. /**
  104606. * 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,
  104607. * which still works and will still be found in many Playgrounds.
  104608. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  104609. * @param name Define the name of the camera in the scene
  104610. * @param position Define the start position of the camera in the scene
  104611. * @param scene Define the scene the camera belongs to
  104612. */
  104613. constructor(name: string, position: Vector3, scene: Scene);
  104614. /**
  104615. * Gets the current object class name.
  104616. * @return the class name
  104617. */
  104618. getClassName(): string;
  104619. }
  104620. }
  104621. declare module BABYLON {
  104622. /**
  104623. * This represents a FPS type of camera. This is only here for back compat purpose.
  104624. * Please use the UniversalCamera instead as both are identical.
  104625. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  104626. */
  104627. export class GamepadCamera extends UniversalCamera {
  104628. /**
  104629. * Instantiates a new Gamepad Camera
  104630. * This represents a FPS type of camera. This is only here for back compat purpose.
  104631. * Please use the UniversalCamera instead as both are identical.
  104632. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  104633. * @param name Define the name of the camera in the scene
  104634. * @param position Define the start position of the camera in the scene
  104635. * @param scene Define the scene the camera belongs to
  104636. */
  104637. constructor(name: string, position: Vector3, scene: Scene);
  104638. /**
  104639. * Gets the current object class name.
  104640. * @return the class name
  104641. */
  104642. getClassName(): string;
  104643. }
  104644. }
  104645. declare module BABYLON {
  104646. /** @hidden */
  104647. export var passPixelShader: {
  104648. name: string;
  104649. shader: string;
  104650. };
  104651. }
  104652. declare module BABYLON {
  104653. /** @hidden */
  104654. export var passCubePixelShader: {
  104655. name: string;
  104656. shader: string;
  104657. };
  104658. }
  104659. declare module BABYLON {
  104660. /**
  104661. * PassPostProcess which produces an output the same as it's input
  104662. */
  104663. export class PassPostProcess extends PostProcess {
  104664. /**
  104665. * Creates the PassPostProcess
  104666. * @param name The name of the effect.
  104667. * @param options The required width/height ratio to downsize to before computing the render pass.
  104668. * @param camera The camera to apply the render pass to.
  104669. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  104670. * @param engine The engine which the post process will be applied. (default: current engine)
  104671. * @param reusable If the post process can be reused on the same frame. (default: false)
  104672. * @param textureType The type of texture to be used when performing the post processing.
  104673. * @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)
  104674. */
  104675. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  104676. }
  104677. /**
  104678. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  104679. */
  104680. export class PassCubePostProcess extends PostProcess {
  104681. private _face;
  104682. /**
  104683. * Gets or sets the cube face to display.
  104684. * * 0 is +X
  104685. * * 1 is -X
  104686. * * 2 is +Y
  104687. * * 3 is -Y
  104688. * * 4 is +Z
  104689. * * 5 is -Z
  104690. */
  104691. face: number;
  104692. /**
  104693. * Creates the PassCubePostProcess
  104694. * @param name The name of the effect.
  104695. * @param options The required width/height ratio to downsize to before computing the render pass.
  104696. * @param camera The camera to apply the render pass to.
  104697. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  104698. * @param engine The engine which the post process will be applied. (default: current engine)
  104699. * @param reusable If the post process can be reused on the same frame. (default: false)
  104700. * @param textureType The type of texture to be used when performing the post processing.
  104701. * @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)
  104702. */
  104703. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  104704. }
  104705. }
  104706. declare module BABYLON {
  104707. /** @hidden */
  104708. export var anaglyphPixelShader: {
  104709. name: string;
  104710. shader: string;
  104711. };
  104712. }
  104713. declare module BABYLON {
  104714. /**
  104715. * Postprocess used to generate anaglyphic rendering
  104716. */
  104717. export class AnaglyphPostProcess extends PostProcess {
  104718. private _passedProcess;
  104719. /**
  104720. * Creates a new AnaglyphPostProcess
  104721. * @param name defines postprocess name
  104722. * @param options defines creation options or target ratio scale
  104723. * @param rigCameras defines cameras using this postprocess
  104724. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  104725. * @param engine defines hosting engine
  104726. * @param reusable defines if the postprocess will be reused multiple times per frame
  104727. */
  104728. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  104729. }
  104730. }
  104731. declare module BABYLON {
  104732. /**
  104733. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  104734. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  104735. */
  104736. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  104737. /**
  104738. * Creates a new AnaglyphArcRotateCamera
  104739. * @param name defines camera name
  104740. * @param alpha defines alpha angle (in radians)
  104741. * @param beta defines beta angle (in radians)
  104742. * @param radius defines radius
  104743. * @param target defines camera target
  104744. * @param interaxialDistance defines distance between each color axis
  104745. * @param scene defines the hosting scene
  104746. */
  104747. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  104748. /**
  104749. * Gets camera class name
  104750. * @returns AnaglyphArcRotateCamera
  104751. */
  104752. getClassName(): string;
  104753. }
  104754. }
  104755. declare module BABYLON {
  104756. /**
  104757. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  104758. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  104759. */
  104760. export class AnaglyphFreeCamera extends FreeCamera {
  104761. /**
  104762. * Creates a new AnaglyphFreeCamera
  104763. * @param name defines camera name
  104764. * @param position defines initial position
  104765. * @param interaxialDistance defines distance between each color axis
  104766. * @param scene defines the hosting scene
  104767. */
  104768. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  104769. /**
  104770. * Gets camera class name
  104771. * @returns AnaglyphFreeCamera
  104772. */
  104773. getClassName(): string;
  104774. }
  104775. }
  104776. declare module BABYLON {
  104777. /**
  104778. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  104779. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  104780. */
  104781. export class AnaglyphGamepadCamera extends GamepadCamera {
  104782. /**
  104783. * Creates a new AnaglyphGamepadCamera
  104784. * @param name defines camera name
  104785. * @param position defines initial position
  104786. * @param interaxialDistance defines distance between each color axis
  104787. * @param scene defines the hosting scene
  104788. */
  104789. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  104790. /**
  104791. * Gets camera class name
  104792. * @returns AnaglyphGamepadCamera
  104793. */
  104794. getClassName(): string;
  104795. }
  104796. }
  104797. declare module BABYLON {
  104798. /**
  104799. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  104800. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  104801. */
  104802. export class AnaglyphUniversalCamera extends UniversalCamera {
  104803. /**
  104804. * Creates a new AnaglyphUniversalCamera
  104805. * @param name defines camera name
  104806. * @param position defines initial position
  104807. * @param interaxialDistance defines distance between each color axis
  104808. * @param scene defines the hosting scene
  104809. */
  104810. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  104811. /**
  104812. * Gets camera class name
  104813. * @returns AnaglyphUniversalCamera
  104814. */
  104815. getClassName(): string;
  104816. }
  104817. }
  104818. declare module BABYLON {
  104819. /** @hidden */
  104820. export var stereoscopicInterlacePixelShader: {
  104821. name: string;
  104822. shader: string;
  104823. };
  104824. }
  104825. declare module BABYLON {
  104826. /**
  104827. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  104828. */
  104829. export class StereoscopicInterlacePostProcess extends PostProcess {
  104830. private _stepSize;
  104831. private _passedProcess;
  104832. /**
  104833. * Initializes a StereoscopicInterlacePostProcess
  104834. * @param name The name of the effect.
  104835. * @param rigCameras The rig cameras to be appled to the post process
  104836. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  104837. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  104838. * @param engine The engine which the post process will be applied. (default: current engine)
  104839. * @param reusable If the post process can be reused on the same frame. (default: false)
  104840. */
  104841. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  104842. }
  104843. }
  104844. declare module BABYLON {
  104845. /**
  104846. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  104847. * @see http://doc.babylonjs.com/features/cameras
  104848. */
  104849. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  104850. /**
  104851. * Creates a new StereoscopicArcRotateCamera
  104852. * @param name defines camera name
  104853. * @param alpha defines alpha angle (in radians)
  104854. * @param beta defines beta angle (in radians)
  104855. * @param radius defines radius
  104856. * @param target defines camera target
  104857. * @param interaxialDistance defines distance between each color axis
  104858. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  104859. * @param scene defines the hosting scene
  104860. */
  104861. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  104862. /**
  104863. * Gets camera class name
  104864. * @returns StereoscopicArcRotateCamera
  104865. */
  104866. getClassName(): string;
  104867. }
  104868. }
  104869. declare module BABYLON {
  104870. /**
  104871. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  104872. * @see http://doc.babylonjs.com/features/cameras
  104873. */
  104874. export class StereoscopicFreeCamera extends FreeCamera {
  104875. /**
  104876. * Creates a new StereoscopicFreeCamera
  104877. * @param name defines camera name
  104878. * @param position defines initial position
  104879. * @param interaxialDistance defines distance between each color axis
  104880. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  104881. * @param scene defines the hosting scene
  104882. */
  104883. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  104884. /**
  104885. * Gets camera class name
  104886. * @returns StereoscopicFreeCamera
  104887. */
  104888. getClassName(): string;
  104889. }
  104890. }
  104891. declare module BABYLON {
  104892. /**
  104893. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  104894. * @see http://doc.babylonjs.com/features/cameras
  104895. */
  104896. export class StereoscopicGamepadCamera extends GamepadCamera {
  104897. /**
  104898. * Creates a new StereoscopicGamepadCamera
  104899. * @param name defines camera name
  104900. * @param position defines initial position
  104901. * @param interaxialDistance defines distance between each color axis
  104902. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  104903. * @param scene defines the hosting scene
  104904. */
  104905. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  104906. /**
  104907. * Gets camera class name
  104908. * @returns StereoscopicGamepadCamera
  104909. */
  104910. getClassName(): string;
  104911. }
  104912. }
  104913. declare module BABYLON {
  104914. /**
  104915. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  104916. * @see http://doc.babylonjs.com/features/cameras
  104917. */
  104918. export class StereoscopicUniversalCamera extends UniversalCamera {
  104919. /**
  104920. * Creates a new StereoscopicUniversalCamera
  104921. * @param name defines camera name
  104922. * @param position defines initial position
  104923. * @param interaxialDistance defines distance between each color axis
  104924. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  104925. * @param scene defines the hosting scene
  104926. */
  104927. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  104928. /**
  104929. * Gets camera class name
  104930. * @returns StereoscopicUniversalCamera
  104931. */
  104932. getClassName(): string;
  104933. }
  104934. }
  104935. declare module BABYLON {
  104936. /**
  104937. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  104938. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  104939. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  104940. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  104941. */
  104942. export class VirtualJoysticksCamera extends FreeCamera {
  104943. /**
  104944. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  104945. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  104946. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  104947. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  104948. * @param name Define the name of the camera in the scene
  104949. * @param position Define the start position of the camera in the scene
  104950. * @param scene Define the scene the camera belongs to
  104951. */
  104952. constructor(name: string, position: Vector3, scene: Scene);
  104953. /**
  104954. * Gets the current object class name.
  104955. * @return the class name
  104956. */
  104957. getClassName(): string;
  104958. }
  104959. }
  104960. declare module BABYLON {
  104961. /**
  104962. * This represents all the required metrics to create a VR camera.
  104963. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  104964. */
  104965. export class VRCameraMetrics {
  104966. /**
  104967. * Define the horizontal resolution off the screen.
  104968. */
  104969. hResolution: number;
  104970. /**
  104971. * Define the vertical resolution off the screen.
  104972. */
  104973. vResolution: number;
  104974. /**
  104975. * Define the horizontal screen size.
  104976. */
  104977. hScreenSize: number;
  104978. /**
  104979. * Define the vertical screen size.
  104980. */
  104981. vScreenSize: number;
  104982. /**
  104983. * Define the vertical screen center position.
  104984. */
  104985. vScreenCenter: number;
  104986. /**
  104987. * Define the distance of the eyes to the screen.
  104988. */
  104989. eyeToScreenDistance: number;
  104990. /**
  104991. * Define the distance between both lenses
  104992. */
  104993. lensSeparationDistance: number;
  104994. /**
  104995. * Define the distance between both viewer's eyes.
  104996. */
  104997. interpupillaryDistance: number;
  104998. /**
  104999. * Define the distortion factor of the VR postprocess.
  105000. * Please, touch with care.
  105001. */
  105002. distortionK: number[];
  105003. /**
  105004. * Define the chromatic aberration correction factors for the VR post process.
  105005. */
  105006. chromaAbCorrection: number[];
  105007. /**
  105008. * Define the scale factor of the post process.
  105009. * The smaller the better but the slower.
  105010. */
  105011. postProcessScaleFactor: number;
  105012. /**
  105013. * Define an offset for the lens center.
  105014. */
  105015. lensCenterOffset: number;
  105016. /**
  105017. * Define if the current vr camera should compensate the distortion of the lense or not.
  105018. */
  105019. compensateDistortion: boolean;
  105020. /**
  105021. * Defines if multiview should be enabled when rendering (Default: false)
  105022. */
  105023. multiviewEnabled: boolean;
  105024. /**
  105025. * Gets the rendering aspect ratio based on the provided resolutions.
  105026. */
  105027. readonly aspectRatio: number;
  105028. /**
  105029. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  105030. */
  105031. readonly aspectRatioFov: number;
  105032. /**
  105033. * @hidden
  105034. */
  105035. readonly leftHMatrix: Matrix;
  105036. /**
  105037. * @hidden
  105038. */
  105039. readonly rightHMatrix: Matrix;
  105040. /**
  105041. * @hidden
  105042. */
  105043. readonly leftPreViewMatrix: Matrix;
  105044. /**
  105045. * @hidden
  105046. */
  105047. readonly rightPreViewMatrix: Matrix;
  105048. /**
  105049. * Get the default VRMetrics based on the most generic setup.
  105050. * @returns the default vr metrics
  105051. */
  105052. static GetDefault(): VRCameraMetrics;
  105053. }
  105054. }
  105055. declare module BABYLON {
  105056. /** @hidden */
  105057. export var vrDistortionCorrectionPixelShader: {
  105058. name: string;
  105059. shader: string;
  105060. };
  105061. }
  105062. declare module BABYLON {
  105063. /**
  105064. * VRDistortionCorrectionPostProcess used for mobile VR
  105065. */
  105066. export class VRDistortionCorrectionPostProcess extends PostProcess {
  105067. private _isRightEye;
  105068. private _distortionFactors;
  105069. private _postProcessScaleFactor;
  105070. private _lensCenterOffset;
  105071. private _scaleIn;
  105072. private _scaleFactor;
  105073. private _lensCenter;
  105074. /**
  105075. * Initializes the VRDistortionCorrectionPostProcess
  105076. * @param name The name of the effect.
  105077. * @param camera The camera to apply the render pass to.
  105078. * @param isRightEye If this is for the right eye distortion
  105079. * @param vrMetrics All the required metrics for the VR camera
  105080. */
  105081. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  105082. }
  105083. }
  105084. declare module BABYLON {
  105085. /**
  105086. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  105087. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  105088. */
  105089. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  105090. /**
  105091. * Creates a new VRDeviceOrientationArcRotateCamera
  105092. * @param name defines camera name
  105093. * @param alpha defines the camera rotation along the logitudinal axis
  105094. * @param beta defines the camera rotation along the latitudinal axis
  105095. * @param radius defines the camera distance from its target
  105096. * @param target defines the camera target
  105097. * @param scene defines the scene the camera belongs to
  105098. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  105099. * @param vrCameraMetrics defines the vr metrics associated to the camera
  105100. */
  105101. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  105102. /**
  105103. * Gets camera class name
  105104. * @returns VRDeviceOrientationArcRotateCamera
  105105. */
  105106. getClassName(): string;
  105107. }
  105108. }
  105109. declare module BABYLON {
  105110. /**
  105111. * Camera used to simulate VR rendering (based on FreeCamera)
  105112. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  105113. */
  105114. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  105115. /**
  105116. * Creates a new VRDeviceOrientationFreeCamera
  105117. * @param name defines camera name
  105118. * @param position defines the start position of the camera
  105119. * @param scene defines the scene the camera belongs to
  105120. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  105121. * @param vrCameraMetrics defines the vr metrics associated to the camera
  105122. */
  105123. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  105124. /**
  105125. * Gets camera class name
  105126. * @returns VRDeviceOrientationFreeCamera
  105127. */
  105128. getClassName(): string;
  105129. }
  105130. }
  105131. declare module BABYLON {
  105132. /**
  105133. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  105134. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  105135. */
  105136. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  105137. /**
  105138. * Creates a new VRDeviceOrientationGamepadCamera
  105139. * @param name defines camera name
  105140. * @param position defines the start position of the camera
  105141. * @param scene defines the scene the camera belongs to
  105142. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  105143. * @param vrCameraMetrics defines the vr metrics associated to the camera
  105144. */
  105145. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  105146. /**
  105147. * Gets camera class name
  105148. * @returns VRDeviceOrientationGamepadCamera
  105149. */
  105150. getClassName(): string;
  105151. }
  105152. }
  105153. declare module BABYLON {
  105154. /**
  105155. * Base class of materials working in push mode in babylon JS
  105156. * @hidden
  105157. */
  105158. export class PushMaterial extends Material {
  105159. protected _activeEffect: Effect;
  105160. protected _normalMatrix: Matrix;
  105161. /**
  105162. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  105163. * This means that the material can keep using a previous shader while a new one is being compiled.
  105164. * This is mostly used when shader parallel compilation is supported (true by default)
  105165. */
  105166. allowShaderHotSwapping: boolean;
  105167. constructor(name: string, scene: Scene);
  105168. getEffect(): Effect;
  105169. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  105170. /**
  105171. * Binds the given world matrix to the active effect
  105172. *
  105173. * @param world the matrix to bind
  105174. */
  105175. bindOnlyWorldMatrix(world: Matrix): void;
  105176. /**
  105177. * Binds the given normal matrix to the active effect
  105178. *
  105179. * @param normalMatrix the matrix to bind
  105180. */
  105181. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  105182. bind(world: Matrix, mesh?: Mesh): void;
  105183. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  105184. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  105185. }
  105186. }
  105187. declare module BABYLON {
  105188. /**
  105189. * This groups all the flags used to control the materials channel.
  105190. */
  105191. export class MaterialFlags {
  105192. private static _DiffuseTextureEnabled;
  105193. /**
  105194. * Are diffuse textures enabled in the application.
  105195. */
  105196. static DiffuseTextureEnabled: boolean;
  105197. private static _AmbientTextureEnabled;
  105198. /**
  105199. * Are ambient textures enabled in the application.
  105200. */
  105201. static AmbientTextureEnabled: boolean;
  105202. private static _OpacityTextureEnabled;
  105203. /**
  105204. * Are opacity textures enabled in the application.
  105205. */
  105206. static OpacityTextureEnabled: boolean;
  105207. private static _ReflectionTextureEnabled;
  105208. /**
  105209. * Are reflection textures enabled in the application.
  105210. */
  105211. static ReflectionTextureEnabled: boolean;
  105212. private static _EmissiveTextureEnabled;
  105213. /**
  105214. * Are emissive textures enabled in the application.
  105215. */
  105216. static EmissiveTextureEnabled: boolean;
  105217. private static _SpecularTextureEnabled;
  105218. /**
  105219. * Are specular textures enabled in the application.
  105220. */
  105221. static SpecularTextureEnabled: boolean;
  105222. private static _BumpTextureEnabled;
  105223. /**
  105224. * Are bump textures enabled in the application.
  105225. */
  105226. static BumpTextureEnabled: boolean;
  105227. private static _LightmapTextureEnabled;
  105228. /**
  105229. * Are lightmap textures enabled in the application.
  105230. */
  105231. static LightmapTextureEnabled: boolean;
  105232. private static _RefractionTextureEnabled;
  105233. /**
  105234. * Are refraction textures enabled in the application.
  105235. */
  105236. static RefractionTextureEnabled: boolean;
  105237. private static _ColorGradingTextureEnabled;
  105238. /**
  105239. * Are color grading textures enabled in the application.
  105240. */
  105241. static ColorGradingTextureEnabled: boolean;
  105242. private static _FresnelEnabled;
  105243. /**
  105244. * Are fresnels enabled in the application.
  105245. */
  105246. static FresnelEnabled: boolean;
  105247. private static _ClearCoatTextureEnabled;
  105248. /**
  105249. * Are clear coat textures enabled in the application.
  105250. */
  105251. static ClearCoatTextureEnabled: boolean;
  105252. private static _ClearCoatBumpTextureEnabled;
  105253. /**
  105254. * Are clear coat bump textures enabled in the application.
  105255. */
  105256. static ClearCoatBumpTextureEnabled: boolean;
  105257. private static _ClearCoatTintTextureEnabled;
  105258. /**
  105259. * Are clear coat tint textures enabled in the application.
  105260. */
  105261. static ClearCoatTintTextureEnabled: boolean;
  105262. private static _SheenTextureEnabled;
  105263. /**
  105264. * Are sheen textures enabled in the application.
  105265. */
  105266. static SheenTextureEnabled: boolean;
  105267. private static _AnisotropicTextureEnabled;
  105268. /**
  105269. * Are anisotropic textures enabled in the application.
  105270. */
  105271. static AnisotropicTextureEnabled: boolean;
  105272. private static _ThicknessTextureEnabled;
  105273. /**
  105274. * Are thickness textures enabled in the application.
  105275. */
  105276. static ThicknessTextureEnabled: boolean;
  105277. }
  105278. }
  105279. declare module BABYLON {
  105280. /** @hidden */
  105281. export var defaultFragmentDeclaration: {
  105282. name: string;
  105283. shader: string;
  105284. };
  105285. }
  105286. declare module BABYLON {
  105287. /** @hidden */
  105288. export var defaultUboDeclaration: {
  105289. name: string;
  105290. shader: string;
  105291. };
  105292. }
  105293. declare module BABYLON {
  105294. /** @hidden */
  105295. export var lightFragmentDeclaration: {
  105296. name: string;
  105297. shader: string;
  105298. };
  105299. }
  105300. declare module BABYLON {
  105301. /** @hidden */
  105302. export var lightUboDeclaration: {
  105303. name: string;
  105304. shader: string;
  105305. };
  105306. }
  105307. declare module BABYLON {
  105308. /** @hidden */
  105309. export var lightsFragmentFunctions: {
  105310. name: string;
  105311. shader: string;
  105312. };
  105313. }
  105314. declare module BABYLON {
  105315. /** @hidden */
  105316. export var shadowsFragmentFunctions: {
  105317. name: string;
  105318. shader: string;
  105319. };
  105320. }
  105321. declare module BABYLON {
  105322. /** @hidden */
  105323. export var fresnelFunction: {
  105324. name: string;
  105325. shader: string;
  105326. };
  105327. }
  105328. declare module BABYLON {
  105329. /** @hidden */
  105330. export var reflectionFunction: {
  105331. name: string;
  105332. shader: string;
  105333. };
  105334. }
  105335. declare module BABYLON {
  105336. /** @hidden */
  105337. export var bumpFragmentFunctions: {
  105338. name: string;
  105339. shader: string;
  105340. };
  105341. }
  105342. declare module BABYLON {
  105343. /** @hidden */
  105344. export var logDepthDeclaration: {
  105345. name: string;
  105346. shader: string;
  105347. };
  105348. }
  105349. declare module BABYLON {
  105350. /** @hidden */
  105351. export var bumpFragment: {
  105352. name: string;
  105353. shader: string;
  105354. };
  105355. }
  105356. declare module BABYLON {
  105357. /** @hidden */
  105358. export var depthPrePass: {
  105359. name: string;
  105360. shader: string;
  105361. };
  105362. }
  105363. declare module BABYLON {
  105364. /** @hidden */
  105365. export var lightFragment: {
  105366. name: string;
  105367. shader: string;
  105368. };
  105369. }
  105370. declare module BABYLON {
  105371. /** @hidden */
  105372. export var logDepthFragment: {
  105373. name: string;
  105374. shader: string;
  105375. };
  105376. }
  105377. declare module BABYLON {
  105378. /** @hidden */
  105379. export var defaultPixelShader: {
  105380. name: string;
  105381. shader: string;
  105382. };
  105383. }
  105384. declare module BABYLON {
  105385. /** @hidden */
  105386. export var defaultVertexDeclaration: {
  105387. name: string;
  105388. shader: string;
  105389. };
  105390. }
  105391. declare module BABYLON {
  105392. /** @hidden */
  105393. export var bumpVertexDeclaration: {
  105394. name: string;
  105395. shader: string;
  105396. };
  105397. }
  105398. declare module BABYLON {
  105399. /** @hidden */
  105400. export var bumpVertex: {
  105401. name: string;
  105402. shader: string;
  105403. };
  105404. }
  105405. declare module BABYLON {
  105406. /** @hidden */
  105407. export var fogVertex: {
  105408. name: string;
  105409. shader: string;
  105410. };
  105411. }
  105412. declare module BABYLON {
  105413. /** @hidden */
  105414. export var shadowsVertex: {
  105415. name: string;
  105416. shader: string;
  105417. };
  105418. }
  105419. declare module BABYLON {
  105420. /** @hidden */
  105421. export var pointCloudVertex: {
  105422. name: string;
  105423. shader: string;
  105424. };
  105425. }
  105426. declare module BABYLON {
  105427. /** @hidden */
  105428. export var logDepthVertex: {
  105429. name: string;
  105430. shader: string;
  105431. };
  105432. }
  105433. declare module BABYLON {
  105434. /** @hidden */
  105435. export var defaultVertexShader: {
  105436. name: string;
  105437. shader: string;
  105438. };
  105439. }
  105440. declare module BABYLON {
  105441. /** @hidden */
  105442. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  105443. MAINUV1: boolean;
  105444. MAINUV2: boolean;
  105445. DIFFUSE: boolean;
  105446. DIFFUSEDIRECTUV: number;
  105447. AMBIENT: boolean;
  105448. AMBIENTDIRECTUV: number;
  105449. OPACITY: boolean;
  105450. OPACITYDIRECTUV: number;
  105451. OPACITYRGB: boolean;
  105452. REFLECTION: boolean;
  105453. EMISSIVE: boolean;
  105454. EMISSIVEDIRECTUV: number;
  105455. SPECULAR: boolean;
  105456. SPECULARDIRECTUV: number;
  105457. BUMP: boolean;
  105458. BUMPDIRECTUV: number;
  105459. PARALLAX: boolean;
  105460. PARALLAXOCCLUSION: boolean;
  105461. SPECULAROVERALPHA: boolean;
  105462. CLIPPLANE: boolean;
  105463. CLIPPLANE2: boolean;
  105464. CLIPPLANE3: boolean;
  105465. CLIPPLANE4: boolean;
  105466. ALPHATEST: boolean;
  105467. DEPTHPREPASS: boolean;
  105468. ALPHAFROMDIFFUSE: boolean;
  105469. POINTSIZE: boolean;
  105470. FOG: boolean;
  105471. SPECULARTERM: boolean;
  105472. DIFFUSEFRESNEL: boolean;
  105473. OPACITYFRESNEL: boolean;
  105474. REFLECTIONFRESNEL: boolean;
  105475. REFRACTIONFRESNEL: boolean;
  105476. EMISSIVEFRESNEL: boolean;
  105477. FRESNEL: boolean;
  105478. NORMAL: boolean;
  105479. UV1: boolean;
  105480. UV2: boolean;
  105481. VERTEXCOLOR: boolean;
  105482. VERTEXALPHA: boolean;
  105483. NUM_BONE_INFLUENCERS: number;
  105484. BonesPerMesh: number;
  105485. BONETEXTURE: boolean;
  105486. INSTANCES: boolean;
  105487. GLOSSINESS: boolean;
  105488. ROUGHNESS: boolean;
  105489. EMISSIVEASILLUMINATION: boolean;
  105490. LINKEMISSIVEWITHDIFFUSE: boolean;
  105491. REFLECTIONFRESNELFROMSPECULAR: boolean;
  105492. LIGHTMAP: boolean;
  105493. LIGHTMAPDIRECTUV: number;
  105494. OBJECTSPACE_NORMALMAP: boolean;
  105495. USELIGHTMAPASSHADOWMAP: boolean;
  105496. REFLECTIONMAP_3D: boolean;
  105497. REFLECTIONMAP_SPHERICAL: boolean;
  105498. REFLECTIONMAP_PLANAR: boolean;
  105499. REFLECTIONMAP_CUBIC: boolean;
  105500. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  105501. REFLECTIONMAP_PROJECTION: boolean;
  105502. REFLECTIONMAP_SKYBOX: boolean;
  105503. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  105504. REFLECTIONMAP_EXPLICIT: boolean;
  105505. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  105506. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  105507. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  105508. INVERTCUBICMAP: boolean;
  105509. LOGARITHMICDEPTH: boolean;
  105510. REFRACTION: boolean;
  105511. REFRACTIONMAP_3D: boolean;
  105512. REFLECTIONOVERALPHA: boolean;
  105513. TWOSIDEDLIGHTING: boolean;
  105514. SHADOWFLOAT: boolean;
  105515. MORPHTARGETS: boolean;
  105516. MORPHTARGETS_NORMAL: boolean;
  105517. MORPHTARGETS_TANGENT: boolean;
  105518. MORPHTARGETS_UV: boolean;
  105519. NUM_MORPH_INFLUENCERS: number;
  105520. NONUNIFORMSCALING: boolean;
  105521. PREMULTIPLYALPHA: boolean;
  105522. IMAGEPROCESSING: boolean;
  105523. VIGNETTE: boolean;
  105524. VIGNETTEBLENDMODEMULTIPLY: boolean;
  105525. VIGNETTEBLENDMODEOPAQUE: boolean;
  105526. TONEMAPPING: boolean;
  105527. TONEMAPPING_ACES: boolean;
  105528. CONTRAST: boolean;
  105529. COLORCURVES: boolean;
  105530. COLORGRADING: boolean;
  105531. COLORGRADING3D: boolean;
  105532. SAMPLER3DGREENDEPTH: boolean;
  105533. SAMPLER3DBGRMAP: boolean;
  105534. IMAGEPROCESSINGPOSTPROCESS: boolean;
  105535. MULTIVIEW: boolean;
  105536. /**
  105537. * If the reflection texture on this material is in linear color space
  105538. * @hidden
  105539. */
  105540. IS_REFLECTION_LINEAR: boolean;
  105541. /**
  105542. * If the refraction texture on this material is in linear color space
  105543. * @hidden
  105544. */
  105545. IS_REFRACTION_LINEAR: boolean;
  105546. EXPOSURE: boolean;
  105547. constructor();
  105548. setReflectionMode(modeToEnable: string): void;
  105549. }
  105550. /**
  105551. * This is the default material used in Babylon. It is the best trade off between quality
  105552. * and performances.
  105553. * @see http://doc.babylonjs.com/babylon101/materials
  105554. */
  105555. export class StandardMaterial extends PushMaterial {
  105556. private _diffuseTexture;
  105557. /**
  105558. * The basic texture of the material as viewed under a light.
  105559. */
  105560. diffuseTexture: Nullable<BaseTexture>;
  105561. private _ambientTexture;
  105562. /**
  105563. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  105564. */
  105565. ambientTexture: Nullable<BaseTexture>;
  105566. private _opacityTexture;
  105567. /**
  105568. * Define the transparency of the material from a texture.
  105569. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  105570. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  105571. */
  105572. opacityTexture: Nullable<BaseTexture>;
  105573. private _reflectionTexture;
  105574. /**
  105575. * Define the texture used to display the reflection.
  105576. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  105577. */
  105578. reflectionTexture: Nullable<BaseTexture>;
  105579. private _emissiveTexture;
  105580. /**
  105581. * Define texture of the material as if self lit.
  105582. * This will be mixed in the final result even in the absence of light.
  105583. */
  105584. emissiveTexture: Nullable<BaseTexture>;
  105585. private _specularTexture;
  105586. /**
  105587. * Define how the color and intensity of the highlight given by the light in the material.
  105588. */
  105589. specularTexture: Nullable<BaseTexture>;
  105590. private _bumpTexture;
  105591. /**
  105592. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  105593. * 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.
  105594. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  105595. */
  105596. bumpTexture: Nullable<BaseTexture>;
  105597. private _lightmapTexture;
  105598. /**
  105599. * Complex lighting can be computationally expensive to compute at runtime.
  105600. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  105601. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  105602. */
  105603. lightmapTexture: Nullable<BaseTexture>;
  105604. private _refractionTexture;
  105605. /**
  105606. * Define the texture used to display the refraction.
  105607. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  105608. */
  105609. refractionTexture: Nullable<BaseTexture>;
  105610. /**
  105611. * The color of the material lit by the environmental background lighting.
  105612. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  105613. */
  105614. ambientColor: Color3;
  105615. /**
  105616. * The basic color of the material as viewed under a light.
  105617. */
  105618. diffuseColor: Color3;
  105619. /**
  105620. * Define how the color and intensity of the highlight given by the light in the material.
  105621. */
  105622. specularColor: Color3;
  105623. /**
  105624. * Define the color of the material as if self lit.
  105625. * This will be mixed in the final result even in the absence of light.
  105626. */
  105627. emissiveColor: Color3;
  105628. /**
  105629. * Defines how sharp are the highlights in the material.
  105630. * The bigger the value the sharper giving a more glossy feeling to the result.
  105631. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  105632. */
  105633. specularPower: number;
  105634. private _useAlphaFromDiffuseTexture;
  105635. /**
  105636. * Does the transparency come from the diffuse texture alpha channel.
  105637. */
  105638. useAlphaFromDiffuseTexture: boolean;
  105639. private _useEmissiveAsIllumination;
  105640. /**
  105641. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  105642. */
  105643. useEmissiveAsIllumination: boolean;
  105644. private _linkEmissiveWithDiffuse;
  105645. /**
  105646. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  105647. * the emissive level when the final color is close to one.
  105648. */
  105649. linkEmissiveWithDiffuse: boolean;
  105650. private _useSpecularOverAlpha;
  105651. /**
  105652. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  105653. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  105654. */
  105655. useSpecularOverAlpha: boolean;
  105656. private _useReflectionOverAlpha;
  105657. /**
  105658. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  105659. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  105660. */
  105661. useReflectionOverAlpha: boolean;
  105662. private _disableLighting;
  105663. /**
  105664. * Does lights from the scene impacts this material.
  105665. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  105666. */
  105667. disableLighting: boolean;
  105668. private _useObjectSpaceNormalMap;
  105669. /**
  105670. * Allows using an object space normal map (instead of tangent space).
  105671. */
  105672. useObjectSpaceNormalMap: boolean;
  105673. private _useParallax;
  105674. /**
  105675. * Is parallax enabled or not.
  105676. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  105677. */
  105678. useParallax: boolean;
  105679. private _useParallaxOcclusion;
  105680. /**
  105681. * Is parallax occlusion enabled or not.
  105682. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  105683. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  105684. */
  105685. useParallaxOcclusion: boolean;
  105686. /**
  105687. * 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.
  105688. */
  105689. parallaxScaleBias: number;
  105690. private _roughness;
  105691. /**
  105692. * Helps to define how blurry the reflections should appears in the material.
  105693. */
  105694. roughness: number;
  105695. /**
  105696. * In case of refraction, define the value of the index of refraction.
  105697. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  105698. */
  105699. indexOfRefraction: number;
  105700. /**
  105701. * Invert the refraction texture alongside the y axis.
  105702. * It can be useful with procedural textures or probe for instance.
  105703. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  105704. */
  105705. invertRefractionY: boolean;
  105706. /**
  105707. * Defines the alpha limits in alpha test mode.
  105708. */
  105709. alphaCutOff: number;
  105710. private _useLightmapAsShadowmap;
  105711. /**
  105712. * In case of light mapping, define whether the map contains light or shadow informations.
  105713. */
  105714. useLightmapAsShadowmap: boolean;
  105715. private _diffuseFresnelParameters;
  105716. /**
  105717. * Define the diffuse fresnel parameters of the material.
  105718. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105719. */
  105720. diffuseFresnelParameters: FresnelParameters;
  105721. private _opacityFresnelParameters;
  105722. /**
  105723. * Define the opacity fresnel parameters of the material.
  105724. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105725. */
  105726. opacityFresnelParameters: FresnelParameters;
  105727. private _reflectionFresnelParameters;
  105728. /**
  105729. * Define the reflection fresnel parameters of the material.
  105730. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105731. */
  105732. reflectionFresnelParameters: FresnelParameters;
  105733. private _refractionFresnelParameters;
  105734. /**
  105735. * Define the refraction fresnel parameters of the material.
  105736. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105737. */
  105738. refractionFresnelParameters: FresnelParameters;
  105739. private _emissiveFresnelParameters;
  105740. /**
  105741. * Define the emissive fresnel parameters of the material.
  105742. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105743. */
  105744. emissiveFresnelParameters: FresnelParameters;
  105745. private _useReflectionFresnelFromSpecular;
  105746. /**
  105747. * If true automatically deducts the fresnels values from the material specularity.
  105748. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  105749. */
  105750. useReflectionFresnelFromSpecular: boolean;
  105751. private _useGlossinessFromSpecularMapAlpha;
  105752. /**
  105753. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  105754. */
  105755. useGlossinessFromSpecularMapAlpha: boolean;
  105756. private _maxSimultaneousLights;
  105757. /**
  105758. * Defines the maximum number of lights that can be used in the material
  105759. */
  105760. maxSimultaneousLights: number;
  105761. private _invertNormalMapX;
  105762. /**
  105763. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  105764. */
  105765. invertNormalMapX: boolean;
  105766. private _invertNormalMapY;
  105767. /**
  105768. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  105769. */
  105770. invertNormalMapY: boolean;
  105771. private _twoSidedLighting;
  105772. /**
  105773. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  105774. */
  105775. twoSidedLighting: boolean;
  105776. /**
  105777. * Default configuration related to image processing available in the standard Material.
  105778. */
  105779. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  105780. /**
  105781. * Gets the image processing configuration used either in this material.
  105782. */
  105783. /**
  105784. * Sets the Default image processing configuration used either in the this material.
  105785. *
  105786. * If sets to null, the scene one is in use.
  105787. */
  105788. imageProcessingConfiguration: ImageProcessingConfiguration;
  105789. /**
  105790. * Keep track of the image processing observer to allow dispose and replace.
  105791. */
  105792. private _imageProcessingObserver;
  105793. /**
  105794. * Attaches a new image processing configuration to the Standard Material.
  105795. * @param configuration
  105796. */
  105797. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  105798. /**
  105799. * Gets wether the color curves effect is enabled.
  105800. */
  105801. /**
  105802. * Sets wether the color curves effect is enabled.
  105803. */
  105804. cameraColorCurvesEnabled: boolean;
  105805. /**
  105806. * Gets wether the color grading effect is enabled.
  105807. */
  105808. /**
  105809. * Gets wether the color grading effect is enabled.
  105810. */
  105811. cameraColorGradingEnabled: boolean;
  105812. /**
  105813. * Gets wether tonemapping is enabled or not.
  105814. */
  105815. /**
  105816. * Sets wether tonemapping is enabled or not
  105817. */
  105818. cameraToneMappingEnabled: boolean;
  105819. /**
  105820. * The camera exposure used on this material.
  105821. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  105822. * This corresponds to a photographic exposure.
  105823. */
  105824. /**
  105825. * The camera exposure used on this material.
  105826. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  105827. * This corresponds to a photographic exposure.
  105828. */
  105829. cameraExposure: number;
  105830. /**
  105831. * Gets The camera contrast used on this material.
  105832. */
  105833. /**
  105834. * Sets The camera contrast used on this material.
  105835. */
  105836. cameraContrast: number;
  105837. /**
  105838. * Gets the Color Grading 2D Lookup Texture.
  105839. */
  105840. /**
  105841. * Sets the Color Grading 2D Lookup Texture.
  105842. */
  105843. cameraColorGradingTexture: Nullable<BaseTexture>;
  105844. /**
  105845. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  105846. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  105847. * 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;
  105848. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  105849. */
  105850. /**
  105851. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  105852. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  105853. * 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;
  105854. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  105855. */
  105856. cameraColorCurves: Nullable<ColorCurves>;
  105857. /**
  105858. * Custom callback helping to override the default shader used in the material.
  105859. */
  105860. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  105861. protected _renderTargets: SmartArray<RenderTargetTexture>;
  105862. protected _worldViewProjectionMatrix: Matrix;
  105863. protected _globalAmbientColor: Color3;
  105864. protected _useLogarithmicDepth: boolean;
  105865. protected _rebuildInParallel: boolean;
  105866. /**
  105867. * Instantiates a new standard material.
  105868. * This is the default material used in Babylon. It is the best trade off between quality
  105869. * and performances.
  105870. * @see http://doc.babylonjs.com/babylon101/materials
  105871. * @param name Define the name of the material in the scene
  105872. * @param scene Define the scene the material belong to
  105873. */
  105874. constructor(name: string, scene: Scene);
  105875. /**
  105876. * Gets a boolean indicating that current material needs to register RTT
  105877. */
  105878. readonly hasRenderTargetTextures: boolean;
  105879. /**
  105880. * Gets the current class name of the material e.g. "StandardMaterial"
  105881. * Mainly use in serialization.
  105882. * @returns the class name
  105883. */
  105884. getClassName(): string;
  105885. /**
  105886. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  105887. * You can try switching to logarithmic depth.
  105888. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  105889. */
  105890. useLogarithmicDepth: boolean;
  105891. /**
  105892. * Specifies if the material will require alpha blending
  105893. * @returns a boolean specifying if alpha blending is needed
  105894. */
  105895. needAlphaBlending(): boolean;
  105896. /**
  105897. * Specifies if this material should be rendered in alpha test mode
  105898. * @returns a boolean specifying if an alpha test is needed.
  105899. */
  105900. needAlphaTesting(): boolean;
  105901. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  105902. /**
  105903. * Get the texture used for alpha test purpose.
  105904. * @returns the diffuse texture in case of the standard material.
  105905. */
  105906. getAlphaTestTexture(): Nullable<BaseTexture>;
  105907. /**
  105908. * Get if the submesh is ready to be used and all its information available.
  105909. * Child classes can use it to update shaders
  105910. * @param mesh defines the mesh to check
  105911. * @param subMesh defines which submesh to check
  105912. * @param useInstances specifies that instances should be used
  105913. * @returns a boolean indicating that the submesh is ready or not
  105914. */
  105915. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105916. /**
  105917. * Builds the material UBO layouts.
  105918. * Used internally during the effect preparation.
  105919. */
  105920. buildUniformLayout(): void;
  105921. /**
  105922. * Unbinds the material from the mesh
  105923. */
  105924. unbind(): void;
  105925. /**
  105926. * Binds the submesh to this material by preparing the effect and shader to draw
  105927. * @param world defines the world transformation matrix
  105928. * @param mesh defines the mesh containing the submesh
  105929. * @param subMesh defines the submesh to bind the material to
  105930. */
  105931. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  105932. /**
  105933. * Get the list of animatables in the material.
  105934. * @returns the list of animatables object used in the material
  105935. */
  105936. getAnimatables(): IAnimatable[];
  105937. /**
  105938. * Gets the active textures from the material
  105939. * @returns an array of textures
  105940. */
  105941. getActiveTextures(): BaseTexture[];
  105942. /**
  105943. * Specifies if the material uses a texture
  105944. * @param texture defines the texture to check against the material
  105945. * @returns a boolean specifying if the material uses the texture
  105946. */
  105947. hasTexture(texture: BaseTexture): boolean;
  105948. /**
  105949. * Disposes the material
  105950. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  105951. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  105952. */
  105953. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  105954. /**
  105955. * Makes a duplicate of the material, and gives it a new name
  105956. * @param name defines the new name for the duplicated material
  105957. * @returns the cloned material
  105958. */
  105959. clone(name: string): StandardMaterial;
  105960. /**
  105961. * Serializes this material in a JSON representation
  105962. * @returns the serialized material object
  105963. */
  105964. serialize(): any;
  105965. /**
  105966. * Creates a standard material from parsed material data
  105967. * @param source defines the JSON representation of the material
  105968. * @param scene defines the hosting scene
  105969. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  105970. * @returns a new standard material
  105971. */
  105972. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  105973. /**
  105974. * Are diffuse textures enabled in the application.
  105975. */
  105976. static DiffuseTextureEnabled: boolean;
  105977. /**
  105978. * Are ambient textures enabled in the application.
  105979. */
  105980. static AmbientTextureEnabled: boolean;
  105981. /**
  105982. * Are opacity textures enabled in the application.
  105983. */
  105984. static OpacityTextureEnabled: boolean;
  105985. /**
  105986. * Are reflection textures enabled in the application.
  105987. */
  105988. static ReflectionTextureEnabled: boolean;
  105989. /**
  105990. * Are emissive textures enabled in the application.
  105991. */
  105992. static EmissiveTextureEnabled: boolean;
  105993. /**
  105994. * Are specular textures enabled in the application.
  105995. */
  105996. static SpecularTextureEnabled: boolean;
  105997. /**
  105998. * Are bump textures enabled in the application.
  105999. */
  106000. static BumpTextureEnabled: boolean;
  106001. /**
  106002. * Are lightmap textures enabled in the application.
  106003. */
  106004. static LightmapTextureEnabled: boolean;
  106005. /**
  106006. * Are refraction textures enabled in the application.
  106007. */
  106008. static RefractionTextureEnabled: boolean;
  106009. /**
  106010. * Are color grading textures enabled in the application.
  106011. */
  106012. static ColorGradingTextureEnabled: boolean;
  106013. /**
  106014. * Are fresnels enabled in the application.
  106015. */
  106016. static FresnelEnabled: boolean;
  106017. }
  106018. }
  106019. declare module BABYLON {
  106020. /**
  106021. * A class extending Texture allowing drawing on a texture
  106022. * @see http://doc.babylonjs.com/how_to/dynamictexture
  106023. */
  106024. export class DynamicTexture extends Texture {
  106025. private _generateMipMaps;
  106026. private _canvas;
  106027. private _context;
  106028. private _engine;
  106029. /**
  106030. * Creates a DynamicTexture
  106031. * @param name defines the name of the texture
  106032. * @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
  106033. * @param scene defines the scene where you want the texture
  106034. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  106035. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  106036. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  106037. */
  106038. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  106039. /**
  106040. * Get the current class name of the texture useful for serialization or dynamic coding.
  106041. * @returns "DynamicTexture"
  106042. */
  106043. getClassName(): string;
  106044. /**
  106045. * Gets the current state of canRescale
  106046. */
  106047. readonly canRescale: boolean;
  106048. private _recreate;
  106049. /**
  106050. * Scales the texture
  106051. * @param ratio the scale factor to apply to both width and height
  106052. */
  106053. scale(ratio: number): void;
  106054. /**
  106055. * Resizes the texture
  106056. * @param width the new width
  106057. * @param height the new height
  106058. */
  106059. scaleTo(width: number, height: number): void;
  106060. /**
  106061. * Gets the context of the canvas used by the texture
  106062. * @returns the canvas context of the dynamic texture
  106063. */
  106064. getContext(): CanvasRenderingContext2D;
  106065. /**
  106066. * Clears the texture
  106067. */
  106068. clear(): void;
  106069. /**
  106070. * Updates the texture
  106071. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  106072. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  106073. */
  106074. update(invertY?: boolean, premulAlpha?: boolean): void;
  106075. /**
  106076. * Draws text onto the texture
  106077. * @param text defines the text to be drawn
  106078. * @param x defines the placement of the text from the left
  106079. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  106080. * @param font defines the font to be used with font-style, font-size, font-name
  106081. * @param color defines the color used for the text
  106082. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  106083. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  106084. * @param update defines whether texture is immediately update (default is true)
  106085. */
  106086. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  106087. /**
  106088. * Clones the texture
  106089. * @returns the clone of the texture.
  106090. */
  106091. clone(): DynamicTexture;
  106092. /**
  106093. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  106094. * @returns a serialized dynamic texture object
  106095. */
  106096. serialize(): any;
  106097. /** @hidden */
  106098. _rebuild(): void;
  106099. }
  106100. }
  106101. declare module BABYLON {
  106102. /** @hidden */
  106103. export var imageProcessingPixelShader: {
  106104. name: string;
  106105. shader: string;
  106106. };
  106107. }
  106108. declare module BABYLON {
  106109. /**
  106110. * ImageProcessingPostProcess
  106111. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  106112. */
  106113. export class ImageProcessingPostProcess extends PostProcess {
  106114. /**
  106115. * Default configuration related to image processing available in the PBR Material.
  106116. */
  106117. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  106118. /**
  106119. * Gets the image processing configuration used either in this material.
  106120. */
  106121. /**
  106122. * Sets the Default image processing configuration used either in the this material.
  106123. *
  106124. * If sets to null, the scene one is in use.
  106125. */
  106126. imageProcessingConfiguration: ImageProcessingConfiguration;
  106127. /**
  106128. * Keep track of the image processing observer to allow dispose and replace.
  106129. */
  106130. private _imageProcessingObserver;
  106131. /**
  106132. * Attaches a new image processing configuration to the PBR Material.
  106133. * @param configuration
  106134. */
  106135. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  106136. /**
  106137. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  106138. */
  106139. /**
  106140. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  106141. */
  106142. colorCurves: Nullable<ColorCurves>;
  106143. /**
  106144. * Gets wether the color curves effect is enabled.
  106145. */
  106146. /**
  106147. * Sets wether the color curves effect is enabled.
  106148. */
  106149. colorCurvesEnabled: boolean;
  106150. /**
  106151. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  106152. */
  106153. /**
  106154. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  106155. */
  106156. colorGradingTexture: Nullable<BaseTexture>;
  106157. /**
  106158. * Gets wether the color grading effect is enabled.
  106159. */
  106160. /**
  106161. * Gets wether the color grading effect is enabled.
  106162. */
  106163. colorGradingEnabled: boolean;
  106164. /**
  106165. * Gets exposure used in the effect.
  106166. */
  106167. /**
  106168. * Sets exposure used in the effect.
  106169. */
  106170. exposure: number;
  106171. /**
  106172. * Gets wether tonemapping is enabled or not.
  106173. */
  106174. /**
  106175. * Sets wether tonemapping is enabled or not
  106176. */
  106177. toneMappingEnabled: boolean;
  106178. /**
  106179. * Gets the type of tone mapping effect.
  106180. */
  106181. /**
  106182. * Sets the type of tone mapping effect.
  106183. */
  106184. toneMappingType: number;
  106185. /**
  106186. * Gets contrast used in the effect.
  106187. */
  106188. /**
  106189. * Sets contrast used in the effect.
  106190. */
  106191. contrast: number;
  106192. /**
  106193. * Gets Vignette stretch size.
  106194. */
  106195. /**
  106196. * Sets Vignette stretch size.
  106197. */
  106198. vignetteStretch: number;
  106199. /**
  106200. * Gets Vignette centre X Offset.
  106201. */
  106202. /**
  106203. * Sets Vignette centre X Offset.
  106204. */
  106205. vignetteCentreX: number;
  106206. /**
  106207. * Gets Vignette centre Y Offset.
  106208. */
  106209. /**
  106210. * Sets Vignette centre Y Offset.
  106211. */
  106212. vignetteCentreY: number;
  106213. /**
  106214. * Gets Vignette weight or intensity of the vignette effect.
  106215. */
  106216. /**
  106217. * Sets Vignette weight or intensity of the vignette effect.
  106218. */
  106219. vignetteWeight: number;
  106220. /**
  106221. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  106222. * if vignetteEnabled is set to true.
  106223. */
  106224. /**
  106225. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  106226. * if vignetteEnabled is set to true.
  106227. */
  106228. vignetteColor: Color4;
  106229. /**
  106230. * Gets Camera field of view used by the Vignette effect.
  106231. */
  106232. /**
  106233. * Sets Camera field of view used by the Vignette effect.
  106234. */
  106235. vignetteCameraFov: number;
  106236. /**
  106237. * Gets the vignette blend mode allowing different kind of effect.
  106238. */
  106239. /**
  106240. * Sets the vignette blend mode allowing different kind of effect.
  106241. */
  106242. vignetteBlendMode: number;
  106243. /**
  106244. * Gets wether the vignette effect is enabled.
  106245. */
  106246. /**
  106247. * Sets wether the vignette effect is enabled.
  106248. */
  106249. vignetteEnabled: boolean;
  106250. private _fromLinearSpace;
  106251. /**
  106252. * Gets wether the input of the processing is in Gamma or Linear Space.
  106253. */
  106254. /**
  106255. * Sets wether the input of the processing is in Gamma or Linear Space.
  106256. */
  106257. fromLinearSpace: boolean;
  106258. /**
  106259. * Defines cache preventing GC.
  106260. */
  106261. private _defines;
  106262. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  106263. /**
  106264. * "ImageProcessingPostProcess"
  106265. * @returns "ImageProcessingPostProcess"
  106266. */
  106267. getClassName(): string;
  106268. protected _updateParameters(): void;
  106269. dispose(camera?: Camera): void;
  106270. }
  106271. }
  106272. declare module BABYLON {
  106273. /**
  106274. * Class containing static functions to help procedurally build meshes
  106275. */
  106276. export class GroundBuilder {
  106277. /**
  106278. * Creates a ground mesh
  106279. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  106280. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  106281. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  106282. * @param name defines the name of the mesh
  106283. * @param options defines the options used to create the mesh
  106284. * @param scene defines the hosting scene
  106285. * @returns the ground mesh
  106286. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  106287. */
  106288. static CreateGround(name: string, options: {
  106289. width?: number;
  106290. height?: number;
  106291. subdivisions?: number;
  106292. subdivisionsX?: number;
  106293. subdivisionsY?: number;
  106294. updatable?: boolean;
  106295. }, scene: any): Mesh;
  106296. /**
  106297. * Creates a tiled ground mesh
  106298. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  106299. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  106300. * * 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
  106301. * * 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
  106302. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  106303. * @param name defines the name of the mesh
  106304. * @param options defines the options used to create the mesh
  106305. * @param scene defines the hosting scene
  106306. * @returns the tiled ground mesh
  106307. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  106308. */
  106309. static CreateTiledGround(name: string, options: {
  106310. xmin: number;
  106311. zmin: number;
  106312. xmax: number;
  106313. zmax: number;
  106314. subdivisions?: {
  106315. w: number;
  106316. h: number;
  106317. };
  106318. precision?: {
  106319. w: number;
  106320. h: number;
  106321. };
  106322. updatable?: boolean;
  106323. }, scene?: Nullable<Scene>): Mesh;
  106324. /**
  106325. * Creates a ground mesh from a height map
  106326. * * The parameter `url` sets the URL of the height map image resource.
  106327. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  106328. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  106329. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  106330. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  106331. * * 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.
  106332. * * 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).
  106333. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  106334. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  106335. * @param name defines the name of the mesh
  106336. * @param url defines the url to the height map
  106337. * @param options defines the options used to create the mesh
  106338. * @param scene defines the hosting scene
  106339. * @returns the ground mesh
  106340. * @see https://doc.babylonjs.com/babylon101/height_map
  106341. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  106342. */
  106343. static CreateGroundFromHeightMap(name: string, url: string, options: {
  106344. width?: number;
  106345. height?: number;
  106346. subdivisions?: number;
  106347. minHeight?: number;
  106348. maxHeight?: number;
  106349. colorFilter?: Color3;
  106350. alphaFilter?: number;
  106351. updatable?: boolean;
  106352. onReady?: (mesh: GroundMesh) => void;
  106353. }, scene?: Nullable<Scene>): GroundMesh;
  106354. }
  106355. }
  106356. declare module BABYLON {
  106357. /**
  106358. * Class containing static functions to help procedurally build meshes
  106359. */
  106360. export class TorusBuilder {
  106361. /**
  106362. * Creates a torus mesh
  106363. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  106364. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  106365. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  106366. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  106367. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  106368. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  106369. * @param name defines the name of the mesh
  106370. * @param options defines the options used to create the mesh
  106371. * @param scene defines the hosting scene
  106372. * @returns the torus mesh
  106373. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  106374. */
  106375. static CreateTorus(name: string, options: {
  106376. diameter?: number;
  106377. thickness?: number;
  106378. tessellation?: number;
  106379. updatable?: boolean;
  106380. sideOrientation?: number;
  106381. frontUVs?: Vector4;
  106382. backUVs?: Vector4;
  106383. }, scene: any): Mesh;
  106384. }
  106385. }
  106386. declare module BABYLON {
  106387. /**
  106388. * Class containing static functions to help procedurally build meshes
  106389. */
  106390. export class CylinderBuilder {
  106391. /**
  106392. * Creates a cylinder or a cone mesh
  106393. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  106394. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  106395. * * 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.
  106396. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  106397. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  106398. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  106399. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  106400. * * 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).
  106401. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  106402. * * 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).
  106403. * * 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
  106404. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  106405. * * 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
  106406. * * 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.
  106407. * * If `enclose` is false, a ring surface is one element.
  106408. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  106409. * * 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
  106410. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  106411. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  106412. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  106413. * @param name defines the name of the mesh
  106414. * @param options defines the options used to create the mesh
  106415. * @param scene defines the hosting scene
  106416. * @returns the cylinder mesh
  106417. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  106418. */
  106419. static CreateCylinder(name: string, options: {
  106420. height?: number;
  106421. diameterTop?: number;
  106422. diameterBottom?: number;
  106423. diameter?: number;
  106424. tessellation?: number;
  106425. subdivisions?: number;
  106426. arc?: number;
  106427. faceColors?: Color4[];
  106428. faceUV?: Vector4[];
  106429. updatable?: boolean;
  106430. hasRings?: boolean;
  106431. enclose?: boolean;
  106432. cap?: number;
  106433. sideOrientation?: number;
  106434. frontUVs?: Vector4;
  106435. backUVs?: Vector4;
  106436. }, scene: any): Mesh;
  106437. }
  106438. }
  106439. declare module BABYLON {
  106440. /**
  106441. * Options to modify the vr teleportation behavior.
  106442. */
  106443. export interface VRTeleportationOptions {
  106444. /**
  106445. * The name of the mesh which should be used as the teleportation floor. (default: null)
  106446. */
  106447. floorMeshName?: string;
  106448. /**
  106449. * A list of meshes to be used as the teleportation floor. (default: empty)
  106450. */
  106451. floorMeshes?: Mesh[];
  106452. }
  106453. /**
  106454. * Options to modify the vr experience helper's behavior.
  106455. */
  106456. export interface VRExperienceHelperOptions extends WebVROptions {
  106457. /**
  106458. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  106459. */
  106460. createDeviceOrientationCamera?: boolean;
  106461. /**
  106462. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  106463. */
  106464. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  106465. /**
  106466. * Uses the main button on the controller to toggle the laser casted. (default: true)
  106467. */
  106468. laserToggle?: boolean;
  106469. /**
  106470. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  106471. */
  106472. floorMeshes?: Mesh[];
  106473. /**
  106474. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  106475. */
  106476. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  106477. }
  106478. /**
  106479. * Event containing information after VR has been entered
  106480. */
  106481. export class OnAfterEnteringVRObservableEvent {
  106482. /**
  106483. * If entering vr was successful
  106484. */
  106485. success: boolean;
  106486. }
  106487. /**
  106488. * Helps to quickly add VR support to an existing scene.
  106489. * See http://doc.babylonjs.com/how_to/webvr_helper
  106490. */
  106491. export class VRExperienceHelper {
  106492. /** Options to modify the vr experience helper's behavior. */
  106493. webVROptions: VRExperienceHelperOptions;
  106494. private _scene;
  106495. private _position;
  106496. private _btnVR;
  106497. private _btnVRDisplayed;
  106498. private _webVRsupported;
  106499. private _webVRready;
  106500. private _webVRrequesting;
  106501. private _webVRpresenting;
  106502. private _hasEnteredVR;
  106503. private _fullscreenVRpresenting;
  106504. private _canvas;
  106505. private _webVRCamera;
  106506. private _vrDeviceOrientationCamera;
  106507. private _deviceOrientationCamera;
  106508. private _existingCamera;
  106509. private _onKeyDown;
  106510. private _onVrDisplayPresentChange;
  106511. private _onVRDisplayChanged;
  106512. private _onVRRequestPresentStart;
  106513. private _onVRRequestPresentComplete;
  106514. /**
  106515. * 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)
  106516. */
  106517. enableGazeEvenWhenNoPointerLock: boolean;
  106518. /**
  106519. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  106520. */
  106521. exitVROnDoubleTap: boolean;
  106522. /**
  106523. * Observable raised right before entering VR.
  106524. */
  106525. onEnteringVRObservable: Observable<VRExperienceHelper>;
  106526. /**
  106527. * Observable raised when entering VR has completed.
  106528. */
  106529. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  106530. /**
  106531. * Observable raised when exiting VR.
  106532. */
  106533. onExitingVRObservable: Observable<VRExperienceHelper>;
  106534. /**
  106535. * Observable raised when controller mesh is loaded.
  106536. */
  106537. onControllerMeshLoadedObservable: Observable<WebVRController>;
  106538. /** Return this.onEnteringVRObservable
  106539. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  106540. */
  106541. readonly onEnteringVR: Observable<VRExperienceHelper>;
  106542. /** Return this.onExitingVRObservable
  106543. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  106544. */
  106545. readonly onExitingVR: Observable<VRExperienceHelper>;
  106546. /** Return this.onControllerMeshLoadedObservable
  106547. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  106548. */
  106549. readonly onControllerMeshLoaded: Observable<WebVRController>;
  106550. private _rayLength;
  106551. private _useCustomVRButton;
  106552. private _teleportationRequested;
  106553. private _teleportActive;
  106554. private _floorMeshName;
  106555. private _floorMeshesCollection;
  106556. private _rotationAllowed;
  106557. private _teleportBackwardsVector;
  106558. private _teleportationTarget;
  106559. private _isDefaultTeleportationTarget;
  106560. private _postProcessMove;
  106561. private _teleportationFillColor;
  106562. private _teleportationBorderColor;
  106563. private _rotationAngle;
  106564. private _haloCenter;
  106565. private _cameraGazer;
  106566. private _padSensibilityUp;
  106567. private _padSensibilityDown;
  106568. private _leftController;
  106569. private _rightController;
  106570. /**
  106571. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  106572. */
  106573. onNewMeshSelected: Observable<AbstractMesh>;
  106574. /**
  106575. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  106576. * This observable will provide the mesh and the controller used to select the mesh
  106577. */
  106578. onMeshSelectedWithController: Observable<{
  106579. mesh: AbstractMesh;
  106580. controller: WebVRController;
  106581. }>;
  106582. /**
  106583. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  106584. */
  106585. onNewMeshPicked: Observable<PickingInfo>;
  106586. private _circleEase;
  106587. /**
  106588. * Observable raised before camera teleportation
  106589. */
  106590. onBeforeCameraTeleport: Observable<Vector3>;
  106591. /**
  106592. * Observable raised after camera teleportation
  106593. */
  106594. onAfterCameraTeleport: Observable<Vector3>;
  106595. /**
  106596. * Observable raised when current selected mesh gets unselected
  106597. */
  106598. onSelectedMeshUnselected: Observable<AbstractMesh>;
  106599. private _raySelectionPredicate;
  106600. /**
  106601. * To be optionaly changed by user to define custom ray selection
  106602. */
  106603. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  106604. /**
  106605. * To be optionaly changed by user to define custom selection logic (after ray selection)
  106606. */
  106607. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  106608. /**
  106609. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  106610. */
  106611. teleportationEnabled: boolean;
  106612. private _defaultHeight;
  106613. private _teleportationInitialized;
  106614. private _interactionsEnabled;
  106615. private _interactionsRequested;
  106616. private _displayGaze;
  106617. private _displayLaserPointer;
  106618. /**
  106619. * The mesh used to display where the user is going to teleport.
  106620. */
  106621. /**
  106622. * Sets the mesh to be used to display where the user is going to teleport.
  106623. */
  106624. teleportationTarget: Mesh;
  106625. /**
  106626. * 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
  106627. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  106628. * See http://doc.babylonjs.com/resources/baking_transformations
  106629. */
  106630. gazeTrackerMesh: Mesh;
  106631. /**
  106632. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  106633. */
  106634. updateGazeTrackerScale: boolean;
  106635. /**
  106636. * If the gaze trackers color should be updated when selecting meshes
  106637. */
  106638. updateGazeTrackerColor: boolean;
  106639. /**
  106640. * If the controller laser color should be updated when selecting meshes
  106641. */
  106642. updateControllerLaserColor: boolean;
  106643. /**
  106644. * The gaze tracking mesh corresponding to the left controller
  106645. */
  106646. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  106647. /**
  106648. * The gaze tracking mesh corresponding to the right controller
  106649. */
  106650. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  106651. /**
  106652. * If the ray of the gaze should be displayed.
  106653. */
  106654. /**
  106655. * Sets if the ray of the gaze should be displayed.
  106656. */
  106657. displayGaze: boolean;
  106658. /**
  106659. * If the ray of the LaserPointer should be displayed.
  106660. */
  106661. /**
  106662. * Sets if the ray of the LaserPointer should be displayed.
  106663. */
  106664. displayLaserPointer: boolean;
  106665. /**
  106666. * The deviceOrientationCamera used as the camera when not in VR.
  106667. */
  106668. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  106669. /**
  106670. * Based on the current WebVR support, returns the current VR camera used.
  106671. */
  106672. readonly currentVRCamera: Nullable<Camera>;
  106673. /**
  106674. * The webVRCamera which is used when in VR.
  106675. */
  106676. readonly webVRCamera: WebVRFreeCamera;
  106677. /**
  106678. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  106679. */
  106680. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  106681. /**
  106682. * The html button that is used to trigger entering into VR.
  106683. */
  106684. readonly vrButton: Nullable<HTMLButtonElement>;
  106685. private readonly _teleportationRequestInitiated;
  106686. /**
  106687. * Defines wether or not Pointer lock should be requested when switching to
  106688. * full screen.
  106689. */
  106690. requestPointerLockOnFullScreen: boolean;
  106691. /**
  106692. * Instantiates a VRExperienceHelper.
  106693. * Helps to quickly add VR support to an existing scene.
  106694. * @param scene The scene the VRExperienceHelper belongs to.
  106695. * @param webVROptions Options to modify the vr experience helper's behavior.
  106696. */
  106697. constructor(scene: Scene,
  106698. /** Options to modify the vr experience helper's behavior. */
  106699. webVROptions?: VRExperienceHelperOptions);
  106700. private _onDefaultMeshLoaded;
  106701. private _onResize;
  106702. private _onFullscreenChange;
  106703. /**
  106704. * Gets a value indicating if we are currently in VR mode.
  106705. */
  106706. readonly isInVRMode: boolean;
  106707. private onVrDisplayPresentChange;
  106708. private onVRDisplayChanged;
  106709. private moveButtonToBottomRight;
  106710. private displayVRButton;
  106711. private updateButtonVisibility;
  106712. private _cachedAngularSensibility;
  106713. /**
  106714. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  106715. * Otherwise, will use the fullscreen API.
  106716. */
  106717. enterVR(): void;
  106718. /**
  106719. * Attempt to exit VR, or fullscreen.
  106720. */
  106721. exitVR(): void;
  106722. /**
  106723. * The position of the vr experience helper.
  106724. */
  106725. /**
  106726. * Sets the position of the vr experience helper.
  106727. */
  106728. position: Vector3;
  106729. /**
  106730. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  106731. */
  106732. enableInteractions(): void;
  106733. private readonly _noControllerIsActive;
  106734. private beforeRender;
  106735. private _isTeleportationFloor;
  106736. /**
  106737. * Adds a floor mesh to be used for teleportation.
  106738. * @param floorMesh the mesh to be used for teleportation.
  106739. */
  106740. addFloorMesh(floorMesh: Mesh): void;
  106741. /**
  106742. * Removes a floor mesh from being used for teleportation.
  106743. * @param floorMesh the mesh to be removed.
  106744. */
  106745. removeFloorMesh(floorMesh: Mesh): void;
  106746. /**
  106747. * Enables interactions and teleportation using the VR controllers and gaze.
  106748. * @param vrTeleportationOptions options to modify teleportation behavior.
  106749. */
  106750. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  106751. private _onNewGamepadConnected;
  106752. private _tryEnableInteractionOnController;
  106753. private _onNewGamepadDisconnected;
  106754. private _enableInteractionOnController;
  106755. private _checkTeleportWithRay;
  106756. private _checkRotate;
  106757. private _checkTeleportBackwards;
  106758. private _enableTeleportationOnController;
  106759. private _createTeleportationCircles;
  106760. private _displayTeleportationTarget;
  106761. private _hideTeleportationTarget;
  106762. private _rotateCamera;
  106763. private _moveTeleportationSelectorTo;
  106764. private _workingVector;
  106765. private _workingQuaternion;
  106766. private _workingMatrix;
  106767. /**
  106768. * Teleports the users feet to the desired location
  106769. * @param location The location where the user's feet should be placed
  106770. */
  106771. teleportCamera(location: Vector3): void;
  106772. private _convertNormalToDirectionOfRay;
  106773. private _castRayAndSelectObject;
  106774. private _notifySelectedMeshUnselected;
  106775. /**
  106776. * Sets the color of the laser ray from the vr controllers.
  106777. * @param color new color for the ray.
  106778. */
  106779. changeLaserColor(color: Color3): void;
  106780. /**
  106781. * Sets the color of the ray from the vr headsets gaze.
  106782. * @param color new color for the ray.
  106783. */
  106784. changeGazeColor(color: Color3): void;
  106785. /**
  106786. * Exits VR and disposes of the vr experience helper
  106787. */
  106788. dispose(): void;
  106789. /**
  106790. * Gets the name of the VRExperienceHelper class
  106791. * @returns "VRExperienceHelper"
  106792. */
  106793. getClassName(): string;
  106794. }
  106795. }
  106796. declare module BABYLON {
  106797. /**
  106798. * Manages an XRSession to work with Babylon's engine
  106799. * @see https://doc.babylonjs.com/how_to/webxr
  106800. */
  106801. export class WebXRSessionManager implements IDisposable {
  106802. private scene;
  106803. /**
  106804. * Fires every time a new xrFrame arrives which can be used to update the camera
  106805. */
  106806. onXRFrameObservable: Observable<any>;
  106807. /**
  106808. * Fires when the xr session is ended either by the device or manually done
  106809. */
  106810. onXRSessionEnded: Observable<any>;
  106811. /**
  106812. * Underlying xr session
  106813. */
  106814. session: XRSession;
  106815. /**
  106816. * Type of reference space used when creating the session
  106817. */
  106818. referenceSpace: XRReferenceSpace;
  106819. /** @hidden */
  106820. _sessionRenderTargetTexture: Nullable<RenderTargetTexture>;
  106821. /**
  106822. * Current XR frame
  106823. */
  106824. currentFrame: Nullable<XRFrame>;
  106825. private _xrNavigator;
  106826. private baseLayer;
  106827. /**
  106828. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  106829. * @param scene The scene which the session should be created for
  106830. */
  106831. constructor(scene: Scene);
  106832. /**
  106833. * Initializes the manager
  106834. * After initialization enterXR can be called to start an XR session
  106835. * @returns Promise which resolves after it is initialized
  106836. */
  106837. initializeAsync(): Promise<void>;
  106838. /**
  106839. * Initializes an xr session
  106840. * @param xrSessionMode mode to initialize
  106841. * @returns a promise which will resolve once the session has been initialized
  106842. */
  106843. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  106844. /**
  106845. * Sets the reference space on the xr session
  106846. * @param referenceSpace space to set
  106847. * @returns a promise that will resolve once the reference space has been set
  106848. */
  106849. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  106850. /**
  106851. * Updates the render state of the session
  106852. * @param state state to set
  106853. * @returns a promise that resolves once the render state has been updated
  106854. */
  106855. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  106856. /**
  106857. * Starts rendering to the xr layer
  106858. * @returns a promise that will resolve once rendering has started
  106859. */
  106860. startRenderingToXRAsync(): Promise<void>;
  106861. /**
  106862. * Stops the xrSession and restores the renderloop
  106863. * @returns Promise which resolves after it exits XR
  106864. */
  106865. exitXRAsync(): Promise<unknown>;
  106866. /**
  106867. * Checks if a session would be supported for the creation options specified
  106868. * @param sessionMode session mode to check if supported eg. immersive-vr
  106869. * @returns true if supported
  106870. */
  106871. supportsSessionAsync(sessionMode: XRSessionMode): any;
  106872. /**
  106873. * @hidden
  106874. * Converts the render layer of xrSession to a render target
  106875. * @param session session to create render target for
  106876. * @param scene scene the new render target should be created for
  106877. */
  106878. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  106879. /**
  106880. * Disposes of the session manager
  106881. */
  106882. dispose(): void;
  106883. }
  106884. }
  106885. declare module BABYLON {
  106886. /**
  106887. * WebXR Camera which holds the views for the xrSession
  106888. * @see https://doc.babylonjs.com/how_to/webxr
  106889. */
  106890. export class WebXRCamera extends FreeCamera {
  106891. private static _TmpMatrix;
  106892. /**
  106893. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  106894. * @param name the name of the camera
  106895. * @param scene the scene to add the camera to
  106896. */
  106897. constructor(name: string, scene: Scene);
  106898. private _updateNumberOfRigCameras;
  106899. /** @hidden */
  106900. _updateForDualEyeDebugging(pupilDistance?: number): void;
  106901. /**
  106902. * Updates the cameras position from the current pose information of the XR session
  106903. * @param xrSessionManager the session containing pose information
  106904. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  106905. */
  106906. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  106907. }
  106908. }
  106909. declare module BABYLON {
  106910. /**
  106911. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  106912. */
  106913. export class WebXRManagedOutputCanvas implements IDisposable {
  106914. private helper;
  106915. private _canvas;
  106916. /**
  106917. * xrpresent context of the canvas which can be used to display/mirror xr content
  106918. */
  106919. canvasContext: WebGLRenderingContext;
  106920. /**
  106921. * xr layer for the canvas
  106922. */
  106923. xrLayer: Nullable<XRWebGLLayer>;
  106924. /**
  106925. * Initializes the xr layer for the session
  106926. * @param xrSession xr session
  106927. * @returns a promise that will resolve once the XR Layer has been created
  106928. */
  106929. initializeXRLayerAsync(xrSession: any): any;
  106930. /**
  106931. * Initializes the canvas to be added/removed upon entering/exiting xr
  106932. * @param helper the xr experience helper used to trigger adding/removing of the canvas
  106933. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  106934. */
  106935. constructor(helper: WebXRExperienceHelper, canvas?: HTMLCanvasElement);
  106936. /**
  106937. * Disposes of the object
  106938. */
  106939. dispose(): void;
  106940. private _setManagedOutputCanvas;
  106941. private _addCanvas;
  106942. private _removeCanvas;
  106943. }
  106944. }
  106945. declare module BABYLON {
  106946. /**
  106947. * States of the webXR experience
  106948. */
  106949. export enum WebXRState {
  106950. /**
  106951. * Transitioning to being in XR mode
  106952. */
  106953. ENTERING_XR = 0,
  106954. /**
  106955. * Transitioning to non XR mode
  106956. */
  106957. EXITING_XR = 1,
  106958. /**
  106959. * In XR mode and presenting
  106960. */
  106961. IN_XR = 2,
  106962. /**
  106963. * Not entered XR mode
  106964. */
  106965. NOT_IN_XR = 3
  106966. }
  106967. /**
  106968. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  106969. * @see https://doc.babylonjs.com/how_to/webxr
  106970. */
  106971. export class WebXRExperienceHelper implements IDisposable {
  106972. private scene;
  106973. /**
  106974. * 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
  106975. */
  106976. container: AbstractMesh;
  106977. /**
  106978. * Camera used to render xr content
  106979. */
  106980. camera: WebXRCamera;
  106981. /**
  106982. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  106983. */
  106984. state: WebXRState;
  106985. private _setState;
  106986. private static _TmpVector;
  106987. /**
  106988. * Fires when the state of the experience helper has changed
  106989. */
  106990. onStateChangedObservable: Observable<WebXRState>;
  106991. /** Session manager used to keep track of xr session */
  106992. sessionManager: WebXRSessionManager;
  106993. private _nonVRCamera;
  106994. private _originalSceneAutoClear;
  106995. private _supported;
  106996. /**
  106997. * Creates the experience helper
  106998. * @param scene the scene to attach the experience helper to
  106999. * @returns a promise for the experience helper
  107000. */
  107001. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  107002. /**
  107003. * Creates a WebXRExperienceHelper
  107004. * @param scene The scene the helper should be created in
  107005. */
  107006. private constructor();
  107007. /**
  107008. * Exits XR mode and returns the scene to its original state
  107009. * @returns promise that resolves after xr mode has exited
  107010. */
  107011. exitXRAsync(): Promise<unknown>;
  107012. /**
  107013. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  107014. * @param sessionCreationOptions options for the XR session
  107015. * @param referenceSpaceType frame of reference of the XR session
  107016. * @param outputCanvas the output canvas that will be used to enter XR mode
  107017. * @returns promise that resolves after xr mode has entered
  107018. */
  107019. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, outputCanvas: WebXRManagedOutputCanvas): any;
  107020. /**
  107021. * Updates the global position of the camera by moving the camera's container
  107022. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  107023. * @param position The desired global position of the camera
  107024. */
  107025. setPositionOfCameraUsingContainer(position: Vector3): void;
  107026. /**
  107027. * Rotates the xr camera by rotating the camera's container around the camera's position
  107028. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  107029. * @param rotation the desired quaternion rotation to apply to the camera
  107030. */
  107031. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  107032. /**
  107033. * Disposes of the experience helper
  107034. */
  107035. dispose(): void;
  107036. }
  107037. }
  107038. declare module BABYLON {
  107039. /**
  107040. * Button which can be used to enter a different mode of XR
  107041. */
  107042. export class WebXREnterExitUIButton {
  107043. /** button element */
  107044. element: HTMLElement;
  107045. /** XR initialization options for the button */
  107046. sessionMode: XRSessionMode;
  107047. /** Reference space type */
  107048. referenceSpaceType: XRReferenceSpaceType;
  107049. /**
  107050. * Creates a WebXREnterExitUIButton
  107051. * @param element button element
  107052. * @param sessionMode XR initialization session mode
  107053. * @param referenceSpaceType the type of reference space to be used
  107054. */
  107055. constructor(
  107056. /** button element */
  107057. element: HTMLElement,
  107058. /** XR initialization options for the button */
  107059. sessionMode: XRSessionMode,
  107060. /** Reference space type */
  107061. referenceSpaceType: XRReferenceSpaceType);
  107062. /**
  107063. * Overwritable function which can be used to update the button's visuals when the state changes
  107064. * @param activeButton the current active button in the UI
  107065. */
  107066. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  107067. }
  107068. /**
  107069. * Options to create the webXR UI
  107070. */
  107071. export class WebXREnterExitUIOptions {
  107072. /**
  107073. * Context to enter xr with
  107074. */
  107075. webXRManagedOutputCanvas?: Nullable<WebXRManagedOutputCanvas>;
  107076. /**
  107077. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  107078. */
  107079. customButtons?: Array<WebXREnterExitUIButton>;
  107080. }
  107081. /**
  107082. * UI to allow the user to enter/exit XR mode
  107083. */
  107084. export class WebXREnterExitUI implements IDisposable {
  107085. private scene;
  107086. private _overlay;
  107087. private _buttons;
  107088. private _activeButton;
  107089. /**
  107090. * Fired every time the active button is changed.
  107091. *
  107092. * When xr is entered via a button that launches xr that button will be the callback parameter
  107093. *
  107094. * When exiting xr the callback parameter will be null)
  107095. */
  107096. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  107097. /**
  107098. * Creates UI to allow the user to enter/exit XR mode
  107099. * @param scene the scene to add the ui to
  107100. * @param helper the xr experience helper to enter/exit xr with
  107101. * @param options options to configure the UI
  107102. * @returns the created ui
  107103. */
  107104. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  107105. private constructor();
  107106. private _updateButtons;
  107107. /**
  107108. * Disposes of the object
  107109. */
  107110. dispose(): void;
  107111. }
  107112. }
  107113. declare module BABYLON {
  107114. /**
  107115. * Represents an XR input
  107116. */
  107117. export class WebXRController {
  107118. private scene;
  107119. /** The underlying input source for the controller */
  107120. inputSource: XRInputSource;
  107121. private parentContainer;
  107122. /**
  107123. * 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
  107124. */
  107125. grip?: AbstractMesh;
  107126. /**
  107127. * Pointer which can be used to select objects or attach a visible laser to
  107128. */
  107129. pointer: AbstractMesh;
  107130. /**
  107131. * Event that fires when the controller is removed/disposed
  107132. */
  107133. onDisposeObservable: Observable<{}>;
  107134. private _tmpMatrix;
  107135. private _tmpQuaternion;
  107136. private _tmpVector;
  107137. /**
  107138. * Creates the controller
  107139. * @see https://doc.babylonjs.com/how_to/webxr
  107140. * @param scene the scene which the controller should be associated to
  107141. * @param inputSource the underlying input source for the controller
  107142. * @param parentContainer parent that the controller meshes should be children of
  107143. */
  107144. constructor(scene: Scene,
  107145. /** The underlying input source for the controller */
  107146. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  107147. /**
  107148. * Updates the controller pose based on the given XRFrame
  107149. * @param xrFrame xr frame to update the pose with
  107150. * @param referenceSpace reference space to use
  107151. */
  107152. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  107153. /**
  107154. * Gets a world space ray coming from the controller
  107155. * @param result the resulting ray
  107156. */
  107157. getWorldPointerRayToRef(result: Ray): void;
  107158. /**
  107159. * Disposes of the object
  107160. */
  107161. dispose(): void;
  107162. }
  107163. }
  107164. declare module BABYLON {
  107165. /**
  107166. * XR input used to track XR inputs such as controllers/rays
  107167. */
  107168. export class WebXRInput implements IDisposable {
  107169. /**
  107170. * Base experience the input listens to
  107171. */
  107172. baseExperience: WebXRExperienceHelper;
  107173. /**
  107174. * XR controllers being tracked
  107175. */
  107176. controllers: Array<WebXRController>;
  107177. private _frameObserver;
  107178. private _stateObserver;
  107179. /**
  107180. * Event when a controller has been connected/added
  107181. */
  107182. onControllerAddedObservable: Observable<WebXRController>;
  107183. /**
  107184. * Event when a controller has been removed/disconnected
  107185. */
  107186. onControllerRemovedObservable: Observable<WebXRController>;
  107187. /**
  107188. * Initializes the WebXRInput
  107189. * @param baseExperience experience helper which the input should be created for
  107190. */
  107191. constructor(
  107192. /**
  107193. * Base experience the input listens to
  107194. */
  107195. baseExperience: WebXRExperienceHelper);
  107196. private _onInputSourcesChange;
  107197. private _addAndRemoveControllers;
  107198. /**
  107199. * Disposes of the object
  107200. */
  107201. dispose(): void;
  107202. }
  107203. }
  107204. declare module BABYLON {
  107205. /**
  107206. * Enables teleportation
  107207. */
  107208. export class WebXRControllerTeleportation {
  107209. private _teleportationFillColor;
  107210. private _teleportationBorderColor;
  107211. private _tmpRay;
  107212. private _tmpVector;
  107213. /**
  107214. * Creates a WebXRControllerTeleportation
  107215. * @param input input manager to add teleportation to
  107216. * @param floorMeshes floormeshes which can be teleported to
  107217. */
  107218. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  107219. }
  107220. }
  107221. declare module BABYLON {
  107222. /**
  107223. * Handles pointer input automatically for the pointer of XR controllers
  107224. */
  107225. export class WebXRControllerPointerSelection {
  107226. private static _idCounter;
  107227. private _tmpRay;
  107228. /**
  107229. * Creates a WebXRControllerPointerSelection
  107230. * @param input input manager to setup pointer selection
  107231. */
  107232. constructor(input: WebXRInput);
  107233. private _convertNormalToDirectionOfRay;
  107234. private _updatePointerDistance;
  107235. }
  107236. }
  107237. declare module BABYLON {
  107238. /**
  107239. * Class used to represent data loading progression
  107240. */
  107241. export class SceneLoaderProgressEvent {
  107242. /** defines if data length to load can be evaluated */
  107243. readonly lengthComputable: boolean;
  107244. /** defines the loaded data length */
  107245. readonly loaded: number;
  107246. /** defines the data length to load */
  107247. readonly total: number;
  107248. /**
  107249. * Create a new progress event
  107250. * @param lengthComputable defines if data length to load can be evaluated
  107251. * @param loaded defines the loaded data length
  107252. * @param total defines the data length to load
  107253. */
  107254. constructor(
  107255. /** defines if data length to load can be evaluated */
  107256. lengthComputable: boolean,
  107257. /** defines the loaded data length */
  107258. loaded: number,
  107259. /** defines the data length to load */
  107260. total: number);
  107261. /**
  107262. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  107263. * @param event defines the source event
  107264. * @returns a new SceneLoaderProgressEvent
  107265. */
  107266. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  107267. }
  107268. /**
  107269. * Interface used by SceneLoader plugins to define supported file extensions
  107270. */
  107271. export interface ISceneLoaderPluginExtensions {
  107272. /**
  107273. * Defines the list of supported extensions
  107274. */
  107275. [extension: string]: {
  107276. isBinary: boolean;
  107277. };
  107278. }
  107279. /**
  107280. * Interface used by SceneLoader plugin factory
  107281. */
  107282. export interface ISceneLoaderPluginFactory {
  107283. /**
  107284. * Defines the name of the factory
  107285. */
  107286. name: string;
  107287. /**
  107288. * Function called to create a new plugin
  107289. * @return the new plugin
  107290. */
  107291. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  107292. /**
  107293. * Boolean indicating if the plugin can direct load specific data
  107294. */
  107295. canDirectLoad?: (data: string) => boolean;
  107296. }
  107297. /**
  107298. * Interface used to define a SceneLoader plugin
  107299. */
  107300. export interface ISceneLoaderPlugin {
  107301. /**
  107302. * The friendly name of this plugin.
  107303. */
  107304. name: string;
  107305. /**
  107306. * The file extensions supported by this plugin.
  107307. */
  107308. extensions: string | ISceneLoaderPluginExtensions;
  107309. /**
  107310. * Import meshes into a scene.
  107311. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  107312. * @param scene The scene to import into
  107313. * @param data The data to import
  107314. * @param rootUrl The root url for scene and resources
  107315. * @param meshes The meshes array to import into
  107316. * @param particleSystems The particle systems array to import into
  107317. * @param skeletons The skeletons array to import into
  107318. * @param onError The callback when import fails
  107319. * @returns True if successful or false otherwise
  107320. */
  107321. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  107322. /**
  107323. * Load into a scene.
  107324. * @param scene The scene to load into
  107325. * @param data The data to import
  107326. * @param rootUrl The root url for scene and resources
  107327. * @param onError The callback when import fails
  107328. * @returns true if successful or false otherwise
  107329. */
  107330. load(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  107331. /**
  107332. * The callback that returns true if the data can be directly loaded.
  107333. */
  107334. canDirectLoad?: (data: string) => boolean;
  107335. /**
  107336. * The callback that allows custom handling of the root url based on the response url.
  107337. */
  107338. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  107339. /**
  107340. * Load into an asset container.
  107341. * @param scene The scene to load into
  107342. * @param data The data to import
  107343. * @param rootUrl The root url for scene and resources
  107344. * @param onError The callback when import fails
  107345. * @returns The loaded asset container
  107346. */
  107347. loadAssetContainer(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  107348. }
  107349. /**
  107350. * Interface used to define an async SceneLoader plugin
  107351. */
  107352. export interface ISceneLoaderPluginAsync {
  107353. /**
  107354. * The friendly name of this plugin.
  107355. */
  107356. name: string;
  107357. /**
  107358. * The file extensions supported by this plugin.
  107359. */
  107360. extensions: string | ISceneLoaderPluginExtensions;
  107361. /**
  107362. * Import meshes into a scene.
  107363. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  107364. * @param scene The scene to import into
  107365. * @param data The data to import
  107366. * @param rootUrl The root url for scene and resources
  107367. * @param onProgress The callback when the load progresses
  107368. * @param fileName Defines the name of the file to load
  107369. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  107370. */
  107371. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  107372. meshes: AbstractMesh[];
  107373. particleSystems: IParticleSystem[];
  107374. skeletons: Skeleton[];
  107375. animationGroups: AnimationGroup[];
  107376. }>;
  107377. /**
  107378. * Load into a scene.
  107379. * @param scene The scene to load into
  107380. * @param data The data to import
  107381. * @param rootUrl The root url for scene and resources
  107382. * @param onProgress The callback when the load progresses
  107383. * @param fileName Defines the name of the file to load
  107384. * @returns Nothing
  107385. */
  107386. loadAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  107387. /**
  107388. * The callback that returns true if the data can be directly loaded.
  107389. */
  107390. canDirectLoad?: (data: string) => boolean;
  107391. /**
  107392. * The callback that allows custom handling of the root url based on the response url.
  107393. */
  107394. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  107395. /**
  107396. * Load into an asset container.
  107397. * @param scene The scene to load into
  107398. * @param data The data to import
  107399. * @param rootUrl The root url for scene and resources
  107400. * @param onProgress The callback when the load progresses
  107401. * @param fileName Defines the name of the file to load
  107402. * @returns The loaded asset container
  107403. */
  107404. loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  107405. }
  107406. /**
  107407. * Class used to load scene from various file formats using registered plugins
  107408. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  107409. */
  107410. export class SceneLoader {
  107411. /**
  107412. * No logging while loading
  107413. */
  107414. static readonly NO_LOGGING: number;
  107415. /**
  107416. * Minimal logging while loading
  107417. */
  107418. static readonly MINIMAL_LOGGING: number;
  107419. /**
  107420. * Summary logging while loading
  107421. */
  107422. static readonly SUMMARY_LOGGING: number;
  107423. /**
  107424. * Detailled logging while loading
  107425. */
  107426. static readonly DETAILED_LOGGING: number;
  107427. /**
  107428. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  107429. */
  107430. static ForceFullSceneLoadingForIncremental: boolean;
  107431. /**
  107432. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  107433. */
  107434. static ShowLoadingScreen: boolean;
  107435. /**
  107436. * Defines the current logging level (while loading the scene)
  107437. * @ignorenaming
  107438. */
  107439. static loggingLevel: number;
  107440. /**
  107441. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  107442. */
  107443. static CleanBoneMatrixWeights: boolean;
  107444. /**
  107445. * Event raised when a plugin is used to load a scene
  107446. */
  107447. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  107448. private static _registeredPlugins;
  107449. private static _getDefaultPlugin;
  107450. private static _getPluginForExtension;
  107451. private static _getPluginForDirectLoad;
  107452. private static _getPluginForFilename;
  107453. private static _getDirectLoad;
  107454. private static _loadData;
  107455. private static _getFileInfo;
  107456. /**
  107457. * Gets a plugin that can load the given extension
  107458. * @param extension defines the extension to load
  107459. * @returns a plugin or null if none works
  107460. */
  107461. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  107462. /**
  107463. * Gets a boolean indicating that the given extension can be loaded
  107464. * @param extension defines the extension to load
  107465. * @returns true if the extension is supported
  107466. */
  107467. static IsPluginForExtensionAvailable(extension: string): boolean;
  107468. /**
  107469. * Adds a new plugin to the list of registered plugins
  107470. * @param plugin defines the plugin to add
  107471. */
  107472. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  107473. /**
  107474. * Import meshes into a scene
  107475. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  107476. * @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)
  107477. * @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)
  107478. * @param scene the instance of BABYLON.Scene to append to
  107479. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  107480. * @param onProgress a callback with a progress event for each file being loaded
  107481. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  107482. * @param pluginExtension the extension used to determine the plugin
  107483. * @returns The loaded plugin
  107484. */
  107485. 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>;
  107486. /**
  107487. * Import meshes into a scene
  107488. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  107489. * @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)
  107490. * @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)
  107491. * @param scene the instance of BABYLON.Scene to append to
  107492. * @param onProgress a callback with a progress event for each file being loaded
  107493. * @param pluginExtension the extension used to determine the plugin
  107494. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  107495. */
  107496. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  107497. meshes: AbstractMesh[];
  107498. particleSystems: IParticleSystem[];
  107499. skeletons: Skeleton[];
  107500. animationGroups: AnimationGroup[];
  107501. }>;
  107502. /**
  107503. * Load a scene
  107504. * @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)
  107505. * @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)
  107506. * @param engine is the instance of BABYLON.Engine to use to create the scene
  107507. * @param onSuccess a callback with the scene when import succeeds
  107508. * @param onProgress a callback with a progress event for each file being loaded
  107509. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  107510. * @param pluginExtension the extension used to determine the plugin
  107511. * @returns The loaded plugin
  107512. */
  107513. 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>;
  107514. /**
  107515. * Load a scene
  107516. * @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)
  107517. * @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)
  107518. * @param engine is the instance of BABYLON.Engine to use to create the scene
  107519. * @param onProgress a callback with a progress event for each file being loaded
  107520. * @param pluginExtension the extension used to determine the plugin
  107521. * @returns The loaded scene
  107522. */
  107523. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  107524. /**
  107525. * Append a scene
  107526. * @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)
  107527. * @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)
  107528. * @param scene is the instance of BABYLON.Scene to append to
  107529. * @param onSuccess a callback with the scene when import succeeds
  107530. * @param onProgress a callback with a progress event for each file being loaded
  107531. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  107532. * @param pluginExtension the extension used to determine the plugin
  107533. * @returns The loaded plugin
  107534. */
  107535. 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>;
  107536. /**
  107537. * Append a scene
  107538. * @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)
  107539. * @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)
  107540. * @param scene is the instance of BABYLON.Scene to append to
  107541. * @param onProgress a callback with a progress event for each file being loaded
  107542. * @param pluginExtension the extension used to determine the plugin
  107543. * @returns The given scene
  107544. */
  107545. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  107546. /**
  107547. * Load a scene into an asset container
  107548. * @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)
  107549. * @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)
  107550. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  107551. * @param onSuccess a callback with the scene when import succeeds
  107552. * @param onProgress a callback with a progress event for each file being loaded
  107553. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  107554. * @param pluginExtension the extension used to determine the plugin
  107555. * @returns The loaded plugin
  107556. */
  107557. 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>;
  107558. /**
  107559. * Load a scene into an asset container
  107560. * @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)
  107561. * @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)
  107562. * @param scene is the instance of Scene to append to
  107563. * @param onProgress a callback with a progress event for each file being loaded
  107564. * @param pluginExtension the extension used to determine the plugin
  107565. * @returns The loaded asset container
  107566. */
  107567. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  107568. }
  107569. }
  107570. declare module BABYLON {
  107571. /**
  107572. * Generic Controller
  107573. */
  107574. export class GenericController extends WebVRController {
  107575. /**
  107576. * Base Url for the controller model.
  107577. */
  107578. static readonly MODEL_BASE_URL: string;
  107579. /**
  107580. * File name for the controller model.
  107581. */
  107582. static readonly MODEL_FILENAME: string;
  107583. /**
  107584. * Creates a new GenericController from a gamepad
  107585. * @param vrGamepad the gamepad that the controller should be created from
  107586. */
  107587. constructor(vrGamepad: any);
  107588. /**
  107589. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  107590. * @param scene scene in which to add meshes
  107591. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  107592. */
  107593. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  107594. /**
  107595. * Called once for each button that changed state since the last frame
  107596. * @param buttonIdx Which button index changed
  107597. * @param state New state of the button
  107598. * @param changes Which properties on the state changed since last frame
  107599. */
  107600. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  107601. }
  107602. }
  107603. declare module BABYLON {
  107604. /**
  107605. * Defines the WindowsMotionController object that the state of the windows motion controller
  107606. */
  107607. export class WindowsMotionController extends WebVRController {
  107608. /**
  107609. * The base url used to load the left and right controller models
  107610. */
  107611. static MODEL_BASE_URL: string;
  107612. /**
  107613. * The name of the left controller model file
  107614. */
  107615. static MODEL_LEFT_FILENAME: string;
  107616. /**
  107617. * The name of the right controller model file
  107618. */
  107619. static MODEL_RIGHT_FILENAME: string;
  107620. /**
  107621. * The controller name prefix for this controller type
  107622. */
  107623. static readonly GAMEPAD_ID_PREFIX: string;
  107624. /**
  107625. * The controller id pattern for this controller type
  107626. */
  107627. private static readonly GAMEPAD_ID_PATTERN;
  107628. private _loadedMeshInfo;
  107629. private readonly _mapping;
  107630. /**
  107631. * Fired when the trackpad on this controller is clicked
  107632. */
  107633. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  107634. /**
  107635. * Fired when the trackpad on this controller is modified
  107636. */
  107637. onTrackpadValuesChangedObservable: Observable<StickValues>;
  107638. /**
  107639. * The current x and y values of this controller's trackpad
  107640. */
  107641. trackpad: StickValues;
  107642. /**
  107643. * Creates a new WindowsMotionController from a gamepad
  107644. * @param vrGamepad the gamepad that the controller should be created from
  107645. */
  107646. constructor(vrGamepad: any);
  107647. /**
  107648. * Fired when the trigger on this controller is modified
  107649. */
  107650. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107651. /**
  107652. * Fired when the menu button on this controller is modified
  107653. */
  107654. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107655. /**
  107656. * Fired when the grip button on this controller is modified
  107657. */
  107658. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107659. /**
  107660. * Fired when the thumbstick button on this controller is modified
  107661. */
  107662. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107663. /**
  107664. * Fired when the touchpad button on this controller is modified
  107665. */
  107666. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107667. /**
  107668. * Fired when the touchpad values on this controller are modified
  107669. */
  107670. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  107671. private _updateTrackpad;
  107672. /**
  107673. * Called once per frame by the engine.
  107674. */
  107675. update(): void;
  107676. /**
  107677. * Called once for each button that changed state since the last frame
  107678. * @param buttonIdx Which button index changed
  107679. * @param state New state of the button
  107680. * @param changes Which properties on the state changed since last frame
  107681. */
  107682. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  107683. /**
  107684. * Moves the buttons on the controller mesh based on their current state
  107685. * @param buttonName the name of the button to move
  107686. * @param buttonValue the value of the button which determines the buttons new position
  107687. */
  107688. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  107689. /**
  107690. * Moves the axis on the controller mesh based on its current state
  107691. * @param axis the index of the axis
  107692. * @param axisValue the value of the axis which determines the meshes new position
  107693. * @hidden
  107694. */
  107695. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  107696. /**
  107697. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  107698. * @param scene scene in which to add meshes
  107699. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  107700. */
  107701. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  107702. /**
  107703. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  107704. * can be transformed by button presses and axes values, based on this._mapping.
  107705. *
  107706. * @param scene scene in which the meshes exist
  107707. * @param meshes list of meshes that make up the controller model to process
  107708. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  107709. */
  107710. private processModel;
  107711. private createMeshInfo;
  107712. /**
  107713. * Gets the ray of the controller in the direction the controller is pointing
  107714. * @param length the length the resulting ray should be
  107715. * @returns a ray in the direction the controller is pointing
  107716. */
  107717. getForwardRay(length?: number): Ray;
  107718. /**
  107719. * Disposes of the controller
  107720. */
  107721. dispose(): void;
  107722. }
  107723. }
  107724. declare module BABYLON {
  107725. /**
  107726. * Oculus Touch Controller
  107727. */
  107728. export class OculusTouchController extends WebVRController {
  107729. /**
  107730. * Base Url for the controller model.
  107731. */
  107732. static MODEL_BASE_URL: string;
  107733. /**
  107734. * File name for the left controller model.
  107735. */
  107736. static MODEL_LEFT_FILENAME: string;
  107737. /**
  107738. * File name for the right controller model.
  107739. */
  107740. static MODEL_RIGHT_FILENAME: string;
  107741. /**
  107742. * Base Url for the Quest controller model.
  107743. */
  107744. static QUEST_MODEL_BASE_URL: string;
  107745. /**
  107746. * @hidden
  107747. * If the controllers are running on a device that needs the updated Quest controller models
  107748. */
  107749. static _IsQuest: boolean;
  107750. /**
  107751. * Fired when the secondary trigger on this controller is modified
  107752. */
  107753. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  107754. /**
  107755. * Fired when the thumb rest on this controller is modified
  107756. */
  107757. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  107758. /**
  107759. * Creates a new OculusTouchController from a gamepad
  107760. * @param vrGamepad the gamepad that the controller should be created from
  107761. */
  107762. constructor(vrGamepad: any);
  107763. /**
  107764. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  107765. * @param scene scene in which to add meshes
  107766. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  107767. */
  107768. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  107769. /**
  107770. * Fired when the A button on this controller is modified
  107771. */
  107772. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107773. /**
  107774. * Fired when the B button on this controller is modified
  107775. */
  107776. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107777. /**
  107778. * Fired when the X button on this controller is modified
  107779. */
  107780. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107781. /**
  107782. * Fired when the Y button on this controller is modified
  107783. */
  107784. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107785. /**
  107786. * Called once for each button that changed state since the last frame
  107787. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  107788. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  107789. * 2) secondary trigger (same)
  107790. * 3) A (right) X (left), touch, pressed = value
  107791. * 4) B / Y
  107792. * 5) thumb rest
  107793. * @param buttonIdx Which button index changed
  107794. * @param state New state of the button
  107795. * @param changes Which properties on the state changed since last frame
  107796. */
  107797. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  107798. }
  107799. }
  107800. declare module BABYLON {
  107801. /**
  107802. * Vive Controller
  107803. */
  107804. export class ViveController extends WebVRController {
  107805. /**
  107806. * Base Url for the controller model.
  107807. */
  107808. static MODEL_BASE_URL: string;
  107809. /**
  107810. * File name for the controller model.
  107811. */
  107812. static MODEL_FILENAME: string;
  107813. /**
  107814. * Creates a new ViveController from a gamepad
  107815. * @param vrGamepad the gamepad that the controller should be created from
  107816. */
  107817. constructor(vrGamepad: any);
  107818. /**
  107819. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  107820. * @param scene scene in which to add meshes
  107821. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  107822. */
  107823. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  107824. /**
  107825. * Fired when the left button on this controller is modified
  107826. */
  107827. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107828. /**
  107829. * Fired when the right button on this controller is modified
  107830. */
  107831. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107832. /**
  107833. * Fired when the menu button on this controller is modified
  107834. */
  107835. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  107836. /**
  107837. * Called once for each button that changed state since the last frame
  107838. * Vive mapping:
  107839. * 0: touchpad
  107840. * 1: trigger
  107841. * 2: left AND right buttons
  107842. * 3: menu button
  107843. * @param buttonIdx Which button index changed
  107844. * @param state New state of the button
  107845. * @param changes Which properties on the state changed since last frame
  107846. */
  107847. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  107848. }
  107849. }
  107850. declare module BABYLON {
  107851. /**
  107852. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  107853. */
  107854. export class WebXRControllerModelLoader {
  107855. /**
  107856. * Creates the WebXRControllerModelLoader
  107857. * @param input xr input that creates the controllers
  107858. */
  107859. constructor(input: WebXRInput);
  107860. }
  107861. }
  107862. declare module BABYLON {
  107863. /**
  107864. * Contains an array of blocks representing the octree
  107865. */
  107866. export interface IOctreeContainer<T> {
  107867. /**
  107868. * Blocks within the octree
  107869. */
  107870. blocks: Array<OctreeBlock<T>>;
  107871. }
  107872. /**
  107873. * Class used to store a cell in an octree
  107874. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  107875. */
  107876. export class OctreeBlock<T> {
  107877. /**
  107878. * Gets the content of the current block
  107879. */
  107880. entries: T[];
  107881. /**
  107882. * Gets the list of block children
  107883. */
  107884. blocks: Array<OctreeBlock<T>>;
  107885. private _depth;
  107886. private _maxDepth;
  107887. private _capacity;
  107888. private _minPoint;
  107889. private _maxPoint;
  107890. private _boundingVectors;
  107891. private _creationFunc;
  107892. /**
  107893. * Creates a new block
  107894. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  107895. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  107896. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  107897. * @param depth defines the current depth of this block in the octree
  107898. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  107899. * @param creationFunc defines a callback to call when an element is added to the block
  107900. */
  107901. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  107902. /**
  107903. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  107904. */
  107905. readonly capacity: number;
  107906. /**
  107907. * Gets the minimum vector (in world space) of the block's bounding box
  107908. */
  107909. readonly minPoint: Vector3;
  107910. /**
  107911. * Gets the maximum vector (in world space) of the block's bounding box
  107912. */
  107913. readonly maxPoint: Vector3;
  107914. /**
  107915. * Add a new element to this block
  107916. * @param entry defines the element to add
  107917. */
  107918. addEntry(entry: T): void;
  107919. /**
  107920. * Remove an element from this block
  107921. * @param entry defines the element to remove
  107922. */
  107923. removeEntry(entry: T): void;
  107924. /**
  107925. * Add an array of elements to this block
  107926. * @param entries defines the array of elements to add
  107927. */
  107928. addEntries(entries: T[]): void;
  107929. /**
  107930. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  107931. * @param frustumPlanes defines the frustum planes to test
  107932. * @param selection defines the array to store current content if selection is positive
  107933. * @param allowDuplicate defines if the selection array can contains duplicated entries
  107934. */
  107935. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  107936. /**
  107937. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  107938. * @param sphereCenter defines the bounding sphere center
  107939. * @param sphereRadius defines the bounding sphere radius
  107940. * @param selection defines the array to store current content if selection is positive
  107941. * @param allowDuplicate defines if the selection array can contains duplicated entries
  107942. */
  107943. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  107944. /**
  107945. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  107946. * @param ray defines the ray to test with
  107947. * @param selection defines the array to store current content if selection is positive
  107948. */
  107949. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  107950. /**
  107951. * Subdivide the content into child blocks (this block will then be empty)
  107952. */
  107953. createInnerBlocks(): void;
  107954. /**
  107955. * @hidden
  107956. */
  107957. 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;
  107958. }
  107959. }
  107960. declare module BABYLON {
  107961. /**
  107962. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  107963. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  107964. */
  107965. export class Octree<T> {
  107966. /** 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.) */
  107967. maxDepth: number;
  107968. /**
  107969. * Blocks within the octree containing objects
  107970. */
  107971. blocks: Array<OctreeBlock<T>>;
  107972. /**
  107973. * Content stored in the octree
  107974. */
  107975. dynamicContent: T[];
  107976. private _maxBlockCapacity;
  107977. private _selectionContent;
  107978. private _creationFunc;
  107979. /**
  107980. * Creates a octree
  107981. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  107982. * @param creationFunc function to be used to instatiate the octree
  107983. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  107984. * @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.)
  107985. */
  107986. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  107987. /** 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.) */
  107988. maxDepth?: number);
  107989. /**
  107990. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  107991. * @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);
  107992. * @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);
  107993. * @param entries meshes to be added to the octree blocks
  107994. */
  107995. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  107996. /**
  107997. * Adds a mesh to the octree
  107998. * @param entry Mesh to add to the octree
  107999. */
  108000. addMesh(entry: T): void;
  108001. /**
  108002. * Remove an element from the octree
  108003. * @param entry defines the element to remove
  108004. */
  108005. removeMesh(entry: T): void;
  108006. /**
  108007. * Selects an array of meshes within the frustum
  108008. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  108009. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  108010. * @returns array of meshes within the frustum
  108011. */
  108012. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  108013. /**
  108014. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  108015. * @param sphereCenter defines the bounding sphere center
  108016. * @param sphereRadius defines the bounding sphere radius
  108017. * @param allowDuplicate defines if the selection array can contains duplicated entries
  108018. * @returns an array of objects that intersect the sphere
  108019. */
  108020. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  108021. /**
  108022. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  108023. * @param ray defines the ray to test with
  108024. * @returns array of intersected objects
  108025. */
  108026. intersectsRay(ray: Ray): SmartArray<T>;
  108027. /**
  108028. * Adds a mesh into the octree block if it intersects the block
  108029. */
  108030. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  108031. /**
  108032. * Adds a submesh into the octree block if it intersects the block
  108033. */
  108034. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  108035. }
  108036. }
  108037. declare module BABYLON {
  108038. interface Scene {
  108039. /**
  108040. * @hidden
  108041. * Backing Filed
  108042. */
  108043. _selectionOctree: Octree<AbstractMesh>;
  108044. /**
  108045. * Gets the octree used to boost mesh selection (picking)
  108046. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  108047. */
  108048. selectionOctree: Octree<AbstractMesh>;
  108049. /**
  108050. * Creates or updates the octree used to boost selection (picking)
  108051. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  108052. * @param maxCapacity defines the maximum capacity per leaf
  108053. * @param maxDepth defines the maximum depth of the octree
  108054. * @returns an octree of AbstractMesh
  108055. */
  108056. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  108057. }
  108058. interface AbstractMesh {
  108059. /**
  108060. * @hidden
  108061. * Backing Field
  108062. */
  108063. _submeshesOctree: Octree<SubMesh>;
  108064. /**
  108065. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  108066. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  108067. * @param maxCapacity defines the maximum size of each block (64 by default)
  108068. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  108069. * @returns the new octree
  108070. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  108071. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  108072. */
  108073. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  108074. }
  108075. /**
  108076. * Defines the octree scene component responsible to manage any octrees
  108077. * in a given scene.
  108078. */
  108079. export class OctreeSceneComponent {
  108080. /**
  108081. * The component name help to identify the component in the list of scene components.
  108082. */
  108083. readonly name: string;
  108084. /**
  108085. * The scene the component belongs to.
  108086. */
  108087. scene: Scene;
  108088. /**
  108089. * Indicates if the meshes have been checked to make sure they are isEnabled()
  108090. */
  108091. readonly checksIsEnabled: boolean;
  108092. /**
  108093. * Creates a new instance of the component for the given scene
  108094. * @param scene Defines the scene to register the component in
  108095. */
  108096. constructor(scene: Scene);
  108097. /**
  108098. * Registers the component in a given scene
  108099. */
  108100. register(): void;
  108101. /**
  108102. * Return the list of active meshes
  108103. * @returns the list of active meshes
  108104. */
  108105. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  108106. /**
  108107. * Return the list of active sub meshes
  108108. * @param mesh The mesh to get the candidates sub meshes from
  108109. * @returns the list of active sub meshes
  108110. */
  108111. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  108112. private _tempRay;
  108113. /**
  108114. * Return the list of sub meshes intersecting with a given local ray
  108115. * @param mesh defines the mesh to find the submesh for
  108116. * @param localRay defines the ray in local space
  108117. * @returns the list of intersecting sub meshes
  108118. */
  108119. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  108120. /**
  108121. * Return the list of sub meshes colliding with a collider
  108122. * @param mesh defines the mesh to find the submesh for
  108123. * @param collider defines the collider to evaluate the collision against
  108124. * @returns the list of colliding sub meshes
  108125. */
  108126. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  108127. /**
  108128. * Rebuilds the elements related to this component in case of
  108129. * context lost for instance.
  108130. */
  108131. rebuild(): void;
  108132. /**
  108133. * Disposes the component and the associated ressources.
  108134. */
  108135. dispose(): void;
  108136. }
  108137. }
  108138. declare module BABYLON {
  108139. /**
  108140. * Renders a layer on top of an existing scene
  108141. */
  108142. export class UtilityLayerRenderer implements IDisposable {
  108143. /** the original scene that will be rendered on top of */
  108144. originalScene: Scene;
  108145. private _pointerCaptures;
  108146. private _lastPointerEvents;
  108147. private static _DefaultUtilityLayer;
  108148. private static _DefaultKeepDepthUtilityLayer;
  108149. private _sharedGizmoLight;
  108150. private _renderCamera;
  108151. /**
  108152. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  108153. * @returns the camera that is used when rendering the utility layer
  108154. */
  108155. getRenderCamera(): Nullable<Camera>;
  108156. /**
  108157. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  108158. * @param cam the camera that should be used when rendering the utility layer
  108159. */
  108160. setRenderCamera(cam: Nullable<Camera>): void;
  108161. /**
  108162. * @hidden
  108163. * Light which used by gizmos to get light shading
  108164. */
  108165. _getSharedGizmoLight(): HemisphericLight;
  108166. /**
  108167. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  108168. */
  108169. pickUtilitySceneFirst: boolean;
  108170. /**
  108171. * 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)
  108172. */
  108173. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  108174. /**
  108175. * 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)
  108176. */
  108177. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  108178. /**
  108179. * The scene that is rendered on top of the original scene
  108180. */
  108181. utilityLayerScene: Scene;
  108182. /**
  108183. * If the utility layer should automatically be rendered on top of existing scene
  108184. */
  108185. shouldRender: boolean;
  108186. /**
  108187. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  108188. */
  108189. onlyCheckPointerDownEvents: boolean;
  108190. /**
  108191. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  108192. */
  108193. processAllEvents: boolean;
  108194. /**
  108195. * Observable raised when the pointer move from the utility layer scene to the main scene
  108196. */
  108197. onPointerOutObservable: Observable<number>;
  108198. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  108199. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  108200. private _afterRenderObserver;
  108201. private _sceneDisposeObserver;
  108202. private _originalPointerObserver;
  108203. /**
  108204. * Instantiates a UtilityLayerRenderer
  108205. * @param originalScene the original scene that will be rendered on top of
  108206. * @param handleEvents boolean indicating if the utility layer should handle events
  108207. */
  108208. constructor(
  108209. /** the original scene that will be rendered on top of */
  108210. originalScene: Scene, handleEvents?: boolean);
  108211. private _notifyObservers;
  108212. /**
  108213. * Renders the utility layers scene on top of the original scene
  108214. */
  108215. render(): void;
  108216. /**
  108217. * Disposes of the renderer
  108218. */
  108219. dispose(): void;
  108220. private _updateCamera;
  108221. }
  108222. }
  108223. declare module BABYLON {
  108224. /**
  108225. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  108226. */
  108227. export class Gizmo implements IDisposable {
  108228. /** The utility layer the gizmo will be added to */
  108229. gizmoLayer: UtilityLayerRenderer;
  108230. /**
  108231. * The root mesh of the gizmo
  108232. */
  108233. _rootMesh: Mesh;
  108234. private _attachedMesh;
  108235. /**
  108236. * Ratio for the scale of the gizmo (Default: 1)
  108237. */
  108238. scaleRatio: number;
  108239. /**
  108240. * If a custom mesh has been set (Default: false)
  108241. */
  108242. protected _customMeshSet: boolean;
  108243. /**
  108244. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  108245. * * When set, interactions will be enabled
  108246. */
  108247. attachedMesh: Nullable<AbstractMesh>;
  108248. /**
  108249. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  108250. * @param mesh The mesh to replace the default mesh of the gizmo
  108251. */
  108252. setCustomMesh(mesh: Mesh): void;
  108253. /**
  108254. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  108255. */
  108256. updateGizmoRotationToMatchAttachedMesh: boolean;
  108257. /**
  108258. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  108259. */
  108260. updateGizmoPositionToMatchAttachedMesh: boolean;
  108261. /**
  108262. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  108263. */
  108264. updateScale: boolean;
  108265. protected _interactionsEnabled: boolean;
  108266. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108267. private _beforeRenderObserver;
  108268. private _tempVector;
  108269. /**
  108270. * Creates a gizmo
  108271. * @param gizmoLayer The utility layer the gizmo will be added to
  108272. */
  108273. constructor(
  108274. /** The utility layer the gizmo will be added to */
  108275. gizmoLayer?: UtilityLayerRenderer);
  108276. /**
  108277. * Updates the gizmo to match the attached mesh's position/rotation
  108278. */
  108279. protected _update(): void;
  108280. /**
  108281. * Disposes of the gizmo
  108282. */
  108283. dispose(): void;
  108284. }
  108285. }
  108286. declare module BABYLON {
  108287. /**
  108288. * Single plane drag gizmo
  108289. */
  108290. export class PlaneDragGizmo extends Gizmo {
  108291. /**
  108292. * Drag behavior responsible for the gizmos dragging interactions
  108293. */
  108294. dragBehavior: PointerDragBehavior;
  108295. private _pointerObserver;
  108296. /**
  108297. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108298. */
  108299. snapDistance: number;
  108300. /**
  108301. * Event that fires each time the gizmo snaps to a new location.
  108302. * * snapDistance is the the change in distance
  108303. */
  108304. onSnapObservable: Observable<{
  108305. snapDistance: number;
  108306. }>;
  108307. private _plane;
  108308. private _coloredMaterial;
  108309. private _hoverMaterial;
  108310. private _isEnabled;
  108311. private _parent;
  108312. /** @hidden */
  108313. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  108314. /** @hidden */
  108315. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  108316. /**
  108317. * Creates a PlaneDragGizmo
  108318. * @param gizmoLayer The utility layer the gizmo will be added to
  108319. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  108320. * @param color The color of the gizmo
  108321. */
  108322. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  108323. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108324. /**
  108325. * If the gizmo is enabled
  108326. */
  108327. isEnabled: boolean;
  108328. /**
  108329. * Disposes of the gizmo
  108330. */
  108331. dispose(): void;
  108332. }
  108333. }
  108334. declare module BABYLON {
  108335. /**
  108336. * Gizmo that enables dragging a mesh along 3 axis
  108337. */
  108338. export class PositionGizmo extends Gizmo {
  108339. /**
  108340. * Internal gizmo used for interactions on the x axis
  108341. */
  108342. xGizmo: AxisDragGizmo;
  108343. /**
  108344. * Internal gizmo used for interactions on the y axis
  108345. */
  108346. yGizmo: AxisDragGizmo;
  108347. /**
  108348. * Internal gizmo used for interactions on the z axis
  108349. */
  108350. zGizmo: AxisDragGizmo;
  108351. /**
  108352. * Internal gizmo used for interactions on the yz plane
  108353. */
  108354. xPlaneGizmo: PlaneDragGizmo;
  108355. /**
  108356. * Internal gizmo used for interactions on the xz plane
  108357. */
  108358. yPlaneGizmo: PlaneDragGizmo;
  108359. /**
  108360. * Internal gizmo used for interactions on the xy plane
  108361. */
  108362. zPlaneGizmo: PlaneDragGizmo;
  108363. /**
  108364. * private variables
  108365. */
  108366. private _meshAttached;
  108367. private _updateGizmoRotationToMatchAttachedMesh;
  108368. private _snapDistance;
  108369. private _scaleRatio;
  108370. /** Fires an event when any of it's sub gizmos are dragged */
  108371. onDragStartObservable: Observable<unknown>;
  108372. /** Fires an event when any of it's sub gizmos are released from dragging */
  108373. onDragEndObservable: Observable<unknown>;
  108374. /**
  108375. * If set to true, planar drag is enabled
  108376. */
  108377. private _planarGizmoEnabled;
  108378. attachedMesh: Nullable<AbstractMesh>;
  108379. /**
  108380. * Creates a PositionGizmo
  108381. * @param gizmoLayer The utility layer the gizmo will be added to
  108382. */
  108383. constructor(gizmoLayer?: UtilityLayerRenderer);
  108384. /**
  108385. * If the planar drag gizmo is enabled
  108386. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  108387. */
  108388. planarGizmoEnabled: boolean;
  108389. updateGizmoRotationToMatchAttachedMesh: boolean;
  108390. /**
  108391. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108392. */
  108393. snapDistance: number;
  108394. /**
  108395. * Ratio for the scale of the gizmo (Default: 1)
  108396. */
  108397. scaleRatio: number;
  108398. /**
  108399. * Disposes of the gizmo
  108400. */
  108401. dispose(): void;
  108402. /**
  108403. * CustomMeshes are not supported by this gizmo
  108404. * @param mesh The mesh to replace the default mesh of the gizmo
  108405. */
  108406. setCustomMesh(mesh: Mesh): void;
  108407. }
  108408. }
  108409. declare module BABYLON {
  108410. /**
  108411. * Single axis drag gizmo
  108412. */
  108413. export class AxisDragGizmo extends Gizmo {
  108414. /**
  108415. * Drag behavior responsible for the gizmos dragging interactions
  108416. */
  108417. dragBehavior: PointerDragBehavior;
  108418. private _pointerObserver;
  108419. /**
  108420. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108421. */
  108422. snapDistance: number;
  108423. /**
  108424. * Event that fires each time the gizmo snaps to a new location.
  108425. * * snapDistance is the the change in distance
  108426. */
  108427. onSnapObservable: Observable<{
  108428. snapDistance: number;
  108429. }>;
  108430. private _isEnabled;
  108431. private _parent;
  108432. private _arrow;
  108433. private _coloredMaterial;
  108434. private _hoverMaterial;
  108435. /** @hidden */
  108436. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  108437. /** @hidden */
  108438. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  108439. /**
  108440. * Creates an AxisDragGizmo
  108441. * @param gizmoLayer The utility layer the gizmo will be added to
  108442. * @param dragAxis The axis which the gizmo will be able to drag on
  108443. * @param color The color of the gizmo
  108444. */
  108445. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  108446. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108447. /**
  108448. * If the gizmo is enabled
  108449. */
  108450. isEnabled: boolean;
  108451. /**
  108452. * Disposes of the gizmo
  108453. */
  108454. dispose(): void;
  108455. }
  108456. }
  108457. declare module BABYLON.Debug {
  108458. /**
  108459. * The Axes viewer will show 3 axes in a specific point in space
  108460. */
  108461. export class AxesViewer {
  108462. private _xAxis;
  108463. private _yAxis;
  108464. private _zAxis;
  108465. private _scaleLinesFactor;
  108466. private _instanced;
  108467. /**
  108468. * Gets the hosting scene
  108469. */
  108470. scene: Scene;
  108471. /**
  108472. * Gets or sets a number used to scale line length
  108473. */
  108474. scaleLines: number;
  108475. /** Gets the node hierarchy used to render x-axis */
  108476. readonly xAxis: TransformNode;
  108477. /** Gets the node hierarchy used to render y-axis */
  108478. readonly yAxis: TransformNode;
  108479. /** Gets the node hierarchy used to render z-axis */
  108480. readonly zAxis: TransformNode;
  108481. /**
  108482. * Creates a new AxesViewer
  108483. * @param scene defines the hosting scene
  108484. * @param scaleLines defines a number used to scale line length (1 by default)
  108485. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  108486. * @param xAxis defines the node hierarchy used to render the x-axis
  108487. * @param yAxis defines the node hierarchy used to render the y-axis
  108488. * @param zAxis defines the node hierarchy used to render the z-axis
  108489. */
  108490. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  108491. /**
  108492. * Force the viewer to update
  108493. * @param position defines the position of the viewer
  108494. * @param xaxis defines the x axis of the viewer
  108495. * @param yaxis defines the y axis of the viewer
  108496. * @param zaxis defines the z axis of the viewer
  108497. */
  108498. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  108499. /**
  108500. * Creates an instance of this axes viewer.
  108501. * @returns a new axes viewer with instanced meshes
  108502. */
  108503. createInstance(): AxesViewer;
  108504. /** Releases resources */
  108505. dispose(): void;
  108506. private static _SetRenderingGroupId;
  108507. }
  108508. }
  108509. declare module BABYLON.Debug {
  108510. /**
  108511. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  108512. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  108513. */
  108514. export class BoneAxesViewer extends AxesViewer {
  108515. /**
  108516. * Gets or sets the target mesh where to display the axes viewer
  108517. */
  108518. mesh: Nullable<Mesh>;
  108519. /**
  108520. * Gets or sets the target bone where to display the axes viewer
  108521. */
  108522. bone: Nullable<Bone>;
  108523. /** Gets current position */
  108524. pos: Vector3;
  108525. /** Gets direction of X axis */
  108526. xaxis: Vector3;
  108527. /** Gets direction of Y axis */
  108528. yaxis: Vector3;
  108529. /** Gets direction of Z axis */
  108530. zaxis: Vector3;
  108531. /**
  108532. * Creates a new BoneAxesViewer
  108533. * @param scene defines the hosting scene
  108534. * @param bone defines the target bone
  108535. * @param mesh defines the target mesh
  108536. * @param scaleLines defines a scaling factor for line length (1 by default)
  108537. */
  108538. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  108539. /**
  108540. * Force the viewer to update
  108541. */
  108542. update(): void;
  108543. /** Releases resources */
  108544. dispose(): void;
  108545. }
  108546. }
  108547. declare module BABYLON {
  108548. /**
  108549. * Interface used to define scene explorer extensibility option
  108550. */
  108551. export interface IExplorerExtensibilityOption {
  108552. /**
  108553. * Define the option label
  108554. */
  108555. label: string;
  108556. /**
  108557. * Defines the action to execute on click
  108558. */
  108559. action: (entity: any) => void;
  108560. }
  108561. /**
  108562. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  108563. */
  108564. export interface IExplorerExtensibilityGroup {
  108565. /**
  108566. * Defines a predicate to test if a given type mut be extended
  108567. */
  108568. predicate: (entity: any) => boolean;
  108569. /**
  108570. * Gets the list of options added to a type
  108571. */
  108572. entries: IExplorerExtensibilityOption[];
  108573. }
  108574. /**
  108575. * Interface used to define the options to use to create the Inspector
  108576. */
  108577. export interface IInspectorOptions {
  108578. /**
  108579. * Display in overlay mode (default: false)
  108580. */
  108581. overlay?: boolean;
  108582. /**
  108583. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  108584. */
  108585. globalRoot?: HTMLElement;
  108586. /**
  108587. * Display the Scene explorer
  108588. */
  108589. showExplorer?: boolean;
  108590. /**
  108591. * Display the property inspector
  108592. */
  108593. showInspector?: boolean;
  108594. /**
  108595. * Display in embed mode (both panes on the right)
  108596. */
  108597. embedMode?: boolean;
  108598. /**
  108599. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  108600. */
  108601. handleResize?: boolean;
  108602. /**
  108603. * Allow the panes to popup (default: true)
  108604. */
  108605. enablePopup?: boolean;
  108606. /**
  108607. * Allow the panes to be closed by users (default: true)
  108608. */
  108609. enableClose?: boolean;
  108610. /**
  108611. * Optional list of extensibility entries
  108612. */
  108613. explorerExtensibility?: IExplorerExtensibilityGroup[];
  108614. /**
  108615. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  108616. */
  108617. inspectorURL?: string;
  108618. }
  108619. interface Scene {
  108620. /**
  108621. * @hidden
  108622. * Backing field
  108623. */
  108624. _debugLayer: DebugLayer;
  108625. /**
  108626. * Gets the debug layer (aka Inspector) associated with the scene
  108627. * @see http://doc.babylonjs.com/features/playground_debuglayer
  108628. */
  108629. debugLayer: DebugLayer;
  108630. }
  108631. /**
  108632. * The debug layer (aka Inspector) is the go to tool in order to better understand
  108633. * what is happening in your scene
  108634. * @see http://doc.babylonjs.com/features/playground_debuglayer
  108635. */
  108636. export class DebugLayer {
  108637. /**
  108638. * Define the url to get the inspector script from.
  108639. * By default it uses the babylonjs CDN.
  108640. * @ignoreNaming
  108641. */
  108642. static InspectorURL: string;
  108643. private _scene;
  108644. private BJSINSPECTOR;
  108645. private _onPropertyChangedObservable?;
  108646. /**
  108647. * Observable triggered when a property is changed through the inspector.
  108648. */
  108649. readonly onPropertyChangedObservable: any;
  108650. /**
  108651. * Instantiates a new debug layer.
  108652. * The debug layer (aka Inspector) is the go to tool in order to better understand
  108653. * what is happening in your scene
  108654. * @see http://doc.babylonjs.com/features/playground_debuglayer
  108655. * @param scene Defines the scene to inspect
  108656. */
  108657. constructor(scene: Scene);
  108658. /** Creates the inspector window. */
  108659. private _createInspector;
  108660. /**
  108661. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  108662. * @param entity defines the entity to select
  108663. * @param lineContainerTitle defines the specific block to highlight
  108664. */
  108665. select(entity: any, lineContainerTitle?: string): void;
  108666. /** Get the inspector from bundle or global */
  108667. private _getGlobalInspector;
  108668. /**
  108669. * Get if the inspector is visible or not.
  108670. * @returns true if visible otherwise, false
  108671. */
  108672. isVisible(): boolean;
  108673. /**
  108674. * Hide the inspector and close its window.
  108675. */
  108676. hide(): void;
  108677. /**
  108678. * Launch the debugLayer.
  108679. * @param config Define the configuration of the inspector
  108680. * @return a promise fulfilled when the debug layer is visible
  108681. */
  108682. show(config?: IInspectorOptions): Promise<DebugLayer>;
  108683. }
  108684. }
  108685. declare module BABYLON {
  108686. /**
  108687. * Class containing static functions to help procedurally build meshes
  108688. */
  108689. export class BoxBuilder {
  108690. /**
  108691. * Creates a box mesh
  108692. * * The parameter `size` sets the size (float) of each box side (default 1)
  108693. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  108694. * * 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)
  108695. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  108696. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108697. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108698. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108699. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  108700. * @param name defines the name of the mesh
  108701. * @param options defines the options used to create the mesh
  108702. * @param scene defines the hosting scene
  108703. * @returns the box mesh
  108704. */
  108705. static CreateBox(name: string, options: {
  108706. size?: number;
  108707. width?: number;
  108708. height?: number;
  108709. depth?: number;
  108710. faceUV?: Vector4[];
  108711. faceColors?: Color4[];
  108712. sideOrientation?: number;
  108713. frontUVs?: Vector4;
  108714. backUVs?: Vector4;
  108715. wrap?: boolean;
  108716. topBaseAt?: number;
  108717. bottomBaseAt?: number;
  108718. updatable?: boolean;
  108719. }, scene?: Nullable<Scene>): Mesh;
  108720. }
  108721. }
  108722. declare module BABYLON {
  108723. /**
  108724. * Class containing static functions to help procedurally build meshes
  108725. */
  108726. export class SphereBuilder {
  108727. /**
  108728. * Creates a sphere mesh
  108729. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  108730. * * 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`)
  108731. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  108732. * * 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
  108733. * * 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)
  108734. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108735. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108736. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108737. * @param name defines the name of the mesh
  108738. * @param options defines the options used to create the mesh
  108739. * @param scene defines the hosting scene
  108740. * @returns the sphere mesh
  108741. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  108742. */
  108743. static CreateSphere(name: string, options: {
  108744. segments?: number;
  108745. diameter?: number;
  108746. diameterX?: number;
  108747. diameterY?: number;
  108748. diameterZ?: number;
  108749. arc?: number;
  108750. slice?: number;
  108751. sideOrientation?: number;
  108752. frontUVs?: Vector4;
  108753. backUVs?: Vector4;
  108754. updatable?: boolean;
  108755. }, scene?: Nullable<Scene>): Mesh;
  108756. }
  108757. }
  108758. declare module BABYLON.Debug {
  108759. /**
  108760. * Used to show the physics impostor around the specific mesh
  108761. */
  108762. export class PhysicsViewer {
  108763. /** @hidden */
  108764. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  108765. /** @hidden */
  108766. protected _meshes: Array<Nullable<AbstractMesh>>;
  108767. /** @hidden */
  108768. protected _scene: Nullable<Scene>;
  108769. /** @hidden */
  108770. protected _numMeshes: number;
  108771. /** @hidden */
  108772. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  108773. private _renderFunction;
  108774. private _utilityLayer;
  108775. private _debugBoxMesh;
  108776. private _debugSphereMesh;
  108777. private _debugCylinderMesh;
  108778. private _debugMaterial;
  108779. private _debugMeshMeshes;
  108780. /**
  108781. * Creates a new PhysicsViewer
  108782. * @param scene defines the hosting scene
  108783. */
  108784. constructor(scene: Scene);
  108785. /** @hidden */
  108786. protected _updateDebugMeshes(): void;
  108787. /**
  108788. * Renders a specified physic impostor
  108789. * @param impostor defines the impostor to render
  108790. * @param targetMesh defines the mesh represented by the impostor
  108791. * @returns the new debug mesh used to render the impostor
  108792. */
  108793. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  108794. /**
  108795. * Hides a specified physic impostor
  108796. * @param impostor defines the impostor to hide
  108797. */
  108798. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  108799. private _getDebugMaterial;
  108800. private _getDebugBoxMesh;
  108801. private _getDebugSphereMesh;
  108802. private _getDebugCylinderMesh;
  108803. private _getDebugMeshMesh;
  108804. private _getDebugMesh;
  108805. /** Releases all resources */
  108806. dispose(): void;
  108807. }
  108808. }
  108809. declare module BABYLON {
  108810. /**
  108811. * Class containing static functions to help procedurally build meshes
  108812. */
  108813. export class LinesBuilder {
  108814. /**
  108815. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  108816. * * 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
  108817. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  108818. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  108819. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  108820. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  108821. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  108822. * * 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
  108823. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  108824. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108825. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  108826. * @param name defines the name of the new line system
  108827. * @param options defines the options used to create the line system
  108828. * @param scene defines the hosting scene
  108829. * @returns a new line system mesh
  108830. */
  108831. static CreateLineSystem(name: string, options: {
  108832. lines: Vector3[][];
  108833. updatable?: boolean;
  108834. instance?: Nullable<LinesMesh>;
  108835. colors?: Nullable<Color4[][]>;
  108836. useVertexAlpha?: boolean;
  108837. }, scene: Nullable<Scene>): LinesMesh;
  108838. /**
  108839. * Creates a line mesh
  108840. * 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
  108841. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  108842. * * The parameter `points` is an array successive Vector3
  108843. * * 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
  108844. * * The optional parameter `colors` is an array of successive Color4, one per line point
  108845. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  108846. * * When updating an instance, remember that only point positions can change, not the number of points
  108847. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108848. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  108849. * @param name defines the name of the new line system
  108850. * @param options defines the options used to create the line system
  108851. * @param scene defines the hosting scene
  108852. * @returns a new line mesh
  108853. */
  108854. static CreateLines(name: string, options: {
  108855. points: Vector3[];
  108856. updatable?: boolean;
  108857. instance?: Nullable<LinesMesh>;
  108858. colors?: Color4[];
  108859. useVertexAlpha?: boolean;
  108860. }, scene?: Nullable<Scene>): LinesMesh;
  108861. /**
  108862. * Creates a dashed line mesh
  108863. * * 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
  108864. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  108865. * * The parameter `points` is an array successive Vector3
  108866. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  108867. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  108868. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108869. * * 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
  108870. * * When updating an instance, remember that only point positions can change, not the number of points
  108871. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108872. * @param name defines the name of the mesh
  108873. * @param options defines the options used to create the mesh
  108874. * @param scene defines the hosting scene
  108875. * @returns the dashed line mesh
  108876. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  108877. */
  108878. static CreateDashedLines(name: string, options: {
  108879. points: Vector3[];
  108880. dashSize?: number;
  108881. gapSize?: number;
  108882. dashNb?: number;
  108883. updatable?: boolean;
  108884. instance?: LinesMesh;
  108885. }, scene?: Nullable<Scene>): LinesMesh;
  108886. }
  108887. }
  108888. declare module BABYLON {
  108889. /**
  108890. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  108891. * in order to better appreciate the issue one might have.
  108892. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  108893. */
  108894. export class RayHelper {
  108895. /**
  108896. * Defines the ray we are currently tryin to visualize.
  108897. */
  108898. ray: Nullable<Ray>;
  108899. private _renderPoints;
  108900. private _renderLine;
  108901. private _renderFunction;
  108902. private _scene;
  108903. private _updateToMeshFunction;
  108904. private _attachedToMesh;
  108905. private _meshSpaceDirection;
  108906. private _meshSpaceOrigin;
  108907. /**
  108908. * Helper function to create a colored helper in a scene in one line.
  108909. * @param ray Defines the ray we are currently tryin to visualize
  108910. * @param scene Defines the scene the ray is used in
  108911. * @param color Defines the color we want to see the ray in
  108912. * @returns The newly created ray helper.
  108913. */
  108914. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  108915. /**
  108916. * Instantiate a new ray helper.
  108917. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  108918. * in order to better appreciate the issue one might have.
  108919. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  108920. * @param ray Defines the ray we are currently tryin to visualize
  108921. */
  108922. constructor(ray: Ray);
  108923. /**
  108924. * Shows the ray we are willing to debug.
  108925. * @param scene Defines the scene the ray needs to be rendered in
  108926. * @param color Defines the color the ray needs to be rendered in
  108927. */
  108928. show(scene: Scene, color?: Color3): void;
  108929. /**
  108930. * Hides the ray we are debugging.
  108931. */
  108932. hide(): void;
  108933. private _render;
  108934. /**
  108935. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  108936. * @param mesh Defines the mesh we want the helper attached to
  108937. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  108938. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  108939. * @param length Defines the length of the ray
  108940. */
  108941. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  108942. /**
  108943. * Detach the ray helper from the mesh it has previously been attached to.
  108944. */
  108945. detachFromMesh(): void;
  108946. private _updateToMesh;
  108947. /**
  108948. * Dispose the helper and release its associated resources.
  108949. */
  108950. dispose(): void;
  108951. }
  108952. }
  108953. declare module BABYLON.Debug {
  108954. /**
  108955. * Class used to render a debug view of a given skeleton
  108956. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  108957. */
  108958. export class SkeletonViewer {
  108959. /** defines the skeleton to render */
  108960. skeleton: Skeleton;
  108961. /** defines the mesh attached to the skeleton */
  108962. mesh: AbstractMesh;
  108963. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  108964. autoUpdateBonesMatrices: boolean;
  108965. /** defines the rendering group id to use with the viewer */
  108966. renderingGroupId: number;
  108967. /** Gets or sets the color used to render the skeleton */
  108968. color: Color3;
  108969. private _scene;
  108970. private _debugLines;
  108971. private _debugMesh;
  108972. private _isEnabled;
  108973. private _renderFunction;
  108974. private _utilityLayer;
  108975. /**
  108976. * Returns the mesh used to render the bones
  108977. */
  108978. readonly debugMesh: Nullable<LinesMesh>;
  108979. /**
  108980. * Creates a new SkeletonViewer
  108981. * @param skeleton defines the skeleton to render
  108982. * @param mesh defines the mesh attached to the skeleton
  108983. * @param scene defines the hosting scene
  108984. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  108985. * @param renderingGroupId defines the rendering group id to use with the viewer
  108986. */
  108987. constructor(
  108988. /** defines the skeleton to render */
  108989. skeleton: Skeleton,
  108990. /** defines the mesh attached to the skeleton */
  108991. mesh: AbstractMesh, scene: Scene,
  108992. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  108993. autoUpdateBonesMatrices?: boolean,
  108994. /** defines the rendering group id to use with the viewer */
  108995. renderingGroupId?: number);
  108996. /** Gets or sets a boolean indicating if the viewer is enabled */
  108997. isEnabled: boolean;
  108998. private _getBonePosition;
  108999. private _getLinesForBonesWithLength;
  109000. private _getLinesForBonesNoLength;
  109001. /** Update the viewer to sync with current skeleton state */
  109002. update(): void;
  109003. /** Release associated resources */
  109004. dispose(): void;
  109005. }
  109006. }
  109007. declare module BABYLON {
  109008. /**
  109009. * Options to create the null engine
  109010. */
  109011. export class NullEngineOptions {
  109012. /**
  109013. * Render width (Default: 512)
  109014. */
  109015. renderWidth: number;
  109016. /**
  109017. * Render height (Default: 256)
  109018. */
  109019. renderHeight: number;
  109020. /**
  109021. * Texture size (Default: 512)
  109022. */
  109023. textureSize: number;
  109024. /**
  109025. * If delta time between frames should be constant
  109026. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  109027. */
  109028. deterministicLockstep: boolean;
  109029. /**
  109030. * Maximum about of steps between frames (Default: 4)
  109031. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  109032. */
  109033. lockstepMaxSteps: number;
  109034. }
  109035. /**
  109036. * The null engine class provides support for headless version of babylon.js.
  109037. * This can be used in server side scenario or for testing purposes
  109038. */
  109039. export class NullEngine extends Engine {
  109040. private _options;
  109041. /**
  109042. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  109043. */
  109044. isDeterministicLockStep(): boolean;
  109045. /** @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep */
  109046. getLockstepMaxSteps(): number;
  109047. /**
  109048. * Sets hardware scaling, used to save performance if needed
  109049. * @see https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  109050. */
  109051. getHardwareScalingLevel(): number;
  109052. constructor(options?: NullEngineOptions);
  109053. createVertexBuffer(vertices: FloatArray): DataBuffer;
  109054. createIndexBuffer(indices: IndicesArray): DataBuffer;
  109055. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  109056. getRenderWidth(useScreen?: boolean): number;
  109057. getRenderHeight(useScreen?: boolean): number;
  109058. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  109059. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  109060. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  109061. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  109062. bindSamplers(effect: Effect): void;
  109063. enableEffect(effect: Effect): void;
  109064. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  109065. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  109066. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  109067. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  109068. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  109069. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  109070. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  109071. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  109072. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  109073. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  109074. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  109075. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  109076. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  109077. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  109078. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  109079. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  109080. setFloat(uniform: WebGLUniformLocation, value: number): void;
  109081. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  109082. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  109083. setBool(uniform: WebGLUniformLocation, bool: number): void;
  109084. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  109085. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  109086. bindBuffers(vertexBuffers: {
  109087. [key: string]: VertexBuffer;
  109088. }, indexBuffer: DataBuffer, effect: Effect): void;
  109089. wipeCaches(bruteForce?: boolean): void;
  109090. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  109091. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  109092. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  109093. /** @hidden */
  109094. _createTexture(): WebGLTexture;
  109095. /** @hidden */
  109096. _releaseTexture(texture: InternalTexture): void;
  109097. 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;
  109098. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  109099. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  109100. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  109101. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  109102. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  109103. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  109104. areAllEffectsReady(): boolean;
  109105. /**
  109106. * @hidden
  109107. * Get the current error code of the webGL context
  109108. * @returns the error code
  109109. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  109110. */
  109111. getError(): number;
  109112. /** @hidden */
  109113. _getUnpackAlignement(): number;
  109114. /** @hidden */
  109115. _unpackFlipY(value: boolean): void;
  109116. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  109117. /**
  109118. * Updates a dynamic vertex buffer.
  109119. * @param vertexBuffer the vertex buffer to update
  109120. * @param data the data used to update the vertex buffer
  109121. * @param byteOffset the byte offset of the data (optional)
  109122. * @param byteLength the byte length of the data (optional)
  109123. */
  109124. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  109125. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  109126. /** @hidden */
  109127. _bindTexture(channel: number, texture: InternalTexture): void;
  109128. protected _deleteBuffer(buffer: WebGLBuffer): void;
  109129. releaseEffects(): void;
  109130. displayLoadingUI(): void;
  109131. hideLoadingUI(): void;
  109132. /** @hidden */
  109133. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109134. /** @hidden */
  109135. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109136. /** @hidden */
  109137. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109138. /** @hidden */
  109139. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  109140. }
  109141. }
  109142. declare module BABYLON {
  109143. /** @hidden */
  109144. export class _OcclusionDataStorage {
  109145. /** @hidden */
  109146. occlusionInternalRetryCounter: number;
  109147. /** @hidden */
  109148. isOcclusionQueryInProgress: boolean;
  109149. /** @hidden */
  109150. isOccluded: boolean;
  109151. /** @hidden */
  109152. occlusionRetryCount: number;
  109153. /** @hidden */
  109154. occlusionType: number;
  109155. /** @hidden */
  109156. occlusionQueryAlgorithmType: number;
  109157. }
  109158. interface Engine {
  109159. /**
  109160. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  109161. * @return the new query
  109162. */
  109163. createQuery(): WebGLQuery;
  109164. /**
  109165. * Delete and release a webGL query
  109166. * @param query defines the query to delete
  109167. * @return the current engine
  109168. */
  109169. deleteQuery(query: WebGLQuery): Engine;
  109170. /**
  109171. * Check if a given query has resolved and got its value
  109172. * @param query defines the query to check
  109173. * @returns true if the query got its value
  109174. */
  109175. isQueryResultAvailable(query: WebGLQuery): boolean;
  109176. /**
  109177. * Gets the value of a given query
  109178. * @param query defines the query to check
  109179. * @returns the value of the query
  109180. */
  109181. getQueryResult(query: WebGLQuery): number;
  109182. /**
  109183. * Initiates an occlusion query
  109184. * @param algorithmType defines the algorithm to use
  109185. * @param query defines the query to use
  109186. * @returns the current engine
  109187. * @see http://doc.babylonjs.com/features/occlusionquery
  109188. */
  109189. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  109190. /**
  109191. * Ends an occlusion query
  109192. * @see http://doc.babylonjs.com/features/occlusionquery
  109193. * @param algorithmType defines the algorithm to use
  109194. * @returns the current engine
  109195. */
  109196. endOcclusionQuery(algorithmType: number): Engine;
  109197. /**
  109198. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  109199. * Please note that only one query can be issued at a time
  109200. * @returns a time token used to track the time span
  109201. */
  109202. startTimeQuery(): Nullable<_TimeToken>;
  109203. /**
  109204. * Ends a time query
  109205. * @param token defines the token used to measure the time span
  109206. * @returns the time spent (in ns)
  109207. */
  109208. endTimeQuery(token: _TimeToken): int;
  109209. /** @hidden */
  109210. _currentNonTimestampToken: Nullable<_TimeToken>;
  109211. /** @hidden */
  109212. _createTimeQuery(): WebGLQuery;
  109213. /** @hidden */
  109214. _deleteTimeQuery(query: WebGLQuery): void;
  109215. /** @hidden */
  109216. _getGlAlgorithmType(algorithmType: number): number;
  109217. /** @hidden */
  109218. _getTimeQueryResult(query: WebGLQuery): any;
  109219. /** @hidden */
  109220. _getTimeQueryAvailability(query: WebGLQuery): any;
  109221. }
  109222. interface AbstractMesh {
  109223. /**
  109224. * Backing filed
  109225. * @hidden
  109226. */
  109227. __occlusionDataStorage: _OcclusionDataStorage;
  109228. /**
  109229. * Access property
  109230. * @hidden
  109231. */
  109232. _occlusionDataStorage: _OcclusionDataStorage;
  109233. /**
  109234. * 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.
  109235. * The default value is -1 which means don't break the query and wait till the result
  109236. * @see http://doc.babylonjs.com/features/occlusionquery
  109237. */
  109238. occlusionRetryCount: number;
  109239. /**
  109240. * 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:
  109241. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  109242. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  109243. * * 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.
  109244. * @see http://doc.babylonjs.com/features/occlusionquery
  109245. */
  109246. occlusionType: number;
  109247. /**
  109248. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  109249. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  109250. * * 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.
  109251. * @see http://doc.babylonjs.com/features/occlusionquery
  109252. */
  109253. occlusionQueryAlgorithmType: number;
  109254. /**
  109255. * 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
  109256. * @see http://doc.babylonjs.com/features/occlusionquery
  109257. */
  109258. isOccluded: boolean;
  109259. /**
  109260. * Flag to check the progress status of the query
  109261. * @see http://doc.babylonjs.com/features/occlusionquery
  109262. */
  109263. isOcclusionQueryInProgress: boolean;
  109264. }
  109265. }
  109266. declare module BABYLON {
  109267. /** @hidden */
  109268. export var _forceTransformFeedbackToBundle: boolean;
  109269. interface Engine {
  109270. /**
  109271. * Creates a webGL transform feedback object
  109272. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  109273. * @returns the webGL transform feedback object
  109274. */
  109275. createTransformFeedback(): WebGLTransformFeedback;
  109276. /**
  109277. * Delete a webGL transform feedback object
  109278. * @param value defines the webGL transform feedback object to delete
  109279. */
  109280. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  109281. /**
  109282. * Bind a webGL transform feedback object to the webgl context
  109283. * @param value defines the webGL transform feedback object to bind
  109284. */
  109285. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  109286. /**
  109287. * Begins a transform feedback operation
  109288. * @param usePoints defines if points or triangles must be used
  109289. */
  109290. beginTransformFeedback(usePoints: boolean): void;
  109291. /**
  109292. * Ends a transform feedback operation
  109293. */
  109294. endTransformFeedback(): void;
  109295. /**
  109296. * Specify the varyings to use with transform feedback
  109297. * @param program defines the associated webGL program
  109298. * @param value defines the list of strings representing the varying names
  109299. */
  109300. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  109301. /**
  109302. * Bind a webGL buffer for a transform feedback operation
  109303. * @param value defines the webGL buffer to bind
  109304. */
  109305. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  109306. }
  109307. }
  109308. declare module BABYLON {
  109309. /**
  109310. * Creation options of the multi render target texture.
  109311. */
  109312. export interface IMultiRenderTargetOptions {
  109313. /**
  109314. * Define if the texture needs to create mip maps after render.
  109315. */
  109316. generateMipMaps?: boolean;
  109317. /**
  109318. * Define the types of all the draw buffers we want to create
  109319. */
  109320. types?: number[];
  109321. /**
  109322. * Define the sampling modes of all the draw buffers we want to create
  109323. */
  109324. samplingModes?: number[];
  109325. /**
  109326. * Define if a depth buffer is required
  109327. */
  109328. generateDepthBuffer?: boolean;
  109329. /**
  109330. * Define if a stencil buffer is required
  109331. */
  109332. generateStencilBuffer?: boolean;
  109333. /**
  109334. * Define if a depth texture is required instead of a depth buffer
  109335. */
  109336. generateDepthTexture?: boolean;
  109337. /**
  109338. * Define the number of desired draw buffers
  109339. */
  109340. textureCount?: number;
  109341. /**
  109342. * Define if aspect ratio should be adapted to the texture or stay the scene one
  109343. */
  109344. doNotChangeAspectRatio?: boolean;
  109345. /**
  109346. * Define the default type of the buffers we are creating
  109347. */
  109348. defaultType?: number;
  109349. }
  109350. /**
  109351. * A multi render target, like a render target provides the ability to render to a texture.
  109352. * Unlike the render target, it can render to several draw buffers in one draw.
  109353. * This is specially interesting in deferred rendering or for any effects requiring more than
  109354. * just one color from a single pass.
  109355. */
  109356. export class MultiRenderTarget extends RenderTargetTexture {
  109357. private _internalTextures;
  109358. private _textures;
  109359. private _multiRenderTargetOptions;
  109360. /**
  109361. * Get if draw buffers are currently supported by the used hardware and browser.
  109362. */
  109363. readonly isSupported: boolean;
  109364. /**
  109365. * Get the list of textures generated by the multi render target.
  109366. */
  109367. readonly textures: Texture[];
  109368. /**
  109369. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  109370. */
  109371. readonly depthTexture: Texture;
  109372. /**
  109373. * Set the wrapping mode on U of all the textures we are rendering to.
  109374. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  109375. */
  109376. wrapU: number;
  109377. /**
  109378. * Set the wrapping mode on V of all the textures we are rendering to.
  109379. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  109380. */
  109381. wrapV: number;
  109382. /**
  109383. * Instantiate a new multi render target texture.
  109384. * A multi render target, like a render target provides the ability to render to a texture.
  109385. * Unlike the render target, it can render to several draw buffers in one draw.
  109386. * This is specially interesting in deferred rendering or for any effects requiring more than
  109387. * just one color from a single pass.
  109388. * @param name Define the name of the texture
  109389. * @param size Define the size of the buffers to render to
  109390. * @param count Define the number of target we are rendering into
  109391. * @param scene Define the scene the texture belongs to
  109392. * @param options Define the options used to create the multi render target
  109393. */
  109394. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  109395. /** @hidden */
  109396. _rebuild(): void;
  109397. private _createInternalTextures;
  109398. private _createTextures;
  109399. /**
  109400. * Define the number of samples used if MSAA is enabled.
  109401. */
  109402. samples: number;
  109403. /**
  109404. * Resize all the textures in the multi render target.
  109405. * Be carrefull as it will recreate all the data in the new texture.
  109406. * @param size Define the new size
  109407. */
  109408. resize(size: any): void;
  109409. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  109410. /**
  109411. * Dispose the render targets and their associated resources
  109412. */
  109413. dispose(): void;
  109414. /**
  109415. * Release all the underlying texture used as draw buffers.
  109416. */
  109417. releaseInternalTextures(): void;
  109418. }
  109419. }
  109420. declare module BABYLON {
  109421. interface Engine {
  109422. /**
  109423. * Unbind a list of render target textures from the webGL context
  109424. * This is used only when drawBuffer extension or webGL2 are active
  109425. * @param textures defines the render target textures to unbind
  109426. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  109427. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  109428. */
  109429. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  109430. /**
  109431. * Create a multi render target texture
  109432. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  109433. * @param size defines the size of the texture
  109434. * @param options defines the creation options
  109435. * @returns the cube texture as an InternalTexture
  109436. */
  109437. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  109438. /**
  109439. * Update the sample count for a given multiple render target texture
  109440. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  109441. * @param textures defines the textures to update
  109442. * @param samples defines the sample count to set
  109443. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  109444. */
  109445. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  109446. }
  109447. }
  109448. declare module BABYLON {
  109449. /** @hidden */
  109450. export var rgbdEncodePixelShader: {
  109451. name: string;
  109452. shader: string;
  109453. };
  109454. }
  109455. declare module BABYLON {
  109456. /** @hidden */
  109457. export var rgbdDecodePixelShader: {
  109458. name: string;
  109459. shader: string;
  109460. };
  109461. }
  109462. declare module BABYLON {
  109463. /**
  109464. * Raw texture data and descriptor sufficient for WebGL texture upload
  109465. */
  109466. export interface EnvironmentTextureInfo {
  109467. /**
  109468. * Version of the environment map
  109469. */
  109470. version: number;
  109471. /**
  109472. * Width of image
  109473. */
  109474. width: number;
  109475. /**
  109476. * Irradiance information stored in the file.
  109477. */
  109478. irradiance: any;
  109479. /**
  109480. * Specular information stored in the file.
  109481. */
  109482. specular: any;
  109483. }
  109484. /**
  109485. * Defines One Image in the file. It requires only the position in the file
  109486. * as well as the length.
  109487. */
  109488. interface BufferImageData {
  109489. /**
  109490. * Length of the image data.
  109491. */
  109492. length: number;
  109493. /**
  109494. * Position of the data from the null terminator delimiting the end of the JSON.
  109495. */
  109496. position: number;
  109497. }
  109498. /**
  109499. * Defines the specular data enclosed in the file.
  109500. * This corresponds to the version 1 of the data.
  109501. */
  109502. export interface EnvironmentTextureSpecularInfoV1 {
  109503. /**
  109504. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  109505. */
  109506. specularDataPosition?: number;
  109507. /**
  109508. * This contains all the images data needed to reconstruct the cubemap.
  109509. */
  109510. mipmaps: Array<BufferImageData>;
  109511. /**
  109512. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  109513. */
  109514. lodGenerationScale: number;
  109515. }
  109516. /**
  109517. * Sets of helpers addressing the serialization and deserialization of environment texture
  109518. * stored in a BabylonJS env file.
  109519. * Those files are usually stored as .env files.
  109520. */
  109521. export class EnvironmentTextureTools {
  109522. /**
  109523. * Magic number identifying the env file.
  109524. */
  109525. private static _MagicBytes;
  109526. /**
  109527. * Gets the environment info from an env file.
  109528. * @param data The array buffer containing the .env bytes.
  109529. * @returns the environment file info (the json header) if successfully parsed.
  109530. */
  109531. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  109532. /**
  109533. * Creates an environment texture from a loaded cube texture.
  109534. * @param texture defines the cube texture to convert in env file
  109535. * @return a promise containing the environment data if succesfull.
  109536. */
  109537. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  109538. /**
  109539. * Creates a JSON representation of the spherical data.
  109540. * @param texture defines the texture containing the polynomials
  109541. * @return the JSON representation of the spherical info
  109542. */
  109543. private static _CreateEnvTextureIrradiance;
  109544. /**
  109545. * Creates the ArrayBufferViews used for initializing environment texture image data.
  109546. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  109547. * @param info parameters that determine what views will be created for accessing the underlying buffer
  109548. * @return the views described by info providing access to the underlying buffer
  109549. */
  109550. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  109551. /**
  109552. * Uploads the texture info contained in the env file to the GPU.
  109553. * @param texture defines the internal texture to upload to
  109554. * @param arrayBuffer defines the buffer cotaining the data to load
  109555. * @param info defines the texture info retrieved through the GetEnvInfo method
  109556. * @returns a promise
  109557. */
  109558. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  109559. /**
  109560. * Uploads the levels of image data to the GPU.
  109561. * @param texture defines the internal texture to upload to
  109562. * @param imageData defines the array buffer views of image data [mipmap][face]
  109563. * @returns a promise
  109564. */
  109565. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  109566. /**
  109567. * Uploads spherical polynomials information to the texture.
  109568. * @param texture defines the texture we are trying to upload the information to
  109569. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  109570. */
  109571. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  109572. /** @hidden */
  109573. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  109574. }
  109575. }
  109576. declare module BABYLON {
  109577. /**
  109578. * Contains position and normal vectors for a vertex
  109579. */
  109580. export class PositionNormalVertex {
  109581. /** the position of the vertex (defaut: 0,0,0) */
  109582. position: Vector3;
  109583. /** the normal of the vertex (defaut: 0,1,0) */
  109584. normal: Vector3;
  109585. /**
  109586. * Creates a PositionNormalVertex
  109587. * @param position the position of the vertex (defaut: 0,0,0)
  109588. * @param normal the normal of the vertex (defaut: 0,1,0)
  109589. */
  109590. constructor(
  109591. /** the position of the vertex (defaut: 0,0,0) */
  109592. position?: Vector3,
  109593. /** the normal of the vertex (defaut: 0,1,0) */
  109594. normal?: Vector3);
  109595. /**
  109596. * Clones the PositionNormalVertex
  109597. * @returns the cloned PositionNormalVertex
  109598. */
  109599. clone(): PositionNormalVertex;
  109600. }
  109601. /**
  109602. * Contains position, normal and uv vectors for a vertex
  109603. */
  109604. export class PositionNormalTextureVertex {
  109605. /** the position of the vertex (defaut: 0,0,0) */
  109606. position: Vector3;
  109607. /** the normal of the vertex (defaut: 0,1,0) */
  109608. normal: Vector3;
  109609. /** the uv of the vertex (default: 0,0) */
  109610. uv: Vector2;
  109611. /**
  109612. * Creates a PositionNormalTextureVertex
  109613. * @param position the position of the vertex (defaut: 0,0,0)
  109614. * @param normal the normal of the vertex (defaut: 0,1,0)
  109615. * @param uv the uv of the vertex (default: 0,0)
  109616. */
  109617. constructor(
  109618. /** the position of the vertex (defaut: 0,0,0) */
  109619. position?: Vector3,
  109620. /** the normal of the vertex (defaut: 0,1,0) */
  109621. normal?: Vector3,
  109622. /** the uv of the vertex (default: 0,0) */
  109623. uv?: Vector2);
  109624. /**
  109625. * Clones the PositionNormalTextureVertex
  109626. * @returns the cloned PositionNormalTextureVertex
  109627. */
  109628. clone(): PositionNormalTextureVertex;
  109629. }
  109630. }
  109631. declare module BABYLON {
  109632. /** @hidden */
  109633. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  109634. private _genericAttributeLocation;
  109635. private _varyingLocationCount;
  109636. private _varyingLocationMap;
  109637. private _replacements;
  109638. private _textureCount;
  109639. private _uniforms;
  109640. lineProcessor(line: string): string;
  109641. attributeProcessor(attribute: string): string;
  109642. varyingProcessor(varying: string, isFragment: boolean): string;
  109643. uniformProcessor(uniform: string): string;
  109644. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  109645. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  109646. }
  109647. }
  109648. declare module BABYLON {
  109649. /**
  109650. * Container for accessors for natively-stored mesh data buffers.
  109651. */
  109652. class NativeDataBuffer extends DataBuffer {
  109653. /**
  109654. * Accessor value used to identify/retrieve a natively-stored index buffer.
  109655. */
  109656. nativeIndexBuffer?: any;
  109657. /**
  109658. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  109659. */
  109660. nativeVertexBuffer?: any;
  109661. }
  109662. /** @hidden */
  109663. export class NativeEngine extends Engine {
  109664. private readonly _native;
  109665. getHardwareScalingLevel(): number;
  109666. constructor();
  109667. /**
  109668. * Can be used to override the current requestAnimationFrame requester.
  109669. * @hidden
  109670. */
  109671. protected _queueNewFrame(bindedRenderFunction: any, requester: any): number;
  109672. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  109673. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  109674. createVertexBuffer(data: DataArray): NativeDataBuffer;
  109675. recordVertexArrayObject(vertexBuffers: {
  109676. [key: string]: VertexBuffer;
  109677. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  109678. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  109679. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  109680. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  109681. /**
  109682. * Draw a list of indexed primitives
  109683. * @param fillMode defines the primitive to use
  109684. * @param indexStart defines the starting index
  109685. * @param indexCount defines the number of index to draw
  109686. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  109687. */
  109688. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  109689. /**
  109690. * Draw a list of unindexed primitives
  109691. * @param fillMode defines the primitive to use
  109692. * @param verticesStart defines the index of first vertex to draw
  109693. * @param verticesCount defines the count of vertices to draw
  109694. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  109695. */
  109696. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  109697. createPipelineContext(): IPipelineContext;
  109698. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  109699. /** @hidden */
  109700. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  109701. /** @hidden */
  109702. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  109703. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  109704. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  109705. protected _setProgram(program: WebGLProgram): void;
  109706. _releaseEffect(effect: Effect): void;
  109707. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  109708. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  109709. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  109710. bindSamplers(effect: Effect): void;
  109711. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  109712. getRenderWidth(useScreen?: boolean): number;
  109713. getRenderHeight(useScreen?: boolean): number;
  109714. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  109715. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  109716. /**
  109717. * Set the z offset to apply to current rendering
  109718. * @param value defines the offset to apply
  109719. */
  109720. setZOffset(value: number): void;
  109721. /**
  109722. * Gets the current value of the zOffset
  109723. * @returns the current zOffset state
  109724. */
  109725. getZOffset(): number;
  109726. /**
  109727. * Enable or disable depth buffering
  109728. * @param enable defines the state to set
  109729. */
  109730. setDepthBuffer(enable: boolean): void;
  109731. /**
  109732. * Gets a boolean indicating if depth writing is enabled
  109733. * @returns the current depth writing state
  109734. */
  109735. getDepthWrite(): boolean;
  109736. /**
  109737. * Enable or disable depth writing
  109738. * @param enable defines the state to set
  109739. */
  109740. setDepthWrite(enable: boolean): void;
  109741. /**
  109742. * Enable or disable color writing
  109743. * @param enable defines the state to set
  109744. */
  109745. setColorWrite(enable: boolean): void;
  109746. /**
  109747. * Gets a boolean indicating if color writing is enabled
  109748. * @returns the current color writing state
  109749. */
  109750. getColorWrite(): boolean;
  109751. /**
  109752. * Sets alpha constants used by some alpha blending modes
  109753. * @param r defines the red component
  109754. * @param g defines the green component
  109755. * @param b defines the blue component
  109756. * @param a defines the alpha component
  109757. */
  109758. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  109759. /**
  109760. * Sets the current alpha mode
  109761. * @param mode defines the mode to use (one of the BABYLON.Engine.ALPHA_XXX)
  109762. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  109763. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  109764. */
  109765. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  109766. /**
  109767. * Gets the current alpha mode
  109768. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  109769. * @returns the current alpha mode
  109770. */
  109771. getAlphaMode(): number;
  109772. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  109773. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  109774. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  109775. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  109776. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  109777. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  109778. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  109779. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  109780. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  109781. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  109782. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  109783. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  109784. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  109785. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  109786. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  109787. setFloat(uniform: WebGLUniformLocation, value: number): void;
  109788. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  109789. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  109790. setBool(uniform: WebGLUniformLocation, bool: number): void;
  109791. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  109792. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  109793. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  109794. wipeCaches(bruteForce?: boolean): void;
  109795. _createTexture(): WebGLTexture;
  109796. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  109797. /**
  109798. * Usually called from BABYLON.Texture.ts.
  109799. * Passed information to create a WebGLTexture
  109800. * @param urlArg defines a value which contains one of the following:
  109801. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  109802. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  109803. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  109804. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  109805. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  109806. * @param scene needed for loading to the correct scene
  109807. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  109808. * @param onLoad optional callback to be called upon successful completion
  109809. * @param onError optional callback to be called upon failure
  109810. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  109811. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  109812. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  109813. * @param forcedExtension defines the extension to use to pick the right loader
  109814. * @returns a InternalTexture for assignment back into BABYLON.Texture
  109815. */
  109816. 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;
  109817. /**
  109818. * Creates a cube texture
  109819. * @param rootUrl defines the url where the files to load is located
  109820. * @param scene defines the current scene
  109821. * @param files defines the list of files to load (1 per face)
  109822. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  109823. * @param onLoad defines an optional callback raised when the texture is loaded
  109824. * @param onError defines an optional callback raised if there is an issue to load the texture
  109825. * @param format defines the format of the data
  109826. * @param forcedExtension defines the extension to use to pick the right loader
  109827. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  109828. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  109829. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  109830. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  109831. * @returns the cube texture as an InternalTexture
  109832. */
  109833. 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;
  109834. private _getSamplingFilter;
  109835. private static _GetNativeTextureFormat;
  109836. createRenderTargetTexture(size: number | {
  109837. width: number;
  109838. height: number;
  109839. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  109840. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  109841. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  109842. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  109843. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  109844. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  109845. /**
  109846. * Updates a dynamic vertex buffer.
  109847. * @param vertexBuffer the vertex buffer to update
  109848. * @param data the data used to update the vertex buffer
  109849. * @param byteOffset the byte offset of the data (optional)
  109850. * @param byteLength the byte length of the data (optional)
  109851. */
  109852. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  109853. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  109854. private _updateAnisotropicLevel;
  109855. private _getAddressMode;
  109856. /** @hidden */
  109857. _bindTexture(channel: number, texture: InternalTexture): void;
  109858. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  109859. releaseEffects(): void;
  109860. /** @hidden */
  109861. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109862. /** @hidden */
  109863. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109864. /** @hidden */
  109865. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  109866. /** @hidden */
  109867. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  109868. }
  109869. }
  109870. declare module BABYLON {
  109871. /**
  109872. * Gather the list of clipboard event types as constants.
  109873. */
  109874. export class ClipboardEventTypes {
  109875. /**
  109876. * The clipboard event is fired when a copy command is active (pressed).
  109877. */
  109878. static readonly COPY: number;
  109879. /**
  109880. * The clipboard event is fired when a cut command is active (pressed).
  109881. */
  109882. static readonly CUT: number;
  109883. /**
  109884. * The clipboard event is fired when a paste command is active (pressed).
  109885. */
  109886. static readonly PASTE: number;
  109887. }
  109888. /**
  109889. * This class is used to store clipboard related info for the onClipboardObservable event.
  109890. */
  109891. export class ClipboardInfo {
  109892. /**
  109893. * Defines the type of event (BABYLON.ClipboardEventTypes)
  109894. */
  109895. type: number;
  109896. /**
  109897. * Defines the related dom event
  109898. */
  109899. event: ClipboardEvent;
  109900. /**
  109901. *Creates an instance of ClipboardInfo.
  109902. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  109903. * @param event Defines the related dom event
  109904. */
  109905. constructor(
  109906. /**
  109907. * Defines the type of event (BABYLON.ClipboardEventTypes)
  109908. */
  109909. type: number,
  109910. /**
  109911. * Defines the related dom event
  109912. */
  109913. event: ClipboardEvent);
  109914. /**
  109915. * Get the clipboard event's type from the keycode.
  109916. * @param keyCode Defines the keyCode for the current keyboard event.
  109917. * @return {number}
  109918. */
  109919. static GetTypeFromCharacter(keyCode: number): number;
  109920. }
  109921. }
  109922. declare module BABYLON {
  109923. /**
  109924. * Google Daydream controller
  109925. */
  109926. export class DaydreamController extends WebVRController {
  109927. /**
  109928. * Base Url for the controller model.
  109929. */
  109930. static MODEL_BASE_URL: string;
  109931. /**
  109932. * File name for the controller model.
  109933. */
  109934. static MODEL_FILENAME: string;
  109935. /**
  109936. * Gamepad Id prefix used to identify Daydream Controller.
  109937. */
  109938. static readonly GAMEPAD_ID_PREFIX: string;
  109939. /**
  109940. * Creates a new DaydreamController from a gamepad
  109941. * @param vrGamepad the gamepad that the controller should be created from
  109942. */
  109943. constructor(vrGamepad: any);
  109944. /**
  109945. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  109946. * @param scene scene in which to add meshes
  109947. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  109948. */
  109949. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  109950. /**
  109951. * Called once for each button that changed state since the last frame
  109952. * @param buttonIdx Which button index changed
  109953. * @param state New state of the button
  109954. * @param changes Which properties on the state changed since last frame
  109955. */
  109956. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  109957. }
  109958. }
  109959. declare module BABYLON {
  109960. /**
  109961. * Gear VR Controller
  109962. */
  109963. export class GearVRController extends WebVRController {
  109964. /**
  109965. * Base Url for the controller model.
  109966. */
  109967. static MODEL_BASE_URL: string;
  109968. /**
  109969. * File name for the controller model.
  109970. */
  109971. static MODEL_FILENAME: string;
  109972. /**
  109973. * Gamepad Id prefix used to identify this controller.
  109974. */
  109975. static readonly GAMEPAD_ID_PREFIX: string;
  109976. private readonly _buttonIndexToObservableNameMap;
  109977. /**
  109978. * Creates a new GearVRController from a gamepad
  109979. * @param vrGamepad the gamepad that the controller should be created from
  109980. */
  109981. constructor(vrGamepad: any);
  109982. /**
  109983. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  109984. * @param scene scene in which to add meshes
  109985. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  109986. */
  109987. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  109988. /**
  109989. * Called once for each button that changed state since the last frame
  109990. * @param buttonIdx Which button index changed
  109991. * @param state New state of the button
  109992. * @param changes Which properties on the state changed since last frame
  109993. */
  109994. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  109995. }
  109996. }
  109997. declare module BABYLON {
  109998. /**
  109999. * Class containing static functions to help procedurally build meshes
  110000. */
  110001. export class PolyhedronBuilder {
  110002. /**
  110003. * Creates a polyhedron mesh
  110004. * * 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
  110005. * * The parameter `size` (positive float, default 1) sets the polygon size
  110006. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  110007. * * 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`
  110008. * * 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
  110009. * * 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)`)
  110010. * * 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
  110011. * * 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
  110012. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  110013. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  110014. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  110015. * @param name defines the name of the mesh
  110016. * @param options defines the options used to create the mesh
  110017. * @param scene defines the hosting scene
  110018. * @returns the polyhedron mesh
  110019. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  110020. */
  110021. static CreatePolyhedron(name: string, options: {
  110022. type?: number;
  110023. size?: number;
  110024. sizeX?: number;
  110025. sizeY?: number;
  110026. sizeZ?: number;
  110027. custom?: any;
  110028. faceUV?: Vector4[];
  110029. faceColors?: Color4[];
  110030. flat?: boolean;
  110031. updatable?: boolean;
  110032. sideOrientation?: number;
  110033. frontUVs?: Vector4;
  110034. backUVs?: Vector4;
  110035. }, scene?: Nullable<Scene>): Mesh;
  110036. }
  110037. }
  110038. declare module BABYLON {
  110039. /**
  110040. * Gizmo that enables scaling a mesh along 3 axis
  110041. */
  110042. export class ScaleGizmo extends Gizmo {
  110043. /**
  110044. * Internal gizmo used for interactions on the x axis
  110045. */
  110046. xGizmo: AxisScaleGizmo;
  110047. /**
  110048. * Internal gizmo used for interactions on the y axis
  110049. */
  110050. yGizmo: AxisScaleGizmo;
  110051. /**
  110052. * Internal gizmo used for interactions on the z axis
  110053. */
  110054. zGizmo: AxisScaleGizmo;
  110055. /**
  110056. * Internal gizmo used to scale all axis equally
  110057. */
  110058. uniformScaleGizmo: AxisScaleGizmo;
  110059. private _meshAttached;
  110060. private _updateGizmoRotationToMatchAttachedMesh;
  110061. private _snapDistance;
  110062. private _scaleRatio;
  110063. private _uniformScalingMesh;
  110064. private _octahedron;
  110065. /** Fires an event when any of it's sub gizmos are dragged */
  110066. onDragStartObservable: Observable<unknown>;
  110067. /** Fires an event when any of it's sub gizmos are released from dragging */
  110068. onDragEndObservable: Observable<unknown>;
  110069. attachedMesh: Nullable<AbstractMesh>;
  110070. /**
  110071. * Creates a ScaleGizmo
  110072. * @param gizmoLayer The utility layer the gizmo will be added to
  110073. */
  110074. constructor(gizmoLayer?: UtilityLayerRenderer);
  110075. updateGizmoRotationToMatchAttachedMesh: boolean;
  110076. /**
  110077. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110078. */
  110079. snapDistance: number;
  110080. /**
  110081. * Ratio for the scale of the gizmo (Default: 1)
  110082. */
  110083. scaleRatio: number;
  110084. /**
  110085. * Disposes of the gizmo
  110086. */
  110087. dispose(): void;
  110088. }
  110089. }
  110090. declare module BABYLON {
  110091. /**
  110092. * Single axis scale gizmo
  110093. */
  110094. export class AxisScaleGizmo extends Gizmo {
  110095. /**
  110096. * Drag behavior responsible for the gizmos dragging interactions
  110097. */
  110098. dragBehavior: PointerDragBehavior;
  110099. private _pointerObserver;
  110100. /**
  110101. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110102. */
  110103. snapDistance: number;
  110104. /**
  110105. * Event that fires each time the gizmo snaps to a new location.
  110106. * * snapDistance is the the change in distance
  110107. */
  110108. onSnapObservable: Observable<{
  110109. snapDistance: number;
  110110. }>;
  110111. /**
  110112. * If the scaling operation should be done on all axis (default: false)
  110113. */
  110114. uniformScaling: boolean;
  110115. private _isEnabled;
  110116. private _parent;
  110117. private _arrow;
  110118. private _coloredMaterial;
  110119. private _hoverMaterial;
  110120. /**
  110121. * Creates an AxisScaleGizmo
  110122. * @param gizmoLayer The utility layer the gizmo will be added to
  110123. * @param dragAxis The axis which the gizmo will be able to scale on
  110124. * @param color The color of the gizmo
  110125. */
  110126. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  110127. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110128. /**
  110129. * If the gizmo is enabled
  110130. */
  110131. isEnabled: boolean;
  110132. /**
  110133. * Disposes of the gizmo
  110134. */
  110135. dispose(): void;
  110136. /**
  110137. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  110138. * @param mesh The mesh to replace the default mesh of the gizmo
  110139. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  110140. */
  110141. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  110142. }
  110143. }
  110144. declare module BABYLON {
  110145. /**
  110146. * Bounding box gizmo
  110147. */
  110148. export class BoundingBoxGizmo extends Gizmo {
  110149. private _lineBoundingBox;
  110150. private _rotateSpheresParent;
  110151. private _scaleBoxesParent;
  110152. private _boundingDimensions;
  110153. private _renderObserver;
  110154. private _pointerObserver;
  110155. private _scaleDragSpeed;
  110156. private _tmpQuaternion;
  110157. private _tmpVector;
  110158. private _tmpRotationMatrix;
  110159. /**
  110160. * 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)
  110161. */
  110162. ignoreChildren: boolean;
  110163. /**
  110164. * 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)
  110165. */
  110166. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  110167. /**
  110168. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  110169. */
  110170. rotationSphereSize: number;
  110171. /**
  110172. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  110173. */
  110174. scaleBoxSize: number;
  110175. /**
  110176. * 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)
  110177. */
  110178. fixedDragMeshScreenSize: boolean;
  110179. /**
  110180. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  110181. */
  110182. fixedDragMeshScreenSizeDistanceFactor: number;
  110183. /**
  110184. * Fired when a rotation sphere or scale box is dragged
  110185. */
  110186. onDragStartObservable: Observable<{}>;
  110187. /**
  110188. * Fired when a scale box is dragged
  110189. */
  110190. onScaleBoxDragObservable: Observable<{}>;
  110191. /**
  110192. * Fired when a scale box drag is ended
  110193. */
  110194. onScaleBoxDragEndObservable: Observable<{}>;
  110195. /**
  110196. * Fired when a rotation sphere is dragged
  110197. */
  110198. onRotationSphereDragObservable: Observable<{}>;
  110199. /**
  110200. * Fired when a rotation sphere drag is ended
  110201. */
  110202. onRotationSphereDragEndObservable: Observable<{}>;
  110203. /**
  110204. * 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)
  110205. */
  110206. scalePivot: Nullable<Vector3>;
  110207. /**
  110208. * Mesh used as a pivot to rotate the attached mesh
  110209. */
  110210. private _anchorMesh;
  110211. private _existingMeshScale;
  110212. private _dragMesh;
  110213. private pointerDragBehavior;
  110214. private coloredMaterial;
  110215. private hoverColoredMaterial;
  110216. /**
  110217. * Sets the color of the bounding box gizmo
  110218. * @param color the color to set
  110219. */
  110220. setColor(color: Color3): void;
  110221. /**
  110222. * Creates an BoundingBoxGizmo
  110223. * @param gizmoLayer The utility layer the gizmo will be added to
  110224. * @param color The color of the gizmo
  110225. */
  110226. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  110227. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110228. private _selectNode;
  110229. /**
  110230. * Updates the bounding box information for the Gizmo
  110231. */
  110232. updateBoundingBox(): void;
  110233. private _updateRotationSpheres;
  110234. private _updateScaleBoxes;
  110235. /**
  110236. * Enables rotation on the specified axis and disables rotation on the others
  110237. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  110238. */
  110239. setEnabledRotationAxis(axis: string): void;
  110240. /**
  110241. * Enables/disables scaling
  110242. * @param enable if scaling should be enabled
  110243. */
  110244. setEnabledScaling(enable: boolean): void;
  110245. private _updateDummy;
  110246. /**
  110247. * Enables a pointer drag behavior on the bounding box of the gizmo
  110248. */
  110249. enableDragBehavior(): void;
  110250. /**
  110251. * Disposes of the gizmo
  110252. */
  110253. dispose(): void;
  110254. /**
  110255. * 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)
  110256. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  110257. * @returns the bounding box mesh with the passed in mesh as a child
  110258. */
  110259. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  110260. /**
  110261. * CustomMeshes are not supported by this gizmo
  110262. * @param mesh The mesh to replace the default mesh of the gizmo
  110263. */
  110264. setCustomMesh(mesh: Mesh): void;
  110265. }
  110266. }
  110267. declare module BABYLON {
  110268. /**
  110269. * Single plane rotation gizmo
  110270. */
  110271. export class PlaneRotationGizmo extends Gizmo {
  110272. /**
  110273. * Drag behavior responsible for the gizmos dragging interactions
  110274. */
  110275. dragBehavior: PointerDragBehavior;
  110276. private _pointerObserver;
  110277. /**
  110278. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  110279. */
  110280. snapDistance: number;
  110281. /**
  110282. * Event that fires each time the gizmo snaps to a new location.
  110283. * * snapDistance is the the change in distance
  110284. */
  110285. onSnapObservable: Observable<{
  110286. snapDistance: number;
  110287. }>;
  110288. private _isEnabled;
  110289. private _parent;
  110290. /**
  110291. * Creates a PlaneRotationGizmo
  110292. * @param gizmoLayer The utility layer the gizmo will be added to
  110293. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  110294. * @param color The color of the gizmo
  110295. * @param tessellation Amount of tessellation to be used when creating rotation circles
  110296. * @param useEulerRotation Use and update Euler angle instead of quaternion
  110297. */
  110298. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  110299. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110300. /**
  110301. * If the gizmo is enabled
  110302. */
  110303. isEnabled: boolean;
  110304. /**
  110305. * Disposes of the gizmo
  110306. */
  110307. dispose(): void;
  110308. }
  110309. }
  110310. declare module BABYLON {
  110311. /**
  110312. * Gizmo that enables rotating a mesh along 3 axis
  110313. */
  110314. export class RotationGizmo extends Gizmo {
  110315. /**
  110316. * Internal gizmo used for interactions on the x axis
  110317. */
  110318. xGizmo: PlaneRotationGizmo;
  110319. /**
  110320. * Internal gizmo used for interactions on the y axis
  110321. */
  110322. yGizmo: PlaneRotationGizmo;
  110323. /**
  110324. * Internal gizmo used for interactions on the z axis
  110325. */
  110326. zGizmo: PlaneRotationGizmo;
  110327. /** Fires an event when any of it's sub gizmos are dragged */
  110328. onDragStartObservable: Observable<unknown>;
  110329. /** Fires an event when any of it's sub gizmos are released from dragging */
  110330. onDragEndObservable: Observable<unknown>;
  110331. private _meshAttached;
  110332. attachedMesh: Nullable<AbstractMesh>;
  110333. /**
  110334. * Creates a RotationGizmo
  110335. * @param gizmoLayer The utility layer the gizmo will be added to
  110336. * @param tessellation Amount of tessellation to be used when creating rotation circles
  110337. * @param useEulerRotation Use and update Euler angle instead of quaternion
  110338. */
  110339. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  110340. updateGizmoRotationToMatchAttachedMesh: boolean;
  110341. /**
  110342. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110343. */
  110344. snapDistance: number;
  110345. /**
  110346. * Ratio for the scale of the gizmo (Default: 1)
  110347. */
  110348. scaleRatio: number;
  110349. /**
  110350. * Disposes of the gizmo
  110351. */
  110352. dispose(): void;
  110353. /**
  110354. * CustomMeshes are not supported by this gizmo
  110355. * @param mesh The mesh to replace the default mesh of the gizmo
  110356. */
  110357. setCustomMesh(mesh: Mesh): void;
  110358. }
  110359. }
  110360. declare module BABYLON {
  110361. /**
  110362. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  110363. */
  110364. export class GizmoManager implements IDisposable {
  110365. private scene;
  110366. /**
  110367. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  110368. */
  110369. gizmos: {
  110370. positionGizmo: Nullable<PositionGizmo>;
  110371. rotationGizmo: Nullable<RotationGizmo>;
  110372. scaleGizmo: Nullable<ScaleGizmo>;
  110373. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  110374. };
  110375. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  110376. clearGizmoOnEmptyPointerEvent: boolean;
  110377. /** Fires an event when the manager is attached to a mesh */
  110378. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  110379. private _gizmosEnabled;
  110380. private _pointerObserver;
  110381. private _attachedMesh;
  110382. private _boundingBoxColor;
  110383. private _defaultUtilityLayer;
  110384. private _defaultKeepDepthUtilityLayer;
  110385. /**
  110386. * When bounding box gizmo is enabled, this can be used to track drag/end events
  110387. */
  110388. boundingBoxDragBehavior: SixDofDragBehavior;
  110389. /**
  110390. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  110391. */
  110392. attachableMeshes: Nullable<Array<AbstractMesh>>;
  110393. /**
  110394. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  110395. */
  110396. usePointerToAttachGizmos: boolean;
  110397. /**
  110398. * Utility layer that the bounding box gizmo belongs to
  110399. */
  110400. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  110401. /**
  110402. * Utility layer that all gizmos besides bounding box belong to
  110403. */
  110404. readonly utilityLayer: UtilityLayerRenderer;
  110405. /**
  110406. * Instatiates a gizmo manager
  110407. * @param scene the scene to overlay the gizmos on top of
  110408. */
  110409. constructor(scene: Scene);
  110410. /**
  110411. * Attaches a set of gizmos to the specified mesh
  110412. * @param mesh The mesh the gizmo's should be attached to
  110413. */
  110414. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  110415. /**
  110416. * If the position gizmo is enabled
  110417. */
  110418. positionGizmoEnabled: boolean;
  110419. /**
  110420. * If the rotation gizmo is enabled
  110421. */
  110422. rotationGizmoEnabled: boolean;
  110423. /**
  110424. * If the scale gizmo is enabled
  110425. */
  110426. scaleGizmoEnabled: boolean;
  110427. /**
  110428. * If the boundingBox gizmo is enabled
  110429. */
  110430. boundingBoxGizmoEnabled: boolean;
  110431. /**
  110432. * Disposes of the gizmo manager
  110433. */
  110434. dispose(): void;
  110435. }
  110436. }
  110437. declare module BABYLON {
  110438. /**
  110439. * A directional light is defined by a direction (what a surprise!).
  110440. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  110441. * 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.
  110442. * Documentation: https://doc.babylonjs.com/babylon101/lights
  110443. */
  110444. export class DirectionalLight extends ShadowLight {
  110445. private _shadowFrustumSize;
  110446. /**
  110447. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  110448. */
  110449. /**
  110450. * Specifies a fix frustum size for the shadow generation.
  110451. */
  110452. shadowFrustumSize: number;
  110453. private _shadowOrthoScale;
  110454. /**
  110455. * Gets the shadow projection scale against the optimal computed one.
  110456. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  110457. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  110458. */
  110459. /**
  110460. * Sets the shadow projection scale against the optimal computed one.
  110461. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  110462. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  110463. */
  110464. shadowOrthoScale: number;
  110465. /**
  110466. * Automatically compute the projection matrix to best fit (including all the casters)
  110467. * on each frame.
  110468. */
  110469. autoUpdateExtends: boolean;
  110470. private _orthoLeft;
  110471. private _orthoRight;
  110472. private _orthoTop;
  110473. private _orthoBottom;
  110474. /**
  110475. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  110476. * The directional light is emitted from everywhere in the given direction.
  110477. * It can cast shadows.
  110478. * Documentation : https://doc.babylonjs.com/babylon101/lights
  110479. * @param name The friendly name of the light
  110480. * @param direction The direction of the light
  110481. * @param scene The scene the light belongs to
  110482. */
  110483. constructor(name: string, direction: Vector3, scene: Scene);
  110484. /**
  110485. * Returns the string "DirectionalLight".
  110486. * @return The class name
  110487. */
  110488. getClassName(): string;
  110489. /**
  110490. * Returns the integer 1.
  110491. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  110492. */
  110493. getTypeID(): number;
  110494. /**
  110495. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  110496. * Returns the DirectionalLight Shadow projection matrix.
  110497. */
  110498. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  110499. /**
  110500. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  110501. * Returns the DirectionalLight Shadow projection matrix.
  110502. */
  110503. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  110504. /**
  110505. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  110506. * Returns the DirectionalLight Shadow projection matrix.
  110507. */
  110508. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  110509. protected _buildUniformLayout(): void;
  110510. /**
  110511. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  110512. * @param effect The effect to update
  110513. * @param lightIndex The index of the light in the effect to update
  110514. * @returns The directional light
  110515. */
  110516. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  110517. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  110518. /**
  110519. * Gets the minZ used for shadow according to both the scene and the light.
  110520. *
  110521. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  110522. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  110523. * @param activeCamera The camera we are returning the min for
  110524. * @returns the depth min z
  110525. */
  110526. getDepthMinZ(activeCamera: Camera): number;
  110527. /**
  110528. * Gets the maxZ used for shadow according to both the scene and the light.
  110529. *
  110530. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  110531. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  110532. * @param activeCamera The camera we are returning the max for
  110533. * @returns the depth max z
  110534. */
  110535. getDepthMaxZ(activeCamera: Camera): number;
  110536. /**
  110537. * Prepares the list of defines specific to the light type.
  110538. * @param defines the list of defines
  110539. * @param lightIndex defines the index of the light for the effect
  110540. */
  110541. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  110542. }
  110543. }
  110544. declare module BABYLON {
  110545. /**
  110546. * Class containing static functions to help procedurally build meshes
  110547. */
  110548. export class HemisphereBuilder {
  110549. /**
  110550. * Creates a hemisphere mesh
  110551. * @param name defines the name of the mesh
  110552. * @param options defines the options used to create the mesh
  110553. * @param scene defines the hosting scene
  110554. * @returns the hemisphere mesh
  110555. */
  110556. static CreateHemisphere(name: string, options: {
  110557. segments?: number;
  110558. diameter?: number;
  110559. sideOrientation?: number;
  110560. }, scene: any): Mesh;
  110561. }
  110562. }
  110563. declare module BABYLON {
  110564. /**
  110565. * A spot light is defined by a position, a direction, an angle, and an exponent.
  110566. * These values define a cone of light starting from the position, emitting toward the direction.
  110567. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  110568. * and the exponent defines the speed of the decay of the light with distance (reach).
  110569. * Documentation: https://doc.babylonjs.com/babylon101/lights
  110570. */
  110571. export class SpotLight extends ShadowLight {
  110572. private _angle;
  110573. private _innerAngle;
  110574. private _cosHalfAngle;
  110575. private _lightAngleScale;
  110576. private _lightAngleOffset;
  110577. /**
  110578. * Gets the cone angle of the spot light in Radians.
  110579. */
  110580. /**
  110581. * Sets the cone angle of the spot light in Radians.
  110582. */
  110583. angle: number;
  110584. /**
  110585. * Only used in gltf falloff mode, this defines the angle where
  110586. * the directional falloff will start before cutting at angle which could be seen
  110587. * as outer angle.
  110588. */
  110589. /**
  110590. * Only used in gltf falloff mode, this defines the angle where
  110591. * the directional falloff will start before cutting at angle which could be seen
  110592. * as outer angle.
  110593. */
  110594. innerAngle: number;
  110595. private _shadowAngleScale;
  110596. /**
  110597. * Allows scaling the angle of the light for shadow generation only.
  110598. */
  110599. /**
  110600. * Allows scaling the angle of the light for shadow generation only.
  110601. */
  110602. shadowAngleScale: number;
  110603. /**
  110604. * The light decay speed with the distance from the emission spot.
  110605. */
  110606. exponent: number;
  110607. private _projectionTextureMatrix;
  110608. /**
  110609. * Allows reading the projecton texture
  110610. */
  110611. readonly projectionTextureMatrix: Matrix;
  110612. protected _projectionTextureLightNear: number;
  110613. /**
  110614. * Gets the near clip of the Spotlight for texture projection.
  110615. */
  110616. /**
  110617. * Sets the near clip of the Spotlight for texture projection.
  110618. */
  110619. projectionTextureLightNear: number;
  110620. protected _projectionTextureLightFar: number;
  110621. /**
  110622. * Gets the far clip of the Spotlight for texture projection.
  110623. */
  110624. /**
  110625. * Sets the far clip of the Spotlight for texture projection.
  110626. */
  110627. projectionTextureLightFar: number;
  110628. protected _projectionTextureUpDirection: Vector3;
  110629. /**
  110630. * Gets the Up vector of the Spotlight for texture projection.
  110631. */
  110632. /**
  110633. * Sets the Up vector of the Spotlight for texture projection.
  110634. */
  110635. projectionTextureUpDirection: Vector3;
  110636. private _projectionTexture;
  110637. /**
  110638. * Gets the projection texture of the light.
  110639. */
  110640. /**
  110641. * Sets the projection texture of the light.
  110642. */
  110643. projectionTexture: Nullable<BaseTexture>;
  110644. private _projectionTextureViewLightDirty;
  110645. private _projectionTextureProjectionLightDirty;
  110646. private _projectionTextureDirty;
  110647. private _projectionTextureViewTargetVector;
  110648. private _projectionTextureViewLightMatrix;
  110649. private _projectionTextureProjectionLightMatrix;
  110650. private _projectionTextureScalingMatrix;
  110651. /**
  110652. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  110653. * It can cast shadows.
  110654. * Documentation : https://doc.babylonjs.com/babylon101/lights
  110655. * @param name The light friendly name
  110656. * @param position The position of the spot light in the scene
  110657. * @param direction The direction of the light in the scene
  110658. * @param angle The cone angle of the light in Radians
  110659. * @param exponent The light decay speed with the distance from the emission spot
  110660. * @param scene The scene the lights belongs to
  110661. */
  110662. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  110663. /**
  110664. * Returns the string "SpotLight".
  110665. * @returns the class name
  110666. */
  110667. getClassName(): string;
  110668. /**
  110669. * Returns the integer 2.
  110670. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  110671. */
  110672. getTypeID(): number;
  110673. /**
  110674. * Overrides the direction setter to recompute the projection texture view light Matrix.
  110675. */
  110676. protected _setDirection(value: Vector3): void;
  110677. /**
  110678. * Overrides the position setter to recompute the projection texture view light Matrix.
  110679. */
  110680. protected _setPosition(value: Vector3): void;
  110681. /**
  110682. * 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.
  110683. * Returns the SpotLight.
  110684. */
  110685. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  110686. protected _computeProjectionTextureViewLightMatrix(): void;
  110687. protected _computeProjectionTextureProjectionLightMatrix(): void;
  110688. /**
  110689. * Main function for light texture projection matrix computing.
  110690. */
  110691. protected _computeProjectionTextureMatrix(): void;
  110692. protected _buildUniformLayout(): void;
  110693. private _computeAngleValues;
  110694. /**
  110695. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  110696. * @param effect The effect to update
  110697. * @param lightIndex The index of the light in the effect to update
  110698. * @returns The spot light
  110699. */
  110700. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  110701. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  110702. /**
  110703. * Disposes the light and the associated resources.
  110704. */
  110705. dispose(): void;
  110706. /**
  110707. * Prepares the list of defines specific to the light type.
  110708. * @param defines the list of defines
  110709. * @param lightIndex defines the index of the light for the effect
  110710. */
  110711. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  110712. }
  110713. }
  110714. declare module BABYLON {
  110715. /**
  110716. * Gizmo that enables viewing a light
  110717. */
  110718. export class LightGizmo extends Gizmo {
  110719. private _lightMesh;
  110720. private _material;
  110721. private cachedPosition;
  110722. private cachedForward;
  110723. /**
  110724. * Creates a LightGizmo
  110725. * @param gizmoLayer The utility layer the gizmo will be added to
  110726. */
  110727. constructor(gizmoLayer?: UtilityLayerRenderer);
  110728. private _light;
  110729. /**
  110730. * The light that the gizmo is attached to
  110731. */
  110732. light: Nullable<Light>;
  110733. /**
  110734. * Gets the material used to render the light gizmo
  110735. */
  110736. readonly material: StandardMaterial;
  110737. /**
  110738. * @hidden
  110739. * Updates the gizmo to match the attached mesh's position/rotation
  110740. */
  110741. protected _update(): void;
  110742. private static _Scale;
  110743. /**
  110744. * Creates the lines for a light mesh
  110745. */
  110746. private static _createLightLines;
  110747. /**
  110748. * Disposes of the light gizmo
  110749. */
  110750. dispose(): void;
  110751. private static _CreateHemisphericLightMesh;
  110752. private static _CreatePointLightMesh;
  110753. private static _CreateSpotLightMesh;
  110754. private static _CreateDirectionalLightMesh;
  110755. }
  110756. }
  110757. declare module BABYLON {
  110758. /** @hidden */
  110759. export var backgroundFragmentDeclaration: {
  110760. name: string;
  110761. shader: string;
  110762. };
  110763. }
  110764. declare module BABYLON {
  110765. /** @hidden */
  110766. export var backgroundUboDeclaration: {
  110767. name: string;
  110768. shader: string;
  110769. };
  110770. }
  110771. declare module BABYLON {
  110772. /** @hidden */
  110773. export var backgroundPixelShader: {
  110774. name: string;
  110775. shader: string;
  110776. };
  110777. }
  110778. declare module BABYLON {
  110779. /** @hidden */
  110780. export var backgroundVertexDeclaration: {
  110781. name: string;
  110782. shader: string;
  110783. };
  110784. }
  110785. declare module BABYLON {
  110786. /** @hidden */
  110787. export var backgroundVertexShader: {
  110788. name: string;
  110789. shader: string;
  110790. };
  110791. }
  110792. declare module BABYLON {
  110793. /**
  110794. * Background material used to create an efficient environement around your scene.
  110795. */
  110796. export class BackgroundMaterial extends PushMaterial {
  110797. /**
  110798. * Standard reflectance value at parallel view angle.
  110799. */
  110800. static StandardReflectance0: number;
  110801. /**
  110802. * Standard reflectance value at grazing angle.
  110803. */
  110804. static StandardReflectance90: number;
  110805. protected _primaryColor: Color3;
  110806. /**
  110807. * Key light Color (multiply against the environement texture)
  110808. */
  110809. primaryColor: Color3;
  110810. protected __perceptualColor: Nullable<Color3>;
  110811. /**
  110812. * Experimental Internal Use Only.
  110813. *
  110814. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  110815. * This acts as a helper to set the primary color to a more "human friendly" value.
  110816. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  110817. * output color as close as possible from the chosen value.
  110818. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  110819. * part of lighting setup.)
  110820. */
  110821. _perceptualColor: Nullable<Color3>;
  110822. protected _primaryColorShadowLevel: float;
  110823. /**
  110824. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  110825. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  110826. */
  110827. primaryColorShadowLevel: float;
  110828. protected _primaryColorHighlightLevel: float;
  110829. /**
  110830. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  110831. * The primary color is used at the level chosen to define what the white area would look.
  110832. */
  110833. primaryColorHighlightLevel: float;
  110834. protected _reflectionTexture: Nullable<BaseTexture>;
  110835. /**
  110836. * Reflection Texture used in the material.
  110837. * Should be author in a specific way for the best result (refer to the documentation).
  110838. */
  110839. reflectionTexture: Nullable<BaseTexture>;
  110840. protected _reflectionBlur: float;
  110841. /**
  110842. * Reflection Texture level of blur.
  110843. *
  110844. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  110845. * texture twice.
  110846. */
  110847. reflectionBlur: float;
  110848. protected _diffuseTexture: Nullable<BaseTexture>;
  110849. /**
  110850. * Diffuse Texture used in the material.
  110851. * Should be author in a specific way for the best result (refer to the documentation).
  110852. */
  110853. diffuseTexture: Nullable<BaseTexture>;
  110854. protected _shadowLights: Nullable<IShadowLight[]>;
  110855. /**
  110856. * Specify the list of lights casting shadow on the material.
  110857. * All scene shadow lights will be included if null.
  110858. */
  110859. shadowLights: Nullable<IShadowLight[]>;
  110860. protected _shadowLevel: float;
  110861. /**
  110862. * Helps adjusting the shadow to a softer level if required.
  110863. * 0 means black shadows and 1 means no shadows.
  110864. */
  110865. shadowLevel: float;
  110866. protected _sceneCenter: Vector3;
  110867. /**
  110868. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  110869. * It is usually zero but might be interesting to modify according to your setup.
  110870. */
  110871. sceneCenter: Vector3;
  110872. protected _opacityFresnel: boolean;
  110873. /**
  110874. * This helps specifying that the material is falling off to the sky box at grazing angle.
  110875. * This helps ensuring a nice transition when the camera goes under the ground.
  110876. */
  110877. opacityFresnel: boolean;
  110878. protected _reflectionFresnel: boolean;
  110879. /**
  110880. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  110881. * This helps adding a mirror texture on the ground.
  110882. */
  110883. reflectionFresnel: boolean;
  110884. protected _reflectionFalloffDistance: number;
  110885. /**
  110886. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  110887. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  110888. */
  110889. reflectionFalloffDistance: number;
  110890. protected _reflectionAmount: number;
  110891. /**
  110892. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  110893. */
  110894. reflectionAmount: number;
  110895. protected _reflectionReflectance0: number;
  110896. /**
  110897. * This specifies the weight of the reflection at grazing angle.
  110898. */
  110899. reflectionReflectance0: number;
  110900. protected _reflectionReflectance90: number;
  110901. /**
  110902. * This specifies the weight of the reflection at a perpendicular point of view.
  110903. */
  110904. reflectionReflectance90: number;
  110905. /**
  110906. * Sets the reflection reflectance fresnel values according to the default standard
  110907. * empirically know to work well :-)
  110908. */
  110909. reflectionStandardFresnelWeight: number;
  110910. protected _useRGBColor: boolean;
  110911. /**
  110912. * Helps to directly use the maps channels instead of their level.
  110913. */
  110914. useRGBColor: boolean;
  110915. protected _enableNoise: boolean;
  110916. /**
  110917. * This helps reducing the banding effect that could occur on the background.
  110918. */
  110919. enableNoise: boolean;
  110920. /**
  110921. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  110922. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  110923. * Recommended to be keep at 1.0 except for special cases.
  110924. */
  110925. fovMultiplier: number;
  110926. private _fovMultiplier;
  110927. /**
  110928. * Enable the FOV adjustment feature controlled by fovMultiplier.
  110929. */
  110930. useEquirectangularFOV: boolean;
  110931. private _maxSimultaneousLights;
  110932. /**
  110933. * Number of Simultaneous lights allowed on the material.
  110934. */
  110935. maxSimultaneousLights: int;
  110936. /**
  110937. * Default configuration related to image processing available in the Background Material.
  110938. */
  110939. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110940. /**
  110941. * Keep track of the image processing observer to allow dispose and replace.
  110942. */
  110943. private _imageProcessingObserver;
  110944. /**
  110945. * Attaches a new image processing configuration to the PBR Material.
  110946. * @param configuration (if null the scene configuration will be use)
  110947. */
  110948. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110949. /**
  110950. * Gets the image processing configuration used either in this material.
  110951. */
  110952. /**
  110953. * Sets the Default image processing configuration used either in the this material.
  110954. *
  110955. * If sets to null, the scene one is in use.
  110956. */
  110957. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  110958. /**
  110959. * Gets wether the color curves effect is enabled.
  110960. */
  110961. /**
  110962. * Sets wether the color curves effect is enabled.
  110963. */
  110964. cameraColorCurvesEnabled: boolean;
  110965. /**
  110966. * Gets wether the color grading effect is enabled.
  110967. */
  110968. /**
  110969. * Gets wether the color grading effect is enabled.
  110970. */
  110971. cameraColorGradingEnabled: boolean;
  110972. /**
  110973. * Gets wether tonemapping is enabled or not.
  110974. */
  110975. /**
  110976. * Sets wether tonemapping is enabled or not
  110977. */
  110978. cameraToneMappingEnabled: boolean;
  110979. /**
  110980. * The camera exposure used on this material.
  110981. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110982. * This corresponds to a photographic exposure.
  110983. */
  110984. /**
  110985. * The camera exposure used on this material.
  110986. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110987. * This corresponds to a photographic exposure.
  110988. */
  110989. cameraExposure: float;
  110990. /**
  110991. * Gets The camera contrast used on this material.
  110992. */
  110993. /**
  110994. * Sets The camera contrast used on this material.
  110995. */
  110996. cameraContrast: float;
  110997. /**
  110998. * Gets the Color Grading 2D Lookup Texture.
  110999. */
  111000. /**
  111001. * Sets the Color Grading 2D Lookup Texture.
  111002. */
  111003. cameraColorGradingTexture: Nullable<BaseTexture>;
  111004. /**
  111005. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111006. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111007. * 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;
  111008. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111009. */
  111010. /**
  111011. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111012. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111013. * 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;
  111014. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111015. */
  111016. cameraColorCurves: Nullable<ColorCurves>;
  111017. /**
  111018. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  111019. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  111020. */
  111021. switchToBGR: boolean;
  111022. private _renderTargets;
  111023. private _reflectionControls;
  111024. private _white;
  111025. private _primaryShadowColor;
  111026. private _primaryHighlightColor;
  111027. /**
  111028. * Instantiates a Background Material in the given scene
  111029. * @param name The friendly name of the material
  111030. * @param scene The scene to add the material to
  111031. */
  111032. constructor(name: string, scene: Scene);
  111033. /**
  111034. * Gets a boolean indicating that current material needs to register RTT
  111035. */
  111036. readonly hasRenderTargetTextures: boolean;
  111037. /**
  111038. * The entire material has been created in order to prevent overdraw.
  111039. * @returns false
  111040. */
  111041. needAlphaTesting(): boolean;
  111042. /**
  111043. * The entire material has been created in order to prevent overdraw.
  111044. * @returns true if blending is enable
  111045. */
  111046. needAlphaBlending(): boolean;
  111047. /**
  111048. * Checks wether the material is ready to be rendered for a given mesh.
  111049. * @param mesh The mesh to render
  111050. * @param subMesh The submesh to check against
  111051. * @param useInstances Specify wether or not the material is used with instances
  111052. * @returns true if all the dependencies are ready (Textures, Effects...)
  111053. */
  111054. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  111055. /**
  111056. * Compute the primary color according to the chosen perceptual color.
  111057. */
  111058. private _computePrimaryColorFromPerceptualColor;
  111059. /**
  111060. * Compute the highlights and shadow colors according to their chosen levels.
  111061. */
  111062. private _computePrimaryColors;
  111063. /**
  111064. * Build the uniform buffer used in the material.
  111065. */
  111066. buildUniformLayout(): void;
  111067. /**
  111068. * Unbind the material.
  111069. */
  111070. unbind(): void;
  111071. /**
  111072. * Bind only the world matrix to the material.
  111073. * @param world The world matrix to bind.
  111074. */
  111075. bindOnlyWorldMatrix(world: Matrix): void;
  111076. /**
  111077. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  111078. * @param world The world matrix to bind.
  111079. * @param subMesh The submesh to bind for.
  111080. */
  111081. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  111082. /**
  111083. * Checks to see if a texture is used in the material.
  111084. * @param texture - Base texture to use.
  111085. * @returns - Boolean specifying if a texture is used in the material.
  111086. */
  111087. hasTexture(texture: BaseTexture): boolean;
  111088. /**
  111089. * Dispose the material.
  111090. * @param forceDisposeEffect Force disposal of the associated effect.
  111091. * @param forceDisposeTextures Force disposal of the associated textures.
  111092. */
  111093. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  111094. /**
  111095. * Clones the material.
  111096. * @param name The cloned name.
  111097. * @returns The cloned material.
  111098. */
  111099. clone(name: string): BackgroundMaterial;
  111100. /**
  111101. * Serializes the current material to its JSON representation.
  111102. * @returns The JSON representation.
  111103. */
  111104. serialize(): any;
  111105. /**
  111106. * Gets the class name of the material
  111107. * @returns "BackgroundMaterial"
  111108. */
  111109. getClassName(): string;
  111110. /**
  111111. * Parse a JSON input to create back a background material.
  111112. * @param source The JSON data to parse
  111113. * @param scene The scene to create the parsed material in
  111114. * @param rootUrl The root url of the assets the material depends upon
  111115. * @returns the instantiated BackgroundMaterial.
  111116. */
  111117. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  111118. }
  111119. }
  111120. declare module BABYLON {
  111121. /**
  111122. * Represents the different options available during the creation of
  111123. * a Environment helper.
  111124. *
  111125. * This can control the default ground, skybox and image processing setup of your scene.
  111126. */
  111127. export interface IEnvironmentHelperOptions {
  111128. /**
  111129. * Specifies wether or not to create a ground.
  111130. * True by default.
  111131. */
  111132. createGround: boolean;
  111133. /**
  111134. * Specifies the ground size.
  111135. * 15 by default.
  111136. */
  111137. groundSize: number;
  111138. /**
  111139. * The texture used on the ground for the main color.
  111140. * Comes from the BabylonJS CDN by default.
  111141. *
  111142. * Remarks: Can be either a texture or a url.
  111143. */
  111144. groundTexture: string | BaseTexture;
  111145. /**
  111146. * The color mixed in the ground texture by default.
  111147. * BabylonJS clearColor by default.
  111148. */
  111149. groundColor: Color3;
  111150. /**
  111151. * Specifies the ground opacity.
  111152. * 1 by default.
  111153. */
  111154. groundOpacity: number;
  111155. /**
  111156. * Enables the ground to receive shadows.
  111157. * True by default.
  111158. */
  111159. enableGroundShadow: boolean;
  111160. /**
  111161. * Helps preventing the shadow to be fully black on the ground.
  111162. * 0.5 by default.
  111163. */
  111164. groundShadowLevel: number;
  111165. /**
  111166. * Creates a mirror texture attach to the ground.
  111167. * false by default.
  111168. */
  111169. enableGroundMirror: boolean;
  111170. /**
  111171. * Specifies the ground mirror size ratio.
  111172. * 0.3 by default as the default kernel is 64.
  111173. */
  111174. groundMirrorSizeRatio: number;
  111175. /**
  111176. * Specifies the ground mirror blur kernel size.
  111177. * 64 by default.
  111178. */
  111179. groundMirrorBlurKernel: number;
  111180. /**
  111181. * Specifies the ground mirror visibility amount.
  111182. * 1 by default
  111183. */
  111184. groundMirrorAmount: number;
  111185. /**
  111186. * Specifies the ground mirror reflectance weight.
  111187. * This uses the standard weight of the background material to setup the fresnel effect
  111188. * of the mirror.
  111189. * 1 by default.
  111190. */
  111191. groundMirrorFresnelWeight: number;
  111192. /**
  111193. * Specifies the ground mirror Falloff distance.
  111194. * This can helps reducing the size of the reflection.
  111195. * 0 by Default.
  111196. */
  111197. groundMirrorFallOffDistance: number;
  111198. /**
  111199. * Specifies the ground mirror texture type.
  111200. * Unsigned Int by Default.
  111201. */
  111202. groundMirrorTextureType: number;
  111203. /**
  111204. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  111205. * the shown objects.
  111206. */
  111207. groundYBias: number;
  111208. /**
  111209. * Specifies wether or not to create a skybox.
  111210. * True by default.
  111211. */
  111212. createSkybox: boolean;
  111213. /**
  111214. * Specifies the skybox size.
  111215. * 20 by default.
  111216. */
  111217. skyboxSize: number;
  111218. /**
  111219. * The texture used on the skybox for the main color.
  111220. * Comes from the BabylonJS CDN by default.
  111221. *
  111222. * Remarks: Can be either a texture or a url.
  111223. */
  111224. skyboxTexture: string | BaseTexture;
  111225. /**
  111226. * The color mixed in the skybox texture by default.
  111227. * BabylonJS clearColor by default.
  111228. */
  111229. skyboxColor: Color3;
  111230. /**
  111231. * The background rotation around the Y axis of the scene.
  111232. * This helps aligning the key lights of your scene with the background.
  111233. * 0 by default.
  111234. */
  111235. backgroundYRotation: number;
  111236. /**
  111237. * Compute automatically the size of the elements to best fit with the scene.
  111238. */
  111239. sizeAuto: boolean;
  111240. /**
  111241. * Default position of the rootMesh if autoSize is not true.
  111242. */
  111243. rootPosition: Vector3;
  111244. /**
  111245. * Sets up the image processing in the scene.
  111246. * true by default.
  111247. */
  111248. setupImageProcessing: boolean;
  111249. /**
  111250. * The texture used as your environment texture in the scene.
  111251. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  111252. *
  111253. * Remarks: Can be either a texture or a url.
  111254. */
  111255. environmentTexture: string | BaseTexture;
  111256. /**
  111257. * The value of the exposure to apply to the scene.
  111258. * 0.6 by default if setupImageProcessing is true.
  111259. */
  111260. cameraExposure: number;
  111261. /**
  111262. * The value of the contrast to apply to the scene.
  111263. * 1.6 by default if setupImageProcessing is true.
  111264. */
  111265. cameraContrast: number;
  111266. /**
  111267. * Specifies wether or not tonemapping should be enabled in the scene.
  111268. * true by default if setupImageProcessing is true.
  111269. */
  111270. toneMappingEnabled: boolean;
  111271. }
  111272. /**
  111273. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  111274. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  111275. * It also helps with the default setup of your imageProcessing configuration.
  111276. */
  111277. export class EnvironmentHelper {
  111278. /**
  111279. * Default ground texture URL.
  111280. */
  111281. private static _groundTextureCDNUrl;
  111282. /**
  111283. * Default skybox texture URL.
  111284. */
  111285. private static _skyboxTextureCDNUrl;
  111286. /**
  111287. * Default environment texture URL.
  111288. */
  111289. private static _environmentTextureCDNUrl;
  111290. /**
  111291. * Creates the default options for the helper.
  111292. */
  111293. private static _getDefaultOptions;
  111294. private _rootMesh;
  111295. /**
  111296. * Gets the root mesh created by the helper.
  111297. */
  111298. readonly rootMesh: Mesh;
  111299. private _skybox;
  111300. /**
  111301. * Gets the skybox created by the helper.
  111302. */
  111303. readonly skybox: Nullable<Mesh>;
  111304. private _skyboxTexture;
  111305. /**
  111306. * Gets the skybox texture created by the helper.
  111307. */
  111308. readonly skyboxTexture: Nullable<BaseTexture>;
  111309. private _skyboxMaterial;
  111310. /**
  111311. * Gets the skybox material created by the helper.
  111312. */
  111313. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  111314. private _ground;
  111315. /**
  111316. * Gets the ground mesh created by the helper.
  111317. */
  111318. readonly ground: Nullable<Mesh>;
  111319. private _groundTexture;
  111320. /**
  111321. * Gets the ground texture created by the helper.
  111322. */
  111323. readonly groundTexture: Nullable<BaseTexture>;
  111324. private _groundMirror;
  111325. /**
  111326. * Gets the ground mirror created by the helper.
  111327. */
  111328. readonly groundMirror: Nullable<MirrorTexture>;
  111329. /**
  111330. * Gets the ground mirror render list to helps pushing the meshes
  111331. * you wish in the ground reflection.
  111332. */
  111333. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  111334. private _groundMaterial;
  111335. /**
  111336. * Gets the ground material created by the helper.
  111337. */
  111338. readonly groundMaterial: Nullable<BackgroundMaterial>;
  111339. /**
  111340. * Stores the creation options.
  111341. */
  111342. private readonly _scene;
  111343. private _options;
  111344. /**
  111345. * This observable will be notified with any error during the creation of the environment,
  111346. * mainly texture creation errors.
  111347. */
  111348. onErrorObservable: Observable<{
  111349. message?: string;
  111350. exception?: any;
  111351. }>;
  111352. /**
  111353. * constructor
  111354. * @param options Defines the options we want to customize the helper
  111355. * @param scene The scene to add the material to
  111356. */
  111357. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  111358. /**
  111359. * Updates the background according to the new options
  111360. * @param options
  111361. */
  111362. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  111363. /**
  111364. * Sets the primary color of all the available elements.
  111365. * @param color the main color to affect to the ground and the background
  111366. */
  111367. setMainColor(color: Color3): void;
  111368. /**
  111369. * Setup the image processing according to the specified options.
  111370. */
  111371. private _setupImageProcessing;
  111372. /**
  111373. * Setup the environment texture according to the specified options.
  111374. */
  111375. private _setupEnvironmentTexture;
  111376. /**
  111377. * Setup the background according to the specified options.
  111378. */
  111379. private _setupBackground;
  111380. /**
  111381. * Get the scene sizes according to the setup.
  111382. */
  111383. private _getSceneSize;
  111384. /**
  111385. * Setup the ground according to the specified options.
  111386. */
  111387. private _setupGround;
  111388. /**
  111389. * Setup the ground material according to the specified options.
  111390. */
  111391. private _setupGroundMaterial;
  111392. /**
  111393. * Setup the ground diffuse texture according to the specified options.
  111394. */
  111395. private _setupGroundDiffuseTexture;
  111396. /**
  111397. * Setup the ground mirror texture according to the specified options.
  111398. */
  111399. private _setupGroundMirrorTexture;
  111400. /**
  111401. * Setup the ground to receive the mirror texture.
  111402. */
  111403. private _setupMirrorInGroundMaterial;
  111404. /**
  111405. * Setup the skybox according to the specified options.
  111406. */
  111407. private _setupSkybox;
  111408. /**
  111409. * Setup the skybox material according to the specified options.
  111410. */
  111411. private _setupSkyboxMaterial;
  111412. /**
  111413. * Setup the skybox reflection texture according to the specified options.
  111414. */
  111415. private _setupSkyboxReflectionTexture;
  111416. private _errorHandler;
  111417. /**
  111418. * Dispose all the elements created by the Helper.
  111419. */
  111420. dispose(): void;
  111421. }
  111422. }
  111423. declare module BABYLON {
  111424. /**
  111425. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  111426. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  111427. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  111428. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  111429. */
  111430. export class PhotoDome extends TransformNode {
  111431. /**
  111432. * Define the image as a Monoscopic panoramic 360 image.
  111433. */
  111434. static readonly MODE_MONOSCOPIC: number;
  111435. /**
  111436. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  111437. */
  111438. static readonly MODE_TOPBOTTOM: number;
  111439. /**
  111440. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  111441. */
  111442. static readonly MODE_SIDEBYSIDE: number;
  111443. private _useDirectMapping;
  111444. /**
  111445. * The texture being displayed on the sphere
  111446. */
  111447. protected _photoTexture: Texture;
  111448. /**
  111449. * Gets or sets the texture being displayed on the sphere
  111450. */
  111451. photoTexture: Texture;
  111452. /**
  111453. * Observable raised when an error occured while loading the 360 image
  111454. */
  111455. onLoadErrorObservable: Observable<string>;
  111456. /**
  111457. * The skybox material
  111458. */
  111459. protected _material: BackgroundMaterial;
  111460. /**
  111461. * The surface used for the skybox
  111462. */
  111463. protected _mesh: Mesh;
  111464. /**
  111465. * Gets the mesh used for the skybox.
  111466. */
  111467. readonly mesh: Mesh;
  111468. /**
  111469. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  111470. * Also see the options.resolution property.
  111471. */
  111472. fovMultiplier: number;
  111473. private _imageMode;
  111474. /**
  111475. * Gets or set the current video mode for the video. It can be:
  111476. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  111477. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  111478. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  111479. */
  111480. imageMode: number;
  111481. /**
  111482. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  111483. * @param name Element's name, child elements will append suffixes for their own names.
  111484. * @param urlsOfPhoto defines the url of the photo to display
  111485. * @param options defines an object containing optional or exposed sub element properties
  111486. * @param onError defines a callback called when an error occured while loading the texture
  111487. */
  111488. constructor(name: string, urlOfPhoto: string, options: {
  111489. resolution?: number;
  111490. size?: number;
  111491. useDirectMapping?: boolean;
  111492. faceForward?: boolean;
  111493. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  111494. private _onBeforeCameraRenderObserver;
  111495. private _changeImageMode;
  111496. /**
  111497. * Releases resources associated with this node.
  111498. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111499. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111500. */
  111501. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111502. }
  111503. }
  111504. declare module BABYLON {
  111505. /**
  111506. * Class used to host RGBD texture specific utilities
  111507. */
  111508. export class RGBDTextureTools {
  111509. /**
  111510. * Expand the RGBD Texture from RGBD to Half Float if possible.
  111511. * @param texture the texture to expand.
  111512. */
  111513. static ExpandRGBDTexture(texture: Texture): void;
  111514. }
  111515. }
  111516. declare module BABYLON {
  111517. /**
  111518. * Class used to host texture specific utilities
  111519. */
  111520. export class BRDFTextureTools {
  111521. /**
  111522. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  111523. * @param scene defines the hosting scene
  111524. * @returns the environment BRDF texture
  111525. */
  111526. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  111527. private static _environmentBRDFBase64Texture;
  111528. }
  111529. }
  111530. declare module BABYLON {
  111531. /**
  111532. * @hidden
  111533. */
  111534. export interface IMaterialClearCoatDefines {
  111535. CLEARCOAT: boolean;
  111536. CLEARCOAT_DEFAULTIOR: boolean;
  111537. CLEARCOAT_TEXTURE: boolean;
  111538. CLEARCOAT_TEXTUREDIRECTUV: number;
  111539. CLEARCOAT_BUMP: boolean;
  111540. CLEARCOAT_BUMPDIRECTUV: number;
  111541. CLEARCOAT_TINT: boolean;
  111542. CLEARCOAT_TINT_TEXTURE: boolean;
  111543. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  111544. /** @hidden */
  111545. _areTexturesDirty: boolean;
  111546. }
  111547. /**
  111548. * Define the code related to the clear coat parameters of the pbr material.
  111549. */
  111550. export class PBRClearCoatConfiguration {
  111551. /**
  111552. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  111553. * The default fits with a polyurethane material.
  111554. */
  111555. private static readonly _DefaultIndexOfRefraction;
  111556. private _isEnabled;
  111557. /**
  111558. * Defines if the clear coat is enabled in the material.
  111559. */
  111560. isEnabled: boolean;
  111561. /**
  111562. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  111563. */
  111564. intensity: number;
  111565. /**
  111566. * Defines the clear coat layer roughness.
  111567. */
  111568. roughness: number;
  111569. private _indexOfRefraction;
  111570. /**
  111571. * Defines the index of refraction of the clear coat.
  111572. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  111573. * The default fits with a polyurethane material.
  111574. * Changing the default value is more performance intensive.
  111575. */
  111576. indexOfRefraction: number;
  111577. private _texture;
  111578. /**
  111579. * Stores the clear coat values in a texture.
  111580. */
  111581. texture: Nullable<BaseTexture>;
  111582. private _bumpTexture;
  111583. /**
  111584. * Define the clear coat specific bump texture.
  111585. */
  111586. bumpTexture: Nullable<BaseTexture>;
  111587. private _isTintEnabled;
  111588. /**
  111589. * Defines if the clear coat tint is enabled in the material.
  111590. */
  111591. isTintEnabled: boolean;
  111592. /**
  111593. * Defines the clear coat tint of the material.
  111594. * This is only use if tint is enabled
  111595. */
  111596. tintColor: Color3;
  111597. /**
  111598. * Defines the distance at which the tint color should be found in the
  111599. * clear coat media.
  111600. * This is only use if tint is enabled
  111601. */
  111602. tintColorAtDistance: number;
  111603. /**
  111604. * Defines the clear coat layer thickness.
  111605. * This is only use if tint is enabled
  111606. */
  111607. tintThickness: number;
  111608. private _tintTexture;
  111609. /**
  111610. * Stores the clear tint values in a texture.
  111611. * rgb is tint
  111612. * a is a thickness factor
  111613. */
  111614. tintTexture: Nullable<BaseTexture>;
  111615. /** @hidden */
  111616. private _internalMarkAllSubMeshesAsTexturesDirty;
  111617. /** @hidden */
  111618. _markAllSubMeshesAsTexturesDirty(): void;
  111619. /**
  111620. * Instantiate a new istance of clear coat configuration.
  111621. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  111622. */
  111623. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  111624. /**
  111625. * Gets wehter the submesh is ready to be used or not.
  111626. * @param defines the list of "defines" to update.
  111627. * @param scene defines the scene the material belongs to.
  111628. * @param engine defines the engine the material belongs to.
  111629. * @param disableBumpMap defines wether the material disables bump or not.
  111630. * @returns - boolean indicating that the submesh is ready or not.
  111631. */
  111632. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  111633. /**
  111634. * Checks to see if a texture is used in the material.
  111635. * @param defines the list of "defines" to update.
  111636. * @param scene defines the scene to the material belongs to.
  111637. */
  111638. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  111639. /**
  111640. * Binds the material data.
  111641. * @param uniformBuffer defines the Uniform buffer to fill in.
  111642. * @param scene defines the scene the material belongs to.
  111643. * @param engine defines the engine the material belongs to.
  111644. * @param disableBumpMap defines wether the material disables bump or not.
  111645. * @param isFrozen defines wether the material is frozen or not.
  111646. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  111647. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  111648. */
  111649. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  111650. /**
  111651. * Checks to see if a texture is used in the material.
  111652. * @param texture - Base texture to use.
  111653. * @returns - Boolean specifying if a texture is used in the material.
  111654. */
  111655. hasTexture(texture: BaseTexture): boolean;
  111656. /**
  111657. * Returns an array of the actively used textures.
  111658. * @param activeTextures Array of BaseTextures
  111659. */
  111660. getActiveTextures(activeTextures: BaseTexture[]): void;
  111661. /**
  111662. * Returns the animatable textures.
  111663. * @param animatables Array of animatable textures.
  111664. */
  111665. getAnimatables(animatables: IAnimatable[]): void;
  111666. /**
  111667. * Disposes the resources of the material.
  111668. * @param forceDisposeTextures - Forces the disposal of all textures.
  111669. */
  111670. dispose(forceDisposeTextures?: boolean): void;
  111671. /**
  111672. * Get the current class name of the texture useful for serialization or dynamic coding.
  111673. * @returns "PBRClearCoatConfiguration"
  111674. */
  111675. getClassName(): string;
  111676. /**
  111677. * Add fallbacks to the effect fallbacks list.
  111678. * @param defines defines the Base texture to use.
  111679. * @param fallbacks defines the current fallback list.
  111680. * @param currentRank defines the current fallback rank.
  111681. * @returns the new fallback rank.
  111682. */
  111683. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  111684. /**
  111685. * Add the required uniforms to the current list.
  111686. * @param uniforms defines the current uniform list.
  111687. */
  111688. static AddUniforms(uniforms: string[]): void;
  111689. /**
  111690. * Add the required samplers to the current list.
  111691. * @param samplers defines the current sampler list.
  111692. */
  111693. static AddSamplers(samplers: string[]): void;
  111694. /**
  111695. * Add the required uniforms to the current buffer.
  111696. * @param uniformBuffer defines the current uniform buffer.
  111697. */
  111698. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  111699. /**
  111700. * Makes a duplicate of the current configuration into another one.
  111701. * @param clearCoatConfiguration define the config where to copy the info
  111702. */
  111703. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  111704. /**
  111705. * Serializes this clear coat configuration.
  111706. * @returns - An object with the serialized config.
  111707. */
  111708. serialize(): any;
  111709. /**
  111710. * Parses a anisotropy Configuration from a serialized object.
  111711. * @param source - Serialized object.
  111712. * @param scene Defines the scene we are parsing for
  111713. * @param rootUrl Defines the rootUrl to load from
  111714. */
  111715. parse(source: any, scene: Scene, rootUrl: string): void;
  111716. }
  111717. }
  111718. declare module BABYLON {
  111719. /**
  111720. * @hidden
  111721. */
  111722. export interface IMaterialAnisotropicDefines {
  111723. ANISOTROPIC: boolean;
  111724. ANISOTROPIC_TEXTURE: boolean;
  111725. ANISOTROPIC_TEXTUREDIRECTUV: number;
  111726. MAINUV1: boolean;
  111727. _areTexturesDirty: boolean;
  111728. _needUVs: boolean;
  111729. }
  111730. /**
  111731. * Define the code related to the anisotropic parameters of the pbr material.
  111732. */
  111733. export class PBRAnisotropicConfiguration {
  111734. private _isEnabled;
  111735. /**
  111736. * Defines if the anisotropy is enabled in the material.
  111737. */
  111738. isEnabled: boolean;
  111739. /**
  111740. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  111741. */
  111742. intensity: number;
  111743. /**
  111744. * Defines if the effect is along the tangents, bitangents or in between.
  111745. * By default, the effect is "strectching" the highlights along the tangents.
  111746. */
  111747. direction: Vector2;
  111748. private _texture;
  111749. /**
  111750. * Stores the anisotropy values in a texture.
  111751. * rg is direction (like normal from -1 to 1)
  111752. * b is a intensity
  111753. */
  111754. texture: Nullable<BaseTexture>;
  111755. /** @hidden */
  111756. private _internalMarkAllSubMeshesAsTexturesDirty;
  111757. /** @hidden */
  111758. _markAllSubMeshesAsTexturesDirty(): void;
  111759. /**
  111760. * Instantiate a new istance of anisotropy configuration.
  111761. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  111762. */
  111763. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  111764. /**
  111765. * Specifies that the submesh is ready to be used.
  111766. * @param defines the list of "defines" to update.
  111767. * @param scene defines the scene the material belongs to.
  111768. * @returns - boolean indicating that the submesh is ready or not.
  111769. */
  111770. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  111771. /**
  111772. * Checks to see if a texture is used in the material.
  111773. * @param defines the list of "defines" to update.
  111774. * @param mesh the mesh we are preparing the defines for.
  111775. * @param scene defines the scene the material belongs to.
  111776. */
  111777. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  111778. /**
  111779. * Binds the material data.
  111780. * @param uniformBuffer defines the Uniform buffer to fill in.
  111781. * @param scene defines the scene the material belongs to.
  111782. * @param isFrozen defines wether the material is frozen or not.
  111783. */
  111784. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  111785. /**
  111786. * Checks to see if a texture is used in the material.
  111787. * @param texture - Base texture to use.
  111788. * @returns - Boolean specifying if a texture is used in the material.
  111789. */
  111790. hasTexture(texture: BaseTexture): boolean;
  111791. /**
  111792. * Returns an array of the actively used textures.
  111793. * @param activeTextures Array of BaseTextures
  111794. */
  111795. getActiveTextures(activeTextures: BaseTexture[]): void;
  111796. /**
  111797. * Returns the animatable textures.
  111798. * @param animatables Array of animatable textures.
  111799. */
  111800. getAnimatables(animatables: IAnimatable[]): void;
  111801. /**
  111802. * Disposes the resources of the material.
  111803. * @param forceDisposeTextures - Forces the disposal of all textures.
  111804. */
  111805. dispose(forceDisposeTextures?: boolean): void;
  111806. /**
  111807. * Get the current class name of the texture useful for serialization or dynamic coding.
  111808. * @returns "PBRAnisotropicConfiguration"
  111809. */
  111810. getClassName(): string;
  111811. /**
  111812. * Add fallbacks to the effect fallbacks list.
  111813. * @param defines defines the Base texture to use.
  111814. * @param fallbacks defines the current fallback list.
  111815. * @param currentRank defines the current fallback rank.
  111816. * @returns the new fallback rank.
  111817. */
  111818. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  111819. /**
  111820. * Add the required uniforms to the current list.
  111821. * @param uniforms defines the current uniform list.
  111822. */
  111823. static AddUniforms(uniforms: string[]): void;
  111824. /**
  111825. * Add the required uniforms to the current buffer.
  111826. * @param uniformBuffer defines the current uniform buffer.
  111827. */
  111828. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  111829. /**
  111830. * Add the required samplers to the current list.
  111831. * @param samplers defines the current sampler list.
  111832. */
  111833. static AddSamplers(samplers: string[]): void;
  111834. /**
  111835. * Makes a duplicate of the current configuration into another one.
  111836. * @param anisotropicConfiguration define the config where to copy the info
  111837. */
  111838. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  111839. /**
  111840. * Serializes this anisotropy configuration.
  111841. * @returns - An object with the serialized config.
  111842. */
  111843. serialize(): any;
  111844. /**
  111845. * Parses a anisotropy Configuration from a serialized object.
  111846. * @param source - Serialized object.
  111847. * @param scene Defines the scene we are parsing for
  111848. * @param rootUrl Defines the rootUrl to load from
  111849. */
  111850. parse(source: any, scene: Scene, rootUrl: string): void;
  111851. }
  111852. }
  111853. declare module BABYLON {
  111854. /**
  111855. * @hidden
  111856. */
  111857. export interface IMaterialBRDFDefines {
  111858. BRDF_V_HEIGHT_CORRELATED: boolean;
  111859. MS_BRDF_ENERGY_CONSERVATION: boolean;
  111860. SPHERICAL_HARMONICS: boolean;
  111861. /** @hidden */
  111862. _areMiscDirty: boolean;
  111863. }
  111864. /**
  111865. * Define the code related to the BRDF parameters of the pbr material.
  111866. */
  111867. export class PBRBRDFConfiguration {
  111868. /**
  111869. * Default value used for the energy conservation.
  111870. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  111871. */
  111872. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  111873. /**
  111874. * Default value used for the Smith Visibility Height Correlated mode.
  111875. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  111876. */
  111877. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  111878. /**
  111879. * Default value used for the IBL diffuse part.
  111880. * This can help switching back to the polynomials mode globally which is a tiny bit
  111881. * less GPU intensive at the drawback of a lower quality.
  111882. */
  111883. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  111884. private _useEnergyConservation;
  111885. /**
  111886. * Defines if the material uses energy conservation.
  111887. */
  111888. useEnergyConservation: boolean;
  111889. private _useSmithVisibilityHeightCorrelated;
  111890. /**
  111891. * LEGACY Mode set to false
  111892. * Defines if the material uses height smith correlated visibility term.
  111893. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  111894. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  111895. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  111896. * Not relying on height correlated will also disable energy conservation.
  111897. */
  111898. useSmithVisibilityHeightCorrelated: boolean;
  111899. private _useSphericalHarmonics;
  111900. /**
  111901. * LEGACY Mode set to false
  111902. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  111903. * diffuse part of the IBL.
  111904. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  111905. * to the ground truth.
  111906. */
  111907. useSphericalHarmonics: boolean;
  111908. /** @hidden */
  111909. private _internalMarkAllSubMeshesAsMiscDirty;
  111910. /** @hidden */
  111911. _markAllSubMeshesAsMiscDirty(): void;
  111912. /**
  111913. * Instantiate a new istance of clear coat configuration.
  111914. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  111915. */
  111916. constructor(markAllSubMeshesAsMiscDirty: () => void);
  111917. /**
  111918. * Checks to see if a texture is used in the material.
  111919. * @param defines the list of "defines" to update.
  111920. */
  111921. prepareDefines(defines: IMaterialBRDFDefines): void;
  111922. /**
  111923. * Get the current class name of the texture useful for serialization or dynamic coding.
  111924. * @returns "PBRClearCoatConfiguration"
  111925. */
  111926. getClassName(): string;
  111927. /**
  111928. * Makes a duplicate of the current configuration into another one.
  111929. * @param brdfConfiguration define the config where to copy the info
  111930. */
  111931. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  111932. /**
  111933. * Serializes this BRDF configuration.
  111934. * @returns - An object with the serialized config.
  111935. */
  111936. serialize(): any;
  111937. /**
  111938. * Parses a anisotropy Configuration from a serialized object.
  111939. * @param source - Serialized object.
  111940. * @param scene Defines the scene we are parsing for
  111941. * @param rootUrl Defines the rootUrl to load from
  111942. */
  111943. parse(source: any, scene: Scene, rootUrl: string): void;
  111944. }
  111945. }
  111946. declare module BABYLON {
  111947. /**
  111948. * @hidden
  111949. */
  111950. export interface IMaterialSheenDefines {
  111951. SHEEN: boolean;
  111952. SHEEN_TEXTURE: boolean;
  111953. SHEEN_TEXTUREDIRECTUV: number;
  111954. SHEEN_LINKWITHALBEDO: boolean;
  111955. /** @hidden */
  111956. _areTexturesDirty: boolean;
  111957. }
  111958. /**
  111959. * Define the code related to the Sheen parameters of the pbr material.
  111960. */
  111961. export class PBRSheenConfiguration {
  111962. private _isEnabled;
  111963. /**
  111964. * Defines if the material uses sheen.
  111965. */
  111966. isEnabled: boolean;
  111967. private _linkSheenWithAlbedo;
  111968. /**
  111969. * Defines if the sheen is linked to the sheen color.
  111970. */
  111971. linkSheenWithAlbedo: boolean;
  111972. /**
  111973. * Defines the sheen intensity.
  111974. */
  111975. intensity: number;
  111976. /**
  111977. * Defines the sheen color.
  111978. */
  111979. color: Color3;
  111980. private _texture;
  111981. /**
  111982. * Stores the sheen tint values in a texture.
  111983. * rgb is tint
  111984. * a is a intensity
  111985. */
  111986. texture: Nullable<BaseTexture>;
  111987. /** @hidden */
  111988. private _internalMarkAllSubMeshesAsTexturesDirty;
  111989. /** @hidden */
  111990. _markAllSubMeshesAsTexturesDirty(): void;
  111991. /**
  111992. * Instantiate a new istance of clear coat configuration.
  111993. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  111994. */
  111995. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  111996. /**
  111997. * Specifies that the submesh is ready to be used.
  111998. * @param defines the list of "defines" to update.
  111999. * @param scene defines the scene the material belongs to.
  112000. * @returns - boolean indicating that the submesh is ready or not.
  112001. */
  112002. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  112003. /**
  112004. * Checks to see if a texture is used in the material.
  112005. * @param defines the list of "defines" to update.
  112006. * @param scene defines the scene the material belongs to.
  112007. */
  112008. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  112009. /**
  112010. * Binds the material data.
  112011. * @param uniformBuffer defines the Uniform buffer to fill in.
  112012. * @param scene defines the scene the material belongs to.
  112013. * @param isFrozen defines wether the material is frozen or not.
  112014. */
  112015. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  112016. /**
  112017. * Checks to see if a texture is used in the material.
  112018. * @param texture - Base texture to use.
  112019. * @returns - Boolean specifying if a texture is used in the material.
  112020. */
  112021. hasTexture(texture: BaseTexture): boolean;
  112022. /**
  112023. * Returns an array of the actively used textures.
  112024. * @param activeTextures Array of BaseTextures
  112025. */
  112026. getActiveTextures(activeTextures: BaseTexture[]): void;
  112027. /**
  112028. * Returns the animatable textures.
  112029. * @param animatables Array of animatable textures.
  112030. */
  112031. getAnimatables(animatables: IAnimatable[]): void;
  112032. /**
  112033. * Disposes the resources of the material.
  112034. * @param forceDisposeTextures - Forces the disposal of all textures.
  112035. */
  112036. dispose(forceDisposeTextures?: boolean): void;
  112037. /**
  112038. * Get the current class name of the texture useful for serialization or dynamic coding.
  112039. * @returns "PBRSheenConfiguration"
  112040. */
  112041. getClassName(): string;
  112042. /**
  112043. * Add fallbacks to the effect fallbacks list.
  112044. * @param defines defines the Base texture to use.
  112045. * @param fallbacks defines the current fallback list.
  112046. * @param currentRank defines the current fallback rank.
  112047. * @returns the new fallback rank.
  112048. */
  112049. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  112050. /**
  112051. * Add the required uniforms to the current list.
  112052. * @param uniforms defines the current uniform list.
  112053. */
  112054. static AddUniforms(uniforms: string[]): void;
  112055. /**
  112056. * Add the required uniforms to the current buffer.
  112057. * @param uniformBuffer defines the current uniform buffer.
  112058. */
  112059. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  112060. /**
  112061. * Add the required samplers to the current list.
  112062. * @param samplers defines the current sampler list.
  112063. */
  112064. static AddSamplers(samplers: string[]): void;
  112065. /**
  112066. * Makes a duplicate of the current configuration into another one.
  112067. * @param sheenConfiguration define the config where to copy the info
  112068. */
  112069. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  112070. /**
  112071. * Serializes this BRDF configuration.
  112072. * @returns - An object with the serialized config.
  112073. */
  112074. serialize(): any;
  112075. /**
  112076. * Parses a anisotropy Configuration from a serialized object.
  112077. * @param source - Serialized object.
  112078. * @param scene Defines the scene we are parsing for
  112079. * @param rootUrl Defines the rootUrl to load from
  112080. */
  112081. parse(source: any, scene: Scene, rootUrl: string): void;
  112082. }
  112083. }
  112084. declare module BABYLON {
  112085. /**
  112086. * @hidden
  112087. */
  112088. export interface IMaterialSubSurfaceDefines {
  112089. SUBSURFACE: boolean;
  112090. SS_REFRACTION: boolean;
  112091. SS_TRANSLUCENCY: boolean;
  112092. SS_SCATERRING: boolean;
  112093. SS_THICKNESSANDMASK_TEXTURE: boolean;
  112094. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  112095. SS_REFRACTIONMAP_3D: boolean;
  112096. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  112097. SS_LODINREFRACTIONALPHA: boolean;
  112098. SS_GAMMAREFRACTION: boolean;
  112099. SS_RGBDREFRACTION: boolean;
  112100. SS_LINEARSPECULARREFRACTION: boolean;
  112101. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  112102. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  112103. /** @hidden */
  112104. _areTexturesDirty: boolean;
  112105. }
  112106. /**
  112107. * Define the code related to the sub surface parameters of the pbr material.
  112108. */
  112109. export class PBRSubSurfaceConfiguration {
  112110. private _isRefractionEnabled;
  112111. /**
  112112. * Defines if the refraction is enabled in the material.
  112113. */
  112114. isRefractionEnabled: boolean;
  112115. private _isTranslucencyEnabled;
  112116. /**
  112117. * Defines if the translucency is enabled in the material.
  112118. */
  112119. isTranslucencyEnabled: boolean;
  112120. private _isScatteringEnabled;
  112121. /**
  112122. * Defines the refraction intensity of the material.
  112123. * The refraction when enabled replaces the Diffuse part of the material.
  112124. * The intensity helps transitionning between diffuse and refraction.
  112125. */
  112126. refractionIntensity: number;
  112127. /**
  112128. * Defines the translucency intensity of the material.
  112129. * When translucency has been enabled, this defines how much of the "translucency"
  112130. * is addded to the diffuse part of the material.
  112131. */
  112132. translucencyIntensity: number;
  112133. /**
  112134. * Defines the scattering intensity of the material.
  112135. * When scattering has been enabled, this defines how much of the "scattered light"
  112136. * is addded to the diffuse part of the material.
  112137. */
  112138. scatteringIntensity: number;
  112139. private _thicknessTexture;
  112140. /**
  112141. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  112142. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  112143. * 0 would mean minimumThickness
  112144. * 1 would mean maximumThickness
  112145. * The other channels might be use as a mask to vary the different effects intensity.
  112146. */
  112147. thicknessTexture: Nullable<BaseTexture>;
  112148. private _refractionTexture;
  112149. /**
  112150. * Defines the texture to use for refraction.
  112151. */
  112152. refractionTexture: Nullable<BaseTexture>;
  112153. private _indexOfRefraction;
  112154. /**
  112155. * Defines the index of refraction used in the material.
  112156. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  112157. */
  112158. indexOfRefraction: number;
  112159. private _invertRefractionY;
  112160. /**
  112161. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  112162. */
  112163. invertRefractionY: boolean;
  112164. private _linkRefractionWithTransparency;
  112165. /**
  112166. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  112167. * Materials half opaque for instance using refraction could benefit from this control.
  112168. */
  112169. linkRefractionWithTransparency: boolean;
  112170. /**
  112171. * Defines the minimum thickness stored in the thickness map.
  112172. * If no thickness map is defined, this value will be used to simulate thickness.
  112173. */
  112174. minimumThickness: number;
  112175. /**
  112176. * Defines the maximum thickness stored in the thickness map.
  112177. */
  112178. maximumThickness: number;
  112179. /**
  112180. * Defines the volume tint of the material.
  112181. * This is used for both translucency and scattering.
  112182. */
  112183. tintColor: Color3;
  112184. /**
  112185. * Defines the distance at which the tint color should be found in the media.
  112186. * This is used for refraction only.
  112187. */
  112188. tintColorAtDistance: number;
  112189. /**
  112190. * Defines how far each channel transmit through the media.
  112191. * It is defined as a color to simplify it selection.
  112192. */
  112193. diffusionDistance: Color3;
  112194. private _useMaskFromThicknessTexture;
  112195. /**
  112196. * Stores the intensity of the different subsurface effects in the thickness texture.
  112197. * * the green channel is the translucency intensity.
  112198. * * the blue channel is the scattering intensity.
  112199. * * the alpha channel is the refraction intensity.
  112200. */
  112201. useMaskFromThicknessTexture: boolean;
  112202. /** @hidden */
  112203. private _internalMarkAllSubMeshesAsTexturesDirty;
  112204. /** @hidden */
  112205. _markAllSubMeshesAsTexturesDirty(): void;
  112206. /**
  112207. * Instantiate a new istance of sub surface configuration.
  112208. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  112209. */
  112210. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  112211. /**
  112212. * Gets wehter the submesh is ready to be used or not.
  112213. * @param defines the list of "defines" to update.
  112214. * @param scene defines the scene the material belongs to.
  112215. * @returns - boolean indicating that the submesh is ready or not.
  112216. */
  112217. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  112218. /**
  112219. * Checks to see if a texture is used in the material.
  112220. * @param defines the list of "defines" to update.
  112221. * @param scene defines the scene to the material belongs to.
  112222. */
  112223. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  112224. /**
  112225. * Binds the material data.
  112226. * @param uniformBuffer defines the Uniform buffer to fill in.
  112227. * @param scene defines the scene the material belongs to.
  112228. * @param engine defines the engine the material belongs to.
  112229. * @param isFrozen defines wether the material is frozen or not.
  112230. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  112231. */
  112232. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  112233. /**
  112234. * Unbinds the material from the mesh.
  112235. * @param activeEffect defines the effect that should be unbound from.
  112236. * @returns true if unbound, otherwise false
  112237. */
  112238. unbind(activeEffect: Effect): boolean;
  112239. /**
  112240. * Returns the texture used for refraction or null if none is used.
  112241. * @param scene defines the scene the material belongs to.
  112242. * @returns - Refraction texture if present. If no refraction texture and refraction
  112243. * is linked with transparency, returns environment texture. Otherwise, returns null.
  112244. */
  112245. private _getRefractionTexture;
  112246. /**
  112247. * Returns true if alpha blending should be disabled.
  112248. */
  112249. readonly disableAlphaBlending: boolean;
  112250. /**
  112251. * Fills the list of render target textures.
  112252. * @param renderTargets the list of render targets to update
  112253. */
  112254. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  112255. /**
  112256. * Checks to see if a texture is used in the material.
  112257. * @param texture - Base texture to use.
  112258. * @returns - Boolean specifying if a texture is used in the material.
  112259. */
  112260. hasTexture(texture: BaseTexture): boolean;
  112261. /**
  112262. * Gets a boolean indicating that current material needs to register RTT
  112263. * @returns true if this uses a render target otherwise false.
  112264. */
  112265. hasRenderTargetTextures(): boolean;
  112266. /**
  112267. * Returns an array of the actively used textures.
  112268. * @param activeTextures Array of BaseTextures
  112269. */
  112270. getActiveTextures(activeTextures: BaseTexture[]): void;
  112271. /**
  112272. * Returns the animatable textures.
  112273. * @param animatables Array of animatable textures.
  112274. */
  112275. getAnimatables(animatables: IAnimatable[]): void;
  112276. /**
  112277. * Disposes the resources of the material.
  112278. * @param forceDisposeTextures - Forces the disposal of all textures.
  112279. */
  112280. dispose(forceDisposeTextures?: boolean): void;
  112281. /**
  112282. * Get the current class name of the texture useful for serialization or dynamic coding.
  112283. * @returns "PBRSubSurfaceConfiguration"
  112284. */
  112285. getClassName(): string;
  112286. /**
  112287. * Add fallbacks to the effect fallbacks list.
  112288. * @param defines defines the Base texture to use.
  112289. * @param fallbacks defines the current fallback list.
  112290. * @param currentRank defines the current fallback rank.
  112291. * @returns the new fallback rank.
  112292. */
  112293. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  112294. /**
  112295. * Add the required uniforms to the current list.
  112296. * @param uniforms defines the current uniform list.
  112297. */
  112298. static AddUniforms(uniforms: string[]): void;
  112299. /**
  112300. * Add the required samplers to the current list.
  112301. * @param samplers defines the current sampler list.
  112302. */
  112303. static AddSamplers(samplers: string[]): void;
  112304. /**
  112305. * Add the required uniforms to the current buffer.
  112306. * @param uniformBuffer defines the current uniform buffer.
  112307. */
  112308. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  112309. /**
  112310. * Makes a duplicate of the current configuration into another one.
  112311. * @param configuration define the config where to copy the info
  112312. */
  112313. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  112314. /**
  112315. * Serializes this Sub Surface configuration.
  112316. * @returns - An object with the serialized config.
  112317. */
  112318. serialize(): any;
  112319. /**
  112320. * Parses a anisotropy Configuration from a serialized object.
  112321. * @param source - Serialized object.
  112322. * @param scene Defines the scene we are parsing for
  112323. * @param rootUrl Defines the rootUrl to load from
  112324. */
  112325. parse(source: any, scene: Scene, rootUrl: string): void;
  112326. }
  112327. }
  112328. declare module BABYLON {
  112329. /** @hidden */
  112330. export var pbrFragmentDeclaration: {
  112331. name: string;
  112332. shader: string;
  112333. };
  112334. }
  112335. declare module BABYLON {
  112336. /** @hidden */
  112337. export var pbrUboDeclaration: {
  112338. name: string;
  112339. shader: string;
  112340. };
  112341. }
  112342. declare module BABYLON {
  112343. /** @hidden */
  112344. export var pbrFragmentExtraDeclaration: {
  112345. name: string;
  112346. shader: string;
  112347. };
  112348. }
  112349. declare module BABYLON {
  112350. /** @hidden */
  112351. export var pbrFragmentSamplersDeclaration: {
  112352. name: string;
  112353. shader: string;
  112354. };
  112355. }
  112356. declare module BABYLON {
  112357. /** @hidden */
  112358. export var pbrHelperFunctions: {
  112359. name: string;
  112360. shader: string;
  112361. };
  112362. }
  112363. declare module BABYLON {
  112364. /** @hidden */
  112365. export var harmonicsFunctions: {
  112366. name: string;
  112367. shader: string;
  112368. };
  112369. }
  112370. declare module BABYLON {
  112371. /** @hidden */
  112372. export var pbrDirectLightingSetupFunctions: {
  112373. name: string;
  112374. shader: string;
  112375. };
  112376. }
  112377. declare module BABYLON {
  112378. /** @hidden */
  112379. export var pbrDirectLightingFalloffFunctions: {
  112380. name: string;
  112381. shader: string;
  112382. };
  112383. }
  112384. declare module BABYLON {
  112385. /** @hidden */
  112386. export var pbrBRDFFunctions: {
  112387. name: string;
  112388. shader: string;
  112389. };
  112390. }
  112391. declare module BABYLON {
  112392. /** @hidden */
  112393. export var pbrDirectLightingFunctions: {
  112394. name: string;
  112395. shader: string;
  112396. };
  112397. }
  112398. declare module BABYLON {
  112399. /** @hidden */
  112400. export var pbrIBLFunctions: {
  112401. name: string;
  112402. shader: string;
  112403. };
  112404. }
  112405. declare module BABYLON {
  112406. /** @hidden */
  112407. export var pbrDebug: {
  112408. name: string;
  112409. shader: string;
  112410. };
  112411. }
  112412. declare module BABYLON {
  112413. /** @hidden */
  112414. export var pbrPixelShader: {
  112415. name: string;
  112416. shader: string;
  112417. };
  112418. }
  112419. declare module BABYLON {
  112420. /** @hidden */
  112421. export var pbrVertexDeclaration: {
  112422. name: string;
  112423. shader: string;
  112424. };
  112425. }
  112426. declare module BABYLON {
  112427. /** @hidden */
  112428. export var pbrVertexShader: {
  112429. name: string;
  112430. shader: string;
  112431. };
  112432. }
  112433. declare module BABYLON {
  112434. /**
  112435. * Manages the defines for the PBR Material.
  112436. * @hidden
  112437. */
  112438. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  112439. PBR: boolean;
  112440. MAINUV1: boolean;
  112441. MAINUV2: boolean;
  112442. UV1: boolean;
  112443. UV2: boolean;
  112444. ALBEDO: boolean;
  112445. ALBEDODIRECTUV: number;
  112446. VERTEXCOLOR: boolean;
  112447. AMBIENT: boolean;
  112448. AMBIENTDIRECTUV: number;
  112449. AMBIENTINGRAYSCALE: boolean;
  112450. OPACITY: boolean;
  112451. VERTEXALPHA: boolean;
  112452. OPACITYDIRECTUV: number;
  112453. OPACITYRGB: boolean;
  112454. ALPHATEST: boolean;
  112455. DEPTHPREPASS: boolean;
  112456. ALPHABLEND: boolean;
  112457. ALPHAFROMALBEDO: boolean;
  112458. ALPHATESTVALUE: string;
  112459. SPECULAROVERALPHA: boolean;
  112460. RADIANCEOVERALPHA: boolean;
  112461. ALPHAFRESNEL: boolean;
  112462. LINEARALPHAFRESNEL: boolean;
  112463. PREMULTIPLYALPHA: boolean;
  112464. EMISSIVE: boolean;
  112465. EMISSIVEDIRECTUV: number;
  112466. REFLECTIVITY: boolean;
  112467. REFLECTIVITYDIRECTUV: number;
  112468. SPECULARTERM: boolean;
  112469. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  112470. MICROSURFACEAUTOMATIC: boolean;
  112471. LODBASEDMICROSFURACE: boolean;
  112472. MICROSURFACEMAP: boolean;
  112473. MICROSURFACEMAPDIRECTUV: number;
  112474. METALLICWORKFLOW: boolean;
  112475. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  112476. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  112477. METALLNESSSTOREINMETALMAPBLUE: boolean;
  112478. AOSTOREINMETALMAPRED: boolean;
  112479. ENVIRONMENTBRDF: boolean;
  112480. ENVIRONMENTBRDF_RGBD: boolean;
  112481. NORMAL: boolean;
  112482. TANGENT: boolean;
  112483. BUMP: boolean;
  112484. BUMPDIRECTUV: number;
  112485. OBJECTSPACE_NORMALMAP: boolean;
  112486. PARALLAX: boolean;
  112487. PARALLAXOCCLUSION: boolean;
  112488. NORMALXYSCALE: boolean;
  112489. LIGHTMAP: boolean;
  112490. LIGHTMAPDIRECTUV: number;
  112491. USELIGHTMAPASSHADOWMAP: boolean;
  112492. GAMMALIGHTMAP: boolean;
  112493. RGBDLIGHTMAP: boolean;
  112494. REFLECTION: boolean;
  112495. REFLECTIONMAP_3D: boolean;
  112496. REFLECTIONMAP_SPHERICAL: boolean;
  112497. REFLECTIONMAP_PLANAR: boolean;
  112498. REFLECTIONMAP_CUBIC: boolean;
  112499. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  112500. REFLECTIONMAP_PROJECTION: boolean;
  112501. REFLECTIONMAP_SKYBOX: boolean;
  112502. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  112503. REFLECTIONMAP_EXPLICIT: boolean;
  112504. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  112505. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  112506. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  112507. INVERTCUBICMAP: boolean;
  112508. USESPHERICALFROMREFLECTIONMAP: boolean;
  112509. USEIRRADIANCEMAP: boolean;
  112510. SPHERICAL_HARMONICS: boolean;
  112511. USESPHERICALINVERTEX: boolean;
  112512. REFLECTIONMAP_OPPOSITEZ: boolean;
  112513. LODINREFLECTIONALPHA: boolean;
  112514. GAMMAREFLECTION: boolean;
  112515. RGBDREFLECTION: boolean;
  112516. LINEARSPECULARREFLECTION: boolean;
  112517. RADIANCEOCCLUSION: boolean;
  112518. HORIZONOCCLUSION: boolean;
  112519. INSTANCES: boolean;
  112520. NUM_BONE_INFLUENCERS: number;
  112521. BonesPerMesh: number;
  112522. BONETEXTURE: boolean;
  112523. NONUNIFORMSCALING: boolean;
  112524. MORPHTARGETS: boolean;
  112525. MORPHTARGETS_NORMAL: boolean;
  112526. MORPHTARGETS_TANGENT: boolean;
  112527. MORPHTARGETS_UV: boolean;
  112528. NUM_MORPH_INFLUENCERS: number;
  112529. IMAGEPROCESSING: boolean;
  112530. VIGNETTE: boolean;
  112531. VIGNETTEBLENDMODEMULTIPLY: boolean;
  112532. VIGNETTEBLENDMODEOPAQUE: boolean;
  112533. TONEMAPPING: boolean;
  112534. TONEMAPPING_ACES: boolean;
  112535. CONTRAST: boolean;
  112536. COLORCURVES: boolean;
  112537. COLORGRADING: boolean;
  112538. COLORGRADING3D: boolean;
  112539. SAMPLER3DGREENDEPTH: boolean;
  112540. SAMPLER3DBGRMAP: boolean;
  112541. IMAGEPROCESSINGPOSTPROCESS: boolean;
  112542. EXPOSURE: boolean;
  112543. MULTIVIEW: boolean;
  112544. USEPHYSICALLIGHTFALLOFF: boolean;
  112545. USEGLTFLIGHTFALLOFF: boolean;
  112546. TWOSIDEDLIGHTING: boolean;
  112547. SHADOWFLOAT: boolean;
  112548. CLIPPLANE: boolean;
  112549. CLIPPLANE2: boolean;
  112550. CLIPPLANE3: boolean;
  112551. CLIPPLANE4: boolean;
  112552. POINTSIZE: boolean;
  112553. FOG: boolean;
  112554. LOGARITHMICDEPTH: boolean;
  112555. FORCENORMALFORWARD: boolean;
  112556. SPECULARAA: boolean;
  112557. CLEARCOAT: boolean;
  112558. CLEARCOAT_DEFAULTIOR: boolean;
  112559. CLEARCOAT_TEXTURE: boolean;
  112560. CLEARCOAT_TEXTUREDIRECTUV: number;
  112561. CLEARCOAT_BUMP: boolean;
  112562. CLEARCOAT_BUMPDIRECTUV: number;
  112563. CLEARCOAT_TINT: boolean;
  112564. CLEARCOAT_TINT_TEXTURE: boolean;
  112565. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  112566. ANISOTROPIC: boolean;
  112567. ANISOTROPIC_TEXTURE: boolean;
  112568. ANISOTROPIC_TEXTUREDIRECTUV: number;
  112569. BRDF_V_HEIGHT_CORRELATED: boolean;
  112570. MS_BRDF_ENERGY_CONSERVATION: boolean;
  112571. SHEEN: boolean;
  112572. SHEEN_TEXTURE: boolean;
  112573. SHEEN_TEXTUREDIRECTUV: number;
  112574. SHEEN_LINKWITHALBEDO: boolean;
  112575. SUBSURFACE: boolean;
  112576. SS_REFRACTION: boolean;
  112577. SS_TRANSLUCENCY: boolean;
  112578. SS_SCATERRING: boolean;
  112579. SS_THICKNESSANDMASK_TEXTURE: boolean;
  112580. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  112581. SS_REFRACTIONMAP_3D: boolean;
  112582. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  112583. SS_LODINREFRACTIONALPHA: boolean;
  112584. SS_GAMMAREFRACTION: boolean;
  112585. SS_RGBDREFRACTION: boolean;
  112586. SS_LINEARSPECULARREFRACTION: boolean;
  112587. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  112588. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  112589. UNLIT: boolean;
  112590. DEBUGMODE: number;
  112591. /**
  112592. * Initializes the PBR Material defines.
  112593. */
  112594. constructor();
  112595. /**
  112596. * Resets the PBR Material defines.
  112597. */
  112598. reset(): void;
  112599. }
  112600. /**
  112601. * The Physically based material base class of BJS.
  112602. *
  112603. * This offers the main features of a standard PBR material.
  112604. * For more information, please refer to the documentation :
  112605. * https://doc.babylonjs.com/how_to/physically_based_rendering
  112606. */
  112607. export abstract class PBRBaseMaterial extends PushMaterial {
  112608. /**
  112609. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  112610. */
  112611. static readonly PBRMATERIAL_OPAQUE: number;
  112612. /**
  112613. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  112614. */
  112615. static readonly PBRMATERIAL_ALPHATEST: number;
  112616. /**
  112617. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  112618. */
  112619. static readonly PBRMATERIAL_ALPHABLEND: number;
  112620. /**
  112621. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  112622. * They are also discarded below the alpha cutoff threshold to improve performances.
  112623. */
  112624. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  112625. /**
  112626. * Defines the default value of how much AO map is occluding the analytical lights
  112627. * (point spot...).
  112628. */
  112629. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  112630. /**
  112631. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  112632. */
  112633. static readonly LIGHTFALLOFF_PHYSICAL: number;
  112634. /**
  112635. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  112636. * to enhance interoperability with other engines.
  112637. */
  112638. static readonly LIGHTFALLOFF_GLTF: number;
  112639. /**
  112640. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  112641. * to enhance interoperability with other materials.
  112642. */
  112643. static readonly LIGHTFALLOFF_STANDARD: number;
  112644. /**
  112645. * Intensity of the direct lights e.g. the four lights available in your scene.
  112646. * This impacts both the direct diffuse and specular highlights.
  112647. */
  112648. protected _directIntensity: number;
  112649. /**
  112650. * Intensity of the emissive part of the material.
  112651. * This helps controlling the emissive effect without modifying the emissive color.
  112652. */
  112653. protected _emissiveIntensity: number;
  112654. /**
  112655. * Intensity of the environment e.g. how much the environment will light the object
  112656. * either through harmonics for rough material or through the refelction for shiny ones.
  112657. */
  112658. protected _environmentIntensity: number;
  112659. /**
  112660. * This is a special control allowing the reduction of the specular highlights coming from the
  112661. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  112662. */
  112663. protected _specularIntensity: number;
  112664. /**
  112665. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  112666. */
  112667. private _lightingInfos;
  112668. /**
  112669. * Debug Control allowing disabling the bump map on this material.
  112670. */
  112671. protected _disableBumpMap: boolean;
  112672. /**
  112673. * AKA Diffuse Texture in standard nomenclature.
  112674. */
  112675. protected _albedoTexture: Nullable<BaseTexture>;
  112676. /**
  112677. * AKA Occlusion Texture in other nomenclature.
  112678. */
  112679. protected _ambientTexture: Nullable<BaseTexture>;
  112680. /**
  112681. * AKA Occlusion Texture Intensity in other nomenclature.
  112682. */
  112683. protected _ambientTextureStrength: number;
  112684. /**
  112685. * Defines how much the AO map is occluding the analytical lights (point spot...).
  112686. * 1 means it completely occludes it
  112687. * 0 mean it has no impact
  112688. */
  112689. protected _ambientTextureImpactOnAnalyticalLights: number;
  112690. /**
  112691. * Stores the alpha values in a texture.
  112692. */
  112693. protected _opacityTexture: Nullable<BaseTexture>;
  112694. /**
  112695. * Stores the reflection values in a texture.
  112696. */
  112697. protected _reflectionTexture: Nullable<BaseTexture>;
  112698. /**
  112699. * Stores the emissive values in a texture.
  112700. */
  112701. protected _emissiveTexture: Nullable<BaseTexture>;
  112702. /**
  112703. * AKA Specular texture in other nomenclature.
  112704. */
  112705. protected _reflectivityTexture: Nullable<BaseTexture>;
  112706. /**
  112707. * Used to switch from specular/glossiness to metallic/roughness workflow.
  112708. */
  112709. protected _metallicTexture: Nullable<BaseTexture>;
  112710. /**
  112711. * Specifies the metallic scalar of the metallic/roughness workflow.
  112712. * Can also be used to scale the metalness values of the metallic texture.
  112713. */
  112714. protected _metallic: Nullable<number>;
  112715. /**
  112716. * Specifies the roughness scalar of the metallic/roughness workflow.
  112717. * Can also be used to scale the roughness values of the metallic texture.
  112718. */
  112719. protected _roughness: Nullable<number>;
  112720. /**
  112721. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  112722. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  112723. */
  112724. protected _microSurfaceTexture: Nullable<BaseTexture>;
  112725. /**
  112726. * Stores surface normal data used to displace a mesh in a texture.
  112727. */
  112728. protected _bumpTexture: Nullable<BaseTexture>;
  112729. /**
  112730. * Stores the pre-calculated light information of a mesh in a texture.
  112731. */
  112732. protected _lightmapTexture: Nullable<BaseTexture>;
  112733. /**
  112734. * The color of a material in ambient lighting.
  112735. */
  112736. protected _ambientColor: Color3;
  112737. /**
  112738. * AKA Diffuse Color in other nomenclature.
  112739. */
  112740. protected _albedoColor: Color3;
  112741. /**
  112742. * AKA Specular Color in other nomenclature.
  112743. */
  112744. protected _reflectivityColor: Color3;
  112745. /**
  112746. * The color applied when light is reflected from a material.
  112747. */
  112748. protected _reflectionColor: Color3;
  112749. /**
  112750. * The color applied when light is emitted from a material.
  112751. */
  112752. protected _emissiveColor: Color3;
  112753. /**
  112754. * AKA Glossiness in other nomenclature.
  112755. */
  112756. protected _microSurface: number;
  112757. /**
  112758. * Specifies that the material will use the light map as a show map.
  112759. */
  112760. protected _useLightmapAsShadowmap: boolean;
  112761. /**
  112762. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  112763. * makes the reflect vector face the model (under horizon).
  112764. */
  112765. protected _useHorizonOcclusion: boolean;
  112766. /**
  112767. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  112768. * too much the area relying on ambient texture to define their ambient occlusion.
  112769. */
  112770. protected _useRadianceOcclusion: boolean;
  112771. /**
  112772. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  112773. */
  112774. protected _useAlphaFromAlbedoTexture: boolean;
  112775. /**
  112776. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  112777. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  112778. */
  112779. protected _useSpecularOverAlpha: boolean;
  112780. /**
  112781. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  112782. */
  112783. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  112784. /**
  112785. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  112786. */
  112787. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  112788. /**
  112789. * Specifies if the metallic texture contains the roughness information in its green channel.
  112790. */
  112791. protected _useRoughnessFromMetallicTextureGreen: boolean;
  112792. /**
  112793. * Specifies if the metallic texture contains the metallness information in its blue channel.
  112794. */
  112795. protected _useMetallnessFromMetallicTextureBlue: boolean;
  112796. /**
  112797. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  112798. */
  112799. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  112800. /**
  112801. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  112802. */
  112803. protected _useAmbientInGrayScale: boolean;
  112804. /**
  112805. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  112806. * The material will try to infer what glossiness each pixel should be.
  112807. */
  112808. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  112809. /**
  112810. * Defines the falloff type used in this material.
  112811. * It by default is Physical.
  112812. */
  112813. protected _lightFalloff: number;
  112814. /**
  112815. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  112816. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  112817. */
  112818. protected _useRadianceOverAlpha: boolean;
  112819. /**
  112820. * Allows using an object space normal map (instead of tangent space).
  112821. */
  112822. protected _useObjectSpaceNormalMap: boolean;
  112823. /**
  112824. * Allows using the bump map in parallax mode.
  112825. */
  112826. protected _useParallax: boolean;
  112827. /**
  112828. * Allows using the bump map in parallax occlusion mode.
  112829. */
  112830. protected _useParallaxOcclusion: boolean;
  112831. /**
  112832. * Controls the scale bias of the parallax mode.
  112833. */
  112834. protected _parallaxScaleBias: number;
  112835. /**
  112836. * If sets to true, disables all the lights affecting the material.
  112837. */
  112838. protected _disableLighting: boolean;
  112839. /**
  112840. * Number of Simultaneous lights allowed on the material.
  112841. */
  112842. protected _maxSimultaneousLights: number;
  112843. /**
  112844. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  112845. */
  112846. protected _invertNormalMapX: boolean;
  112847. /**
  112848. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  112849. */
  112850. protected _invertNormalMapY: boolean;
  112851. /**
  112852. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  112853. */
  112854. protected _twoSidedLighting: boolean;
  112855. /**
  112856. * Defines the alpha limits in alpha test mode.
  112857. */
  112858. protected _alphaCutOff: number;
  112859. /**
  112860. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  112861. */
  112862. protected _forceAlphaTest: boolean;
  112863. /**
  112864. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  112865. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  112866. */
  112867. protected _useAlphaFresnel: boolean;
  112868. /**
  112869. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  112870. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  112871. */
  112872. protected _useLinearAlphaFresnel: boolean;
  112873. /**
  112874. * The transparency mode of the material.
  112875. */
  112876. protected _transparencyMode: Nullable<number>;
  112877. /**
  112878. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  112879. * from cos thetav and roughness:
  112880. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  112881. */
  112882. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  112883. /**
  112884. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  112885. */
  112886. protected _forceIrradianceInFragment: boolean;
  112887. /**
  112888. * Force normal to face away from face.
  112889. */
  112890. protected _forceNormalForward: boolean;
  112891. /**
  112892. * Enables specular anti aliasing in the PBR shader.
  112893. * It will both interacts on the Geometry for analytical and IBL lighting.
  112894. * It also prefilter the roughness map based on the bump values.
  112895. */
  112896. protected _enableSpecularAntiAliasing: boolean;
  112897. /**
  112898. * Default configuration related to image processing available in the PBR Material.
  112899. */
  112900. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  112901. /**
  112902. * Keep track of the image processing observer to allow dispose and replace.
  112903. */
  112904. private _imageProcessingObserver;
  112905. /**
  112906. * Attaches a new image processing configuration to the PBR Material.
  112907. * @param configuration
  112908. */
  112909. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  112910. /**
  112911. * Stores the available render targets.
  112912. */
  112913. private _renderTargets;
  112914. /**
  112915. * Sets the global ambient color for the material used in lighting calculations.
  112916. */
  112917. private _globalAmbientColor;
  112918. /**
  112919. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  112920. */
  112921. private _useLogarithmicDepth;
  112922. /**
  112923. * If set to true, no lighting calculations will be applied.
  112924. */
  112925. private _unlit;
  112926. private _debugMode;
  112927. /**
  112928. * @hidden
  112929. * This is reserved for the inspector.
  112930. * Defines the material debug mode.
  112931. * It helps seeing only some components of the material while troubleshooting.
  112932. */
  112933. debugMode: number;
  112934. /**
  112935. * @hidden
  112936. * This is reserved for the inspector.
  112937. * Specify from where on screen the debug mode should start.
  112938. * The value goes from -1 (full screen) to 1 (not visible)
  112939. * It helps with side by side comparison against the final render
  112940. * This defaults to -1
  112941. */
  112942. private debugLimit;
  112943. /**
  112944. * @hidden
  112945. * This is reserved for the inspector.
  112946. * As the default viewing range might not be enough (if the ambient is really small for instance)
  112947. * You can use the factor to better multiply the final value.
  112948. */
  112949. private debugFactor;
  112950. /**
  112951. * Defines the clear coat layer parameters for the material.
  112952. */
  112953. readonly clearCoat: PBRClearCoatConfiguration;
  112954. /**
  112955. * Defines the anisotropic parameters for the material.
  112956. */
  112957. readonly anisotropy: PBRAnisotropicConfiguration;
  112958. /**
  112959. * Defines the BRDF parameters for the material.
  112960. */
  112961. readonly brdf: PBRBRDFConfiguration;
  112962. /**
  112963. * Defines the Sheen parameters for the material.
  112964. */
  112965. readonly sheen: PBRSheenConfiguration;
  112966. /**
  112967. * Defines the SubSurface parameters for the material.
  112968. */
  112969. readonly subSurface: PBRSubSurfaceConfiguration;
  112970. /**
  112971. * Custom callback helping to override the default shader used in the material.
  112972. */
  112973. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  112974. protected _rebuildInParallel: boolean;
  112975. /**
  112976. * Instantiates a new PBRMaterial instance.
  112977. *
  112978. * @param name The material name
  112979. * @param scene The scene the material will be use in.
  112980. */
  112981. constructor(name: string, scene: Scene);
  112982. /**
  112983. * Gets a boolean indicating that current material needs to register RTT
  112984. */
  112985. readonly hasRenderTargetTextures: boolean;
  112986. /**
  112987. * Gets the name of the material class.
  112988. */
  112989. getClassName(): string;
  112990. /**
  112991. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  112992. */
  112993. /**
  112994. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  112995. */
  112996. useLogarithmicDepth: boolean;
  112997. /**
  112998. * Gets the current transparency mode.
  112999. */
  113000. /**
  113001. * Sets the transparency mode of the material.
  113002. *
  113003. * | Value | Type | Description |
  113004. * | ----- | ----------------------------------- | ----------- |
  113005. * | 0 | OPAQUE | |
  113006. * | 1 | ALPHATEST | |
  113007. * | 2 | ALPHABLEND | |
  113008. * | 3 | ALPHATESTANDBLEND | |
  113009. *
  113010. */
  113011. transparencyMode: Nullable<number>;
  113012. /**
  113013. * Returns true if alpha blending should be disabled.
  113014. */
  113015. private readonly _disableAlphaBlending;
  113016. /**
  113017. * Specifies whether or not this material should be rendered in alpha blend mode.
  113018. */
  113019. needAlphaBlending(): boolean;
  113020. /**
  113021. * Specifies if the mesh will require alpha blending.
  113022. * @param mesh - BJS mesh.
  113023. */
  113024. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  113025. /**
  113026. * Specifies whether or not this material should be rendered in alpha test mode.
  113027. */
  113028. needAlphaTesting(): boolean;
  113029. /**
  113030. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  113031. */
  113032. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  113033. /**
  113034. * Gets the texture used for the alpha test.
  113035. */
  113036. getAlphaTestTexture(): Nullable<BaseTexture>;
  113037. /**
  113038. * Specifies that the submesh is ready to be used.
  113039. * @param mesh - BJS mesh.
  113040. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  113041. * @param useInstances - Specifies that instances should be used.
  113042. * @returns - boolean indicating that the submesh is ready or not.
  113043. */
  113044. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  113045. /**
  113046. * Specifies if the material uses metallic roughness workflow.
  113047. * @returns boolean specifiying if the material uses metallic roughness workflow.
  113048. */
  113049. isMetallicWorkflow(): boolean;
  113050. private _prepareEffect;
  113051. private _prepareDefines;
  113052. /**
  113053. * Force shader compilation
  113054. */
  113055. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  113056. clipPlane: boolean;
  113057. }>): void;
  113058. /**
  113059. * Initializes the uniform buffer layout for the shader.
  113060. */
  113061. buildUniformLayout(): void;
  113062. /**
  113063. * Unbinds the material from the mesh
  113064. */
  113065. unbind(): void;
  113066. /**
  113067. * Binds the submesh data.
  113068. * @param world - The world matrix.
  113069. * @param mesh - The BJS mesh.
  113070. * @param subMesh - A submesh of the BJS mesh.
  113071. */
  113072. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  113073. /**
  113074. * Returns the animatable textures.
  113075. * @returns - Array of animatable textures.
  113076. */
  113077. getAnimatables(): IAnimatable[];
  113078. /**
  113079. * Returns the texture used for reflections.
  113080. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  113081. */
  113082. private _getReflectionTexture;
  113083. /**
  113084. * Returns an array of the actively used textures.
  113085. * @returns - Array of BaseTextures
  113086. */
  113087. getActiveTextures(): BaseTexture[];
  113088. /**
  113089. * Checks to see if a texture is used in the material.
  113090. * @param texture - Base texture to use.
  113091. * @returns - Boolean specifying if a texture is used in the material.
  113092. */
  113093. hasTexture(texture: BaseTexture): boolean;
  113094. /**
  113095. * Disposes the resources of the material.
  113096. * @param forceDisposeEffect - Forces the disposal of effects.
  113097. * @param forceDisposeTextures - Forces the disposal of all textures.
  113098. */
  113099. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  113100. }
  113101. }
  113102. declare module BABYLON {
  113103. /**
  113104. * The Physically based material of BJS.
  113105. *
  113106. * This offers the main features of a standard PBR material.
  113107. * For more information, please refer to the documentation :
  113108. * https://doc.babylonjs.com/how_to/physically_based_rendering
  113109. */
  113110. export class PBRMaterial extends PBRBaseMaterial {
  113111. /**
  113112. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  113113. */
  113114. static readonly PBRMATERIAL_OPAQUE: number;
  113115. /**
  113116. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  113117. */
  113118. static readonly PBRMATERIAL_ALPHATEST: number;
  113119. /**
  113120. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  113121. */
  113122. static readonly PBRMATERIAL_ALPHABLEND: number;
  113123. /**
  113124. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  113125. * They are also discarded below the alpha cutoff threshold to improve performances.
  113126. */
  113127. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  113128. /**
  113129. * Defines the default value of how much AO map is occluding the analytical lights
  113130. * (point spot...).
  113131. */
  113132. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  113133. /**
  113134. * Intensity of the direct lights e.g. the four lights available in your scene.
  113135. * This impacts both the direct diffuse and specular highlights.
  113136. */
  113137. directIntensity: number;
  113138. /**
  113139. * Intensity of the emissive part of the material.
  113140. * This helps controlling the emissive effect without modifying the emissive color.
  113141. */
  113142. emissiveIntensity: number;
  113143. /**
  113144. * Intensity of the environment e.g. how much the environment will light the object
  113145. * either through harmonics for rough material or through the refelction for shiny ones.
  113146. */
  113147. environmentIntensity: number;
  113148. /**
  113149. * This is a special control allowing the reduction of the specular highlights coming from the
  113150. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  113151. */
  113152. specularIntensity: number;
  113153. /**
  113154. * Debug Control allowing disabling the bump map on this material.
  113155. */
  113156. disableBumpMap: boolean;
  113157. /**
  113158. * AKA Diffuse Texture in standard nomenclature.
  113159. */
  113160. albedoTexture: BaseTexture;
  113161. /**
  113162. * AKA Occlusion Texture in other nomenclature.
  113163. */
  113164. ambientTexture: BaseTexture;
  113165. /**
  113166. * AKA Occlusion Texture Intensity in other nomenclature.
  113167. */
  113168. ambientTextureStrength: number;
  113169. /**
  113170. * Defines how much the AO map is occluding the analytical lights (point spot...).
  113171. * 1 means it completely occludes it
  113172. * 0 mean it has no impact
  113173. */
  113174. ambientTextureImpactOnAnalyticalLights: number;
  113175. /**
  113176. * Stores the alpha values in a texture.
  113177. */
  113178. opacityTexture: BaseTexture;
  113179. /**
  113180. * Stores the reflection values in a texture.
  113181. */
  113182. reflectionTexture: Nullable<BaseTexture>;
  113183. /**
  113184. * Stores the emissive values in a texture.
  113185. */
  113186. emissiveTexture: BaseTexture;
  113187. /**
  113188. * AKA Specular texture in other nomenclature.
  113189. */
  113190. reflectivityTexture: BaseTexture;
  113191. /**
  113192. * Used to switch from specular/glossiness to metallic/roughness workflow.
  113193. */
  113194. metallicTexture: BaseTexture;
  113195. /**
  113196. * Specifies the metallic scalar of the metallic/roughness workflow.
  113197. * Can also be used to scale the metalness values of the metallic texture.
  113198. */
  113199. metallic: Nullable<number>;
  113200. /**
  113201. * Specifies the roughness scalar of the metallic/roughness workflow.
  113202. * Can also be used to scale the roughness values of the metallic texture.
  113203. */
  113204. roughness: Nullable<number>;
  113205. /**
  113206. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  113207. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  113208. */
  113209. microSurfaceTexture: BaseTexture;
  113210. /**
  113211. * Stores surface normal data used to displace a mesh in a texture.
  113212. */
  113213. bumpTexture: BaseTexture;
  113214. /**
  113215. * Stores the pre-calculated light information of a mesh in a texture.
  113216. */
  113217. lightmapTexture: BaseTexture;
  113218. /**
  113219. * Stores the refracted light information in a texture.
  113220. */
  113221. refractionTexture: Nullable<BaseTexture>;
  113222. /**
  113223. * The color of a material in ambient lighting.
  113224. */
  113225. ambientColor: Color3;
  113226. /**
  113227. * AKA Diffuse Color in other nomenclature.
  113228. */
  113229. albedoColor: Color3;
  113230. /**
  113231. * AKA Specular Color in other nomenclature.
  113232. */
  113233. reflectivityColor: Color3;
  113234. /**
  113235. * The color reflected from the material.
  113236. */
  113237. reflectionColor: Color3;
  113238. /**
  113239. * The color emitted from the material.
  113240. */
  113241. emissiveColor: Color3;
  113242. /**
  113243. * AKA Glossiness in other nomenclature.
  113244. */
  113245. microSurface: number;
  113246. /**
  113247. * source material index of refraction (IOR)' / 'destination material IOR.
  113248. */
  113249. indexOfRefraction: number;
  113250. /**
  113251. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  113252. */
  113253. invertRefractionY: boolean;
  113254. /**
  113255. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  113256. * Materials half opaque for instance using refraction could benefit from this control.
  113257. */
  113258. linkRefractionWithTransparency: boolean;
  113259. /**
  113260. * If true, the light map contains occlusion information instead of lighting info.
  113261. */
  113262. useLightmapAsShadowmap: boolean;
  113263. /**
  113264. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  113265. */
  113266. useAlphaFromAlbedoTexture: boolean;
  113267. /**
  113268. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  113269. */
  113270. forceAlphaTest: boolean;
  113271. /**
  113272. * Defines the alpha limits in alpha test mode.
  113273. */
  113274. alphaCutOff: number;
  113275. /**
  113276. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  113277. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  113278. */
  113279. useSpecularOverAlpha: boolean;
  113280. /**
  113281. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  113282. */
  113283. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  113284. /**
  113285. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  113286. */
  113287. useRoughnessFromMetallicTextureAlpha: boolean;
  113288. /**
  113289. * Specifies if the metallic texture contains the roughness information in its green channel.
  113290. */
  113291. useRoughnessFromMetallicTextureGreen: boolean;
  113292. /**
  113293. * Specifies if the metallic texture contains the metallness information in its blue channel.
  113294. */
  113295. useMetallnessFromMetallicTextureBlue: boolean;
  113296. /**
  113297. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  113298. */
  113299. useAmbientOcclusionFromMetallicTextureRed: boolean;
  113300. /**
  113301. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  113302. */
  113303. useAmbientInGrayScale: boolean;
  113304. /**
  113305. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  113306. * The material will try to infer what glossiness each pixel should be.
  113307. */
  113308. useAutoMicroSurfaceFromReflectivityMap: boolean;
  113309. /**
  113310. * BJS is using an harcoded light falloff based on a manually sets up range.
  113311. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  113312. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  113313. */
  113314. /**
  113315. * BJS is using an harcoded light falloff based on a manually sets up range.
  113316. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  113317. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  113318. */
  113319. usePhysicalLightFalloff: boolean;
  113320. /**
  113321. * In order to support the falloff compatibility with gltf, a special mode has been added
  113322. * to reproduce the gltf light falloff.
  113323. */
  113324. /**
  113325. * In order to support the falloff compatibility with gltf, a special mode has been added
  113326. * to reproduce the gltf light falloff.
  113327. */
  113328. useGLTFLightFalloff: boolean;
  113329. /**
  113330. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  113331. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  113332. */
  113333. useRadianceOverAlpha: boolean;
  113334. /**
  113335. * Allows using an object space normal map (instead of tangent space).
  113336. */
  113337. useObjectSpaceNormalMap: boolean;
  113338. /**
  113339. * Allows using the bump map in parallax mode.
  113340. */
  113341. useParallax: boolean;
  113342. /**
  113343. * Allows using the bump map in parallax occlusion mode.
  113344. */
  113345. useParallaxOcclusion: boolean;
  113346. /**
  113347. * Controls the scale bias of the parallax mode.
  113348. */
  113349. parallaxScaleBias: number;
  113350. /**
  113351. * If sets to true, disables all the lights affecting the material.
  113352. */
  113353. disableLighting: boolean;
  113354. /**
  113355. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  113356. */
  113357. forceIrradianceInFragment: boolean;
  113358. /**
  113359. * Number of Simultaneous lights allowed on the material.
  113360. */
  113361. maxSimultaneousLights: number;
  113362. /**
  113363. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  113364. */
  113365. invertNormalMapX: boolean;
  113366. /**
  113367. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  113368. */
  113369. invertNormalMapY: boolean;
  113370. /**
  113371. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  113372. */
  113373. twoSidedLighting: boolean;
  113374. /**
  113375. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  113376. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  113377. */
  113378. useAlphaFresnel: boolean;
  113379. /**
  113380. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  113381. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  113382. */
  113383. useLinearAlphaFresnel: boolean;
  113384. /**
  113385. * Let user defines the brdf lookup texture used for IBL.
  113386. * A default 8bit version is embedded but you could point at :
  113387. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  113388. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  113389. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  113390. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  113391. */
  113392. environmentBRDFTexture: Nullable<BaseTexture>;
  113393. /**
  113394. * Force normal to face away from face.
  113395. */
  113396. forceNormalForward: boolean;
  113397. /**
  113398. * Enables specular anti aliasing in the PBR shader.
  113399. * It will both interacts on the Geometry for analytical and IBL lighting.
  113400. * It also prefilter the roughness map based on the bump values.
  113401. */
  113402. enableSpecularAntiAliasing: boolean;
  113403. /**
  113404. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  113405. * makes the reflect vector face the model (under horizon).
  113406. */
  113407. useHorizonOcclusion: boolean;
  113408. /**
  113409. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  113410. * too much the area relying on ambient texture to define their ambient occlusion.
  113411. */
  113412. useRadianceOcclusion: boolean;
  113413. /**
  113414. * If set to true, no lighting calculations will be applied.
  113415. */
  113416. unlit: boolean;
  113417. /**
  113418. * Gets the image processing configuration used either in this material.
  113419. */
  113420. /**
  113421. * Sets the Default image processing configuration used either in the this material.
  113422. *
  113423. * If sets to null, the scene one is in use.
  113424. */
  113425. imageProcessingConfiguration: ImageProcessingConfiguration;
  113426. /**
  113427. * Gets wether the color curves effect is enabled.
  113428. */
  113429. /**
  113430. * Sets wether the color curves effect is enabled.
  113431. */
  113432. cameraColorCurvesEnabled: boolean;
  113433. /**
  113434. * Gets wether the color grading effect is enabled.
  113435. */
  113436. /**
  113437. * Gets wether the color grading effect is enabled.
  113438. */
  113439. cameraColorGradingEnabled: boolean;
  113440. /**
  113441. * Gets wether tonemapping is enabled or not.
  113442. */
  113443. /**
  113444. * Sets wether tonemapping is enabled or not
  113445. */
  113446. cameraToneMappingEnabled: boolean;
  113447. /**
  113448. * The camera exposure used on this material.
  113449. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  113450. * This corresponds to a photographic exposure.
  113451. */
  113452. /**
  113453. * The camera exposure used on this material.
  113454. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  113455. * This corresponds to a photographic exposure.
  113456. */
  113457. cameraExposure: number;
  113458. /**
  113459. * Gets The camera contrast used on this material.
  113460. */
  113461. /**
  113462. * Sets The camera contrast used on this material.
  113463. */
  113464. cameraContrast: number;
  113465. /**
  113466. * Gets the Color Grading 2D Lookup Texture.
  113467. */
  113468. /**
  113469. * Sets the Color Grading 2D Lookup Texture.
  113470. */
  113471. cameraColorGradingTexture: Nullable<BaseTexture>;
  113472. /**
  113473. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  113474. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  113475. * 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;
  113476. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  113477. */
  113478. /**
  113479. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  113480. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  113481. * 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;
  113482. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  113483. */
  113484. cameraColorCurves: Nullable<ColorCurves>;
  113485. /**
  113486. * Instantiates a new PBRMaterial instance.
  113487. *
  113488. * @param name The material name
  113489. * @param scene The scene the material will be use in.
  113490. */
  113491. constructor(name: string, scene: Scene);
  113492. /**
  113493. * Returns the name of this material class.
  113494. */
  113495. getClassName(): string;
  113496. /**
  113497. * Makes a duplicate of the current material.
  113498. * @param name - name to use for the new material.
  113499. */
  113500. clone(name: string): PBRMaterial;
  113501. /**
  113502. * Serializes this PBR Material.
  113503. * @returns - An object with the serialized material.
  113504. */
  113505. serialize(): any;
  113506. /**
  113507. * Parses a PBR Material from a serialized object.
  113508. * @param source - Serialized object.
  113509. * @param scene - BJS scene instance.
  113510. * @param rootUrl - url for the scene object
  113511. * @returns - PBRMaterial
  113512. */
  113513. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  113514. }
  113515. }
  113516. declare module BABYLON {
  113517. /**
  113518. * Direct draw surface info
  113519. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  113520. */
  113521. export interface DDSInfo {
  113522. /**
  113523. * Width of the texture
  113524. */
  113525. width: number;
  113526. /**
  113527. * Width of the texture
  113528. */
  113529. height: number;
  113530. /**
  113531. * Number of Mipmaps for the texture
  113532. * @see https://en.wikipedia.org/wiki/Mipmap
  113533. */
  113534. mipmapCount: number;
  113535. /**
  113536. * If the textures format is a known fourCC format
  113537. * @see https://www.fourcc.org/
  113538. */
  113539. isFourCC: boolean;
  113540. /**
  113541. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  113542. */
  113543. isRGB: boolean;
  113544. /**
  113545. * If the texture is a lumincance format
  113546. */
  113547. isLuminance: boolean;
  113548. /**
  113549. * If this is a cube texture
  113550. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  113551. */
  113552. isCube: boolean;
  113553. /**
  113554. * If the texture is a compressed format eg. FOURCC_DXT1
  113555. */
  113556. isCompressed: boolean;
  113557. /**
  113558. * The dxgiFormat of the texture
  113559. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  113560. */
  113561. dxgiFormat: number;
  113562. /**
  113563. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  113564. */
  113565. textureType: number;
  113566. /**
  113567. * Sphericle polynomial created for the dds texture
  113568. */
  113569. sphericalPolynomial?: SphericalPolynomial;
  113570. }
  113571. /**
  113572. * Class used to provide DDS decompression tools
  113573. */
  113574. export class DDSTools {
  113575. /**
  113576. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  113577. */
  113578. static StoreLODInAlphaChannel: boolean;
  113579. /**
  113580. * Gets DDS information from an array buffer
  113581. * @param arrayBuffer defines the array buffer to read data from
  113582. * @returns the DDS information
  113583. */
  113584. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  113585. private static _FloatView;
  113586. private static _Int32View;
  113587. private static _ToHalfFloat;
  113588. private static _FromHalfFloat;
  113589. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  113590. private static _GetHalfFloatRGBAArrayBuffer;
  113591. private static _GetFloatRGBAArrayBuffer;
  113592. private static _GetFloatAsUIntRGBAArrayBuffer;
  113593. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  113594. private static _GetRGBAArrayBuffer;
  113595. private static _ExtractLongWordOrder;
  113596. private static _GetRGBArrayBuffer;
  113597. private static _GetLuminanceArrayBuffer;
  113598. /**
  113599. * Uploads DDS Levels to a Babylon Texture
  113600. * @hidden
  113601. */
  113602. static UploadDDSLevels(engine: Engine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  113603. }
  113604. interface Engine {
  113605. /**
  113606. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  113607. * @param rootUrl defines the url where the file to load is located
  113608. * @param scene defines the current scene
  113609. * @param lodScale defines scale to apply to the mip map selection
  113610. * @param lodOffset defines offset to apply to the mip map selection
  113611. * @param onLoad defines an optional callback raised when the texture is loaded
  113612. * @param onError defines an optional callback raised if there is an issue to load the texture
  113613. * @param format defines the format of the data
  113614. * @param forcedExtension defines the extension to use to pick the right loader
  113615. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  113616. * @returns the cube texture as an InternalTexture
  113617. */
  113618. 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;
  113619. }
  113620. }
  113621. declare module BABYLON {
  113622. /**
  113623. * Implementation of the DDS Texture Loader.
  113624. * @hidden
  113625. */
  113626. export class _DDSTextureLoader implements IInternalTextureLoader {
  113627. /**
  113628. * Defines wether the loader supports cascade loading the different faces.
  113629. */
  113630. readonly supportCascades: boolean;
  113631. /**
  113632. * This returns if the loader support the current file information.
  113633. * @param extension defines the file extension of the file being loaded
  113634. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113635. * @param fallback defines the fallback internal texture if any
  113636. * @param isBase64 defines whether the texture is encoded as a base64
  113637. * @param isBuffer defines whether the texture data are stored as a buffer
  113638. * @returns true if the loader can load the specified file
  113639. */
  113640. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  113641. /**
  113642. * Transform the url before loading if required.
  113643. * @param rootUrl the url of the texture
  113644. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113645. * @returns the transformed texture
  113646. */
  113647. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  113648. /**
  113649. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  113650. * @param rootUrl the url of the texture
  113651. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113652. * @returns the fallback texture
  113653. */
  113654. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  113655. /**
  113656. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  113657. * @param data contains the texture data
  113658. * @param texture defines the BabylonJS internal texture
  113659. * @param createPolynomials will be true if polynomials have been requested
  113660. * @param onLoad defines the callback to trigger once the texture is ready
  113661. * @param onError defines the callback to trigger in case of error
  113662. */
  113663. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  113664. /**
  113665. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  113666. * @param data contains the texture data
  113667. * @param texture defines the BabylonJS internal texture
  113668. * @param callback defines the method to call once ready to upload
  113669. */
  113670. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  113671. }
  113672. }
  113673. declare module BABYLON {
  113674. /**
  113675. * Implementation of the ENV Texture Loader.
  113676. * @hidden
  113677. */
  113678. export class _ENVTextureLoader implements IInternalTextureLoader {
  113679. /**
  113680. * Defines wether the loader supports cascade loading the different faces.
  113681. */
  113682. readonly supportCascades: boolean;
  113683. /**
  113684. * This returns if the loader support the current file information.
  113685. * @param extension defines the file extension of the file being loaded
  113686. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113687. * @param fallback defines the fallback internal texture if any
  113688. * @param isBase64 defines whether the texture is encoded as a base64
  113689. * @param isBuffer defines whether the texture data are stored as a buffer
  113690. * @returns true if the loader can load the specified file
  113691. */
  113692. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  113693. /**
  113694. * Transform the url before loading if required.
  113695. * @param rootUrl the url of the texture
  113696. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113697. * @returns the transformed texture
  113698. */
  113699. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  113700. /**
  113701. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  113702. * @param rootUrl the url of the texture
  113703. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113704. * @returns the fallback texture
  113705. */
  113706. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  113707. /**
  113708. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  113709. * @param data contains the texture data
  113710. * @param texture defines the BabylonJS internal texture
  113711. * @param createPolynomials will be true if polynomials have been requested
  113712. * @param onLoad defines the callback to trigger once the texture is ready
  113713. * @param onError defines the callback to trigger in case of error
  113714. */
  113715. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  113716. /**
  113717. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  113718. * @param data contains the texture data
  113719. * @param texture defines the BabylonJS internal texture
  113720. * @param callback defines the method to call once ready to upload
  113721. */
  113722. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  113723. }
  113724. }
  113725. declare module BABYLON {
  113726. /**
  113727. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  113728. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  113729. */
  113730. export class KhronosTextureContainer {
  113731. /** contents of the KTX container file */
  113732. arrayBuffer: any;
  113733. private static HEADER_LEN;
  113734. private static COMPRESSED_2D;
  113735. private static COMPRESSED_3D;
  113736. private static TEX_2D;
  113737. private static TEX_3D;
  113738. /**
  113739. * Gets the openGL type
  113740. */
  113741. glType: number;
  113742. /**
  113743. * Gets the openGL type size
  113744. */
  113745. glTypeSize: number;
  113746. /**
  113747. * Gets the openGL format
  113748. */
  113749. glFormat: number;
  113750. /**
  113751. * Gets the openGL internal format
  113752. */
  113753. glInternalFormat: number;
  113754. /**
  113755. * Gets the base internal format
  113756. */
  113757. glBaseInternalFormat: number;
  113758. /**
  113759. * Gets image width in pixel
  113760. */
  113761. pixelWidth: number;
  113762. /**
  113763. * Gets image height in pixel
  113764. */
  113765. pixelHeight: number;
  113766. /**
  113767. * Gets image depth in pixels
  113768. */
  113769. pixelDepth: number;
  113770. /**
  113771. * Gets the number of array elements
  113772. */
  113773. numberOfArrayElements: number;
  113774. /**
  113775. * Gets the number of faces
  113776. */
  113777. numberOfFaces: number;
  113778. /**
  113779. * Gets the number of mipmap levels
  113780. */
  113781. numberOfMipmapLevels: number;
  113782. /**
  113783. * Gets the bytes of key value data
  113784. */
  113785. bytesOfKeyValueData: number;
  113786. /**
  113787. * Gets the load type
  113788. */
  113789. loadType: number;
  113790. /**
  113791. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  113792. */
  113793. isInvalid: boolean;
  113794. /**
  113795. * Creates a new KhronosTextureContainer
  113796. * @param arrayBuffer contents of the KTX container file
  113797. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  113798. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  113799. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  113800. */
  113801. constructor(
  113802. /** contents of the KTX container file */
  113803. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  113804. /**
  113805. * Uploads KTX content to a Babylon Texture.
  113806. * It is assumed that the texture has already been created & is currently bound
  113807. * @hidden
  113808. */
  113809. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  113810. private _upload2DCompressedLevels;
  113811. }
  113812. }
  113813. declare module BABYLON {
  113814. /**
  113815. * Implementation of the KTX Texture Loader.
  113816. * @hidden
  113817. */
  113818. export class _KTXTextureLoader implements IInternalTextureLoader {
  113819. /**
  113820. * Defines wether the loader supports cascade loading the different faces.
  113821. */
  113822. readonly supportCascades: boolean;
  113823. /**
  113824. * This returns if the loader support the current file information.
  113825. * @param extension defines the file extension of the file being loaded
  113826. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113827. * @param fallback defines the fallback internal texture if any
  113828. * @param isBase64 defines whether the texture is encoded as a base64
  113829. * @param isBuffer defines whether the texture data are stored as a buffer
  113830. * @returns true if the loader can load the specified file
  113831. */
  113832. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  113833. /**
  113834. * Transform the url before loading if required.
  113835. * @param rootUrl the url of the texture
  113836. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113837. * @returns the transformed texture
  113838. */
  113839. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  113840. /**
  113841. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  113842. * @param rootUrl the url of the texture
  113843. * @param textureFormatInUse defines the current compressed format in use iun the engine
  113844. * @returns the fallback texture
  113845. */
  113846. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  113847. /**
  113848. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  113849. * @param data contains the texture data
  113850. * @param texture defines the BabylonJS internal texture
  113851. * @param createPolynomials will be true if polynomials have been requested
  113852. * @param onLoad defines the callback to trigger once the texture is ready
  113853. * @param onError defines the callback to trigger in case of error
  113854. */
  113855. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  113856. /**
  113857. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  113858. * @param data contains the texture data
  113859. * @param texture defines the BabylonJS internal texture
  113860. * @param callback defines the method to call once ready to upload
  113861. */
  113862. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  113863. }
  113864. }
  113865. declare module BABYLON {
  113866. /**
  113867. * Options for the default xr helper
  113868. */
  113869. export class WebXRDefaultExperienceOptions {
  113870. /**
  113871. * Floor meshes that should be used for teleporting
  113872. */
  113873. floorMeshes: Array<AbstractMesh>;
  113874. }
  113875. /**
  113876. * Default experience which provides a similar setup to the previous webVRExperience
  113877. */
  113878. export class WebXRDefaultExperience {
  113879. /**
  113880. * Base experience
  113881. */
  113882. baseExperience: WebXRExperienceHelper;
  113883. /**
  113884. * Input experience extension
  113885. */
  113886. input: WebXRInput;
  113887. /**
  113888. * Loads the controller models
  113889. */
  113890. controllerModelLoader: WebXRControllerModelLoader;
  113891. /**
  113892. * Enables laser pointer and selection
  113893. */
  113894. pointerSelection: WebXRControllerPointerSelection;
  113895. /**
  113896. * Enables teleportation
  113897. */
  113898. teleportation: WebXRControllerTeleportation;
  113899. /**
  113900. * Enables ui for enetering/exiting xr
  113901. */
  113902. enterExitUI: WebXREnterExitUI;
  113903. /**
  113904. * Default output canvas xr should render to
  113905. */
  113906. outputCanvas: WebXRManagedOutputCanvas;
  113907. /**
  113908. * Creates the default xr experience
  113909. * @param scene scene
  113910. * @param options options for basic configuration
  113911. * @returns resulting WebXRDefaultExperience
  113912. */
  113913. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  113914. private constructor();
  113915. /**
  113916. * DIsposes of the experience helper
  113917. */
  113918. dispose(): void;
  113919. }
  113920. }
  113921. declare module BABYLON {
  113922. /** @hidden */
  113923. export var _forceSceneHelpersToBundle: boolean;
  113924. interface Scene {
  113925. /**
  113926. * Creates a default light for the scene.
  113927. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  113928. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  113929. */
  113930. createDefaultLight(replace?: boolean): void;
  113931. /**
  113932. * Creates a default camera for the scene.
  113933. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  113934. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  113935. * @param replace has default false, when true replaces the active camera in the scene
  113936. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  113937. */
  113938. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  113939. /**
  113940. * Creates a default camera and a default light.
  113941. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  113942. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  113943. * @param replace has the default false, when true replaces the active camera/light in the scene
  113944. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  113945. */
  113946. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  113947. /**
  113948. * Creates a new sky box
  113949. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  113950. * @param environmentTexture defines the texture to use as environment texture
  113951. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  113952. * @param scale defines the overall scale of the skybox
  113953. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  113954. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  113955. * @returns a new mesh holding the sky box
  113956. */
  113957. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  113958. /**
  113959. * Creates a new environment
  113960. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  113961. * @param options defines the options you can use to configure the environment
  113962. * @returns the new EnvironmentHelper
  113963. */
  113964. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  113965. /**
  113966. * Creates a new VREXperienceHelper
  113967. * @see http://doc.babylonjs.com/how_to/webvr_helper
  113968. * @param webVROptions defines the options used to create the new VREXperienceHelper
  113969. * @returns a new VREXperienceHelper
  113970. */
  113971. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  113972. /**
  113973. * Creates a new WebXRDefaultExperience
  113974. * @see http://doc.babylonjs.com/how_to/webxr
  113975. * @param options experience options
  113976. * @returns a promise for a new WebXRDefaultExperience
  113977. */
  113978. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  113979. }
  113980. }
  113981. declare module BABYLON {
  113982. /**
  113983. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  113984. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  113985. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  113986. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  113987. */
  113988. export class VideoDome extends TransformNode {
  113989. /**
  113990. * Define the video source as a Monoscopic panoramic 360 video.
  113991. */
  113992. static readonly MODE_MONOSCOPIC: number;
  113993. /**
  113994. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  113995. */
  113996. static readonly MODE_TOPBOTTOM: number;
  113997. /**
  113998. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  113999. */
  114000. static readonly MODE_SIDEBYSIDE: number;
  114001. private _halfDome;
  114002. private _useDirectMapping;
  114003. /**
  114004. * The video texture being displayed on the sphere
  114005. */
  114006. protected _videoTexture: VideoTexture;
  114007. /**
  114008. * Gets the video texture being displayed on the sphere
  114009. */
  114010. readonly videoTexture: VideoTexture;
  114011. /**
  114012. * The skybox material
  114013. */
  114014. protected _material: BackgroundMaterial;
  114015. /**
  114016. * The surface used for the skybox
  114017. */
  114018. protected _mesh: Mesh;
  114019. /**
  114020. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  114021. */
  114022. private _halfDomeMask;
  114023. /**
  114024. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114025. * Also see the options.resolution property.
  114026. */
  114027. fovMultiplier: number;
  114028. private _videoMode;
  114029. /**
  114030. * Gets or set the current video mode for the video. It can be:
  114031. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  114032. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  114033. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  114034. */
  114035. videoMode: number;
  114036. /**
  114037. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  114038. *
  114039. */
  114040. /**
  114041. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  114042. */
  114043. halfDome: boolean;
  114044. /**
  114045. * Oberserver used in Stereoscopic VR Mode.
  114046. */
  114047. private _onBeforeCameraRenderObserver;
  114048. /**
  114049. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  114050. * @param name Element's name, child elements will append suffixes for their own names.
  114051. * @param urlsOrVideo defines the url(s) or the video element to use
  114052. * @param options An object containing optional or exposed sub element properties
  114053. */
  114054. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  114055. resolution?: number;
  114056. clickToPlay?: boolean;
  114057. autoPlay?: boolean;
  114058. loop?: boolean;
  114059. size?: number;
  114060. poster?: string;
  114061. faceForward?: boolean;
  114062. useDirectMapping?: boolean;
  114063. halfDomeMode?: boolean;
  114064. }, scene: Scene);
  114065. private _changeVideoMode;
  114066. /**
  114067. * Releases resources associated with this node.
  114068. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  114069. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  114070. */
  114071. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  114072. }
  114073. }
  114074. declare module BABYLON {
  114075. /**
  114076. * This class can be used to get instrumentation data from a Babylon engine
  114077. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  114078. */
  114079. export class EngineInstrumentation implements IDisposable {
  114080. /**
  114081. * Define the instrumented engine.
  114082. */
  114083. engine: Engine;
  114084. private _captureGPUFrameTime;
  114085. private _gpuFrameTimeToken;
  114086. private _gpuFrameTime;
  114087. private _captureShaderCompilationTime;
  114088. private _shaderCompilationTime;
  114089. private _onBeginFrameObserver;
  114090. private _onEndFrameObserver;
  114091. private _onBeforeShaderCompilationObserver;
  114092. private _onAfterShaderCompilationObserver;
  114093. /**
  114094. * Gets the perf counter used for GPU frame time
  114095. */
  114096. readonly gpuFrameTimeCounter: PerfCounter;
  114097. /**
  114098. * Gets the GPU frame time capture status
  114099. */
  114100. /**
  114101. * Enable or disable the GPU frame time capture
  114102. */
  114103. captureGPUFrameTime: boolean;
  114104. /**
  114105. * Gets the perf counter used for shader compilation time
  114106. */
  114107. readonly shaderCompilationTimeCounter: PerfCounter;
  114108. /**
  114109. * Gets the shader compilation time capture status
  114110. */
  114111. /**
  114112. * Enable or disable the shader compilation time capture
  114113. */
  114114. captureShaderCompilationTime: boolean;
  114115. /**
  114116. * Instantiates a new engine instrumentation.
  114117. * This class can be used to get instrumentation data from a Babylon engine
  114118. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  114119. * @param engine Defines the engine to instrument
  114120. */
  114121. constructor(
  114122. /**
  114123. * Define the instrumented engine.
  114124. */
  114125. engine: Engine);
  114126. /**
  114127. * Dispose and release associated resources.
  114128. */
  114129. dispose(): void;
  114130. }
  114131. }
  114132. declare module BABYLON {
  114133. /**
  114134. * This class can be used to get instrumentation data from a Babylon engine
  114135. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  114136. */
  114137. export class SceneInstrumentation implements IDisposable {
  114138. /**
  114139. * Defines the scene to instrument
  114140. */
  114141. scene: Scene;
  114142. private _captureActiveMeshesEvaluationTime;
  114143. private _activeMeshesEvaluationTime;
  114144. private _captureRenderTargetsRenderTime;
  114145. private _renderTargetsRenderTime;
  114146. private _captureFrameTime;
  114147. private _frameTime;
  114148. private _captureRenderTime;
  114149. private _renderTime;
  114150. private _captureInterFrameTime;
  114151. private _interFrameTime;
  114152. private _captureParticlesRenderTime;
  114153. private _particlesRenderTime;
  114154. private _captureSpritesRenderTime;
  114155. private _spritesRenderTime;
  114156. private _capturePhysicsTime;
  114157. private _physicsTime;
  114158. private _captureAnimationsTime;
  114159. private _animationsTime;
  114160. private _captureCameraRenderTime;
  114161. private _cameraRenderTime;
  114162. private _onBeforeActiveMeshesEvaluationObserver;
  114163. private _onAfterActiveMeshesEvaluationObserver;
  114164. private _onBeforeRenderTargetsRenderObserver;
  114165. private _onAfterRenderTargetsRenderObserver;
  114166. private _onAfterRenderObserver;
  114167. private _onBeforeDrawPhaseObserver;
  114168. private _onAfterDrawPhaseObserver;
  114169. private _onBeforeAnimationsObserver;
  114170. private _onBeforeParticlesRenderingObserver;
  114171. private _onAfterParticlesRenderingObserver;
  114172. private _onBeforeSpritesRenderingObserver;
  114173. private _onAfterSpritesRenderingObserver;
  114174. private _onBeforePhysicsObserver;
  114175. private _onAfterPhysicsObserver;
  114176. private _onAfterAnimationsObserver;
  114177. private _onBeforeCameraRenderObserver;
  114178. private _onAfterCameraRenderObserver;
  114179. /**
  114180. * Gets the perf counter used for active meshes evaluation time
  114181. */
  114182. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  114183. /**
  114184. * Gets the active meshes evaluation time capture status
  114185. */
  114186. /**
  114187. * Enable or disable the active meshes evaluation time capture
  114188. */
  114189. captureActiveMeshesEvaluationTime: boolean;
  114190. /**
  114191. * Gets the perf counter used for render targets render time
  114192. */
  114193. readonly renderTargetsRenderTimeCounter: PerfCounter;
  114194. /**
  114195. * Gets the render targets render time capture status
  114196. */
  114197. /**
  114198. * Enable or disable the render targets render time capture
  114199. */
  114200. captureRenderTargetsRenderTime: boolean;
  114201. /**
  114202. * Gets the perf counter used for particles render time
  114203. */
  114204. readonly particlesRenderTimeCounter: PerfCounter;
  114205. /**
  114206. * Gets the particles render time capture status
  114207. */
  114208. /**
  114209. * Enable or disable the particles render time capture
  114210. */
  114211. captureParticlesRenderTime: boolean;
  114212. /**
  114213. * Gets the perf counter used for sprites render time
  114214. */
  114215. readonly spritesRenderTimeCounter: PerfCounter;
  114216. /**
  114217. * Gets the sprites render time capture status
  114218. */
  114219. /**
  114220. * Enable or disable the sprites render time capture
  114221. */
  114222. captureSpritesRenderTime: boolean;
  114223. /**
  114224. * Gets the perf counter used for physics time
  114225. */
  114226. readonly physicsTimeCounter: PerfCounter;
  114227. /**
  114228. * Gets the physics time capture status
  114229. */
  114230. /**
  114231. * Enable or disable the physics time capture
  114232. */
  114233. capturePhysicsTime: boolean;
  114234. /**
  114235. * Gets the perf counter used for animations time
  114236. */
  114237. readonly animationsTimeCounter: PerfCounter;
  114238. /**
  114239. * Gets the animations time capture status
  114240. */
  114241. /**
  114242. * Enable or disable the animations time capture
  114243. */
  114244. captureAnimationsTime: boolean;
  114245. /**
  114246. * Gets the perf counter used for frame time capture
  114247. */
  114248. readonly frameTimeCounter: PerfCounter;
  114249. /**
  114250. * Gets the frame time capture status
  114251. */
  114252. /**
  114253. * Enable or disable the frame time capture
  114254. */
  114255. captureFrameTime: boolean;
  114256. /**
  114257. * Gets the perf counter used for inter-frames time capture
  114258. */
  114259. readonly interFrameTimeCounter: PerfCounter;
  114260. /**
  114261. * Gets the inter-frames time capture status
  114262. */
  114263. /**
  114264. * Enable or disable the inter-frames time capture
  114265. */
  114266. captureInterFrameTime: boolean;
  114267. /**
  114268. * Gets the perf counter used for render time capture
  114269. */
  114270. readonly renderTimeCounter: PerfCounter;
  114271. /**
  114272. * Gets the render time capture status
  114273. */
  114274. /**
  114275. * Enable or disable the render time capture
  114276. */
  114277. captureRenderTime: boolean;
  114278. /**
  114279. * Gets the perf counter used for camera render time capture
  114280. */
  114281. readonly cameraRenderTimeCounter: PerfCounter;
  114282. /**
  114283. * Gets the camera render time capture status
  114284. */
  114285. /**
  114286. * Enable or disable the camera render time capture
  114287. */
  114288. captureCameraRenderTime: boolean;
  114289. /**
  114290. * Gets the perf counter used for draw calls
  114291. */
  114292. readonly drawCallsCounter: PerfCounter;
  114293. /**
  114294. * Instantiates a new scene instrumentation.
  114295. * This class can be used to get instrumentation data from a Babylon engine
  114296. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  114297. * @param scene Defines the scene to instrument
  114298. */
  114299. constructor(
  114300. /**
  114301. * Defines the scene to instrument
  114302. */
  114303. scene: Scene);
  114304. /**
  114305. * Dispose and release associated resources.
  114306. */
  114307. dispose(): void;
  114308. }
  114309. }
  114310. declare module BABYLON {
  114311. /** @hidden */
  114312. export var glowMapGenerationPixelShader: {
  114313. name: string;
  114314. shader: string;
  114315. };
  114316. }
  114317. declare module BABYLON {
  114318. /** @hidden */
  114319. export var glowMapGenerationVertexShader: {
  114320. name: string;
  114321. shader: string;
  114322. };
  114323. }
  114324. declare module BABYLON {
  114325. /**
  114326. * Effect layer options. This helps customizing the behaviour
  114327. * of the effect layer.
  114328. */
  114329. export interface IEffectLayerOptions {
  114330. /**
  114331. * Multiplication factor apply to the canvas size to compute the render target size
  114332. * used to generated the objects (the smaller the faster).
  114333. */
  114334. mainTextureRatio: number;
  114335. /**
  114336. * Enforces a fixed size texture to ensure effect stability across devices.
  114337. */
  114338. mainTextureFixedSize?: number;
  114339. /**
  114340. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  114341. */
  114342. alphaBlendingMode: number;
  114343. /**
  114344. * The camera attached to the layer.
  114345. */
  114346. camera: Nullable<Camera>;
  114347. /**
  114348. * The rendering group to draw the layer in.
  114349. */
  114350. renderingGroupId: number;
  114351. }
  114352. /**
  114353. * The effect layer Helps adding post process effect blended with the main pass.
  114354. *
  114355. * This can be for instance use to generate glow or higlight effects on the scene.
  114356. *
  114357. * The effect layer class can not be used directly and is intented to inherited from to be
  114358. * customized per effects.
  114359. */
  114360. export abstract class EffectLayer {
  114361. private _vertexBuffers;
  114362. private _indexBuffer;
  114363. private _cachedDefines;
  114364. private _effectLayerMapGenerationEffect;
  114365. private _effectLayerOptions;
  114366. private _mergeEffect;
  114367. protected _scene: Scene;
  114368. protected _engine: Engine;
  114369. protected _maxSize: number;
  114370. protected _mainTextureDesiredSize: ISize;
  114371. protected _mainTexture: RenderTargetTexture;
  114372. protected _shouldRender: boolean;
  114373. protected _postProcesses: PostProcess[];
  114374. protected _textures: BaseTexture[];
  114375. protected _emissiveTextureAndColor: {
  114376. texture: Nullable<BaseTexture>;
  114377. color: Color4;
  114378. };
  114379. /**
  114380. * The name of the layer
  114381. */
  114382. name: string;
  114383. /**
  114384. * The clear color of the texture used to generate the glow map.
  114385. */
  114386. neutralColor: Color4;
  114387. /**
  114388. * Specifies wether the highlight layer is enabled or not.
  114389. */
  114390. isEnabled: boolean;
  114391. /**
  114392. * Gets the camera attached to the layer.
  114393. */
  114394. readonly camera: Nullable<Camera>;
  114395. /**
  114396. * Gets the rendering group id the layer should render in.
  114397. */
  114398. renderingGroupId: number;
  114399. /**
  114400. * An event triggered when the effect layer has been disposed.
  114401. */
  114402. onDisposeObservable: Observable<EffectLayer>;
  114403. /**
  114404. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  114405. */
  114406. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  114407. /**
  114408. * An event triggered when the generated texture is being merged in the scene.
  114409. */
  114410. onBeforeComposeObservable: Observable<EffectLayer>;
  114411. /**
  114412. * An event triggered when the generated texture has been merged in the scene.
  114413. */
  114414. onAfterComposeObservable: Observable<EffectLayer>;
  114415. /**
  114416. * An event triggered when the efffect layer changes its size.
  114417. */
  114418. onSizeChangedObservable: Observable<EffectLayer>;
  114419. /** @hidden */
  114420. static _SceneComponentInitialization: (scene: Scene) => void;
  114421. /**
  114422. * Instantiates a new effect Layer and references it in the scene.
  114423. * @param name The name of the layer
  114424. * @param scene The scene to use the layer in
  114425. */
  114426. constructor(
  114427. /** The Friendly of the effect in the scene */
  114428. name: string, scene: Scene);
  114429. /**
  114430. * Get the effect name of the layer.
  114431. * @return The effect name
  114432. */
  114433. abstract getEffectName(): string;
  114434. /**
  114435. * Checks for the readiness of the element composing the layer.
  114436. * @param subMesh the mesh to check for
  114437. * @param useInstances specify wether or not to use instances to render the mesh
  114438. * @return true if ready otherwise, false
  114439. */
  114440. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  114441. /**
  114442. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  114443. * @returns true if the effect requires stencil during the main canvas render pass.
  114444. */
  114445. abstract needStencil(): boolean;
  114446. /**
  114447. * Create the merge effect. This is the shader use to blit the information back
  114448. * to the main canvas at the end of the scene rendering.
  114449. * @returns The effect containing the shader used to merge the effect on the main canvas
  114450. */
  114451. protected abstract _createMergeEffect(): Effect;
  114452. /**
  114453. * Creates the render target textures and post processes used in the effect layer.
  114454. */
  114455. protected abstract _createTextureAndPostProcesses(): void;
  114456. /**
  114457. * Implementation specific of rendering the generating effect on the main canvas.
  114458. * @param effect The effect used to render through
  114459. */
  114460. protected abstract _internalRender(effect: Effect): void;
  114461. /**
  114462. * Sets the required values for both the emissive texture and and the main color.
  114463. */
  114464. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  114465. /**
  114466. * Free any resources and references associated to a mesh.
  114467. * Internal use
  114468. * @param mesh The mesh to free.
  114469. */
  114470. abstract _disposeMesh(mesh: Mesh): void;
  114471. /**
  114472. * Serializes this layer (Glow or Highlight for example)
  114473. * @returns a serialized layer object
  114474. */
  114475. abstract serialize?(): any;
  114476. /**
  114477. * Initializes the effect layer with the required options.
  114478. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  114479. */
  114480. protected _init(options: Partial<IEffectLayerOptions>): void;
  114481. /**
  114482. * Generates the index buffer of the full screen quad blending to the main canvas.
  114483. */
  114484. private _generateIndexBuffer;
  114485. /**
  114486. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  114487. */
  114488. private _generateVertexBuffer;
  114489. /**
  114490. * Sets the main texture desired size which is the closest power of two
  114491. * of the engine canvas size.
  114492. */
  114493. private _setMainTextureSize;
  114494. /**
  114495. * Creates the main texture for the effect layer.
  114496. */
  114497. protected _createMainTexture(): void;
  114498. /**
  114499. * Adds specific effects defines.
  114500. * @param defines The defines to add specifics to.
  114501. */
  114502. protected _addCustomEffectDefines(defines: string[]): void;
  114503. /**
  114504. * Checks for the readiness of the element composing the layer.
  114505. * @param subMesh the mesh to check for
  114506. * @param useInstances specify wether or not to use instances to render the mesh
  114507. * @param emissiveTexture the associated emissive texture used to generate the glow
  114508. * @return true if ready otherwise, false
  114509. */
  114510. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  114511. /**
  114512. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  114513. */
  114514. render(): void;
  114515. /**
  114516. * Determine if a given mesh will be used in the current effect.
  114517. * @param mesh mesh to test
  114518. * @returns true if the mesh will be used
  114519. */
  114520. hasMesh(mesh: AbstractMesh): boolean;
  114521. /**
  114522. * Returns true if the layer contains information to display, otherwise false.
  114523. * @returns true if the glow layer should be rendered
  114524. */
  114525. shouldRender(): boolean;
  114526. /**
  114527. * Returns true if the mesh should render, otherwise false.
  114528. * @param mesh The mesh to render
  114529. * @returns true if it should render otherwise false
  114530. */
  114531. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  114532. /**
  114533. * Returns true if the mesh can be rendered, otherwise false.
  114534. * @param mesh The mesh to render
  114535. * @param material The material used on the mesh
  114536. * @returns true if it can be rendered otherwise false
  114537. */
  114538. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  114539. /**
  114540. * Returns true if the mesh should render, otherwise false.
  114541. * @param mesh The mesh to render
  114542. * @returns true if it should render otherwise false
  114543. */
  114544. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  114545. /**
  114546. * Renders the submesh passed in parameter to the generation map.
  114547. */
  114548. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  114549. /**
  114550. * Rebuild the required buffers.
  114551. * @hidden Internal use only.
  114552. */
  114553. _rebuild(): void;
  114554. /**
  114555. * Dispose only the render target textures and post process.
  114556. */
  114557. private _disposeTextureAndPostProcesses;
  114558. /**
  114559. * Dispose the highlight layer and free resources.
  114560. */
  114561. dispose(): void;
  114562. /**
  114563. * Gets the class name of the effect layer
  114564. * @returns the string with the class name of the effect layer
  114565. */
  114566. getClassName(): string;
  114567. /**
  114568. * Creates an effect layer from parsed effect layer data
  114569. * @param parsedEffectLayer defines effect layer data
  114570. * @param scene defines the current scene
  114571. * @param rootUrl defines the root URL containing the effect layer information
  114572. * @returns a parsed effect Layer
  114573. */
  114574. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  114575. }
  114576. }
  114577. declare module BABYLON {
  114578. interface AbstractScene {
  114579. /**
  114580. * The list of effect layers (highlights/glow) added to the scene
  114581. * @see http://doc.babylonjs.com/how_to/highlight_layer
  114582. * @see http://doc.babylonjs.com/how_to/glow_layer
  114583. */
  114584. effectLayers: Array<EffectLayer>;
  114585. /**
  114586. * Removes the given effect layer from this scene.
  114587. * @param toRemove defines the effect layer to remove
  114588. * @returns the index of the removed effect layer
  114589. */
  114590. removeEffectLayer(toRemove: EffectLayer): number;
  114591. /**
  114592. * Adds the given effect layer to this scene
  114593. * @param newEffectLayer defines the effect layer to add
  114594. */
  114595. addEffectLayer(newEffectLayer: EffectLayer): void;
  114596. }
  114597. /**
  114598. * Defines the layer scene component responsible to manage any effect layers
  114599. * in a given scene.
  114600. */
  114601. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  114602. /**
  114603. * The component name helpfull to identify the component in the list of scene components.
  114604. */
  114605. readonly name: string;
  114606. /**
  114607. * The scene the component belongs to.
  114608. */
  114609. scene: Scene;
  114610. private _engine;
  114611. private _renderEffects;
  114612. private _needStencil;
  114613. private _previousStencilState;
  114614. /**
  114615. * Creates a new instance of the component for the given scene
  114616. * @param scene Defines the scene to register the component in
  114617. */
  114618. constructor(scene: Scene);
  114619. /**
  114620. * Registers the component in a given scene
  114621. */
  114622. register(): void;
  114623. /**
  114624. * Rebuilds the elements related to this component in case of
  114625. * context lost for instance.
  114626. */
  114627. rebuild(): void;
  114628. /**
  114629. * Serializes the component data to the specified json object
  114630. * @param serializationObject The object to serialize to
  114631. */
  114632. serialize(serializationObject: any): void;
  114633. /**
  114634. * Adds all the elements from the container to the scene
  114635. * @param container the container holding the elements
  114636. */
  114637. addFromContainer(container: AbstractScene): void;
  114638. /**
  114639. * Removes all the elements in the container from the scene
  114640. * @param container contains the elements to remove
  114641. * @param dispose if the removed element should be disposed (default: false)
  114642. */
  114643. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  114644. /**
  114645. * Disposes the component and the associated ressources.
  114646. */
  114647. dispose(): void;
  114648. private _isReadyForMesh;
  114649. private _renderMainTexture;
  114650. private _setStencil;
  114651. private _setStencilBack;
  114652. private _draw;
  114653. private _drawCamera;
  114654. private _drawRenderingGroup;
  114655. }
  114656. }
  114657. declare module BABYLON {
  114658. /** @hidden */
  114659. export var glowMapMergePixelShader: {
  114660. name: string;
  114661. shader: string;
  114662. };
  114663. }
  114664. declare module BABYLON {
  114665. /** @hidden */
  114666. export var glowMapMergeVertexShader: {
  114667. name: string;
  114668. shader: string;
  114669. };
  114670. }
  114671. declare module BABYLON {
  114672. interface AbstractScene {
  114673. /**
  114674. * Return a the first highlight layer of the scene with a given name.
  114675. * @param name The name of the highlight layer to look for.
  114676. * @return The highlight layer if found otherwise null.
  114677. */
  114678. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  114679. }
  114680. /**
  114681. * Glow layer options. This helps customizing the behaviour
  114682. * of the glow layer.
  114683. */
  114684. export interface IGlowLayerOptions {
  114685. /**
  114686. * Multiplication factor apply to the canvas size to compute the render target size
  114687. * used to generated the glowing objects (the smaller the faster).
  114688. */
  114689. mainTextureRatio: number;
  114690. /**
  114691. * Enforces a fixed size texture to ensure resize independant blur.
  114692. */
  114693. mainTextureFixedSize?: number;
  114694. /**
  114695. * How big is the kernel of the blur texture.
  114696. */
  114697. blurKernelSize: number;
  114698. /**
  114699. * The camera attached to the layer.
  114700. */
  114701. camera: Nullable<Camera>;
  114702. /**
  114703. * Enable MSAA by chosing the number of samples.
  114704. */
  114705. mainTextureSamples?: number;
  114706. /**
  114707. * The rendering group to draw the layer in.
  114708. */
  114709. renderingGroupId: number;
  114710. }
  114711. /**
  114712. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  114713. *
  114714. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  114715. * glowy meshes to your scene.
  114716. *
  114717. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  114718. */
  114719. export class GlowLayer extends EffectLayer {
  114720. /**
  114721. * Effect Name of the layer.
  114722. */
  114723. static readonly EffectName: string;
  114724. /**
  114725. * The default blur kernel size used for the glow.
  114726. */
  114727. static DefaultBlurKernelSize: number;
  114728. /**
  114729. * The default texture size ratio used for the glow.
  114730. */
  114731. static DefaultTextureRatio: number;
  114732. /**
  114733. * Sets the kernel size of the blur.
  114734. */
  114735. /**
  114736. * Gets the kernel size of the blur.
  114737. */
  114738. blurKernelSize: number;
  114739. /**
  114740. * Sets the glow intensity.
  114741. */
  114742. /**
  114743. * Gets the glow intensity.
  114744. */
  114745. intensity: number;
  114746. private _options;
  114747. private _intensity;
  114748. private _horizontalBlurPostprocess1;
  114749. private _verticalBlurPostprocess1;
  114750. private _horizontalBlurPostprocess2;
  114751. private _verticalBlurPostprocess2;
  114752. private _blurTexture1;
  114753. private _blurTexture2;
  114754. private _postProcesses1;
  114755. private _postProcesses2;
  114756. private _includedOnlyMeshes;
  114757. private _excludedMeshes;
  114758. /**
  114759. * Callback used to let the user override the color selection on a per mesh basis
  114760. */
  114761. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  114762. /**
  114763. * Callback used to let the user override the texture selection on a per mesh basis
  114764. */
  114765. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  114766. /**
  114767. * Instantiates a new glow Layer and references it to the scene.
  114768. * @param name The name of the layer
  114769. * @param scene The scene to use the layer in
  114770. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  114771. */
  114772. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  114773. /**
  114774. * Get the effect name of the layer.
  114775. * @return The effect name
  114776. */
  114777. getEffectName(): string;
  114778. /**
  114779. * Create the merge effect. This is the shader use to blit the information back
  114780. * to the main canvas at the end of the scene rendering.
  114781. */
  114782. protected _createMergeEffect(): Effect;
  114783. /**
  114784. * Creates the render target textures and post processes used in the glow layer.
  114785. */
  114786. protected _createTextureAndPostProcesses(): void;
  114787. /**
  114788. * Checks for the readiness of the element composing the layer.
  114789. * @param subMesh the mesh to check for
  114790. * @param useInstances specify wether or not to use instances to render the mesh
  114791. * @param emissiveTexture the associated emissive texture used to generate the glow
  114792. * @return true if ready otherwise, false
  114793. */
  114794. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  114795. /**
  114796. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  114797. */
  114798. needStencil(): boolean;
  114799. /**
  114800. * Returns true if the mesh can be rendered, otherwise false.
  114801. * @param mesh The mesh to render
  114802. * @param material The material used on the mesh
  114803. * @returns true if it can be rendered otherwise false
  114804. */
  114805. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  114806. /**
  114807. * Implementation specific of rendering the generating effect on the main canvas.
  114808. * @param effect The effect used to render through
  114809. */
  114810. protected _internalRender(effect: Effect): void;
  114811. /**
  114812. * Sets the required values for both the emissive texture and and the main color.
  114813. */
  114814. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  114815. /**
  114816. * Returns true if the mesh should render, otherwise false.
  114817. * @param mesh The mesh to render
  114818. * @returns true if it should render otherwise false
  114819. */
  114820. protected _shouldRenderMesh(mesh: Mesh): boolean;
  114821. /**
  114822. * Adds specific effects defines.
  114823. * @param defines The defines to add specifics to.
  114824. */
  114825. protected _addCustomEffectDefines(defines: string[]): void;
  114826. /**
  114827. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  114828. * @param mesh The mesh to exclude from the glow layer
  114829. */
  114830. addExcludedMesh(mesh: Mesh): void;
  114831. /**
  114832. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  114833. * @param mesh The mesh to remove
  114834. */
  114835. removeExcludedMesh(mesh: Mesh): void;
  114836. /**
  114837. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  114838. * @param mesh The mesh to include in the glow layer
  114839. */
  114840. addIncludedOnlyMesh(mesh: Mesh): void;
  114841. /**
  114842. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  114843. * @param mesh The mesh to remove
  114844. */
  114845. removeIncludedOnlyMesh(mesh: Mesh): void;
  114846. /**
  114847. * Determine if a given mesh will be used in the glow layer
  114848. * @param mesh The mesh to test
  114849. * @returns true if the mesh will be highlighted by the current glow layer
  114850. */
  114851. hasMesh(mesh: AbstractMesh): boolean;
  114852. /**
  114853. * Free any resources and references associated to a mesh.
  114854. * Internal use
  114855. * @param mesh The mesh to free.
  114856. * @hidden
  114857. */
  114858. _disposeMesh(mesh: Mesh): void;
  114859. /**
  114860. * Gets the class name of the effect layer
  114861. * @returns the string with the class name of the effect layer
  114862. */
  114863. getClassName(): string;
  114864. /**
  114865. * Serializes this glow layer
  114866. * @returns a serialized glow layer object
  114867. */
  114868. serialize(): any;
  114869. /**
  114870. * Creates a Glow Layer from parsed glow layer data
  114871. * @param parsedGlowLayer defines glow layer data
  114872. * @param scene defines the current scene
  114873. * @param rootUrl defines the root URL containing the glow layer information
  114874. * @returns a parsed Glow Layer
  114875. */
  114876. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  114877. }
  114878. }
  114879. declare module BABYLON {
  114880. /** @hidden */
  114881. export var glowBlurPostProcessPixelShader: {
  114882. name: string;
  114883. shader: string;
  114884. };
  114885. }
  114886. declare module BABYLON {
  114887. interface AbstractScene {
  114888. /**
  114889. * Return a the first highlight layer of the scene with a given name.
  114890. * @param name The name of the highlight layer to look for.
  114891. * @return The highlight layer if found otherwise null.
  114892. */
  114893. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  114894. }
  114895. /**
  114896. * Highlight layer options. This helps customizing the behaviour
  114897. * of the highlight layer.
  114898. */
  114899. export interface IHighlightLayerOptions {
  114900. /**
  114901. * Multiplication factor apply to the canvas size to compute the render target size
  114902. * used to generated the glowing objects (the smaller the faster).
  114903. */
  114904. mainTextureRatio: number;
  114905. /**
  114906. * Enforces a fixed size texture to ensure resize independant blur.
  114907. */
  114908. mainTextureFixedSize?: number;
  114909. /**
  114910. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  114911. * of the picture to blur (the smaller the faster).
  114912. */
  114913. blurTextureSizeRatio: number;
  114914. /**
  114915. * How big in texel of the blur texture is the vertical blur.
  114916. */
  114917. blurVerticalSize: number;
  114918. /**
  114919. * How big in texel of the blur texture is the horizontal blur.
  114920. */
  114921. blurHorizontalSize: number;
  114922. /**
  114923. * Alpha blending mode used to apply the blur. Default is combine.
  114924. */
  114925. alphaBlendingMode: number;
  114926. /**
  114927. * The camera attached to the layer.
  114928. */
  114929. camera: Nullable<Camera>;
  114930. /**
  114931. * Should we display highlight as a solid stroke?
  114932. */
  114933. isStroke?: boolean;
  114934. /**
  114935. * The rendering group to draw the layer in.
  114936. */
  114937. renderingGroupId: number;
  114938. }
  114939. /**
  114940. * The highlight layer Helps adding a glow effect around a mesh.
  114941. *
  114942. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  114943. * glowy meshes to your scene.
  114944. *
  114945. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  114946. */
  114947. export class HighlightLayer extends EffectLayer {
  114948. name: string;
  114949. /**
  114950. * Effect Name of the highlight layer.
  114951. */
  114952. static readonly EffectName: string;
  114953. /**
  114954. * The neutral color used during the preparation of the glow effect.
  114955. * This is black by default as the blend operation is a blend operation.
  114956. */
  114957. static NeutralColor: Color4;
  114958. /**
  114959. * Stencil value used for glowing meshes.
  114960. */
  114961. static GlowingMeshStencilReference: number;
  114962. /**
  114963. * Stencil value used for the other meshes in the scene.
  114964. */
  114965. static NormalMeshStencilReference: number;
  114966. /**
  114967. * Specifies whether or not the inner glow is ACTIVE in the layer.
  114968. */
  114969. innerGlow: boolean;
  114970. /**
  114971. * Specifies whether or not the outer glow is ACTIVE in the layer.
  114972. */
  114973. outerGlow: boolean;
  114974. /**
  114975. * Specifies the horizontal size of the blur.
  114976. */
  114977. /**
  114978. * Gets the horizontal size of the blur.
  114979. */
  114980. blurHorizontalSize: number;
  114981. /**
  114982. * Specifies the vertical size of the blur.
  114983. */
  114984. /**
  114985. * Gets the vertical size of the blur.
  114986. */
  114987. blurVerticalSize: number;
  114988. /**
  114989. * An event triggered when the highlight layer is being blurred.
  114990. */
  114991. onBeforeBlurObservable: Observable<HighlightLayer>;
  114992. /**
  114993. * An event triggered when the highlight layer has been blurred.
  114994. */
  114995. onAfterBlurObservable: Observable<HighlightLayer>;
  114996. private _instanceGlowingMeshStencilReference;
  114997. private _options;
  114998. private _downSamplePostprocess;
  114999. private _horizontalBlurPostprocess;
  115000. private _verticalBlurPostprocess;
  115001. private _blurTexture;
  115002. private _meshes;
  115003. private _excludedMeshes;
  115004. /**
  115005. * Instantiates a new highlight Layer and references it to the scene..
  115006. * @param name The name of the layer
  115007. * @param scene The scene to use the layer in
  115008. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  115009. */
  115010. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  115011. /**
  115012. * Get the effect name of the layer.
  115013. * @return The effect name
  115014. */
  115015. getEffectName(): string;
  115016. /**
  115017. * Create the merge effect. This is the shader use to blit the information back
  115018. * to the main canvas at the end of the scene rendering.
  115019. */
  115020. protected _createMergeEffect(): Effect;
  115021. /**
  115022. * Creates the render target textures and post processes used in the highlight layer.
  115023. */
  115024. protected _createTextureAndPostProcesses(): void;
  115025. /**
  115026. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  115027. */
  115028. needStencil(): boolean;
  115029. /**
  115030. * Checks for the readiness of the element composing the layer.
  115031. * @param subMesh the mesh to check for
  115032. * @param useInstances specify wether or not to use instances to render the mesh
  115033. * @param emissiveTexture the associated emissive texture used to generate the glow
  115034. * @return true if ready otherwise, false
  115035. */
  115036. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  115037. /**
  115038. * Implementation specific of rendering the generating effect on the main canvas.
  115039. * @param effect The effect used to render through
  115040. */
  115041. protected _internalRender(effect: Effect): void;
  115042. /**
  115043. * Returns true if the layer contains information to display, otherwise false.
  115044. */
  115045. shouldRender(): boolean;
  115046. /**
  115047. * Returns true if the mesh should render, otherwise false.
  115048. * @param mesh The mesh to render
  115049. * @returns true if it should render otherwise false
  115050. */
  115051. protected _shouldRenderMesh(mesh: Mesh): boolean;
  115052. /**
  115053. * Sets the required values for both the emissive texture and and the main color.
  115054. */
  115055. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  115056. /**
  115057. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  115058. * @param mesh The mesh to exclude from the highlight layer
  115059. */
  115060. addExcludedMesh(mesh: Mesh): void;
  115061. /**
  115062. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  115063. * @param mesh The mesh to highlight
  115064. */
  115065. removeExcludedMesh(mesh: Mesh): void;
  115066. /**
  115067. * Determine if a given mesh will be highlighted by the current HighlightLayer
  115068. * @param mesh mesh to test
  115069. * @returns true if the mesh will be highlighted by the current HighlightLayer
  115070. */
  115071. hasMesh(mesh: AbstractMesh): boolean;
  115072. /**
  115073. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  115074. * @param mesh The mesh to highlight
  115075. * @param color The color of the highlight
  115076. * @param glowEmissiveOnly Extract the glow from the emissive texture
  115077. */
  115078. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  115079. /**
  115080. * Remove a mesh from the highlight layer in order to make it stop glowing.
  115081. * @param mesh The mesh to highlight
  115082. */
  115083. removeMesh(mesh: Mesh): void;
  115084. /**
  115085. * Force the stencil to the normal expected value for none glowing parts
  115086. */
  115087. private _defaultStencilReference;
  115088. /**
  115089. * Free any resources and references associated to a mesh.
  115090. * Internal use
  115091. * @param mesh The mesh to free.
  115092. * @hidden
  115093. */
  115094. _disposeMesh(mesh: Mesh): void;
  115095. /**
  115096. * Dispose the highlight layer and free resources.
  115097. */
  115098. dispose(): void;
  115099. /**
  115100. * Gets the class name of the effect layer
  115101. * @returns the string with the class name of the effect layer
  115102. */
  115103. getClassName(): string;
  115104. /**
  115105. * Serializes this Highlight layer
  115106. * @returns a serialized Highlight layer object
  115107. */
  115108. serialize(): any;
  115109. /**
  115110. * Creates a Highlight layer from parsed Highlight layer data
  115111. * @param parsedHightlightLayer defines the Highlight layer data
  115112. * @param scene defines the current scene
  115113. * @param rootUrl defines the root URL containing the Highlight layer information
  115114. * @returns a parsed Highlight layer
  115115. */
  115116. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  115117. }
  115118. }
  115119. declare module BABYLON {
  115120. interface AbstractScene {
  115121. /**
  115122. * The list of layers (background and foreground) of the scene
  115123. */
  115124. layers: Array<Layer>;
  115125. }
  115126. /**
  115127. * Defines the layer scene component responsible to manage any layers
  115128. * in a given scene.
  115129. */
  115130. export class LayerSceneComponent implements ISceneComponent {
  115131. /**
  115132. * The component name helpfull to identify the component in the list of scene components.
  115133. */
  115134. readonly name: string;
  115135. /**
  115136. * The scene the component belongs to.
  115137. */
  115138. scene: Scene;
  115139. private _engine;
  115140. /**
  115141. * Creates a new instance of the component for the given scene
  115142. * @param scene Defines the scene to register the component in
  115143. */
  115144. constructor(scene: Scene);
  115145. /**
  115146. * Registers the component in a given scene
  115147. */
  115148. register(): void;
  115149. /**
  115150. * Rebuilds the elements related to this component in case of
  115151. * context lost for instance.
  115152. */
  115153. rebuild(): void;
  115154. /**
  115155. * Disposes the component and the associated ressources.
  115156. */
  115157. dispose(): void;
  115158. private _draw;
  115159. private _drawCameraPredicate;
  115160. private _drawCameraBackground;
  115161. private _drawCameraForeground;
  115162. private _drawRenderTargetPredicate;
  115163. private _drawRenderTargetBackground;
  115164. private _drawRenderTargetForeground;
  115165. /**
  115166. * Adds all the elements from the container to the scene
  115167. * @param container the container holding the elements
  115168. */
  115169. addFromContainer(container: AbstractScene): void;
  115170. /**
  115171. * Removes all the elements in the container from the scene
  115172. * @param container contains the elements to remove
  115173. * @param dispose if the removed element should be disposed (default: false)
  115174. */
  115175. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  115176. }
  115177. }
  115178. declare module BABYLON {
  115179. /** @hidden */
  115180. export var layerPixelShader: {
  115181. name: string;
  115182. shader: string;
  115183. };
  115184. }
  115185. declare module BABYLON {
  115186. /** @hidden */
  115187. export var layerVertexShader: {
  115188. name: string;
  115189. shader: string;
  115190. };
  115191. }
  115192. declare module BABYLON {
  115193. /**
  115194. * This represents a full screen 2d layer.
  115195. * This can be useful to display a picture in the background of your scene for instance.
  115196. * @see https://www.babylonjs-playground.com/#08A2BS#1
  115197. */
  115198. export class Layer {
  115199. /**
  115200. * Define the name of the layer.
  115201. */
  115202. name: string;
  115203. /**
  115204. * Define the texture the layer should display.
  115205. */
  115206. texture: Nullable<Texture>;
  115207. /**
  115208. * Is the layer in background or foreground.
  115209. */
  115210. isBackground: boolean;
  115211. /**
  115212. * Define the color of the layer (instead of texture).
  115213. */
  115214. color: Color4;
  115215. /**
  115216. * Define the scale of the layer in order to zoom in out of the texture.
  115217. */
  115218. scale: Vector2;
  115219. /**
  115220. * Define an offset for the layer in order to shift the texture.
  115221. */
  115222. offset: Vector2;
  115223. /**
  115224. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  115225. */
  115226. alphaBlendingMode: number;
  115227. /**
  115228. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  115229. * Alpha test will not mix with the background color in case of transparency.
  115230. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  115231. */
  115232. alphaTest: boolean;
  115233. /**
  115234. * Define a mask to restrict the layer to only some of the scene cameras.
  115235. */
  115236. layerMask: number;
  115237. /**
  115238. * Define the list of render target the layer is visible into.
  115239. */
  115240. renderTargetTextures: RenderTargetTexture[];
  115241. /**
  115242. * Define if the layer is only used in renderTarget or if it also
  115243. * renders in the main frame buffer of the canvas.
  115244. */
  115245. renderOnlyInRenderTargetTextures: boolean;
  115246. private _scene;
  115247. private _vertexBuffers;
  115248. private _indexBuffer;
  115249. private _effect;
  115250. private _alphaTestEffect;
  115251. /**
  115252. * An event triggered when the layer is disposed.
  115253. */
  115254. onDisposeObservable: Observable<Layer>;
  115255. private _onDisposeObserver;
  115256. /**
  115257. * Back compatibility with callback before the onDisposeObservable existed.
  115258. * The set callback will be triggered when the layer has been disposed.
  115259. */
  115260. onDispose: () => void;
  115261. /**
  115262. * An event triggered before rendering the scene
  115263. */
  115264. onBeforeRenderObservable: Observable<Layer>;
  115265. private _onBeforeRenderObserver;
  115266. /**
  115267. * Back compatibility with callback before the onBeforeRenderObservable existed.
  115268. * The set callback will be triggered just before rendering the layer.
  115269. */
  115270. onBeforeRender: () => void;
  115271. /**
  115272. * An event triggered after rendering the scene
  115273. */
  115274. onAfterRenderObservable: Observable<Layer>;
  115275. private _onAfterRenderObserver;
  115276. /**
  115277. * Back compatibility with callback before the onAfterRenderObservable existed.
  115278. * The set callback will be triggered just after rendering the layer.
  115279. */
  115280. onAfterRender: () => void;
  115281. /**
  115282. * Instantiates a new layer.
  115283. * This represents a full screen 2d layer.
  115284. * This can be useful to display a picture in the background of your scene for instance.
  115285. * @see https://www.babylonjs-playground.com/#08A2BS#1
  115286. * @param name Define the name of the layer in the scene
  115287. * @param imgUrl Define the url of the texture to display in the layer
  115288. * @param scene Define the scene the layer belongs to
  115289. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  115290. * @param color Defines a color for the layer
  115291. */
  115292. constructor(
  115293. /**
  115294. * Define the name of the layer.
  115295. */
  115296. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  115297. private _createIndexBuffer;
  115298. /** @hidden */
  115299. _rebuild(): void;
  115300. /**
  115301. * Renders the layer in the scene.
  115302. */
  115303. render(): void;
  115304. /**
  115305. * Disposes and releases the associated ressources.
  115306. */
  115307. dispose(): void;
  115308. }
  115309. }
  115310. declare module BABYLON {
  115311. /** @hidden */
  115312. export var lensFlarePixelShader: {
  115313. name: string;
  115314. shader: string;
  115315. };
  115316. }
  115317. declare module BABYLON {
  115318. /** @hidden */
  115319. export var lensFlareVertexShader: {
  115320. name: string;
  115321. shader: string;
  115322. };
  115323. }
  115324. declare module BABYLON {
  115325. /**
  115326. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  115327. * It is usually composed of several `lensFlare`.
  115328. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115329. */
  115330. export class LensFlareSystem {
  115331. /**
  115332. * Define the name of the lens flare system
  115333. */
  115334. name: string;
  115335. /**
  115336. * List of lens flares used in this system.
  115337. */
  115338. lensFlares: LensFlare[];
  115339. /**
  115340. * Define a limit from the border the lens flare can be visible.
  115341. */
  115342. borderLimit: number;
  115343. /**
  115344. * Define a viewport border we do not want to see the lens flare in.
  115345. */
  115346. viewportBorder: number;
  115347. /**
  115348. * Define a predicate which could limit the list of meshes able to occlude the effect.
  115349. */
  115350. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  115351. /**
  115352. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  115353. */
  115354. layerMask: number;
  115355. /**
  115356. * Define the id of the lens flare system in the scene.
  115357. * (equal to name by default)
  115358. */
  115359. id: string;
  115360. private _scene;
  115361. private _emitter;
  115362. private _vertexBuffers;
  115363. private _indexBuffer;
  115364. private _effect;
  115365. private _positionX;
  115366. private _positionY;
  115367. private _isEnabled;
  115368. /** @hidden */
  115369. static _SceneComponentInitialization: (scene: Scene) => void;
  115370. /**
  115371. * Instantiates a lens flare system.
  115372. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  115373. * It is usually composed of several `lensFlare`.
  115374. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115375. * @param name Define the name of the lens flare system in the scene
  115376. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  115377. * @param scene Define the scene the lens flare system belongs to
  115378. */
  115379. constructor(
  115380. /**
  115381. * Define the name of the lens flare system
  115382. */
  115383. name: string, emitter: any, scene: Scene);
  115384. /**
  115385. * Define if the lens flare system is enabled.
  115386. */
  115387. isEnabled: boolean;
  115388. /**
  115389. * Get the scene the effects belongs to.
  115390. * @returns the scene holding the lens flare system
  115391. */
  115392. getScene(): Scene;
  115393. /**
  115394. * Get the emitter of the lens flare system.
  115395. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  115396. * @returns the emitter of the lens flare system
  115397. */
  115398. getEmitter(): any;
  115399. /**
  115400. * Set the emitter of the lens flare system.
  115401. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  115402. * @param newEmitter Define the new emitter of the system
  115403. */
  115404. setEmitter(newEmitter: any): void;
  115405. /**
  115406. * Get the lens flare system emitter position.
  115407. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  115408. * @returns the position
  115409. */
  115410. getEmitterPosition(): Vector3;
  115411. /**
  115412. * @hidden
  115413. */
  115414. computeEffectivePosition(globalViewport: Viewport): boolean;
  115415. /** @hidden */
  115416. _isVisible(): boolean;
  115417. /**
  115418. * @hidden
  115419. */
  115420. render(): boolean;
  115421. /**
  115422. * Dispose and release the lens flare with its associated resources.
  115423. */
  115424. dispose(): void;
  115425. /**
  115426. * Parse a lens flare system from a JSON repressentation
  115427. * @param parsedLensFlareSystem Define the JSON to parse
  115428. * @param scene Define the scene the parsed system should be instantiated in
  115429. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  115430. * @returns the parsed system
  115431. */
  115432. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  115433. /**
  115434. * Serialize the current Lens Flare System into a JSON representation.
  115435. * @returns the serialized JSON
  115436. */
  115437. serialize(): any;
  115438. }
  115439. }
  115440. declare module BABYLON {
  115441. /**
  115442. * This represents one of the lens effect in a `lensFlareSystem`.
  115443. * It controls one of the indiviual texture used in the effect.
  115444. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115445. */
  115446. export class LensFlare {
  115447. /**
  115448. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  115449. */
  115450. size: number;
  115451. /**
  115452. * 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.
  115453. */
  115454. position: number;
  115455. /**
  115456. * Define the lens color.
  115457. */
  115458. color: Color3;
  115459. /**
  115460. * Define the lens texture.
  115461. */
  115462. texture: Nullable<Texture>;
  115463. /**
  115464. * Define the alpha mode to render this particular lens.
  115465. */
  115466. alphaMode: number;
  115467. private _system;
  115468. /**
  115469. * Creates a new Lens Flare.
  115470. * This represents one of the lens effect in a `lensFlareSystem`.
  115471. * It controls one of the indiviual texture used in the effect.
  115472. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115473. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  115474. * @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.
  115475. * @param color Define the lens color
  115476. * @param imgUrl Define the lens texture url
  115477. * @param system Define the `lensFlareSystem` this flare is part of
  115478. * @returns The newly created Lens Flare
  115479. */
  115480. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  115481. /**
  115482. * Instantiates a new Lens Flare.
  115483. * This represents one of the lens effect in a `lensFlareSystem`.
  115484. * It controls one of the indiviual texture used in the effect.
  115485. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115486. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  115487. * @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.
  115488. * @param color Define the lens color
  115489. * @param imgUrl Define the lens texture url
  115490. * @param system Define the `lensFlareSystem` this flare is part of
  115491. */
  115492. constructor(
  115493. /**
  115494. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  115495. */
  115496. size: number,
  115497. /**
  115498. * 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.
  115499. */
  115500. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  115501. /**
  115502. * Dispose and release the lens flare with its associated resources.
  115503. */
  115504. dispose(): void;
  115505. }
  115506. }
  115507. declare module BABYLON {
  115508. interface AbstractScene {
  115509. /**
  115510. * The list of lens flare system added to the scene
  115511. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  115512. */
  115513. lensFlareSystems: Array<LensFlareSystem>;
  115514. /**
  115515. * Removes the given lens flare system from this scene.
  115516. * @param toRemove The lens flare system to remove
  115517. * @returns The index of the removed lens flare system
  115518. */
  115519. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  115520. /**
  115521. * Adds the given lens flare system to this scene
  115522. * @param newLensFlareSystem The lens flare system to add
  115523. */
  115524. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  115525. /**
  115526. * Gets a lens flare system using its name
  115527. * @param name defines the name to look for
  115528. * @returns the lens flare system or null if not found
  115529. */
  115530. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  115531. /**
  115532. * Gets a lens flare system using its id
  115533. * @param id defines the id to look for
  115534. * @returns the lens flare system or null if not found
  115535. */
  115536. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  115537. }
  115538. /**
  115539. * Defines the lens flare scene component responsible to manage any lens flares
  115540. * in a given scene.
  115541. */
  115542. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  115543. /**
  115544. * The component name helpfull to identify the component in the list of scene components.
  115545. */
  115546. readonly name: string;
  115547. /**
  115548. * The scene the component belongs to.
  115549. */
  115550. scene: Scene;
  115551. /**
  115552. * Creates a new instance of the component for the given scene
  115553. * @param scene Defines the scene to register the component in
  115554. */
  115555. constructor(scene: Scene);
  115556. /**
  115557. * Registers the component in a given scene
  115558. */
  115559. register(): void;
  115560. /**
  115561. * Rebuilds the elements related to this component in case of
  115562. * context lost for instance.
  115563. */
  115564. rebuild(): void;
  115565. /**
  115566. * Adds all the elements from the container to the scene
  115567. * @param container the container holding the elements
  115568. */
  115569. addFromContainer(container: AbstractScene): void;
  115570. /**
  115571. * Removes all the elements in the container from the scene
  115572. * @param container contains the elements to remove
  115573. * @param dispose if the removed element should be disposed (default: false)
  115574. */
  115575. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  115576. /**
  115577. * Serializes the component data to the specified json object
  115578. * @param serializationObject The object to serialize to
  115579. */
  115580. serialize(serializationObject: any): void;
  115581. /**
  115582. * Disposes the component and the associated ressources.
  115583. */
  115584. dispose(): void;
  115585. private _draw;
  115586. }
  115587. }
  115588. declare module BABYLON {
  115589. /**
  115590. * Defines the shadow generator component responsible to manage any shadow generators
  115591. * in a given scene.
  115592. */
  115593. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  115594. /**
  115595. * The component name helpfull to identify the component in the list of scene components.
  115596. */
  115597. readonly name: string;
  115598. /**
  115599. * The scene the component belongs to.
  115600. */
  115601. scene: Scene;
  115602. /**
  115603. * Creates a new instance of the component for the given scene
  115604. * @param scene Defines the scene to register the component in
  115605. */
  115606. constructor(scene: Scene);
  115607. /**
  115608. * Registers the component in a given scene
  115609. */
  115610. register(): void;
  115611. /**
  115612. * Rebuilds the elements related to this component in case of
  115613. * context lost for instance.
  115614. */
  115615. rebuild(): void;
  115616. /**
  115617. * Serializes the component data to the specified json object
  115618. * @param serializationObject The object to serialize to
  115619. */
  115620. serialize(serializationObject: any): void;
  115621. /**
  115622. * Adds all the elements from the container to the scene
  115623. * @param container the container holding the elements
  115624. */
  115625. addFromContainer(container: AbstractScene): void;
  115626. /**
  115627. * Removes all the elements in the container from the scene
  115628. * @param container contains the elements to remove
  115629. * @param dispose if the removed element should be disposed (default: false)
  115630. */
  115631. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  115632. /**
  115633. * Rebuilds the elements related to this component in case of
  115634. * context lost for instance.
  115635. */
  115636. dispose(): void;
  115637. private _gatherRenderTargets;
  115638. }
  115639. }
  115640. declare module BABYLON {
  115641. /**
  115642. * A point light is a light defined by an unique point in world space.
  115643. * The light is emitted in every direction from this point.
  115644. * A good example of a point light is a standard light bulb.
  115645. * Documentation: https://doc.babylonjs.com/babylon101/lights
  115646. */
  115647. export class PointLight extends ShadowLight {
  115648. private _shadowAngle;
  115649. /**
  115650. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  115651. * This specifies what angle the shadow will use to be created.
  115652. *
  115653. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  115654. */
  115655. /**
  115656. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  115657. * This specifies what angle the shadow will use to be created.
  115658. *
  115659. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  115660. */
  115661. shadowAngle: number;
  115662. /**
  115663. * Gets the direction if it has been set.
  115664. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  115665. */
  115666. /**
  115667. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  115668. */
  115669. direction: Vector3;
  115670. /**
  115671. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  115672. * A PointLight emits the light in every direction.
  115673. * It can cast shadows.
  115674. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  115675. * ```javascript
  115676. * var pointLight = new PointLight("pl", camera.position, scene);
  115677. * ```
  115678. * Documentation : https://doc.babylonjs.com/babylon101/lights
  115679. * @param name The light friendly name
  115680. * @param position The position of the point light in the scene
  115681. * @param scene The scene the lights belongs to
  115682. */
  115683. constructor(name: string, position: Vector3, scene: Scene);
  115684. /**
  115685. * Returns the string "PointLight"
  115686. * @returns the class name
  115687. */
  115688. getClassName(): string;
  115689. /**
  115690. * Returns the integer 0.
  115691. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  115692. */
  115693. getTypeID(): number;
  115694. /**
  115695. * Specifies wether or not the shadowmap should be a cube texture.
  115696. * @returns true if the shadowmap needs to be a cube texture.
  115697. */
  115698. needCube(): boolean;
  115699. /**
  115700. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  115701. * @param faceIndex The index of the face we are computed the direction to generate shadow
  115702. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  115703. */
  115704. getShadowDirection(faceIndex?: number): Vector3;
  115705. /**
  115706. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  115707. * - fov = PI / 2
  115708. * - aspect ratio : 1.0
  115709. * - z-near and far equal to the active camera minZ and maxZ.
  115710. * Returns the PointLight.
  115711. */
  115712. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  115713. protected _buildUniformLayout(): void;
  115714. /**
  115715. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  115716. * @param effect The effect to update
  115717. * @param lightIndex The index of the light in the effect to update
  115718. * @returns The point light
  115719. */
  115720. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  115721. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  115722. /**
  115723. * Prepares the list of defines specific to the light type.
  115724. * @param defines the list of defines
  115725. * @param lightIndex defines the index of the light for the effect
  115726. */
  115727. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  115728. }
  115729. }
  115730. declare module BABYLON {
  115731. /**
  115732. * Header information of HDR texture files.
  115733. */
  115734. export interface HDRInfo {
  115735. /**
  115736. * The height of the texture in pixels.
  115737. */
  115738. height: number;
  115739. /**
  115740. * The width of the texture in pixels.
  115741. */
  115742. width: number;
  115743. /**
  115744. * The index of the beginning of the data in the binary file.
  115745. */
  115746. dataPosition: number;
  115747. }
  115748. /**
  115749. * This groups tools to convert HDR texture to native colors array.
  115750. */
  115751. export class HDRTools {
  115752. private static Ldexp;
  115753. private static Rgbe2float;
  115754. private static readStringLine;
  115755. /**
  115756. * Reads header information from an RGBE texture stored in a native array.
  115757. * More information on this format are available here:
  115758. * https://en.wikipedia.org/wiki/RGBE_image_format
  115759. *
  115760. * @param uint8array The binary file stored in native array.
  115761. * @return The header information.
  115762. */
  115763. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  115764. /**
  115765. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  115766. * This RGBE texture needs to store the information as a panorama.
  115767. *
  115768. * More information on this format are available here:
  115769. * https://en.wikipedia.org/wiki/RGBE_image_format
  115770. *
  115771. * @param buffer The binary file stored in an array buffer.
  115772. * @param size The expected size of the extracted cubemap.
  115773. * @return The Cube Map information.
  115774. */
  115775. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  115776. /**
  115777. * Returns the pixels data extracted from an RGBE texture.
  115778. * This pixels will be stored left to right up to down in the R G B order in one array.
  115779. *
  115780. * More information on this format are available here:
  115781. * https://en.wikipedia.org/wiki/RGBE_image_format
  115782. *
  115783. * @param uint8array The binary file stored in an array buffer.
  115784. * @param hdrInfo The header information of the file.
  115785. * @return The pixels data in RGB right to left up to down order.
  115786. */
  115787. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  115788. private static RGBE_ReadPixels_RLE;
  115789. }
  115790. }
  115791. declare module BABYLON {
  115792. /**
  115793. * This represents a texture coming from an HDR input.
  115794. *
  115795. * The only supported format is currently panorama picture stored in RGBE format.
  115796. * Example of such files can be found on HDRLib: http://hdrlib.com/
  115797. */
  115798. export class HDRCubeTexture extends BaseTexture {
  115799. private static _facesMapping;
  115800. private _generateHarmonics;
  115801. private _noMipmap;
  115802. private _textureMatrix;
  115803. private _size;
  115804. private _onLoad;
  115805. private _onError;
  115806. /**
  115807. * The texture URL.
  115808. */
  115809. url: string;
  115810. /**
  115811. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  115812. */
  115813. coordinatesMode: number;
  115814. protected _isBlocking: boolean;
  115815. /**
  115816. * Sets wether or not the texture is blocking during loading.
  115817. */
  115818. /**
  115819. * Gets wether or not the texture is blocking during loading.
  115820. */
  115821. isBlocking: boolean;
  115822. protected _rotationY: number;
  115823. /**
  115824. * Sets texture matrix rotation angle around Y axis in radians.
  115825. */
  115826. /**
  115827. * Gets texture matrix rotation angle around Y axis radians.
  115828. */
  115829. rotationY: number;
  115830. /**
  115831. * Gets or sets the center of the bounding box associated with the cube texture
  115832. * It must define where the camera used to render the texture was set
  115833. */
  115834. boundingBoxPosition: Vector3;
  115835. private _boundingBoxSize;
  115836. /**
  115837. * Gets or sets the size of the bounding box associated with the cube texture
  115838. * When defined, the cubemap will switch to local mode
  115839. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  115840. * @example https://www.babylonjs-playground.com/#RNASML
  115841. */
  115842. boundingBoxSize: Vector3;
  115843. /**
  115844. * Instantiates an HDRTexture from the following parameters.
  115845. *
  115846. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  115847. * @param scene The scene the texture will be used in
  115848. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  115849. * @param noMipmap Forces to not generate the mipmap if true
  115850. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  115851. * @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)
  115852. * @param reserved Reserved flag for internal use.
  115853. */
  115854. 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>);
  115855. /**
  115856. * Get the current class name of the texture useful for serialization or dynamic coding.
  115857. * @returns "HDRCubeTexture"
  115858. */
  115859. getClassName(): string;
  115860. /**
  115861. * Occurs when the file is raw .hdr file.
  115862. */
  115863. private loadTexture;
  115864. clone(): HDRCubeTexture;
  115865. delayLoad(): void;
  115866. /**
  115867. * Get the texture reflection matrix used to rotate/transform the reflection.
  115868. * @returns the reflection matrix
  115869. */
  115870. getReflectionTextureMatrix(): Matrix;
  115871. /**
  115872. * Set the texture reflection matrix used to rotate/transform the reflection.
  115873. * @param value Define the reflection matrix to set
  115874. */
  115875. setReflectionTextureMatrix(value: Matrix): void;
  115876. /**
  115877. * Parses a JSON representation of an HDR Texture in order to create the texture
  115878. * @param parsedTexture Define the JSON representation
  115879. * @param scene Define the scene the texture should be created in
  115880. * @param rootUrl Define the root url in case we need to load relative dependencies
  115881. * @returns the newly created texture after parsing
  115882. */
  115883. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  115884. serialize(): any;
  115885. }
  115886. }
  115887. declare module BABYLON {
  115888. /**
  115889. * Class used to control physics engine
  115890. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  115891. */
  115892. export class PhysicsEngine implements IPhysicsEngine {
  115893. private _physicsPlugin;
  115894. /**
  115895. * Global value used to control the smallest number supported by the simulation
  115896. */
  115897. static Epsilon: number;
  115898. private _impostors;
  115899. private _joints;
  115900. /**
  115901. * Gets the gravity vector used by the simulation
  115902. */
  115903. gravity: Vector3;
  115904. /**
  115905. * Factory used to create the default physics plugin.
  115906. * @returns The default physics plugin
  115907. */
  115908. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  115909. /**
  115910. * Creates a new Physics Engine
  115911. * @param gravity defines the gravity vector used by the simulation
  115912. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  115913. */
  115914. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  115915. /**
  115916. * Sets the gravity vector used by the simulation
  115917. * @param gravity defines the gravity vector to use
  115918. */
  115919. setGravity(gravity: Vector3): void;
  115920. /**
  115921. * Set the time step of the physics engine.
  115922. * Default is 1/60.
  115923. * To slow it down, enter 1/600 for example.
  115924. * To speed it up, 1/30
  115925. * @param newTimeStep defines the new timestep to apply to this world.
  115926. */
  115927. setTimeStep(newTimeStep?: number): void;
  115928. /**
  115929. * Get the time step of the physics engine.
  115930. * @returns the current time step
  115931. */
  115932. getTimeStep(): number;
  115933. /**
  115934. * Release all resources
  115935. */
  115936. dispose(): void;
  115937. /**
  115938. * Gets the name of the current physics plugin
  115939. * @returns the name of the plugin
  115940. */
  115941. getPhysicsPluginName(): string;
  115942. /**
  115943. * Adding a new impostor for the impostor tracking.
  115944. * This will be done by the impostor itself.
  115945. * @param impostor the impostor to add
  115946. */
  115947. addImpostor(impostor: PhysicsImpostor): void;
  115948. /**
  115949. * Remove an impostor from the engine.
  115950. * This impostor and its mesh will not longer be updated by the physics engine.
  115951. * @param impostor the impostor to remove
  115952. */
  115953. removeImpostor(impostor: PhysicsImpostor): void;
  115954. /**
  115955. * Add a joint to the physics engine
  115956. * @param mainImpostor defines the main impostor to which the joint is added.
  115957. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  115958. * @param joint defines the joint that will connect both impostors.
  115959. */
  115960. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  115961. /**
  115962. * Removes a joint from the simulation
  115963. * @param mainImpostor defines the impostor used with the joint
  115964. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  115965. * @param joint defines the joint to remove
  115966. */
  115967. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  115968. /**
  115969. * Called by the scene. No need to call it.
  115970. * @param delta defines the timespam between frames
  115971. */
  115972. _step(delta: number): void;
  115973. /**
  115974. * Gets the current plugin used to run the simulation
  115975. * @returns current plugin
  115976. */
  115977. getPhysicsPlugin(): IPhysicsEnginePlugin;
  115978. /**
  115979. * Gets the list of physic impostors
  115980. * @returns an array of PhysicsImpostor
  115981. */
  115982. getImpostors(): Array<PhysicsImpostor>;
  115983. /**
  115984. * Gets the impostor for a physics enabled object
  115985. * @param object defines the object impersonated by the impostor
  115986. * @returns the PhysicsImpostor or null if not found
  115987. */
  115988. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  115989. /**
  115990. * Gets the impostor for a physics body object
  115991. * @param body defines physics body used by the impostor
  115992. * @returns the PhysicsImpostor or null if not found
  115993. */
  115994. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  115995. /**
  115996. * Does a raycast in the physics world
  115997. * @param from when should the ray start?
  115998. * @param to when should the ray end?
  115999. * @returns PhysicsRaycastResult
  116000. */
  116001. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  116002. }
  116003. }
  116004. declare module BABYLON {
  116005. /** @hidden */
  116006. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  116007. private _useDeltaForWorldStep;
  116008. world: any;
  116009. name: string;
  116010. private _physicsMaterials;
  116011. private _fixedTimeStep;
  116012. private _cannonRaycastResult;
  116013. private _raycastResult;
  116014. private _physicsBodysToRemoveAfterStep;
  116015. BJSCANNON: any;
  116016. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  116017. setGravity(gravity: Vector3): void;
  116018. setTimeStep(timeStep: number): void;
  116019. getTimeStep(): number;
  116020. executeStep(delta: number): void;
  116021. private _removeMarkedPhysicsBodiesFromWorld;
  116022. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116023. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116024. generatePhysicsBody(impostor: PhysicsImpostor): void;
  116025. private _processChildMeshes;
  116026. removePhysicsBody(impostor: PhysicsImpostor): void;
  116027. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  116028. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  116029. private _addMaterial;
  116030. private _checkWithEpsilon;
  116031. private _createShape;
  116032. private _createHeightmap;
  116033. private _minus90X;
  116034. private _plus90X;
  116035. private _tmpPosition;
  116036. private _tmpDeltaPosition;
  116037. private _tmpUnityRotation;
  116038. private _updatePhysicsBodyTransformation;
  116039. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  116040. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  116041. isSupported(): boolean;
  116042. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116043. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116044. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116045. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116046. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  116047. getBodyMass(impostor: PhysicsImpostor): number;
  116048. getBodyFriction(impostor: PhysicsImpostor): number;
  116049. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  116050. getBodyRestitution(impostor: PhysicsImpostor): number;
  116051. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  116052. sleepBody(impostor: PhysicsImpostor): void;
  116053. wakeUpBody(impostor: PhysicsImpostor): void;
  116054. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  116055. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  116056. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  116057. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  116058. getRadius(impostor: PhysicsImpostor): number;
  116059. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  116060. dispose(): void;
  116061. private _extendNamespace;
  116062. /**
  116063. * Does a raycast in the physics world
  116064. * @param from when should the ray start?
  116065. * @param to when should the ray end?
  116066. * @returns PhysicsRaycastResult
  116067. */
  116068. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  116069. }
  116070. }
  116071. declare module BABYLON {
  116072. /** @hidden */
  116073. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  116074. world: any;
  116075. name: string;
  116076. BJSOIMO: any;
  116077. private _raycastResult;
  116078. constructor(iterations?: number, oimoInjection?: any);
  116079. setGravity(gravity: Vector3): void;
  116080. setTimeStep(timeStep: number): void;
  116081. getTimeStep(): number;
  116082. private _tmpImpostorsArray;
  116083. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  116084. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116085. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116086. generatePhysicsBody(impostor: PhysicsImpostor): void;
  116087. private _tmpPositionVector;
  116088. removePhysicsBody(impostor: PhysicsImpostor): void;
  116089. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  116090. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  116091. isSupported(): boolean;
  116092. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  116093. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  116094. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116095. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116096. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116097. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116098. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  116099. getBodyMass(impostor: PhysicsImpostor): number;
  116100. getBodyFriction(impostor: PhysicsImpostor): number;
  116101. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  116102. getBodyRestitution(impostor: PhysicsImpostor): number;
  116103. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  116104. sleepBody(impostor: PhysicsImpostor): void;
  116105. wakeUpBody(impostor: PhysicsImpostor): void;
  116106. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  116107. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  116108. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  116109. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  116110. getRadius(impostor: PhysicsImpostor): number;
  116111. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  116112. dispose(): void;
  116113. /**
  116114. * Does a raycast in the physics world
  116115. * @param from when should the ray start?
  116116. * @param to when should the ray end?
  116117. * @returns PhysicsRaycastResult
  116118. */
  116119. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  116120. }
  116121. }
  116122. declare module BABYLON {
  116123. /**
  116124. * Class containing static functions to help procedurally build meshes
  116125. */
  116126. export class RibbonBuilder {
  116127. /**
  116128. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  116129. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  116130. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  116131. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  116132. * * 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
  116133. * * 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
  116134. * * 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
  116135. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  116136. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  116137. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  116138. * * 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
  116139. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  116140. * * 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
  116141. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  116142. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  116143. * @param name defines the name of the mesh
  116144. * @param options defines the options used to create the mesh
  116145. * @param scene defines the hosting scene
  116146. * @returns the ribbon mesh
  116147. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  116148. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  116149. */
  116150. static CreateRibbon(name: string, options: {
  116151. pathArray: Vector3[][];
  116152. closeArray?: boolean;
  116153. closePath?: boolean;
  116154. offset?: number;
  116155. updatable?: boolean;
  116156. sideOrientation?: number;
  116157. frontUVs?: Vector4;
  116158. backUVs?: Vector4;
  116159. instance?: Mesh;
  116160. invertUV?: boolean;
  116161. uvs?: Vector2[];
  116162. colors?: Color4[];
  116163. }, scene?: Nullable<Scene>): Mesh;
  116164. }
  116165. }
  116166. declare module BABYLON {
  116167. /**
  116168. * Class containing static functions to help procedurally build meshes
  116169. */
  116170. export class ShapeBuilder {
  116171. /**
  116172. * 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.
  116173. * * 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.
  116174. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  116175. * * 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.
  116176. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  116177. * * 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
  116178. * * 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
  116179. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  116180. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  116181. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  116182. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  116183. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  116184. * @param name defines the name of the mesh
  116185. * @param options defines the options used to create the mesh
  116186. * @param scene defines the hosting scene
  116187. * @returns the extruded shape mesh
  116188. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  116189. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  116190. */
  116191. static ExtrudeShape(name: string, options: {
  116192. shape: Vector3[];
  116193. path: Vector3[];
  116194. scale?: number;
  116195. rotation?: number;
  116196. cap?: number;
  116197. updatable?: boolean;
  116198. sideOrientation?: number;
  116199. frontUVs?: Vector4;
  116200. backUVs?: Vector4;
  116201. instance?: Mesh;
  116202. invertUV?: boolean;
  116203. }, scene?: Nullable<Scene>): Mesh;
  116204. /**
  116205. * Creates an custom extruded shape mesh.
  116206. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  116207. * * 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.
  116208. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  116209. * * 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
  116210. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  116211. * * 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
  116212. * * It must returns a float value that will be the scale value applied to the shape on each path point
  116213. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  116214. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  116215. * * 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
  116216. * * 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
  116217. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  116218. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  116219. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  116220. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  116221. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  116222. * @param name defines the name of the mesh
  116223. * @param options defines the options used to create the mesh
  116224. * @param scene defines the hosting scene
  116225. * @returns the custom extruded shape mesh
  116226. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  116227. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  116228. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  116229. */
  116230. static ExtrudeShapeCustom(name: string, options: {
  116231. shape: Vector3[];
  116232. path: Vector3[];
  116233. scaleFunction?: any;
  116234. rotationFunction?: any;
  116235. ribbonCloseArray?: boolean;
  116236. ribbonClosePath?: boolean;
  116237. cap?: number;
  116238. updatable?: boolean;
  116239. sideOrientation?: number;
  116240. frontUVs?: Vector4;
  116241. backUVs?: Vector4;
  116242. instance?: Mesh;
  116243. invertUV?: boolean;
  116244. }, scene?: Nullable<Scene>): Mesh;
  116245. private static _ExtrudeShapeGeneric;
  116246. }
  116247. }
  116248. declare module BABYLON {
  116249. /**
  116250. * AmmoJS Physics plugin
  116251. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  116252. * @see https://github.com/kripken/ammo.js/
  116253. */
  116254. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  116255. private _useDeltaForWorldStep;
  116256. /**
  116257. * Reference to the Ammo library
  116258. */
  116259. bjsAMMO: any;
  116260. /**
  116261. * Created ammoJS world which physics bodies are added to
  116262. */
  116263. world: any;
  116264. /**
  116265. * Name of the plugin
  116266. */
  116267. name: string;
  116268. private _timeStep;
  116269. private _fixedTimeStep;
  116270. private _maxSteps;
  116271. private _tmpQuaternion;
  116272. private _tmpAmmoTransform;
  116273. private _tmpAmmoQuaternion;
  116274. private _tmpAmmoConcreteContactResultCallback;
  116275. private _collisionConfiguration;
  116276. private _dispatcher;
  116277. private _overlappingPairCache;
  116278. private _solver;
  116279. private _softBodySolver;
  116280. private _tmpAmmoVectorA;
  116281. private _tmpAmmoVectorB;
  116282. private _tmpAmmoVectorC;
  116283. private _tmpAmmoVectorD;
  116284. private _tmpContactCallbackResult;
  116285. private _tmpAmmoVectorRCA;
  116286. private _tmpAmmoVectorRCB;
  116287. private _raycastResult;
  116288. private static readonly DISABLE_COLLISION_FLAG;
  116289. private static readonly KINEMATIC_FLAG;
  116290. private static readonly DISABLE_DEACTIVATION_FLAG;
  116291. /**
  116292. * Initializes the ammoJS plugin
  116293. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  116294. * @param ammoInjection can be used to inject your own ammo reference
  116295. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  116296. */
  116297. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  116298. /**
  116299. * Sets the gravity of the physics world (m/(s^2))
  116300. * @param gravity Gravity to set
  116301. */
  116302. setGravity(gravity: Vector3): void;
  116303. /**
  116304. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  116305. * @param timeStep timestep to use in seconds
  116306. */
  116307. setTimeStep(timeStep: number): void;
  116308. /**
  116309. * 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)
  116310. * @param fixedTimeStep fixedTimeStep to use in seconds
  116311. */
  116312. setFixedTimeStep(fixedTimeStep: number): void;
  116313. /**
  116314. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  116315. * @param maxSteps the maximum number of steps by the physics engine per frame
  116316. */
  116317. setMaxSteps(maxSteps: number): void;
  116318. /**
  116319. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  116320. * @returns the current timestep in seconds
  116321. */
  116322. getTimeStep(): number;
  116323. private _isImpostorInContact;
  116324. private _isImpostorPairInContact;
  116325. private _stepSimulation;
  116326. /**
  116327. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  116328. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  116329. * After the step the babylon meshes are set to the position of the physics imposters
  116330. * @param delta amount of time to step forward
  116331. * @param impostors array of imposters to update before/after the step
  116332. */
  116333. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  116334. /**
  116335. * Update babylon mesh to match physics world object
  116336. * @param impostor imposter to match
  116337. */
  116338. private _afterSoftStep;
  116339. /**
  116340. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  116341. * @param impostor imposter to match
  116342. */
  116343. private _ropeStep;
  116344. /**
  116345. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  116346. * @param impostor imposter to match
  116347. */
  116348. private _softbodyOrClothStep;
  116349. private _tmpVector;
  116350. private _tmpMatrix;
  116351. /**
  116352. * Applies an impulse on the imposter
  116353. * @param impostor imposter to apply impulse to
  116354. * @param force amount of force to be applied to the imposter
  116355. * @param contactPoint the location to apply the impulse on the imposter
  116356. */
  116357. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116358. /**
  116359. * Applies a force on the imposter
  116360. * @param impostor imposter to apply force
  116361. * @param force amount of force to be applied to the imposter
  116362. * @param contactPoint the location to apply the force on the imposter
  116363. */
  116364. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  116365. /**
  116366. * Creates a physics body using the plugin
  116367. * @param impostor the imposter to create the physics body on
  116368. */
  116369. generatePhysicsBody(impostor: PhysicsImpostor): void;
  116370. /**
  116371. * Removes the physics body from the imposter and disposes of the body's memory
  116372. * @param impostor imposter to remove the physics body from
  116373. */
  116374. removePhysicsBody(impostor: PhysicsImpostor): void;
  116375. /**
  116376. * Generates a joint
  116377. * @param impostorJoint the imposter joint to create the joint with
  116378. */
  116379. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  116380. /**
  116381. * Removes a joint
  116382. * @param impostorJoint the imposter joint to remove the joint from
  116383. */
  116384. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  116385. private _addMeshVerts;
  116386. /**
  116387. * Initialise the soft body vertices to match its object's (mesh) vertices
  116388. * Softbody vertices (nodes) are in world space and to match this
  116389. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  116390. * @param impostor to create the softbody for
  116391. */
  116392. private _softVertexData;
  116393. /**
  116394. * Create an impostor's soft body
  116395. * @param impostor to create the softbody for
  116396. */
  116397. private _createSoftbody;
  116398. /**
  116399. * Create cloth for an impostor
  116400. * @param impostor to create the softbody for
  116401. */
  116402. private _createCloth;
  116403. /**
  116404. * Create rope for an impostor
  116405. * @param impostor to create the softbody for
  116406. */
  116407. private _createRope;
  116408. private _addHullVerts;
  116409. private _createShape;
  116410. /**
  116411. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  116412. * @param impostor imposter containing the physics body and babylon object
  116413. */
  116414. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  116415. /**
  116416. * Sets the babylon object's position/rotation from the physics body's position/rotation
  116417. * @param impostor imposter containing the physics body and babylon object
  116418. * @param newPosition new position
  116419. * @param newRotation new rotation
  116420. */
  116421. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  116422. /**
  116423. * If this plugin is supported
  116424. * @returns true if its supported
  116425. */
  116426. isSupported(): boolean;
  116427. /**
  116428. * Sets the linear velocity of the physics body
  116429. * @param impostor imposter to set the velocity on
  116430. * @param velocity velocity to set
  116431. */
  116432. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116433. /**
  116434. * Sets the angular velocity of the physics body
  116435. * @param impostor imposter to set the velocity on
  116436. * @param velocity velocity to set
  116437. */
  116438. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  116439. /**
  116440. * gets the linear velocity
  116441. * @param impostor imposter to get linear velocity from
  116442. * @returns linear velocity
  116443. */
  116444. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116445. /**
  116446. * gets the angular velocity
  116447. * @param impostor imposter to get angular velocity from
  116448. * @returns angular velocity
  116449. */
  116450. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  116451. /**
  116452. * Sets the mass of physics body
  116453. * @param impostor imposter to set the mass on
  116454. * @param mass mass to set
  116455. */
  116456. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  116457. /**
  116458. * Gets the mass of the physics body
  116459. * @param impostor imposter to get the mass from
  116460. * @returns mass
  116461. */
  116462. getBodyMass(impostor: PhysicsImpostor): number;
  116463. /**
  116464. * Gets friction of the impostor
  116465. * @param impostor impostor to get friction from
  116466. * @returns friction value
  116467. */
  116468. getBodyFriction(impostor: PhysicsImpostor): number;
  116469. /**
  116470. * Sets friction of the impostor
  116471. * @param impostor impostor to set friction on
  116472. * @param friction friction value
  116473. */
  116474. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  116475. /**
  116476. * Gets restitution of the impostor
  116477. * @param impostor impostor to get restitution from
  116478. * @returns restitution value
  116479. */
  116480. getBodyRestitution(impostor: PhysicsImpostor): number;
  116481. /**
  116482. * Sets resitution of the impostor
  116483. * @param impostor impostor to set resitution on
  116484. * @param restitution resitution value
  116485. */
  116486. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  116487. /**
  116488. * Gets pressure inside the impostor
  116489. * @param impostor impostor to get pressure from
  116490. * @returns pressure value
  116491. */
  116492. getBodyPressure(impostor: PhysicsImpostor): number;
  116493. /**
  116494. * Sets pressure inside a soft body impostor
  116495. * Cloth and rope must remain 0 pressure
  116496. * @param impostor impostor to set pressure on
  116497. * @param pressure pressure value
  116498. */
  116499. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  116500. /**
  116501. * Gets stiffness of the impostor
  116502. * @param impostor impostor to get stiffness from
  116503. * @returns pressure value
  116504. */
  116505. getBodyStiffness(impostor: PhysicsImpostor): number;
  116506. /**
  116507. * Sets stiffness of the impostor
  116508. * @param impostor impostor to set stiffness on
  116509. * @param stiffness stiffness value from 0 to 1
  116510. */
  116511. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  116512. /**
  116513. * Gets velocityIterations of the impostor
  116514. * @param impostor impostor to get velocity iterations from
  116515. * @returns velocityIterations value
  116516. */
  116517. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  116518. /**
  116519. * Sets velocityIterations of the impostor
  116520. * @param impostor impostor to set velocity iterations on
  116521. * @param velocityIterations velocityIterations value
  116522. */
  116523. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  116524. /**
  116525. * Gets positionIterations of the impostor
  116526. * @param impostor impostor to get position iterations from
  116527. * @returns positionIterations value
  116528. */
  116529. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  116530. /**
  116531. * Sets positionIterations of the impostor
  116532. * @param impostor impostor to set position on
  116533. * @param positionIterations positionIterations value
  116534. */
  116535. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  116536. /**
  116537. * Append an anchor to a cloth object
  116538. * @param impostor is the cloth impostor to add anchor to
  116539. * @param otherImpostor is the rigid impostor to anchor to
  116540. * @param width ratio across width from 0 to 1
  116541. * @param height ratio up height from 0 to 1
  116542. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  116543. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  116544. */
  116545. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  116546. /**
  116547. * Append an hook to a rope object
  116548. * @param impostor is the rope impostor to add hook to
  116549. * @param otherImpostor is the rigid impostor to hook to
  116550. * @param length ratio along the rope from 0 to 1
  116551. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  116552. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  116553. */
  116554. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  116555. /**
  116556. * Sleeps the physics body and stops it from being active
  116557. * @param impostor impostor to sleep
  116558. */
  116559. sleepBody(impostor: PhysicsImpostor): void;
  116560. /**
  116561. * Activates the physics body
  116562. * @param impostor impostor to activate
  116563. */
  116564. wakeUpBody(impostor: PhysicsImpostor): void;
  116565. /**
  116566. * Updates the distance parameters of the joint
  116567. * @param joint joint to update
  116568. * @param maxDistance maximum distance of the joint
  116569. * @param minDistance minimum distance of the joint
  116570. */
  116571. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  116572. /**
  116573. * Sets a motor on the joint
  116574. * @param joint joint to set motor on
  116575. * @param speed speed of the motor
  116576. * @param maxForce maximum force of the motor
  116577. * @param motorIndex index of the motor
  116578. */
  116579. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  116580. /**
  116581. * Sets the motors limit
  116582. * @param joint joint to set limit on
  116583. * @param upperLimit upper limit
  116584. * @param lowerLimit lower limit
  116585. */
  116586. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  116587. /**
  116588. * Syncs the position and rotation of a mesh with the impostor
  116589. * @param mesh mesh to sync
  116590. * @param impostor impostor to update the mesh with
  116591. */
  116592. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  116593. /**
  116594. * Gets the radius of the impostor
  116595. * @param impostor impostor to get radius from
  116596. * @returns the radius
  116597. */
  116598. getRadius(impostor: PhysicsImpostor): number;
  116599. /**
  116600. * Gets the box size of the impostor
  116601. * @param impostor impostor to get box size from
  116602. * @param result the resulting box size
  116603. */
  116604. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  116605. /**
  116606. * Disposes of the impostor
  116607. */
  116608. dispose(): void;
  116609. /**
  116610. * Does a raycast in the physics world
  116611. * @param from when should the ray start?
  116612. * @param to when should the ray end?
  116613. * @returns PhysicsRaycastResult
  116614. */
  116615. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  116616. }
  116617. }
  116618. declare module BABYLON {
  116619. interface AbstractScene {
  116620. /**
  116621. * The list of reflection probes added to the scene
  116622. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  116623. */
  116624. reflectionProbes: Array<ReflectionProbe>;
  116625. /**
  116626. * Removes the given reflection probe from this scene.
  116627. * @param toRemove The reflection probe to remove
  116628. * @returns The index of the removed reflection probe
  116629. */
  116630. removeReflectionProbe(toRemove: ReflectionProbe): number;
  116631. /**
  116632. * Adds the given reflection probe to this scene.
  116633. * @param newReflectionProbe The reflection probe to add
  116634. */
  116635. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  116636. }
  116637. /**
  116638. * Class used to generate realtime reflection / refraction cube textures
  116639. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  116640. */
  116641. export class ReflectionProbe {
  116642. /** defines the name of the probe */
  116643. name: string;
  116644. private _scene;
  116645. private _renderTargetTexture;
  116646. private _projectionMatrix;
  116647. private _viewMatrix;
  116648. private _target;
  116649. private _add;
  116650. private _attachedMesh;
  116651. private _invertYAxis;
  116652. /** Gets or sets probe position (center of the cube map) */
  116653. position: Vector3;
  116654. /**
  116655. * Creates a new reflection probe
  116656. * @param name defines the name of the probe
  116657. * @param size defines the texture resolution (for each face)
  116658. * @param scene defines the hosting scene
  116659. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  116660. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  116661. */
  116662. constructor(
  116663. /** defines the name of the probe */
  116664. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  116665. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  116666. samples: number;
  116667. /** Gets or sets the refresh rate to use (on every frame by default) */
  116668. refreshRate: number;
  116669. /**
  116670. * Gets the hosting scene
  116671. * @returns a Scene
  116672. */
  116673. getScene(): Scene;
  116674. /** Gets the internal CubeTexture used to render to */
  116675. readonly cubeTexture: RenderTargetTexture;
  116676. /** Gets the list of meshes to render */
  116677. readonly renderList: Nullable<AbstractMesh[]>;
  116678. /**
  116679. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  116680. * @param mesh defines the mesh to attach to
  116681. */
  116682. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  116683. /**
  116684. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  116685. * @param renderingGroupId The rendering group id corresponding to its index
  116686. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  116687. */
  116688. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  116689. /**
  116690. * Clean all associated resources
  116691. */
  116692. dispose(): void;
  116693. /**
  116694. * Converts the reflection probe information to a readable string for debug purpose.
  116695. * @param fullDetails Supports for multiple levels of logging within scene loading
  116696. * @returns the human readable reflection probe info
  116697. */
  116698. toString(fullDetails?: boolean): string;
  116699. /**
  116700. * Get the class name of the relfection probe.
  116701. * @returns "ReflectionProbe"
  116702. */
  116703. getClassName(): string;
  116704. /**
  116705. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  116706. * @returns The JSON representation of the texture
  116707. */
  116708. serialize(): any;
  116709. /**
  116710. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  116711. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  116712. * @param scene Define the scene the parsed reflection probe should be instantiated in
  116713. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  116714. * @returns The parsed reflection probe if successful
  116715. */
  116716. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  116717. }
  116718. }
  116719. declare module BABYLON {
  116720. /** @hidden */
  116721. export var _BabylonLoaderRegistered: boolean;
  116722. }
  116723. declare module BABYLON {
  116724. /**
  116725. * The Physically based simple base material of BJS.
  116726. *
  116727. * This enables better naming and convention enforcements on top of the pbrMaterial.
  116728. * It is used as the base class for both the specGloss and metalRough conventions.
  116729. */
  116730. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  116731. /**
  116732. * Number of Simultaneous lights allowed on the material.
  116733. */
  116734. maxSimultaneousLights: number;
  116735. /**
  116736. * If sets to true, disables all the lights affecting the material.
  116737. */
  116738. disableLighting: boolean;
  116739. /**
  116740. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  116741. */
  116742. environmentTexture: BaseTexture;
  116743. /**
  116744. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  116745. */
  116746. invertNormalMapX: boolean;
  116747. /**
  116748. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  116749. */
  116750. invertNormalMapY: boolean;
  116751. /**
  116752. * Normal map used in the model.
  116753. */
  116754. normalTexture: BaseTexture;
  116755. /**
  116756. * Emissivie color used to self-illuminate the model.
  116757. */
  116758. emissiveColor: Color3;
  116759. /**
  116760. * Emissivie texture used to self-illuminate the model.
  116761. */
  116762. emissiveTexture: BaseTexture;
  116763. /**
  116764. * Occlusion Channel Strenght.
  116765. */
  116766. occlusionStrength: number;
  116767. /**
  116768. * Occlusion Texture of the material (adding extra occlusion effects).
  116769. */
  116770. occlusionTexture: BaseTexture;
  116771. /**
  116772. * Defines the alpha limits in alpha test mode.
  116773. */
  116774. alphaCutOff: number;
  116775. /**
  116776. * Gets the current double sided mode.
  116777. */
  116778. /**
  116779. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116780. */
  116781. doubleSided: boolean;
  116782. /**
  116783. * Stores the pre-calculated light information of a mesh in a texture.
  116784. */
  116785. lightmapTexture: BaseTexture;
  116786. /**
  116787. * If true, the light map contains occlusion information instead of lighting info.
  116788. */
  116789. useLightmapAsShadowmap: boolean;
  116790. /**
  116791. * Instantiates a new PBRMaterial instance.
  116792. *
  116793. * @param name The material name
  116794. * @param scene The scene the material will be use in.
  116795. */
  116796. constructor(name: string, scene: Scene);
  116797. getClassName(): string;
  116798. }
  116799. }
  116800. declare module BABYLON {
  116801. /**
  116802. * The PBR material of BJS following the metal roughness convention.
  116803. *
  116804. * This fits to the PBR convention in the GLTF definition:
  116805. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  116806. */
  116807. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  116808. /**
  116809. * The base color has two different interpretations depending on the value of metalness.
  116810. * When the material is a metal, the base color is the specific measured reflectance value
  116811. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  116812. * of the material.
  116813. */
  116814. baseColor: Color3;
  116815. /**
  116816. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  116817. * well as opacity information in the alpha channel.
  116818. */
  116819. baseTexture: BaseTexture;
  116820. /**
  116821. * Specifies the metallic scalar value of the material.
  116822. * Can also be used to scale the metalness values of the metallic texture.
  116823. */
  116824. metallic: number;
  116825. /**
  116826. * Specifies the roughness scalar value of the material.
  116827. * Can also be used to scale the roughness values of the metallic texture.
  116828. */
  116829. roughness: number;
  116830. /**
  116831. * Texture containing both the metallic value in the B channel and the
  116832. * roughness value in the G channel to keep better precision.
  116833. */
  116834. metallicRoughnessTexture: BaseTexture;
  116835. /**
  116836. * Instantiates a new PBRMetalRoughnessMaterial instance.
  116837. *
  116838. * @param name The material name
  116839. * @param scene The scene the material will be use in.
  116840. */
  116841. constructor(name: string, scene: Scene);
  116842. /**
  116843. * Return the currrent class name of the material.
  116844. */
  116845. getClassName(): string;
  116846. /**
  116847. * Makes a duplicate of the current material.
  116848. * @param name - name to use for the new material.
  116849. */
  116850. clone(name: string): PBRMetallicRoughnessMaterial;
  116851. /**
  116852. * Serialize the material to a parsable JSON object.
  116853. */
  116854. serialize(): any;
  116855. /**
  116856. * Parses a JSON object correponding to the serialize function.
  116857. */
  116858. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  116859. }
  116860. }
  116861. declare module BABYLON {
  116862. /**
  116863. * The PBR material of BJS following the specular glossiness convention.
  116864. *
  116865. * This fits to the PBR convention in the GLTF definition:
  116866. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  116867. */
  116868. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  116869. /**
  116870. * Specifies the diffuse color of the material.
  116871. */
  116872. diffuseColor: Color3;
  116873. /**
  116874. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  116875. * channel.
  116876. */
  116877. diffuseTexture: BaseTexture;
  116878. /**
  116879. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  116880. */
  116881. specularColor: Color3;
  116882. /**
  116883. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  116884. */
  116885. glossiness: number;
  116886. /**
  116887. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  116888. */
  116889. specularGlossinessTexture: BaseTexture;
  116890. /**
  116891. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  116892. *
  116893. * @param name The material name
  116894. * @param scene The scene the material will be use in.
  116895. */
  116896. constructor(name: string, scene: Scene);
  116897. /**
  116898. * Return the currrent class name of the material.
  116899. */
  116900. getClassName(): string;
  116901. /**
  116902. * Makes a duplicate of the current material.
  116903. * @param name - name to use for the new material.
  116904. */
  116905. clone(name: string): PBRSpecularGlossinessMaterial;
  116906. /**
  116907. * Serialize the material to a parsable JSON object.
  116908. */
  116909. serialize(): any;
  116910. /**
  116911. * Parses a JSON object correponding to the serialize function.
  116912. */
  116913. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  116914. }
  116915. }
  116916. declare module BABYLON {
  116917. /**
  116918. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  116919. * It can help converting any input color in a desired output one. This can then be used to create effects
  116920. * from sepia, black and white to sixties or futuristic rendering...
  116921. *
  116922. * The only supported format is currently 3dl.
  116923. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  116924. */
  116925. export class ColorGradingTexture extends BaseTexture {
  116926. /**
  116927. * The current texture matrix. (will always be identity in color grading texture)
  116928. */
  116929. private _textureMatrix;
  116930. /**
  116931. * The texture URL.
  116932. */
  116933. url: string;
  116934. /**
  116935. * Empty line regex stored for GC.
  116936. */
  116937. private static _noneEmptyLineRegex;
  116938. private _engine;
  116939. /**
  116940. * Instantiates a ColorGradingTexture from the following parameters.
  116941. *
  116942. * @param url The location of the color gradind data (currently only supporting 3dl)
  116943. * @param scene The scene the texture will be used in
  116944. */
  116945. constructor(url: string, scene: Scene);
  116946. /**
  116947. * Returns the texture matrix used in most of the material.
  116948. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  116949. */
  116950. getTextureMatrix(): Matrix;
  116951. /**
  116952. * Occurs when the file being loaded is a .3dl LUT file.
  116953. */
  116954. private load3dlTexture;
  116955. /**
  116956. * Starts the loading process of the texture.
  116957. */
  116958. private loadTexture;
  116959. /**
  116960. * Clones the color gradind texture.
  116961. */
  116962. clone(): ColorGradingTexture;
  116963. /**
  116964. * Called during delayed load for textures.
  116965. */
  116966. delayLoad(): void;
  116967. /**
  116968. * Parses a color grading texture serialized by Babylon.
  116969. * @param parsedTexture The texture information being parsedTexture
  116970. * @param scene The scene to load the texture in
  116971. * @param rootUrl The root url of the data assets to load
  116972. * @return A color gradind texture
  116973. */
  116974. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  116975. /**
  116976. * Serializes the LUT texture to json format.
  116977. */
  116978. serialize(): any;
  116979. }
  116980. }
  116981. declare module BABYLON {
  116982. /**
  116983. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  116984. */
  116985. export class EquiRectangularCubeTexture extends BaseTexture {
  116986. /** The six faces of the cube. */
  116987. private static _FacesMapping;
  116988. private _noMipmap;
  116989. private _onLoad;
  116990. private _onError;
  116991. /** The size of the cubemap. */
  116992. private _size;
  116993. /** The buffer of the image. */
  116994. private _buffer;
  116995. /** The width of the input image. */
  116996. private _width;
  116997. /** The height of the input image. */
  116998. private _height;
  116999. /** The URL to the image. */
  117000. url: string;
  117001. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  117002. coordinatesMode: number;
  117003. /**
  117004. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  117005. * @param url The location of the image
  117006. * @param scene The scene the texture will be used in
  117007. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  117008. * @param noMipmap Forces to not generate the mipmap if true
  117009. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  117010. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  117011. * @param onLoad — defines a callback called when texture is loaded
  117012. * @param onError — defines a callback called if there is an error
  117013. */
  117014. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  117015. /**
  117016. * Load the image data, by putting the image on a canvas and extracting its buffer.
  117017. */
  117018. private loadImage;
  117019. /**
  117020. * Convert the image buffer into a cubemap and create a CubeTexture.
  117021. */
  117022. private loadTexture;
  117023. /**
  117024. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  117025. * @param buffer The ArrayBuffer that should be converted.
  117026. * @returns The buffer as Float32Array.
  117027. */
  117028. private getFloat32ArrayFromArrayBuffer;
  117029. /**
  117030. * Get the current class name of the texture useful for serialization or dynamic coding.
  117031. * @returns "EquiRectangularCubeTexture"
  117032. */
  117033. getClassName(): string;
  117034. /**
  117035. * Create a clone of the current EquiRectangularCubeTexture and return it.
  117036. * @returns A clone of the current EquiRectangularCubeTexture.
  117037. */
  117038. clone(): EquiRectangularCubeTexture;
  117039. }
  117040. }
  117041. declare module BABYLON {
  117042. /**
  117043. * Based on jsTGALoader - Javascript loader for TGA file
  117044. * By Vincent Thibault
  117045. * @see http://blog.robrowser.com/javascript-tga-loader.html
  117046. */
  117047. export class TGATools {
  117048. private static _TYPE_INDEXED;
  117049. private static _TYPE_RGB;
  117050. private static _TYPE_GREY;
  117051. private static _TYPE_RLE_INDEXED;
  117052. private static _TYPE_RLE_RGB;
  117053. private static _TYPE_RLE_GREY;
  117054. private static _ORIGIN_MASK;
  117055. private static _ORIGIN_SHIFT;
  117056. private static _ORIGIN_BL;
  117057. private static _ORIGIN_BR;
  117058. private static _ORIGIN_UL;
  117059. private static _ORIGIN_UR;
  117060. /**
  117061. * Gets the header of a TGA file
  117062. * @param data defines the TGA data
  117063. * @returns the header
  117064. */
  117065. static GetTGAHeader(data: Uint8Array): any;
  117066. /**
  117067. * Uploads TGA content to a Babylon Texture
  117068. * @hidden
  117069. */
  117070. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  117071. /** @hidden */
  117072. 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;
  117073. /** @hidden */
  117074. 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;
  117075. /** @hidden */
  117076. 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;
  117077. /** @hidden */
  117078. 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;
  117079. /** @hidden */
  117080. 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;
  117081. /** @hidden */
  117082. 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;
  117083. }
  117084. }
  117085. declare module BABYLON {
  117086. /**
  117087. * Implementation of the TGA Texture Loader.
  117088. * @hidden
  117089. */
  117090. export class _TGATextureLoader implements IInternalTextureLoader {
  117091. /**
  117092. * Defines wether the loader supports cascade loading the different faces.
  117093. */
  117094. readonly supportCascades: boolean;
  117095. /**
  117096. * This returns if the loader support the current file information.
  117097. * @param extension defines the file extension of the file being loaded
  117098. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117099. * @param fallback defines the fallback internal texture if any
  117100. * @param isBase64 defines whether the texture is encoded as a base64
  117101. * @param isBuffer defines whether the texture data are stored as a buffer
  117102. * @returns true if the loader can load the specified file
  117103. */
  117104. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117105. /**
  117106. * Transform the url before loading if required.
  117107. * @param rootUrl the url of the texture
  117108. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117109. * @returns the transformed texture
  117110. */
  117111. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117112. /**
  117113. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117114. * @param rootUrl the url of the texture
  117115. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117116. * @returns the fallback texture
  117117. */
  117118. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117119. /**
  117120. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117121. * @param data contains the texture data
  117122. * @param texture defines the BabylonJS internal texture
  117123. * @param createPolynomials will be true if polynomials have been requested
  117124. * @param onLoad defines the callback to trigger once the texture is ready
  117125. * @param onError defines the callback to trigger in case of error
  117126. */
  117127. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117128. /**
  117129. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117130. * @param data contains the texture data
  117131. * @param texture defines the BabylonJS internal texture
  117132. * @param callback defines the method to call once ready to upload
  117133. */
  117134. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117135. }
  117136. }
  117137. declare module BABYLON {
  117138. /**
  117139. * Info about the .basis files
  117140. */
  117141. class BasisFileInfo {
  117142. /**
  117143. * If the file has alpha
  117144. */
  117145. hasAlpha: boolean;
  117146. /**
  117147. * Info about each image of the basis file
  117148. */
  117149. images: Array<{
  117150. levels: Array<{
  117151. width: number;
  117152. height: number;
  117153. transcodedPixels: ArrayBufferView;
  117154. }>;
  117155. }>;
  117156. }
  117157. /**
  117158. * Result of transcoding a basis file
  117159. */
  117160. class TranscodeResult {
  117161. /**
  117162. * Info about the .basis file
  117163. */
  117164. fileInfo: BasisFileInfo;
  117165. /**
  117166. * Format to use when loading the file
  117167. */
  117168. format: number;
  117169. }
  117170. /**
  117171. * Configuration options for the Basis transcoder
  117172. */
  117173. export class BasisTranscodeConfiguration {
  117174. /**
  117175. * Supported compression formats used to determine the supported output format of the transcoder
  117176. */
  117177. supportedCompressionFormats?: {
  117178. /**
  117179. * etc1 compression format
  117180. */
  117181. etc1?: boolean;
  117182. /**
  117183. * s3tc compression format
  117184. */
  117185. s3tc?: boolean;
  117186. /**
  117187. * pvrtc compression format
  117188. */
  117189. pvrtc?: boolean;
  117190. /**
  117191. * etc2 compression format
  117192. */
  117193. etc2?: boolean;
  117194. };
  117195. /**
  117196. * If mipmap levels should be loaded for transcoded images (Default: true)
  117197. */
  117198. loadMipmapLevels?: boolean;
  117199. /**
  117200. * Index of a single image to load (Default: all images)
  117201. */
  117202. loadSingleImage?: number;
  117203. }
  117204. /**
  117205. * Used to load .Basis files
  117206. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  117207. */
  117208. export class BasisTools {
  117209. private static _IgnoreSupportedFormats;
  117210. /**
  117211. * URL to use when loading the basis transcoder
  117212. */
  117213. static JSModuleURL: string;
  117214. /**
  117215. * URL to use when loading the wasm module for the transcoder
  117216. */
  117217. static WasmModuleURL: string;
  117218. /**
  117219. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  117220. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  117221. * @returns internal format corresponding to the Basis format
  117222. */
  117223. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  117224. private static _WorkerPromise;
  117225. private static _Worker;
  117226. private static _actionId;
  117227. private static _CreateWorkerAsync;
  117228. /**
  117229. * Transcodes a loaded image file to compressed pixel data
  117230. * @param imageData image data to transcode
  117231. * @param config configuration options for the transcoding
  117232. * @returns a promise resulting in the transcoded image
  117233. */
  117234. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  117235. /**
  117236. * Loads a texture from the transcode result
  117237. * @param texture texture load to
  117238. * @param transcodeResult the result of transcoding the basis file to load from
  117239. */
  117240. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  117241. }
  117242. }
  117243. declare module BABYLON {
  117244. /**
  117245. * Loader for .basis file format
  117246. */
  117247. export class _BasisTextureLoader implements IInternalTextureLoader {
  117248. /**
  117249. * Defines whether the loader supports cascade loading the different faces.
  117250. */
  117251. readonly supportCascades: boolean;
  117252. /**
  117253. * This returns if the loader support the current file information.
  117254. * @param extension defines the file extension of the file being loaded
  117255. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117256. * @param fallback defines the fallback internal texture if any
  117257. * @param isBase64 defines whether the texture is encoded as a base64
  117258. * @param isBuffer defines whether the texture data are stored as a buffer
  117259. * @returns true if the loader can load the specified file
  117260. */
  117261. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117262. /**
  117263. * Transform the url before loading if required.
  117264. * @param rootUrl the url of the texture
  117265. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117266. * @returns the transformed texture
  117267. */
  117268. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117269. /**
  117270. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117271. * @param rootUrl the url of the texture
  117272. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117273. * @returns the fallback texture
  117274. */
  117275. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117276. /**
  117277. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  117278. * @param data contains the texture data
  117279. * @param texture defines the BabylonJS internal texture
  117280. * @param createPolynomials will be true if polynomials have been requested
  117281. * @param onLoad defines the callback to trigger once the texture is ready
  117282. * @param onError defines the callback to trigger in case of error
  117283. */
  117284. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117285. /**
  117286. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117287. * @param data contains the texture data
  117288. * @param texture defines the BabylonJS internal texture
  117289. * @param callback defines the method to call once ready to upload
  117290. */
  117291. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117292. }
  117293. }
  117294. declare module BABYLON {
  117295. /**
  117296. * 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.
  117297. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  117298. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  117299. */
  117300. export class CustomProceduralTexture extends ProceduralTexture {
  117301. private _animate;
  117302. private _time;
  117303. private _config;
  117304. private _texturePath;
  117305. /**
  117306. * Instantiates a new Custom Procedural Texture.
  117307. * 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.
  117308. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  117309. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  117310. * @param name Define the name of the texture
  117311. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  117312. * @param size Define the size of the texture to create
  117313. * @param scene Define the scene the texture belongs to
  117314. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  117315. * @param generateMipMaps Define if the texture should creates mip maps or not
  117316. */
  117317. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  117318. private _loadJson;
  117319. /**
  117320. * Is the texture ready to be used ? (rendered at least once)
  117321. * @returns true if ready, otherwise, false.
  117322. */
  117323. isReady(): boolean;
  117324. /**
  117325. * Render the texture to its associated render target.
  117326. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  117327. */
  117328. render(useCameraPostProcess?: boolean): void;
  117329. /**
  117330. * Update the list of dependant textures samplers in the shader.
  117331. */
  117332. updateTextures(): void;
  117333. /**
  117334. * Update the uniform values of the procedural texture in the shader.
  117335. */
  117336. updateShaderUniforms(): void;
  117337. /**
  117338. * Define if the texture animates or not.
  117339. */
  117340. animate: boolean;
  117341. }
  117342. }
  117343. declare module BABYLON {
  117344. /** @hidden */
  117345. export var noisePixelShader: {
  117346. name: string;
  117347. shader: string;
  117348. };
  117349. }
  117350. declare module BABYLON {
  117351. /**
  117352. * Class used to generate noise procedural textures
  117353. */
  117354. export class NoiseProceduralTexture extends ProceduralTexture {
  117355. private _time;
  117356. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  117357. brightness: number;
  117358. /** Defines the number of octaves to process */
  117359. octaves: number;
  117360. /** Defines the level of persistence (0.8 by default) */
  117361. persistence: number;
  117362. /** Gets or sets animation speed factor (default is 1) */
  117363. animationSpeedFactor: number;
  117364. /**
  117365. * Creates a new NoiseProceduralTexture
  117366. * @param name defines the name fo the texture
  117367. * @param size defines the size of the texture (default is 256)
  117368. * @param scene defines the hosting scene
  117369. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  117370. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  117371. */
  117372. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  117373. private _updateShaderUniforms;
  117374. protected _getDefines(): string;
  117375. /** Generate the current state of the procedural texture */
  117376. render(useCameraPostProcess?: boolean): void;
  117377. /**
  117378. * Serializes this noise procedural texture
  117379. * @returns a serialized noise procedural texture object
  117380. */
  117381. serialize(): any;
  117382. /**
  117383. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  117384. * @param parsedTexture defines parsed texture data
  117385. * @param scene defines the current scene
  117386. * @param rootUrl defines the root URL containing noise procedural texture information
  117387. * @returns a parsed NoiseProceduralTexture
  117388. */
  117389. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  117390. }
  117391. }
  117392. declare module BABYLON {
  117393. /**
  117394. * Raw cube texture where the raw buffers are passed in
  117395. */
  117396. export class RawCubeTexture extends CubeTexture {
  117397. /**
  117398. * Creates a cube texture where the raw buffers are passed in.
  117399. * @param scene defines the scene the texture is attached to
  117400. * @param data defines the array of data to use to create each face
  117401. * @param size defines the size of the textures
  117402. * @param format defines the format of the data
  117403. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  117404. * @param generateMipMaps defines if the engine should generate the mip levels
  117405. * @param invertY defines if data must be stored with Y axis inverted
  117406. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  117407. * @param compression defines the compression used (null by default)
  117408. */
  117409. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  117410. /**
  117411. * Updates the raw cube texture.
  117412. * @param data defines the data to store
  117413. * @param format defines the data format
  117414. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  117415. * @param invertY defines if data must be stored with Y axis inverted
  117416. * @param compression defines the compression used (null by default)
  117417. * @param level defines which level of the texture to update
  117418. */
  117419. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  117420. /**
  117421. * Updates a raw cube texture with RGBD encoded data.
  117422. * @param data defines the array of data [mipmap][face] to use to create each face
  117423. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  117424. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  117425. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  117426. * @returns a promsie that resolves when the operation is complete
  117427. */
  117428. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  117429. /**
  117430. * Clones the raw cube texture.
  117431. * @return a new cube texture
  117432. */
  117433. clone(): CubeTexture;
  117434. /** @hidden */
  117435. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  117436. }
  117437. }
  117438. declare module BABYLON {
  117439. /**
  117440. * Class used to store 3D textures containing user data
  117441. */
  117442. export class RawTexture3D extends Texture {
  117443. /** Gets or sets the texture format to use */
  117444. format: number;
  117445. private _engine;
  117446. /**
  117447. * Create a new RawTexture3D
  117448. * @param data defines the data of the texture
  117449. * @param width defines the width of the texture
  117450. * @param height defines the height of the texture
  117451. * @param depth defines the depth of the texture
  117452. * @param format defines the texture format to use
  117453. * @param scene defines the hosting scene
  117454. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  117455. * @param invertY defines if texture must be stored with Y axis inverted
  117456. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  117457. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  117458. */
  117459. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  117460. /** Gets or sets the texture format to use */
  117461. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  117462. /**
  117463. * Update the texture with new data
  117464. * @param data defines the data to store in the texture
  117465. */
  117466. update(data: ArrayBufferView): void;
  117467. }
  117468. }
  117469. declare module BABYLON {
  117470. /**
  117471. * Creates a refraction texture used by refraction channel of the standard material.
  117472. * It is like a mirror but to see through a material.
  117473. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  117474. */
  117475. export class RefractionTexture extends RenderTargetTexture {
  117476. /**
  117477. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  117478. * 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.
  117479. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  117480. */
  117481. refractionPlane: Plane;
  117482. /**
  117483. * Define how deep under the surface we should see.
  117484. */
  117485. depth: number;
  117486. /**
  117487. * Creates a refraction texture used by refraction channel of the standard material.
  117488. * It is like a mirror but to see through a material.
  117489. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  117490. * @param name Define the texture name
  117491. * @param size Define the size of the underlying texture
  117492. * @param scene Define the scene the refraction belongs to
  117493. * @param generateMipMaps Define if we need to generate mips level for the refraction
  117494. */
  117495. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  117496. /**
  117497. * Clone the refraction texture.
  117498. * @returns the cloned texture
  117499. */
  117500. clone(): RefractionTexture;
  117501. /**
  117502. * Serialize the texture to a JSON representation you could use in Parse later on
  117503. * @returns the serialized JSON representation
  117504. */
  117505. serialize(): any;
  117506. }
  117507. }
  117508. declare module BABYLON {
  117509. /**
  117510. * Defines the options related to the creation of an HtmlElementTexture
  117511. */
  117512. export interface IHtmlElementTextureOptions {
  117513. /**
  117514. * Defines wether mip maps should be created or not.
  117515. */
  117516. generateMipMaps?: boolean;
  117517. /**
  117518. * Defines the sampling mode of the texture.
  117519. */
  117520. samplingMode?: number;
  117521. /**
  117522. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  117523. */
  117524. engine: Nullable<Engine>;
  117525. /**
  117526. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  117527. */
  117528. scene: Nullable<Scene>;
  117529. }
  117530. /**
  117531. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  117532. * To be as efficient as possible depending on your constraints nothing aside the first upload
  117533. * is automatically managed.
  117534. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  117535. * in your application.
  117536. *
  117537. * As the update is not automatic, you need to call them manually.
  117538. */
  117539. export class HtmlElementTexture extends BaseTexture {
  117540. /**
  117541. * The texture URL.
  117542. */
  117543. element: HTMLVideoElement | HTMLCanvasElement;
  117544. private static readonly DefaultOptions;
  117545. private _textureMatrix;
  117546. private _engine;
  117547. private _isVideo;
  117548. private _generateMipMaps;
  117549. private _samplingMode;
  117550. /**
  117551. * Instantiates a HtmlElementTexture from the following parameters.
  117552. *
  117553. * @param name Defines the name of the texture
  117554. * @param element Defines the video or canvas the texture is filled with
  117555. * @param options Defines the other none mandatory texture creation options
  117556. */
  117557. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  117558. private _createInternalTexture;
  117559. /**
  117560. * Returns the texture matrix used in most of the material.
  117561. */
  117562. getTextureMatrix(): Matrix;
  117563. /**
  117564. * Updates the content of the texture.
  117565. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  117566. */
  117567. update(invertY?: Nullable<boolean>): void;
  117568. }
  117569. }
  117570. declare module BABYLON {
  117571. /**
  117572. * Enum used to define the target of a block
  117573. */
  117574. export enum NodeMaterialBlockTargets {
  117575. /** Vertex shader */
  117576. Vertex = 1,
  117577. /** Fragment shader */
  117578. Fragment = 2,
  117579. /** Neutral */
  117580. Neutral = 4,
  117581. /** Vertex and Fragment */
  117582. VertexAndFragment = 3
  117583. }
  117584. }
  117585. declare module BABYLON {
  117586. /**
  117587. * Defines the kind of connection point for node based material
  117588. */
  117589. export enum NodeMaterialBlockConnectionPointTypes {
  117590. /** Float */
  117591. Float = 1,
  117592. /** Int */
  117593. Int = 2,
  117594. /** Vector2 */
  117595. Vector2 = 4,
  117596. /** Vector3 */
  117597. Vector3 = 8,
  117598. /** Vector4 */
  117599. Vector4 = 16,
  117600. /** Color3 */
  117601. Color3 = 32,
  117602. /** Color4 */
  117603. Color4 = 64,
  117604. /** Matrix */
  117605. Matrix = 128,
  117606. /** Detect type based on connection */
  117607. AutoDetect = 1024,
  117608. /** Output type that will be defined by input type */
  117609. BasedOnInput = 2048
  117610. }
  117611. }
  117612. declare module BABYLON {
  117613. /**
  117614. * Root class for all node material optimizers
  117615. */
  117616. export class NodeMaterialOptimizer {
  117617. /**
  117618. * Function used to optimize a NodeMaterial graph
  117619. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  117620. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  117621. */
  117622. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  117623. }
  117624. }
  117625. declare module BABYLON {
  117626. /**
  117627. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  117628. */
  117629. export class TransformBlock extends NodeMaterialBlock {
  117630. /**
  117631. * Defines the value to use to complement W value to transform it to a Vector4
  117632. */
  117633. complementW: number;
  117634. /**
  117635. * Defines the value to use to complement z value to transform it to a Vector4
  117636. */
  117637. complementZ: number;
  117638. /**
  117639. * Creates a new TransformBlock
  117640. * @param name defines the block name
  117641. */
  117642. constructor(name: string);
  117643. /**
  117644. * Gets the current class name
  117645. * @returns the class name
  117646. */
  117647. getClassName(): string;
  117648. /**
  117649. * Gets the vector input
  117650. */
  117651. readonly vector: NodeMaterialConnectionPoint;
  117652. /**
  117653. * Gets the output component
  117654. */
  117655. readonly output: NodeMaterialConnectionPoint;
  117656. /**
  117657. * Gets the matrix transform input
  117658. */
  117659. readonly transform: NodeMaterialConnectionPoint;
  117660. protected _buildBlock(state: NodeMaterialBuildState): this;
  117661. serialize(): any;
  117662. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  117663. protected _dumpPropertiesCode(): string;
  117664. }
  117665. }
  117666. declare module BABYLON {
  117667. /**
  117668. * Block used to output the vertex position
  117669. */
  117670. export class VertexOutputBlock extends NodeMaterialBlock {
  117671. /**
  117672. * Creates a new VertexOutputBlock
  117673. * @param name defines the block name
  117674. */
  117675. constructor(name: string);
  117676. /**
  117677. * Gets the current class name
  117678. * @returns the class name
  117679. */
  117680. getClassName(): string;
  117681. /**
  117682. * Gets the vector input component
  117683. */
  117684. readonly vector: NodeMaterialConnectionPoint;
  117685. protected _buildBlock(state: NodeMaterialBuildState): this;
  117686. }
  117687. }
  117688. declare module BABYLON {
  117689. /**
  117690. * Block used to output the final color
  117691. */
  117692. export class FragmentOutputBlock extends NodeMaterialBlock {
  117693. /**
  117694. * Create a new FragmentOutputBlock
  117695. * @param name defines the block name
  117696. */
  117697. constructor(name: string);
  117698. /**
  117699. * Gets the current class name
  117700. * @returns the class name
  117701. */
  117702. getClassName(): string;
  117703. /**
  117704. * Gets the rgba input component
  117705. */
  117706. readonly rgba: NodeMaterialConnectionPoint;
  117707. /**
  117708. * Gets the rgb input component
  117709. */
  117710. readonly rgb: NodeMaterialConnectionPoint;
  117711. /**
  117712. * Gets the a input component
  117713. */
  117714. readonly a: NodeMaterialConnectionPoint;
  117715. protected _buildBlock(state: NodeMaterialBuildState): this;
  117716. }
  117717. }
  117718. declare module BABYLON {
  117719. /**
  117720. * Enum used to define system values e.g. values automatically provided by the system
  117721. */
  117722. export enum NodeMaterialSystemValues {
  117723. /** World */
  117724. World = 1,
  117725. /** View */
  117726. View = 2,
  117727. /** Projection */
  117728. Projection = 3,
  117729. /** ViewProjection */
  117730. ViewProjection = 4,
  117731. /** WorldView */
  117732. WorldView = 5,
  117733. /** WorldViewProjection */
  117734. WorldViewProjection = 6,
  117735. /** CameraPosition */
  117736. CameraPosition = 7,
  117737. /** Fog Color */
  117738. FogColor = 8
  117739. }
  117740. }
  117741. declare module BABYLON {
  117742. /**
  117743. * Block used to read a reflection texture from a sampler
  117744. */
  117745. export class ReflectionTextureBlock extends NodeMaterialBlock {
  117746. private _define3DName;
  117747. private _defineCubicName;
  117748. private _defineExplicitName;
  117749. private _defineProjectionName;
  117750. private _defineLocalCubicName;
  117751. private _defineSphericalName;
  117752. private _definePlanarName;
  117753. private _defineEquirectangularName;
  117754. private _defineMirroredEquirectangularFixedName;
  117755. private _defineEquirectangularFixedName;
  117756. private _defineSkyboxName;
  117757. private _cubeSamplerName;
  117758. private _2DSamplerName;
  117759. private _positionUVWName;
  117760. private _directionWName;
  117761. private _reflectionCoordsName;
  117762. private _reflection2DCoordsName;
  117763. private _reflectionColorName;
  117764. private _reflectionMatrixName;
  117765. /**
  117766. * Gets or sets the texture associated with the node
  117767. */
  117768. texture: Nullable<BaseTexture>;
  117769. /**
  117770. * Create a new TextureBlock
  117771. * @param name defines the block name
  117772. */
  117773. constructor(name: string);
  117774. /**
  117775. * Gets the current class name
  117776. * @returns the class name
  117777. */
  117778. getClassName(): string;
  117779. /**
  117780. * Gets the world position input component
  117781. */
  117782. readonly position: NodeMaterialConnectionPoint;
  117783. /**
  117784. * Gets the world position input component
  117785. */
  117786. readonly worldPosition: NodeMaterialConnectionPoint;
  117787. /**
  117788. * Gets the world normal input component
  117789. */
  117790. readonly worldNormal: NodeMaterialConnectionPoint;
  117791. /**
  117792. * Gets the world input component
  117793. */
  117794. readonly world: NodeMaterialConnectionPoint;
  117795. /**
  117796. * Gets the camera (or eye) position component
  117797. */
  117798. readonly cameraPosition: NodeMaterialConnectionPoint;
  117799. /**
  117800. * Gets the view input component
  117801. */
  117802. readonly view: NodeMaterialConnectionPoint;
  117803. /**
  117804. * Gets the rgb output component
  117805. */
  117806. readonly rgb: NodeMaterialConnectionPoint;
  117807. /**
  117808. * Gets the r output component
  117809. */
  117810. readonly r: NodeMaterialConnectionPoint;
  117811. /**
  117812. * Gets the g output component
  117813. */
  117814. readonly g: NodeMaterialConnectionPoint;
  117815. /**
  117816. * Gets the b output component
  117817. */
  117818. readonly b: NodeMaterialConnectionPoint;
  117819. autoConfigure(material: NodeMaterial): void;
  117820. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  117821. isReady(): boolean;
  117822. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  117823. private _injectVertexCode;
  117824. private _writeOutput;
  117825. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  117826. serialize(): any;
  117827. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  117828. }
  117829. }
  117830. declare module BABYLON {
  117831. /**
  117832. * Interface used to configure the node material editor
  117833. */
  117834. export interface INodeMaterialEditorOptions {
  117835. /** Define the URl to load node editor script */
  117836. editorURL?: string;
  117837. }
  117838. /** @hidden */
  117839. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  117840. /** BONES */
  117841. NUM_BONE_INFLUENCERS: number;
  117842. BonesPerMesh: number;
  117843. BONETEXTURE: boolean;
  117844. /** MORPH TARGETS */
  117845. MORPHTARGETS: boolean;
  117846. MORPHTARGETS_NORMAL: boolean;
  117847. MORPHTARGETS_TANGENT: boolean;
  117848. MORPHTARGETS_UV: boolean;
  117849. NUM_MORPH_INFLUENCERS: number;
  117850. /** IMAGE PROCESSING */
  117851. IMAGEPROCESSING: boolean;
  117852. VIGNETTE: boolean;
  117853. VIGNETTEBLENDMODEMULTIPLY: boolean;
  117854. VIGNETTEBLENDMODEOPAQUE: boolean;
  117855. TONEMAPPING: boolean;
  117856. TONEMAPPING_ACES: boolean;
  117857. CONTRAST: boolean;
  117858. EXPOSURE: boolean;
  117859. COLORCURVES: boolean;
  117860. COLORGRADING: boolean;
  117861. COLORGRADING3D: boolean;
  117862. SAMPLER3DGREENDEPTH: boolean;
  117863. SAMPLER3DBGRMAP: boolean;
  117864. IMAGEPROCESSINGPOSTPROCESS: boolean;
  117865. /** MISC. */
  117866. BUMPDIRECTUV: number;
  117867. constructor();
  117868. setValue(name: string, value: boolean): void;
  117869. }
  117870. /**
  117871. * Class used to configure NodeMaterial
  117872. */
  117873. export interface INodeMaterialOptions {
  117874. /**
  117875. * Defines if blocks should emit comments
  117876. */
  117877. emitComments: boolean;
  117878. }
  117879. /**
  117880. * Class used to create a node based material built by assembling shader blocks
  117881. */
  117882. export class NodeMaterial extends PushMaterial {
  117883. private static _BuildIdGenerator;
  117884. private _options;
  117885. private _vertexCompilationState;
  117886. private _fragmentCompilationState;
  117887. private _sharedData;
  117888. private _buildId;
  117889. private _buildWasSuccessful;
  117890. private _cachedWorldViewMatrix;
  117891. private _cachedWorldViewProjectionMatrix;
  117892. private _optimizers;
  117893. private _animationFrame;
  117894. /** Define the URl to load node editor script */
  117895. static EditorURL: string;
  117896. private BJSNODEMATERIALEDITOR;
  117897. /** Get the inspector from bundle or global */
  117898. private _getGlobalNodeMaterialEditor;
  117899. /**
  117900. * 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)
  117901. */
  117902. ignoreAlpha: boolean;
  117903. /**
  117904. * Defines the maximum number of lights that can be used in the material
  117905. */
  117906. maxSimultaneousLights: number;
  117907. /**
  117908. * Observable raised when the material is built
  117909. */
  117910. onBuildObservable: Observable<NodeMaterial>;
  117911. /**
  117912. * Gets or sets the root nodes of the material vertex shader
  117913. */
  117914. _vertexOutputNodes: NodeMaterialBlock[];
  117915. /**
  117916. * Gets or sets the root nodes of the material fragment (pixel) shader
  117917. */
  117918. _fragmentOutputNodes: NodeMaterialBlock[];
  117919. /** Gets or sets options to control the node material overall behavior */
  117920. options: INodeMaterialOptions;
  117921. /**
  117922. * Default configuration related to image processing available in the standard Material.
  117923. */
  117924. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  117925. /**
  117926. * Gets the image processing configuration used either in this material.
  117927. */
  117928. /**
  117929. * Sets the Default image processing configuration used either in the this material.
  117930. *
  117931. * If sets to null, the scene one is in use.
  117932. */
  117933. imageProcessingConfiguration: ImageProcessingConfiguration;
  117934. /**
  117935. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  117936. */
  117937. attachedBlocks: NodeMaterialBlock[];
  117938. /**
  117939. * Create a new node based material
  117940. * @param name defines the material name
  117941. * @param scene defines the hosting scene
  117942. * @param options defines creation option
  117943. */
  117944. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  117945. /**
  117946. * Gets the current class name of the material e.g. "NodeMaterial"
  117947. * @returns the class name
  117948. */
  117949. getClassName(): string;
  117950. /**
  117951. * Keep track of the image processing observer to allow dispose and replace.
  117952. */
  117953. private _imageProcessingObserver;
  117954. /**
  117955. * Attaches a new image processing configuration to the Standard Material.
  117956. * @param configuration
  117957. */
  117958. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  117959. /**
  117960. * Get a block by its name
  117961. * @param name defines the name of the block to retrieve
  117962. * @returns the required block or null if not found
  117963. */
  117964. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  117965. /**
  117966. * Get a block by its name
  117967. * @param predicate defines the predicate used to find the good candidate
  117968. * @returns the required block or null if not found
  117969. */
  117970. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  117971. /**
  117972. * Get an input block by its name
  117973. * @param predicate defines the predicate used to find the good candidate
  117974. * @returns the required input block or null if not found
  117975. */
  117976. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  117977. /**
  117978. * Gets the list of input blocks attached to this material
  117979. * @returns an array of InputBlocks
  117980. */
  117981. getInputBlocks(): InputBlock[];
  117982. /**
  117983. * Adds a new optimizer to the list of optimizers
  117984. * @param optimizer defines the optimizers to add
  117985. * @returns the current material
  117986. */
  117987. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  117988. /**
  117989. * Remove an optimizer from the list of optimizers
  117990. * @param optimizer defines the optimizers to remove
  117991. * @returns the current material
  117992. */
  117993. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  117994. /**
  117995. * Add a new block to the list of output nodes
  117996. * @param node defines the node to add
  117997. * @returns the current material
  117998. */
  117999. addOutputNode(node: NodeMaterialBlock): this;
  118000. /**
  118001. * Remove a block from the list of root nodes
  118002. * @param node defines the node to remove
  118003. * @returns the current material
  118004. */
  118005. removeOutputNode(node: NodeMaterialBlock): this;
  118006. private _addVertexOutputNode;
  118007. private _removeVertexOutputNode;
  118008. private _addFragmentOutputNode;
  118009. private _removeFragmentOutputNode;
  118010. /**
  118011. * Specifies if the material will require alpha blending
  118012. * @returns a boolean specifying if alpha blending is needed
  118013. */
  118014. needAlphaBlending(): boolean;
  118015. /**
  118016. * Specifies if this material should be rendered in alpha test mode
  118017. * @returns a boolean specifying if an alpha test is needed.
  118018. */
  118019. needAlphaTesting(): boolean;
  118020. private _initializeBlock;
  118021. private _resetDualBlocks;
  118022. /**
  118023. * Build the material and generates the inner effect
  118024. * @param verbose defines if the build should log activity
  118025. */
  118026. build(verbose?: boolean): void;
  118027. /**
  118028. * Runs an otpimization phase to try to improve the shader code
  118029. */
  118030. optimize(): void;
  118031. private _prepareDefinesForAttributes;
  118032. /**
  118033. * Get if the submesh is ready to be used and all its information available.
  118034. * Child classes can use it to update shaders
  118035. * @param mesh defines the mesh to check
  118036. * @param subMesh defines which submesh to check
  118037. * @param useInstances specifies that instances should be used
  118038. * @returns a boolean indicating that the submesh is ready or not
  118039. */
  118040. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  118041. /**
  118042. * Get a string representing the shaders built by the current node graph
  118043. */
  118044. readonly compiledShaders: string;
  118045. /**
  118046. * Binds the world matrix to the material
  118047. * @param world defines the world transformation matrix
  118048. */
  118049. bindOnlyWorldMatrix(world: Matrix): void;
  118050. /**
  118051. * Binds the submesh to this material by preparing the effect and shader to draw
  118052. * @param world defines the world transformation matrix
  118053. * @param mesh defines the mesh containing the submesh
  118054. * @param subMesh defines the submesh to bind the material to
  118055. */
  118056. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  118057. /**
  118058. * Gets the active textures from the material
  118059. * @returns an array of textures
  118060. */
  118061. getActiveTextures(): BaseTexture[];
  118062. /**
  118063. * Gets the list of texture blocks
  118064. * @returns an array of texture blocks
  118065. */
  118066. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  118067. /**
  118068. * Specifies if the material uses a texture
  118069. * @param texture defines the texture to check against the material
  118070. * @returns a boolean specifying if the material uses the texture
  118071. */
  118072. hasTexture(texture: BaseTexture): boolean;
  118073. /**
  118074. * Disposes the material
  118075. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  118076. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  118077. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  118078. */
  118079. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  118080. /** Creates the node editor window. */
  118081. private _createNodeEditor;
  118082. /**
  118083. * Launch the node material editor
  118084. * @param config Define the configuration of the editor
  118085. * @return a promise fulfilled when the node editor is visible
  118086. */
  118087. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  118088. /**
  118089. * Clear the current material
  118090. */
  118091. clear(): void;
  118092. /**
  118093. * Clear the current material and set it to a default state
  118094. */
  118095. setToDefault(): void;
  118096. /**
  118097. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  118098. * @param url defines the url to load from
  118099. * @returns a promise that will fullfil when the material is fully loaded
  118100. */
  118101. loadAsync(url: string): Promise<unknown>;
  118102. private _gatherBlocks;
  118103. /**
  118104. * Generate a string containing the code declaration required to create an equivalent of this material
  118105. * @returns a string
  118106. */
  118107. generateCode(): string;
  118108. /**
  118109. * Serializes this material in a JSON representation
  118110. * @returns the serialized material object
  118111. */
  118112. serialize(): any;
  118113. private _restoreConnections;
  118114. /**
  118115. * Clear the current graph and load a new one from a serialization object
  118116. * @param source defines the JSON representation of the material
  118117. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  118118. */
  118119. loadFromSerialization(source: any, rootUrl?: string): void;
  118120. /**
  118121. * Creates a node material from parsed material data
  118122. * @param source defines the JSON representation of the material
  118123. * @param scene defines the hosting scene
  118124. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  118125. * @returns a new node material
  118126. */
  118127. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  118128. /**
  118129. * Creates a new node material set to default basic configuration
  118130. * @param name defines the name of the material
  118131. * @param scene defines the hosting scene
  118132. * @returns a new NodeMaterial
  118133. */
  118134. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  118135. }
  118136. }
  118137. declare module BABYLON {
  118138. /**
  118139. * Block used to read a texture from a sampler
  118140. */
  118141. export class TextureBlock extends NodeMaterialBlock {
  118142. private _defineName;
  118143. private _samplerName;
  118144. private _transformedUVName;
  118145. private _textureTransformName;
  118146. private _textureInfoName;
  118147. private _mainUVName;
  118148. private _mainUVDefineName;
  118149. /**
  118150. * Gets or sets the texture associated with the node
  118151. */
  118152. texture: Nullable<Texture>;
  118153. /**
  118154. * Create a new TextureBlock
  118155. * @param name defines the block name
  118156. */
  118157. constructor(name: string);
  118158. /**
  118159. * Gets the current class name
  118160. * @returns the class name
  118161. */
  118162. getClassName(): string;
  118163. /**
  118164. * Gets the uv input component
  118165. */
  118166. readonly uv: NodeMaterialConnectionPoint;
  118167. /**
  118168. * Gets the rgba output component
  118169. */
  118170. readonly rgba: NodeMaterialConnectionPoint;
  118171. /**
  118172. * Gets the rgb output component
  118173. */
  118174. readonly rgb: NodeMaterialConnectionPoint;
  118175. /**
  118176. * Gets the r output component
  118177. */
  118178. readonly r: NodeMaterialConnectionPoint;
  118179. /**
  118180. * Gets the g output component
  118181. */
  118182. readonly g: NodeMaterialConnectionPoint;
  118183. /**
  118184. * Gets the b output component
  118185. */
  118186. readonly b: NodeMaterialConnectionPoint;
  118187. /**
  118188. * Gets the a output component
  118189. */
  118190. readonly a: NodeMaterialConnectionPoint;
  118191. readonly target: NodeMaterialBlockTargets;
  118192. autoConfigure(material: NodeMaterial): void;
  118193. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  118194. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  118195. isReady(): boolean;
  118196. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  118197. private readonly _isMixed;
  118198. private _injectVertexCode;
  118199. private _writeOutput;
  118200. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  118201. protected _dumpPropertiesCode(): string;
  118202. serialize(): any;
  118203. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  118204. }
  118205. }
  118206. declare module BABYLON {
  118207. /**
  118208. * Class used to store shared data between 2 NodeMaterialBuildState
  118209. */
  118210. export class NodeMaterialBuildStateSharedData {
  118211. /**
  118212. * Gets the list of emitted varyings
  118213. */
  118214. temps: string[];
  118215. /**
  118216. * Gets the list of emitted varyings
  118217. */
  118218. varyings: string[];
  118219. /**
  118220. * Gets the varying declaration string
  118221. */
  118222. varyingDeclaration: string;
  118223. /**
  118224. * Input blocks
  118225. */
  118226. inputBlocks: InputBlock[];
  118227. /**
  118228. * Input blocks
  118229. */
  118230. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  118231. /**
  118232. * Bindable blocks (Blocks that need to set data to the effect)
  118233. */
  118234. bindableBlocks: NodeMaterialBlock[];
  118235. /**
  118236. * List of blocks that can provide a compilation fallback
  118237. */
  118238. blocksWithFallbacks: NodeMaterialBlock[];
  118239. /**
  118240. * List of blocks that can provide a define update
  118241. */
  118242. blocksWithDefines: NodeMaterialBlock[];
  118243. /**
  118244. * List of blocks that can provide a repeatable content
  118245. */
  118246. repeatableContentBlocks: NodeMaterialBlock[];
  118247. /**
  118248. * List of blocks that can provide a dynamic list of uniforms
  118249. */
  118250. dynamicUniformBlocks: NodeMaterialBlock[];
  118251. /**
  118252. * List of blocks that can block the isReady function for the material
  118253. */
  118254. blockingBlocks: NodeMaterialBlock[];
  118255. /**
  118256. * Gets the list of animated inputs
  118257. */
  118258. animatedInputs: InputBlock[];
  118259. /**
  118260. * Build Id used to avoid multiple recompilations
  118261. */
  118262. buildId: number;
  118263. /** List of emitted variables */
  118264. variableNames: {
  118265. [key: string]: number;
  118266. };
  118267. /** List of emitted defines */
  118268. defineNames: {
  118269. [key: string]: number;
  118270. };
  118271. /** Should emit comments? */
  118272. emitComments: boolean;
  118273. /** Emit build activity */
  118274. verbose: boolean;
  118275. /**
  118276. * Gets the compilation hints emitted at compilation time
  118277. */
  118278. hints: {
  118279. needWorldViewMatrix: boolean;
  118280. needWorldViewProjectionMatrix: boolean;
  118281. needAlphaBlending: boolean;
  118282. needAlphaTesting: boolean;
  118283. };
  118284. /**
  118285. * List of compilation checks
  118286. */
  118287. checks: {
  118288. emitVertex: boolean;
  118289. emitFragment: boolean;
  118290. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  118291. };
  118292. /** Creates a new shared data */
  118293. constructor();
  118294. /**
  118295. * Emits console errors and exceptions if there is a failing check
  118296. */
  118297. emitErrors(): void;
  118298. }
  118299. }
  118300. declare module BABYLON {
  118301. /**
  118302. * Class used to store node based material build state
  118303. */
  118304. export class NodeMaterialBuildState {
  118305. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  118306. supportUniformBuffers: boolean;
  118307. /**
  118308. * Gets the list of emitted attributes
  118309. */
  118310. attributes: string[];
  118311. /**
  118312. * Gets the list of emitted uniforms
  118313. */
  118314. uniforms: string[];
  118315. /**
  118316. * Gets the list of emitted uniform buffers
  118317. */
  118318. uniformBuffers: string[];
  118319. /**
  118320. * Gets the list of emitted samplers
  118321. */
  118322. samplers: string[];
  118323. /**
  118324. * Gets the list of emitted functions
  118325. */
  118326. functions: {
  118327. [key: string]: string;
  118328. };
  118329. /**
  118330. * Gets the list of emitted extensions
  118331. */
  118332. extensions: {
  118333. [key: string]: string;
  118334. };
  118335. /**
  118336. * Gets the target of the compilation state
  118337. */
  118338. target: NodeMaterialBlockTargets;
  118339. /**
  118340. * Gets the list of emitted counters
  118341. */
  118342. counters: {
  118343. [key: string]: number;
  118344. };
  118345. /**
  118346. * Shared data between multiple NodeMaterialBuildState instances
  118347. */
  118348. sharedData: NodeMaterialBuildStateSharedData;
  118349. /** @hidden */
  118350. _vertexState: NodeMaterialBuildState;
  118351. /** @hidden */
  118352. _attributeDeclaration: string;
  118353. /** @hidden */
  118354. _uniformDeclaration: string;
  118355. /** @hidden */
  118356. _samplerDeclaration: string;
  118357. /** @hidden */
  118358. _varyingTransfer: string;
  118359. private _repeatableContentAnchorIndex;
  118360. /** @hidden */
  118361. _builtCompilationString: string;
  118362. /**
  118363. * Gets the emitted compilation strings
  118364. */
  118365. compilationString: string;
  118366. /**
  118367. * Finalize the compilation strings
  118368. * @param state defines the current compilation state
  118369. */
  118370. finalize(state: NodeMaterialBuildState): void;
  118371. /** @hidden */
  118372. readonly _repeatableContentAnchor: string;
  118373. /** @hidden */
  118374. _getFreeVariableName(prefix: string): string;
  118375. /** @hidden */
  118376. _getFreeDefineName(prefix: string): string;
  118377. /** @hidden */
  118378. _excludeVariableName(name: string): void;
  118379. /** @hidden */
  118380. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  118381. /** @hidden */
  118382. _emitExtension(name: string, extension: string): void;
  118383. /** @hidden */
  118384. _emitFunction(name: string, code: string, comments: string): void;
  118385. /** @hidden */
  118386. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  118387. replaceStrings?: {
  118388. search: RegExp;
  118389. replace: string;
  118390. }[];
  118391. repeatKey?: string;
  118392. }): string;
  118393. /** @hidden */
  118394. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  118395. repeatKey?: string;
  118396. removeAttributes?: boolean;
  118397. removeUniforms?: boolean;
  118398. removeVaryings?: boolean;
  118399. removeIfDef?: boolean;
  118400. replaceStrings?: {
  118401. search: RegExp;
  118402. replace: string;
  118403. }[];
  118404. }, storeKey?: string): void;
  118405. /** @hidden */
  118406. _registerTempVariable(name: string): boolean;
  118407. /** @hidden */
  118408. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  118409. /** @hidden */
  118410. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  118411. }
  118412. }
  118413. declare module BABYLON {
  118414. /**
  118415. * Defines a block that can be used inside a node based material
  118416. */
  118417. export class NodeMaterialBlock {
  118418. private _buildId;
  118419. private _buildTarget;
  118420. private _target;
  118421. private _isFinalMerger;
  118422. private _isInput;
  118423. /** @hidden */
  118424. _codeVariableName: string;
  118425. /** @hidden */
  118426. _inputs: NodeMaterialConnectionPoint[];
  118427. /** @hidden */
  118428. _outputs: NodeMaterialConnectionPoint[];
  118429. /** @hidden */
  118430. _preparationId: number;
  118431. /**
  118432. * Gets or sets the name of the block
  118433. */
  118434. name: string;
  118435. /**
  118436. * Gets or sets the unique id of the node
  118437. */
  118438. uniqueId: number;
  118439. /**
  118440. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  118441. */
  118442. readonly isFinalMerger: boolean;
  118443. /**
  118444. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  118445. */
  118446. readonly isInput: boolean;
  118447. /**
  118448. * Gets or sets the build Id
  118449. */
  118450. buildId: number;
  118451. /**
  118452. * Gets or sets the target of the block
  118453. */
  118454. target: NodeMaterialBlockTargets;
  118455. /**
  118456. * Gets the list of input points
  118457. */
  118458. readonly inputs: NodeMaterialConnectionPoint[];
  118459. /** Gets the list of output points */
  118460. readonly outputs: NodeMaterialConnectionPoint[];
  118461. /**
  118462. * Find an input by its name
  118463. * @param name defines the name of the input to look for
  118464. * @returns the input or null if not found
  118465. */
  118466. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  118467. /**
  118468. * Find an output by its name
  118469. * @param name defines the name of the outputto look for
  118470. * @returns the output or null if not found
  118471. */
  118472. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  118473. /**
  118474. * Creates a new NodeMaterialBlock
  118475. * @param name defines the block name
  118476. * @param target defines the target of that block (Vertex by default)
  118477. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  118478. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  118479. */
  118480. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  118481. /**
  118482. * Initialize the block and prepare the context for build
  118483. * @param state defines the state that will be used for the build
  118484. */
  118485. initialize(state: NodeMaterialBuildState): void;
  118486. /**
  118487. * Bind data to effect. Will only be called for blocks with isBindable === true
  118488. * @param effect defines the effect to bind data to
  118489. * @param nodeMaterial defines the hosting NodeMaterial
  118490. * @param mesh defines the mesh that will be rendered
  118491. */
  118492. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  118493. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  118494. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  118495. protected _writeFloat(value: number): string;
  118496. /**
  118497. * Gets the current class name e.g. "NodeMaterialBlock"
  118498. * @returns the class name
  118499. */
  118500. getClassName(): string;
  118501. /**
  118502. * Register a new input. Must be called inside a block constructor
  118503. * @param name defines the connection point name
  118504. * @param type defines the connection point type
  118505. * @param isOptional defines a boolean indicating that this input can be omitted
  118506. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  118507. * @returns the current block
  118508. */
  118509. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  118510. /**
  118511. * Register a new output. Must be called inside a block constructor
  118512. * @param name defines the connection point name
  118513. * @param type defines the connection point type
  118514. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  118515. * @returns the current block
  118516. */
  118517. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  118518. /**
  118519. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  118520. * @param forOutput defines an optional connection point to check compatibility with
  118521. * @returns the first available input or null
  118522. */
  118523. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  118524. /**
  118525. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  118526. * @param forBlock defines an optional block to check compatibility with
  118527. * @returns the first available input or null
  118528. */
  118529. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  118530. /**
  118531. * Gets the sibling of the given output
  118532. * @param current defines the current output
  118533. * @returns the next output in the list or null
  118534. */
  118535. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  118536. /**
  118537. * Connect current block with another block
  118538. * @param other defines the block to connect with
  118539. * @param options define the various options to help pick the right connections
  118540. * @returns the current block
  118541. */
  118542. connectTo(other: NodeMaterialBlock, options?: {
  118543. input?: string;
  118544. output?: string;
  118545. outputSwizzle?: string;
  118546. }): this | undefined;
  118547. protected _buildBlock(state: NodeMaterialBuildState): void;
  118548. /**
  118549. * Add uniforms, samplers and uniform buffers at compilation time
  118550. * @param state defines the state to update
  118551. * @param nodeMaterial defines the node material requesting the update
  118552. * @param defines defines the material defines to update
  118553. */
  118554. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  118555. /**
  118556. * Add potential fallbacks if shader compilation fails
  118557. * @param mesh defines the mesh to be rendered
  118558. * @param fallbacks defines the current prioritized list of fallbacks
  118559. */
  118560. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  118561. /**
  118562. * Update defines for shader compilation
  118563. * @param mesh defines the mesh to be rendered
  118564. * @param nodeMaterial defines the node material requesting the update
  118565. * @param defines defines the material defines to update
  118566. * @param useInstances specifies that instances should be used
  118567. */
  118568. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  118569. /**
  118570. * Initialize defines for shader compilation
  118571. * @param mesh defines the mesh to be rendered
  118572. * @param nodeMaterial defines the node material requesting the update
  118573. * @param defines defines the material defines to be prepared
  118574. * @param useInstances specifies that instances should be used
  118575. */
  118576. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  118577. /**
  118578. * Lets the block try to connect some inputs automatically
  118579. * @param material defines the hosting NodeMaterial
  118580. */
  118581. autoConfigure(material: NodeMaterial): void;
  118582. /**
  118583. * Function called when a block is declared as repeatable content generator
  118584. * @param vertexShaderState defines the current compilation state for the vertex shader
  118585. * @param fragmentShaderState defines the current compilation state for the fragment shader
  118586. * @param mesh defines the mesh to be rendered
  118587. * @param defines defines the material defines to update
  118588. */
  118589. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  118590. /**
  118591. * Checks if the block is ready
  118592. * @param mesh defines the mesh to be rendered
  118593. * @param nodeMaterial defines the node material requesting the update
  118594. * @param defines defines the material defines to update
  118595. * @param useInstances specifies that instances should be used
  118596. * @returns true if the block is ready
  118597. */
  118598. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  118599. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  118600. private _processBuild;
  118601. /**
  118602. * Compile the current node and generate the shader code
  118603. * @param state defines the current compilation state (uniforms, samplers, current string)
  118604. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  118605. * @returns true if already built
  118606. */
  118607. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  118608. protected _inputRename(name: string): string;
  118609. protected _outputRename(name: string): string;
  118610. protected _dumpPropertiesCode(): string;
  118611. /** @hidden */
  118612. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  118613. /**
  118614. * Clone the current block to a new identical block
  118615. * @param scene defines the hosting scene
  118616. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  118617. * @returns a copy of the current block
  118618. */
  118619. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  118620. /**
  118621. * Serializes this block in a JSON representation
  118622. * @returns the serialized block object
  118623. */
  118624. serialize(): any;
  118625. /** @hidden */
  118626. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  118627. }
  118628. }
  118629. declare module BABYLON {
  118630. /**
  118631. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  118632. */
  118633. export enum NodeMaterialBlockConnectionPointMode {
  118634. /** Value is an uniform */
  118635. Uniform = 0,
  118636. /** Value is a mesh attribute */
  118637. Attribute = 1,
  118638. /** Value is a varying between vertex and fragment shaders */
  118639. Varying = 2,
  118640. /** Mode is undefined */
  118641. Undefined = 3
  118642. }
  118643. }
  118644. declare module BABYLON {
  118645. /**
  118646. * Enum defining the type of animations supported by InputBlock
  118647. */
  118648. export enum AnimatedInputBlockTypes {
  118649. /** No animation */
  118650. None = 0,
  118651. /** Time based animation. Will only work for floats */
  118652. Time = 1
  118653. }
  118654. }
  118655. declare module BABYLON {
  118656. /**
  118657. * Block used to expose an input value
  118658. */
  118659. export class InputBlock extends NodeMaterialBlock {
  118660. private _mode;
  118661. private _associatedVariableName;
  118662. private _storedValue;
  118663. private _valueCallback;
  118664. private _type;
  118665. private _animationType;
  118666. /** Gets or set a value used to limit the range of float values */
  118667. min: number;
  118668. /** Gets or set a value used to limit the range of float values */
  118669. max: number;
  118670. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  118671. matrixMode: number;
  118672. /** @hidden */
  118673. _systemValue: Nullable<NodeMaterialSystemValues>;
  118674. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  118675. visibleInInspector: boolean;
  118676. /**
  118677. * Gets or sets the connection point type (default is float)
  118678. */
  118679. readonly type: NodeMaterialBlockConnectionPointTypes;
  118680. /**
  118681. * Creates a new InputBlock
  118682. * @param name defines the block name
  118683. * @param target defines the target of that block (Vertex by default)
  118684. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  118685. */
  118686. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  118687. /**
  118688. * Gets the output component
  118689. */
  118690. readonly output: NodeMaterialConnectionPoint;
  118691. /**
  118692. * Set the source of this connection point to a vertex attribute
  118693. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  118694. * @returns the current connection point
  118695. */
  118696. setAsAttribute(attributeName?: string): InputBlock;
  118697. /**
  118698. * Set the source of this connection point to a system value
  118699. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  118700. * @returns the current connection point
  118701. */
  118702. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  118703. /**
  118704. * Gets or sets the value of that point.
  118705. * Please note that this value will be ignored if valueCallback is defined
  118706. */
  118707. value: any;
  118708. /**
  118709. * Gets or sets a callback used to get the value of that point.
  118710. * Please note that setting this value will force the connection point to ignore the value property
  118711. */
  118712. valueCallback: () => any;
  118713. /**
  118714. * Gets or sets the associated variable name in the shader
  118715. */
  118716. associatedVariableName: string;
  118717. /** Gets or sets the type of animation applied to the input */
  118718. animationType: AnimatedInputBlockTypes;
  118719. /**
  118720. * Gets a boolean indicating that this connection point not defined yet
  118721. */
  118722. readonly isUndefined: boolean;
  118723. /**
  118724. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  118725. * In this case the connection point name must be the name of the uniform to use.
  118726. * Can only be set on inputs
  118727. */
  118728. isUniform: boolean;
  118729. /**
  118730. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  118731. * In this case the connection point name must be the name of the attribute to use
  118732. * Can only be set on inputs
  118733. */
  118734. isAttribute: boolean;
  118735. /**
  118736. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  118737. * Can only be set on exit points
  118738. */
  118739. isVarying: boolean;
  118740. /**
  118741. * Gets a boolean indicating that the current connection point is a system value
  118742. */
  118743. readonly isSystemValue: boolean;
  118744. /**
  118745. * Gets or sets the current well known value or null if not defined as a system value
  118746. */
  118747. systemValue: Nullable<NodeMaterialSystemValues>;
  118748. /**
  118749. * Gets the current class name
  118750. * @returns the class name
  118751. */
  118752. getClassName(): string;
  118753. /**
  118754. * Animate the input if animationType !== None
  118755. * @param scene defines the rendering scene
  118756. */
  118757. animate(scene: Scene): void;
  118758. private _emitDefine;
  118759. initialize(state: NodeMaterialBuildState): void;
  118760. /**
  118761. * Set the input block to its default value (based on its type)
  118762. */
  118763. setDefaultValue(): void;
  118764. protected _dumpPropertiesCode(): string;
  118765. private _emit;
  118766. /** @hidden */
  118767. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  118768. /** @hidden */
  118769. _transmit(effect: Effect, scene: Scene): void;
  118770. protected _buildBlock(state: NodeMaterialBuildState): void;
  118771. serialize(): any;
  118772. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  118773. }
  118774. }
  118775. declare module BABYLON {
  118776. /**
  118777. * Defines a connection point for a block
  118778. */
  118779. export class NodeMaterialConnectionPoint {
  118780. /** @hidden */
  118781. _ownerBlock: NodeMaterialBlock;
  118782. /** @hidden */
  118783. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  118784. private _endpoints;
  118785. private _associatedVariableName;
  118786. /** @hidden */
  118787. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  118788. /** @hidden */
  118789. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  118790. private _type;
  118791. /** @hidden */
  118792. _enforceAssociatedVariableName: boolean;
  118793. /**
  118794. * Gets or sets the additional types supported byt this connection point
  118795. */
  118796. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  118797. /**
  118798. * Gets or sets the associated variable name in the shader
  118799. */
  118800. associatedVariableName: string;
  118801. /**
  118802. * Gets or sets the connection point type (default is float)
  118803. */
  118804. type: NodeMaterialBlockConnectionPointTypes;
  118805. /**
  118806. * Gets or sets the connection point name
  118807. */
  118808. name: string;
  118809. /**
  118810. * Gets or sets a boolean indicating that this connection point can be omitted
  118811. */
  118812. isOptional: boolean;
  118813. /**
  118814. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  118815. */
  118816. define: string;
  118817. /** Gets or sets the target of that connection point */
  118818. target: NodeMaterialBlockTargets;
  118819. /**
  118820. * Gets a boolean indicating that the current point is connected
  118821. */
  118822. readonly isConnected: boolean;
  118823. /**
  118824. * Gets a boolean indicating that the current point is connected to an input block
  118825. */
  118826. readonly isConnectedToInputBlock: boolean;
  118827. /**
  118828. * Gets a the connected input block (if any)
  118829. */
  118830. readonly connectInputBlock: Nullable<InputBlock>;
  118831. /** Get the other side of the connection (if any) */
  118832. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  118833. /** Get the block that owns this connection point */
  118834. readonly ownerBlock: NodeMaterialBlock;
  118835. /** Get the block connected on the other side of this connection (if any) */
  118836. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  118837. /** Get the block connected on the endpoints of this connection (if any) */
  118838. readonly connectedBlocks: Array<NodeMaterialBlock>;
  118839. /** Gets the list of connected endpoints */
  118840. readonly endpoints: NodeMaterialConnectionPoint[];
  118841. /** Gets a boolean indicating if that output point is connected to at least one input */
  118842. readonly hasEndpoints: boolean;
  118843. /**
  118844. * Creates a new connection point
  118845. * @param name defines the connection point name
  118846. * @param ownerBlock defines the block hosting this connection point
  118847. */
  118848. constructor(name: string, ownerBlock: NodeMaterialBlock);
  118849. /**
  118850. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  118851. * @returns the class name
  118852. */
  118853. getClassName(): string;
  118854. /**
  118855. * Gets an boolean indicating if the current point can be connected to another point
  118856. * @param connectionPoint defines the other connection point
  118857. * @returns true if the connection is possible
  118858. */
  118859. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  118860. /**
  118861. * Connect this point to another connection point
  118862. * @param connectionPoint defines the other connection point
  118863. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  118864. * @returns the current connection point
  118865. */
  118866. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  118867. /**
  118868. * Disconnect this point from one of his endpoint
  118869. * @param endpoint defines the other connection point
  118870. * @returns the current connection point
  118871. */
  118872. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  118873. /**
  118874. * Serializes this point in a JSON representation
  118875. * @returns the serialized point object
  118876. */
  118877. serialize(): any;
  118878. }
  118879. }
  118880. declare module BABYLON {
  118881. /**
  118882. * Block used to add support for vertex skinning (bones)
  118883. */
  118884. export class BonesBlock extends NodeMaterialBlock {
  118885. /**
  118886. * Creates a new BonesBlock
  118887. * @param name defines the block name
  118888. */
  118889. constructor(name: string);
  118890. /**
  118891. * Initialize the block and prepare the context for build
  118892. * @param state defines the state that will be used for the build
  118893. */
  118894. initialize(state: NodeMaterialBuildState): void;
  118895. /**
  118896. * Gets the current class name
  118897. * @returns the class name
  118898. */
  118899. getClassName(): string;
  118900. /**
  118901. * Gets the matrix indices input component
  118902. */
  118903. readonly matricesIndices: NodeMaterialConnectionPoint;
  118904. /**
  118905. * Gets the matrix weights input component
  118906. */
  118907. readonly matricesWeights: NodeMaterialConnectionPoint;
  118908. /**
  118909. * Gets the extra matrix indices input component
  118910. */
  118911. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  118912. /**
  118913. * Gets the extra matrix weights input component
  118914. */
  118915. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  118916. /**
  118917. * Gets the world input component
  118918. */
  118919. readonly world: NodeMaterialConnectionPoint;
  118920. /**
  118921. * Gets the output component
  118922. */
  118923. readonly output: NodeMaterialConnectionPoint;
  118924. autoConfigure(material: NodeMaterial): void;
  118925. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  118926. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  118927. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  118928. protected _buildBlock(state: NodeMaterialBuildState): this;
  118929. }
  118930. }
  118931. declare module BABYLON {
  118932. /**
  118933. * Block used to add support for instances
  118934. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  118935. */
  118936. export class InstancesBlock extends NodeMaterialBlock {
  118937. /**
  118938. * Creates a new InstancesBlock
  118939. * @param name defines the block name
  118940. */
  118941. constructor(name: string);
  118942. /**
  118943. * Gets the current class name
  118944. * @returns the class name
  118945. */
  118946. getClassName(): string;
  118947. /**
  118948. * Gets the first world row input component
  118949. */
  118950. readonly world0: NodeMaterialConnectionPoint;
  118951. /**
  118952. * Gets the second world row input component
  118953. */
  118954. readonly world1: NodeMaterialConnectionPoint;
  118955. /**
  118956. * Gets the third world row input component
  118957. */
  118958. readonly world2: NodeMaterialConnectionPoint;
  118959. /**
  118960. * Gets the forth world row input component
  118961. */
  118962. readonly world3: NodeMaterialConnectionPoint;
  118963. /**
  118964. * Gets the world input component
  118965. */
  118966. readonly world: NodeMaterialConnectionPoint;
  118967. /**
  118968. * Gets the output component
  118969. */
  118970. readonly output: NodeMaterialConnectionPoint;
  118971. autoConfigure(material: NodeMaterial): void;
  118972. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  118973. protected _buildBlock(state: NodeMaterialBuildState): this;
  118974. }
  118975. }
  118976. declare module BABYLON {
  118977. /**
  118978. * Block used to add morph targets support to vertex shader
  118979. */
  118980. export class MorphTargetsBlock extends NodeMaterialBlock {
  118981. private _repeatableContentAnchor;
  118982. private _repeatebleContentGenerated;
  118983. /**
  118984. * Create a new MorphTargetsBlock
  118985. * @param name defines the block name
  118986. */
  118987. constructor(name: string);
  118988. /**
  118989. * Gets the current class name
  118990. * @returns the class name
  118991. */
  118992. getClassName(): string;
  118993. /**
  118994. * Gets the position input component
  118995. */
  118996. readonly position: NodeMaterialConnectionPoint;
  118997. /**
  118998. * Gets the normal input component
  118999. */
  119000. readonly normal: NodeMaterialConnectionPoint;
  119001. /**
  119002. * Gets the tangent input component
  119003. */
  119004. readonly tangent: NodeMaterialConnectionPoint;
  119005. /**
  119006. * Gets the tangent input component
  119007. */
  119008. readonly uv: NodeMaterialConnectionPoint;
  119009. /**
  119010. * Gets the position output component
  119011. */
  119012. readonly positionOutput: NodeMaterialConnectionPoint;
  119013. /**
  119014. * Gets the normal output component
  119015. */
  119016. readonly normalOutput: NodeMaterialConnectionPoint;
  119017. /**
  119018. * Gets the tangent output component
  119019. */
  119020. readonly tangentOutput: NodeMaterialConnectionPoint;
  119021. /**
  119022. * Gets the tangent output component
  119023. */
  119024. readonly uvOutput: NodeMaterialConnectionPoint;
  119025. initialize(state: NodeMaterialBuildState): void;
  119026. autoConfigure(material: NodeMaterial): void;
  119027. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119028. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119029. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  119030. protected _buildBlock(state: NodeMaterialBuildState): this;
  119031. }
  119032. }
  119033. declare module BABYLON {
  119034. /**
  119035. * Block used to get data information from a light
  119036. */
  119037. export class LightInformationBlock extends NodeMaterialBlock {
  119038. private _lightDataDefineName;
  119039. private _lightColorDefineName;
  119040. /**
  119041. * Gets or sets the light associated with this block
  119042. */
  119043. light: Nullable<Light>;
  119044. /**
  119045. * Creates a new LightInformationBlock
  119046. * @param name defines the block name
  119047. */
  119048. constructor(name: string);
  119049. /**
  119050. * Gets the current class name
  119051. * @returns the class name
  119052. */
  119053. getClassName(): string;
  119054. /**
  119055. * Gets the world position input component
  119056. */
  119057. readonly worldPosition: NodeMaterialConnectionPoint;
  119058. /**
  119059. * Gets the direction output component
  119060. */
  119061. readonly direction: NodeMaterialConnectionPoint;
  119062. /**
  119063. * Gets the direction output component
  119064. */
  119065. readonly color: NodeMaterialConnectionPoint;
  119066. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119067. protected _buildBlock(state: NodeMaterialBuildState): this;
  119068. serialize(): any;
  119069. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119070. }
  119071. }
  119072. declare module BABYLON {
  119073. /**
  119074. * Block used to add an alpha test in the fragment shader
  119075. */
  119076. export class AlphaTestBlock extends NodeMaterialBlock {
  119077. /**
  119078. * Gets or sets the alpha value where alpha testing happens
  119079. */
  119080. alphaCutOff: number;
  119081. /**
  119082. * Create a new AlphaTestBlock
  119083. * @param name defines the block name
  119084. */
  119085. constructor(name: string);
  119086. /**
  119087. * Gets the current class name
  119088. * @returns the class name
  119089. */
  119090. getClassName(): string;
  119091. /**
  119092. * Gets the color input component
  119093. */
  119094. readonly color: NodeMaterialConnectionPoint;
  119095. /**
  119096. * Gets the alpha input component
  119097. */
  119098. readonly alpha: NodeMaterialConnectionPoint;
  119099. protected _buildBlock(state: NodeMaterialBuildState): this;
  119100. protected _dumpPropertiesCode(): string;
  119101. serialize(): any;
  119102. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119103. }
  119104. }
  119105. declare module BABYLON {
  119106. /**
  119107. * Block used to add image processing support to fragment shader
  119108. */
  119109. export class ImageProcessingBlock extends NodeMaterialBlock {
  119110. /**
  119111. * Create a new ImageProcessingBlock
  119112. * @param name defines the block name
  119113. */
  119114. constructor(name: string);
  119115. /**
  119116. * Gets the current class name
  119117. * @returns the class name
  119118. */
  119119. getClassName(): string;
  119120. /**
  119121. * Gets the color input component
  119122. */
  119123. readonly color: NodeMaterialConnectionPoint;
  119124. /**
  119125. * Gets the output component
  119126. */
  119127. readonly output: NodeMaterialConnectionPoint;
  119128. /**
  119129. * Initialize the block and prepare the context for build
  119130. * @param state defines the state that will be used for the build
  119131. */
  119132. initialize(state: NodeMaterialBuildState): void;
  119133. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  119134. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119135. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119136. protected _buildBlock(state: NodeMaterialBuildState): this;
  119137. }
  119138. }
  119139. declare module BABYLON {
  119140. /**
  119141. * Block used to pertub normals based on a normal map
  119142. */
  119143. export class PerturbNormalBlock extends NodeMaterialBlock {
  119144. private _tangentSpaceParameterName;
  119145. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  119146. invertX: boolean;
  119147. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  119148. invertY: boolean;
  119149. /**
  119150. * Create a new PerturbNormalBlock
  119151. * @param name defines the block name
  119152. */
  119153. constructor(name: string);
  119154. /**
  119155. * Gets the current class name
  119156. * @returns the class name
  119157. */
  119158. getClassName(): string;
  119159. /**
  119160. * Gets the world position input component
  119161. */
  119162. readonly worldPosition: NodeMaterialConnectionPoint;
  119163. /**
  119164. * Gets the world normal input component
  119165. */
  119166. readonly worldNormal: NodeMaterialConnectionPoint;
  119167. /**
  119168. * Gets the uv input component
  119169. */
  119170. readonly uv: NodeMaterialConnectionPoint;
  119171. /**
  119172. * Gets the normal map color input component
  119173. */
  119174. readonly normalMapColor: NodeMaterialConnectionPoint;
  119175. /**
  119176. * Gets the strength input component
  119177. */
  119178. readonly strength: NodeMaterialConnectionPoint;
  119179. /**
  119180. * Gets the output component
  119181. */
  119182. readonly output: NodeMaterialConnectionPoint;
  119183. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119184. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119185. autoConfigure(material: NodeMaterial): void;
  119186. protected _buildBlock(state: NodeMaterialBuildState): this;
  119187. protected _dumpPropertiesCode(): string;
  119188. serialize(): any;
  119189. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119190. }
  119191. }
  119192. declare module BABYLON {
  119193. /**
  119194. * Block used to add support for scene fog
  119195. */
  119196. export class FogBlock extends NodeMaterialBlock {
  119197. private _fogDistanceName;
  119198. private _fogParameters;
  119199. /**
  119200. * Create a new FogBlock
  119201. * @param name defines the block name
  119202. */
  119203. constructor(name: string);
  119204. /**
  119205. * Gets the current class name
  119206. * @returns the class name
  119207. */
  119208. getClassName(): string;
  119209. /**
  119210. * Gets the world position input component
  119211. */
  119212. readonly worldPosition: NodeMaterialConnectionPoint;
  119213. /**
  119214. * Gets the view input component
  119215. */
  119216. readonly view: NodeMaterialConnectionPoint;
  119217. /**
  119218. * Gets the color input component
  119219. */
  119220. readonly input: NodeMaterialConnectionPoint;
  119221. /**
  119222. * Gets the fog color input component
  119223. */
  119224. readonly fogColor: NodeMaterialConnectionPoint;
  119225. /**
  119226. * Gets the output component
  119227. */
  119228. readonly output: NodeMaterialConnectionPoint;
  119229. autoConfigure(material: NodeMaterial): void;
  119230. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119231. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119232. protected _buildBlock(state: NodeMaterialBuildState): this;
  119233. }
  119234. }
  119235. declare module BABYLON {
  119236. /**
  119237. * Block used to add light in the fragment shader
  119238. */
  119239. export class LightBlock extends NodeMaterialBlock {
  119240. private _lightId;
  119241. /**
  119242. * Gets or sets the light associated with this block
  119243. */
  119244. light: Nullable<Light>;
  119245. /**
  119246. * Create a new LightBlock
  119247. * @param name defines the block name
  119248. */
  119249. constructor(name: string);
  119250. /**
  119251. * Gets the current class name
  119252. * @returns the class name
  119253. */
  119254. getClassName(): string;
  119255. /**
  119256. * Gets the world position input component
  119257. */
  119258. readonly worldPosition: NodeMaterialConnectionPoint;
  119259. /**
  119260. * Gets the world normal input component
  119261. */
  119262. readonly worldNormal: NodeMaterialConnectionPoint;
  119263. /**
  119264. * Gets the camera (or eye) position component
  119265. */
  119266. readonly cameraPosition: NodeMaterialConnectionPoint;
  119267. /**
  119268. * Gets the diffuse output component
  119269. */
  119270. readonly diffuseOutput: NodeMaterialConnectionPoint;
  119271. /**
  119272. * Gets the specular output component
  119273. */
  119274. readonly specularOutput: NodeMaterialConnectionPoint;
  119275. autoConfigure(material: NodeMaterial): void;
  119276. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119277. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  119278. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  119279. private _injectVertexCode;
  119280. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  119281. serialize(): any;
  119282. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119283. }
  119284. }
  119285. declare module BABYLON {
  119286. /**
  119287. * Block used to multiply 2 values
  119288. */
  119289. export class MultiplyBlock extends NodeMaterialBlock {
  119290. /**
  119291. * Creates a new MultiplyBlock
  119292. * @param name defines the block name
  119293. */
  119294. constructor(name: string);
  119295. /**
  119296. * Gets the current class name
  119297. * @returns the class name
  119298. */
  119299. getClassName(): string;
  119300. /**
  119301. * Gets the left operand input component
  119302. */
  119303. readonly left: NodeMaterialConnectionPoint;
  119304. /**
  119305. * Gets the right operand input component
  119306. */
  119307. readonly right: NodeMaterialConnectionPoint;
  119308. /**
  119309. * Gets the output component
  119310. */
  119311. readonly output: NodeMaterialConnectionPoint;
  119312. protected _buildBlock(state: NodeMaterialBuildState): this;
  119313. }
  119314. }
  119315. declare module BABYLON {
  119316. /**
  119317. * Block used to add 2 vectors
  119318. */
  119319. export class AddBlock extends NodeMaterialBlock {
  119320. /**
  119321. * Creates a new AddBlock
  119322. * @param name defines the block name
  119323. */
  119324. constructor(name: string);
  119325. /**
  119326. * Gets the current class name
  119327. * @returns the class name
  119328. */
  119329. getClassName(): string;
  119330. /**
  119331. * Gets the left operand input component
  119332. */
  119333. readonly left: NodeMaterialConnectionPoint;
  119334. /**
  119335. * Gets the right operand input component
  119336. */
  119337. readonly right: NodeMaterialConnectionPoint;
  119338. /**
  119339. * Gets the output component
  119340. */
  119341. readonly output: NodeMaterialConnectionPoint;
  119342. protected _buildBlock(state: NodeMaterialBuildState): this;
  119343. }
  119344. }
  119345. declare module BABYLON {
  119346. /**
  119347. * Block used to scale a vector by a float
  119348. */
  119349. export class ScaleBlock extends NodeMaterialBlock {
  119350. /**
  119351. * Creates a new ScaleBlock
  119352. * @param name defines the block name
  119353. */
  119354. constructor(name: string);
  119355. /**
  119356. * Gets the current class name
  119357. * @returns the class name
  119358. */
  119359. getClassName(): string;
  119360. /**
  119361. * Gets the input component
  119362. */
  119363. readonly input: NodeMaterialConnectionPoint;
  119364. /**
  119365. * Gets the factor input component
  119366. */
  119367. readonly factor: NodeMaterialConnectionPoint;
  119368. /**
  119369. * Gets the output component
  119370. */
  119371. readonly output: NodeMaterialConnectionPoint;
  119372. protected _buildBlock(state: NodeMaterialBuildState): this;
  119373. }
  119374. }
  119375. declare module BABYLON {
  119376. /**
  119377. * Block used to clamp a float
  119378. */
  119379. export class ClampBlock extends NodeMaterialBlock {
  119380. /** Gets or sets the minimum range */
  119381. minimum: number;
  119382. /** Gets or sets the maximum range */
  119383. maximum: number;
  119384. /**
  119385. * Creates a new ClampBlock
  119386. * @param name defines the block name
  119387. */
  119388. constructor(name: string);
  119389. /**
  119390. * Gets the current class name
  119391. * @returns the class name
  119392. */
  119393. getClassName(): string;
  119394. /**
  119395. * Gets the value input component
  119396. */
  119397. readonly value: NodeMaterialConnectionPoint;
  119398. /**
  119399. * Gets the output component
  119400. */
  119401. readonly output: NodeMaterialConnectionPoint;
  119402. protected _buildBlock(state: NodeMaterialBuildState): this;
  119403. protected _dumpPropertiesCode(): string;
  119404. serialize(): any;
  119405. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119406. }
  119407. }
  119408. declare module BABYLON {
  119409. /**
  119410. * Block used to apply a cross product between 2 vectors
  119411. */
  119412. export class CrossBlock extends NodeMaterialBlock {
  119413. /**
  119414. * Creates a new CrossBlock
  119415. * @param name defines the block name
  119416. */
  119417. constructor(name: string);
  119418. /**
  119419. * Gets the current class name
  119420. * @returns the class name
  119421. */
  119422. getClassName(): string;
  119423. /**
  119424. * Gets the left operand input component
  119425. */
  119426. readonly left: NodeMaterialConnectionPoint;
  119427. /**
  119428. * Gets the right operand input component
  119429. */
  119430. readonly right: NodeMaterialConnectionPoint;
  119431. /**
  119432. * Gets the output component
  119433. */
  119434. readonly output: NodeMaterialConnectionPoint;
  119435. protected _buildBlock(state: NodeMaterialBuildState): this;
  119436. }
  119437. }
  119438. declare module BABYLON {
  119439. /**
  119440. * Block used to apply a dot product between 2 vectors
  119441. */
  119442. export class DotBlock extends NodeMaterialBlock {
  119443. /**
  119444. * Creates a new DotBlock
  119445. * @param name defines the block name
  119446. */
  119447. constructor(name: string);
  119448. /**
  119449. * Gets the current class name
  119450. * @returns the class name
  119451. */
  119452. getClassName(): string;
  119453. /**
  119454. * Gets the left operand input component
  119455. */
  119456. readonly left: NodeMaterialConnectionPoint;
  119457. /**
  119458. * Gets the right operand input component
  119459. */
  119460. readonly right: NodeMaterialConnectionPoint;
  119461. /**
  119462. * Gets the output component
  119463. */
  119464. readonly output: NodeMaterialConnectionPoint;
  119465. protected _buildBlock(state: NodeMaterialBuildState): this;
  119466. }
  119467. }
  119468. declare module BABYLON {
  119469. /**
  119470. * Block used to remap a float from a range to a new one
  119471. */
  119472. export class RemapBlock extends NodeMaterialBlock {
  119473. /**
  119474. * Gets or sets the source range
  119475. */
  119476. sourceRange: Vector2;
  119477. /**
  119478. * Gets or sets the target range
  119479. */
  119480. targetRange: Vector2;
  119481. /**
  119482. * Creates a new RemapBlock
  119483. * @param name defines the block name
  119484. */
  119485. constructor(name: string);
  119486. /**
  119487. * Gets the current class name
  119488. * @returns the class name
  119489. */
  119490. getClassName(): string;
  119491. /**
  119492. * Gets the input component
  119493. */
  119494. readonly input: NodeMaterialConnectionPoint;
  119495. /**
  119496. * Gets the source min input component
  119497. */
  119498. readonly sourceMin: NodeMaterialConnectionPoint;
  119499. /**
  119500. * Gets the source max input component
  119501. */
  119502. readonly sourceMax: NodeMaterialConnectionPoint;
  119503. /**
  119504. * Gets the target min input component
  119505. */
  119506. readonly targetMin: NodeMaterialConnectionPoint;
  119507. /**
  119508. * Gets the target max input component
  119509. */
  119510. readonly targetMax: NodeMaterialConnectionPoint;
  119511. /**
  119512. * Gets the output component
  119513. */
  119514. readonly output: NodeMaterialConnectionPoint;
  119515. protected _buildBlock(state: NodeMaterialBuildState): this;
  119516. protected _dumpPropertiesCode(): string;
  119517. serialize(): any;
  119518. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119519. }
  119520. }
  119521. declare module BABYLON {
  119522. /**
  119523. * Block used to normalize a vector
  119524. */
  119525. export class NormalizeBlock extends NodeMaterialBlock {
  119526. /**
  119527. * Creates a new NormalizeBlock
  119528. * @param name defines the block name
  119529. */
  119530. constructor(name: string);
  119531. /**
  119532. * Gets the current class name
  119533. * @returns the class name
  119534. */
  119535. getClassName(): string;
  119536. /**
  119537. * Gets the input component
  119538. */
  119539. readonly input: NodeMaterialConnectionPoint;
  119540. /**
  119541. * Gets the output component
  119542. */
  119543. readonly output: NodeMaterialConnectionPoint;
  119544. protected _buildBlock(state: NodeMaterialBuildState): this;
  119545. }
  119546. }
  119547. declare module BABYLON {
  119548. /**
  119549. * Operations supported by the Trigonometry block
  119550. */
  119551. export enum TrigonometryBlockOperations {
  119552. /** Cos */
  119553. Cos = 0,
  119554. /** Sin */
  119555. Sin = 1,
  119556. /** Abs */
  119557. Abs = 2,
  119558. /** Exp */
  119559. Exp = 3,
  119560. /** Exp2 */
  119561. Exp2 = 4,
  119562. /** Round */
  119563. Round = 5,
  119564. /** Floor */
  119565. Floor = 6,
  119566. /** Ceiling */
  119567. Ceiling = 7
  119568. }
  119569. /**
  119570. * Block used to apply trigonometry operation to floats
  119571. */
  119572. export class TrigonometryBlock extends NodeMaterialBlock {
  119573. /**
  119574. * Gets or sets the operation applied by the block
  119575. */
  119576. operation: TrigonometryBlockOperations;
  119577. /**
  119578. * Creates a new TrigonometryBlock
  119579. * @param name defines the block name
  119580. */
  119581. constructor(name: string);
  119582. /**
  119583. * Gets the current class name
  119584. * @returns the class name
  119585. */
  119586. getClassName(): string;
  119587. /**
  119588. * Gets the input component
  119589. */
  119590. readonly input: NodeMaterialConnectionPoint;
  119591. /**
  119592. * Gets the output component
  119593. */
  119594. readonly output: NodeMaterialConnectionPoint;
  119595. protected _buildBlock(state: NodeMaterialBuildState): this;
  119596. serialize(): any;
  119597. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  119598. }
  119599. }
  119600. declare module BABYLON {
  119601. /**
  119602. * Block used to create a Color3/4 out of individual inputs (one for each component)
  119603. */
  119604. export class ColorMergerBlock extends NodeMaterialBlock {
  119605. /**
  119606. * Create a new ColorMergerBlock
  119607. * @param name defines the block name
  119608. */
  119609. constructor(name: string);
  119610. /**
  119611. * Gets the current class name
  119612. * @returns the class name
  119613. */
  119614. getClassName(): string;
  119615. /**
  119616. * Gets the r component (input)
  119617. */
  119618. readonly r: NodeMaterialConnectionPoint;
  119619. /**
  119620. * Gets the g component (input)
  119621. */
  119622. readonly g: NodeMaterialConnectionPoint;
  119623. /**
  119624. * Gets the b component (input)
  119625. */
  119626. readonly b: NodeMaterialConnectionPoint;
  119627. /**
  119628. * Gets the a component (input)
  119629. */
  119630. readonly a: NodeMaterialConnectionPoint;
  119631. /**
  119632. * Gets the rgba component (output)
  119633. */
  119634. readonly rgba: NodeMaterialConnectionPoint;
  119635. /**
  119636. * Gets the rgb component (output)
  119637. */
  119638. readonly rgb: NodeMaterialConnectionPoint;
  119639. protected _buildBlock(state: NodeMaterialBuildState): this;
  119640. }
  119641. }
  119642. declare module BABYLON {
  119643. /**
  119644. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  119645. */
  119646. export class VectorMergerBlock extends NodeMaterialBlock {
  119647. /**
  119648. * Create a new VectorMergerBlock
  119649. * @param name defines the block name
  119650. */
  119651. constructor(name: string);
  119652. /**
  119653. * Gets the current class name
  119654. * @returns the class name
  119655. */
  119656. getClassName(): string;
  119657. /**
  119658. * Gets the x component (input)
  119659. */
  119660. readonly x: NodeMaterialConnectionPoint;
  119661. /**
  119662. * Gets the y component (input)
  119663. */
  119664. readonly y: NodeMaterialConnectionPoint;
  119665. /**
  119666. * Gets the z component (input)
  119667. */
  119668. readonly z: NodeMaterialConnectionPoint;
  119669. /**
  119670. * Gets the w component (input)
  119671. */
  119672. readonly w: NodeMaterialConnectionPoint;
  119673. /**
  119674. * Gets the xyzw component (output)
  119675. */
  119676. readonly xyzw: NodeMaterialConnectionPoint;
  119677. /**
  119678. * Gets the xyz component (output)
  119679. */
  119680. readonly xyz: NodeMaterialConnectionPoint;
  119681. /**
  119682. * Gets the xy component (output)
  119683. */
  119684. readonly xy: NodeMaterialConnectionPoint;
  119685. protected _buildBlock(state: NodeMaterialBuildState): this;
  119686. }
  119687. }
  119688. declare module BABYLON {
  119689. /**
  119690. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  119691. */
  119692. export class ColorSplitterBlock extends NodeMaterialBlock {
  119693. /**
  119694. * Create a new ColorSplitterBlock
  119695. * @param name defines the block name
  119696. */
  119697. constructor(name: string);
  119698. /**
  119699. * Gets the current class name
  119700. * @returns the class name
  119701. */
  119702. getClassName(): string;
  119703. /**
  119704. * Gets the rgba component (input)
  119705. */
  119706. readonly rgba: NodeMaterialConnectionPoint;
  119707. /**
  119708. * Gets the rgb component (input)
  119709. */
  119710. readonly rgbIn: NodeMaterialConnectionPoint;
  119711. /**
  119712. * Gets the rgb component (output)
  119713. */
  119714. readonly rgbOut: NodeMaterialConnectionPoint;
  119715. /**
  119716. * Gets the r component (output)
  119717. */
  119718. readonly r: NodeMaterialConnectionPoint;
  119719. /**
  119720. * Gets the g component (output)
  119721. */
  119722. readonly g: NodeMaterialConnectionPoint;
  119723. /**
  119724. * Gets the b component (output)
  119725. */
  119726. readonly b: NodeMaterialConnectionPoint;
  119727. /**
  119728. * Gets the a component (output)
  119729. */
  119730. readonly a: NodeMaterialConnectionPoint;
  119731. protected _inputRename(name: string): string;
  119732. protected _outputRename(name: string): string;
  119733. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  119734. }
  119735. }
  119736. declare module BABYLON {
  119737. /**
  119738. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  119739. */
  119740. export class VectorSplitterBlock extends NodeMaterialBlock {
  119741. /**
  119742. * Create a new VectorSplitterBlock
  119743. * @param name defines the block name
  119744. */
  119745. constructor(name: string);
  119746. /**
  119747. * Gets the current class name
  119748. * @returns the class name
  119749. */
  119750. getClassName(): string;
  119751. /**
  119752. * Gets the xyzw component (input)
  119753. */
  119754. readonly xyzw: NodeMaterialConnectionPoint;
  119755. /**
  119756. * Gets the xyz component (input)
  119757. */
  119758. readonly xyzIn: NodeMaterialConnectionPoint;
  119759. /**
  119760. * Gets the xy component (input)
  119761. */
  119762. readonly xyIn: NodeMaterialConnectionPoint;
  119763. /**
  119764. * Gets the xyz component (output)
  119765. */
  119766. readonly xyzOut: NodeMaterialConnectionPoint;
  119767. /**
  119768. * Gets the xy component (output)
  119769. */
  119770. readonly xyOut: NodeMaterialConnectionPoint;
  119771. /**
  119772. * Gets the x component (output)
  119773. */
  119774. readonly x: NodeMaterialConnectionPoint;
  119775. /**
  119776. * Gets the y component (output)
  119777. */
  119778. readonly y: NodeMaterialConnectionPoint;
  119779. /**
  119780. * Gets the z component (output)
  119781. */
  119782. readonly z: NodeMaterialConnectionPoint;
  119783. /**
  119784. * Gets the w component (output)
  119785. */
  119786. readonly w: NodeMaterialConnectionPoint;
  119787. protected _inputRename(name: string): string;
  119788. protected _outputRename(name: string): string;
  119789. protected _buildBlock(state: NodeMaterialBuildState): this;
  119790. }
  119791. }
  119792. declare module BABYLON {
  119793. /**
  119794. * Block used to lerp 2 values
  119795. */
  119796. export class LerpBlock extends NodeMaterialBlock {
  119797. /**
  119798. * Creates a new LerpBlock
  119799. * @param name defines the block name
  119800. */
  119801. constructor(name: string);
  119802. /**
  119803. * Gets the current class name
  119804. * @returns the class name
  119805. */
  119806. getClassName(): string;
  119807. /**
  119808. * Gets the left operand input component
  119809. */
  119810. readonly left: NodeMaterialConnectionPoint;
  119811. /**
  119812. * Gets the right operand input component
  119813. */
  119814. readonly right: NodeMaterialConnectionPoint;
  119815. /**
  119816. * Gets the gradient operand input component
  119817. */
  119818. readonly gradient: NodeMaterialConnectionPoint;
  119819. /**
  119820. * Gets the output component
  119821. */
  119822. readonly output: NodeMaterialConnectionPoint;
  119823. protected _buildBlock(state: NodeMaterialBuildState): this;
  119824. }
  119825. }
  119826. declare module BABYLON {
  119827. /**
  119828. * Block used to divide 2 vectors
  119829. */
  119830. export class DivideBlock extends NodeMaterialBlock {
  119831. /**
  119832. * Creates a new DivideBlock
  119833. * @param name defines the block name
  119834. */
  119835. constructor(name: string);
  119836. /**
  119837. * Gets the current class name
  119838. * @returns the class name
  119839. */
  119840. getClassName(): string;
  119841. /**
  119842. * Gets the left operand input component
  119843. */
  119844. readonly left: NodeMaterialConnectionPoint;
  119845. /**
  119846. * Gets the right operand input component
  119847. */
  119848. readonly right: NodeMaterialConnectionPoint;
  119849. /**
  119850. * Gets the output component
  119851. */
  119852. readonly output: NodeMaterialConnectionPoint;
  119853. protected _buildBlock(state: NodeMaterialBuildState): this;
  119854. }
  119855. }
  119856. declare module BABYLON {
  119857. /**
  119858. * Block used to subtract 2 vectors
  119859. */
  119860. export class SubtractBlock extends NodeMaterialBlock {
  119861. /**
  119862. * Creates a new SubtractBlock
  119863. * @param name defines the block name
  119864. */
  119865. constructor(name: string);
  119866. /**
  119867. * Gets the current class name
  119868. * @returns the class name
  119869. */
  119870. getClassName(): string;
  119871. /**
  119872. * Gets the left operand input component
  119873. */
  119874. readonly left: NodeMaterialConnectionPoint;
  119875. /**
  119876. * Gets the right operand input component
  119877. */
  119878. readonly right: NodeMaterialConnectionPoint;
  119879. /**
  119880. * Gets the output component
  119881. */
  119882. readonly output: NodeMaterialConnectionPoint;
  119883. protected _buildBlock(state: NodeMaterialBuildState): this;
  119884. }
  119885. }
  119886. declare module BABYLON {
  119887. /**
  119888. * Block used to step a value
  119889. */
  119890. export class StepBlock extends NodeMaterialBlock {
  119891. /**
  119892. * Creates a new AddBlock
  119893. * @param name defines the block name
  119894. */
  119895. constructor(name: string);
  119896. /**
  119897. * Gets the current class name
  119898. * @returns the class name
  119899. */
  119900. getClassName(): string;
  119901. /**
  119902. * Gets the value operand input component
  119903. */
  119904. readonly value: NodeMaterialConnectionPoint;
  119905. /**
  119906. * Gets the edge operand input component
  119907. */
  119908. readonly edge: NodeMaterialConnectionPoint;
  119909. /**
  119910. * Gets the output component
  119911. */
  119912. readonly output: NodeMaterialConnectionPoint;
  119913. protected _buildBlock(state: NodeMaterialBuildState): this;
  119914. }
  119915. }
  119916. declare module BABYLON {
  119917. /**
  119918. * Block used to get the opposite (1 - x) of a value
  119919. */
  119920. export class OneMinusBlock extends NodeMaterialBlock {
  119921. /**
  119922. * Creates a new OneMinusBlock
  119923. * @param name defines the block name
  119924. */
  119925. constructor(name: string);
  119926. /**
  119927. * Gets the current class name
  119928. * @returns the class name
  119929. */
  119930. getClassName(): string;
  119931. /**
  119932. * Gets the input component
  119933. */
  119934. readonly input: NodeMaterialConnectionPoint;
  119935. /**
  119936. * Gets the output component
  119937. */
  119938. readonly output: NodeMaterialConnectionPoint;
  119939. protected _buildBlock(state: NodeMaterialBuildState): this;
  119940. }
  119941. }
  119942. declare module BABYLON {
  119943. /**
  119944. * Block used to get the view direction
  119945. */
  119946. export class ViewDirectionBlock extends NodeMaterialBlock {
  119947. /**
  119948. * Creates a new ViewDirectionBlock
  119949. * @param name defines the block name
  119950. */
  119951. constructor(name: string);
  119952. /**
  119953. * Gets the current class name
  119954. * @returns the class name
  119955. */
  119956. getClassName(): string;
  119957. /**
  119958. * Gets the world position component
  119959. */
  119960. readonly worldPosition: NodeMaterialConnectionPoint;
  119961. /**
  119962. * Gets the camera position component
  119963. */
  119964. readonly cameraPosition: NodeMaterialConnectionPoint;
  119965. /**
  119966. * Gets the output component
  119967. */
  119968. readonly output: NodeMaterialConnectionPoint;
  119969. autoConfigure(material: NodeMaterial): void;
  119970. protected _buildBlock(state: NodeMaterialBuildState): this;
  119971. }
  119972. }
  119973. declare module BABYLON {
  119974. /**
  119975. * Block used to compute fresnel value
  119976. */
  119977. export class FresnelBlock extends NodeMaterialBlock {
  119978. /**
  119979. * Create a new FresnelBlock
  119980. * @param name defines the block name
  119981. */
  119982. constructor(name: string);
  119983. /**
  119984. * Gets the current class name
  119985. * @returns the class name
  119986. */
  119987. getClassName(): string;
  119988. /**
  119989. * Gets the world normal input component
  119990. */
  119991. readonly worldNormal: NodeMaterialConnectionPoint;
  119992. /**
  119993. * Gets the view direction input component
  119994. */
  119995. readonly viewDirection: NodeMaterialConnectionPoint;
  119996. /**
  119997. * Gets the bias input component
  119998. */
  119999. readonly bias: NodeMaterialConnectionPoint;
  120000. /**
  120001. * Gets the camera (or eye) position component
  120002. */
  120003. readonly power: NodeMaterialConnectionPoint;
  120004. /**
  120005. * Gets the fresnel output component
  120006. */
  120007. readonly fresnel: NodeMaterialConnectionPoint;
  120008. autoConfigure(material: NodeMaterial): void;
  120009. protected _buildBlock(state: NodeMaterialBuildState): this;
  120010. }
  120011. }
  120012. declare module BABYLON {
  120013. /**
  120014. * Block used to get the max of 2 values
  120015. */
  120016. export class MaxBlock extends NodeMaterialBlock {
  120017. /**
  120018. * Creates a new MaxBlock
  120019. * @param name defines the block name
  120020. */
  120021. constructor(name: string);
  120022. /**
  120023. * Gets the current class name
  120024. * @returns the class name
  120025. */
  120026. getClassName(): string;
  120027. /**
  120028. * Gets the left operand input component
  120029. */
  120030. readonly left: NodeMaterialConnectionPoint;
  120031. /**
  120032. * Gets the right operand input component
  120033. */
  120034. readonly right: NodeMaterialConnectionPoint;
  120035. /**
  120036. * Gets the output component
  120037. */
  120038. readonly output: NodeMaterialConnectionPoint;
  120039. protected _buildBlock(state: NodeMaterialBuildState): this;
  120040. }
  120041. }
  120042. declare module BABYLON {
  120043. /**
  120044. * Block used to get the min of 2 values
  120045. */
  120046. export class MinBlock extends NodeMaterialBlock {
  120047. /**
  120048. * Creates a new MinBlock
  120049. * @param name defines the block name
  120050. */
  120051. constructor(name: string);
  120052. /**
  120053. * Gets the current class name
  120054. * @returns the class name
  120055. */
  120056. getClassName(): string;
  120057. /**
  120058. * Gets the left operand input component
  120059. */
  120060. readonly left: NodeMaterialConnectionPoint;
  120061. /**
  120062. * Gets the right operand input component
  120063. */
  120064. readonly right: NodeMaterialConnectionPoint;
  120065. /**
  120066. * Gets the output component
  120067. */
  120068. readonly output: NodeMaterialConnectionPoint;
  120069. protected _buildBlock(state: NodeMaterialBuildState): this;
  120070. }
  120071. }
  120072. declare module BABYLON {
  120073. /**
  120074. * Effect Render Options
  120075. */
  120076. export interface IEffectRendererOptions {
  120077. /**
  120078. * Defines the vertices positions.
  120079. */
  120080. positions?: number[];
  120081. /**
  120082. * Defines the indices.
  120083. */
  120084. indices?: number[];
  120085. }
  120086. /**
  120087. * Helper class to render one or more effects
  120088. */
  120089. export class EffectRenderer {
  120090. private engine;
  120091. private static _DefaultOptions;
  120092. private _vertexBuffers;
  120093. private _indexBuffer;
  120094. private _ringBufferIndex;
  120095. private _ringScreenBuffer;
  120096. private _fullscreenViewport;
  120097. private _getNextFrameBuffer;
  120098. /**
  120099. * Creates an effect renderer
  120100. * @param engine the engine to use for rendering
  120101. * @param options defines the options of the effect renderer
  120102. */
  120103. constructor(engine: Engine, options?: IEffectRendererOptions);
  120104. /**
  120105. * Sets the current viewport in normalized coordinates 0-1
  120106. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  120107. */
  120108. setViewport(viewport?: Viewport): void;
  120109. /**
  120110. * Binds the embedded attributes buffer to the effect.
  120111. * @param effect Defines the effect to bind the attributes for
  120112. */
  120113. bindBuffers(effect: Effect): void;
  120114. /**
  120115. * Sets the current effect wrapper to use during draw.
  120116. * The effect needs to be ready before calling this api.
  120117. * This also sets the default full screen position attribute.
  120118. * @param effectWrapper Defines the effect to draw with
  120119. */
  120120. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  120121. /**
  120122. * Draws a full screen quad.
  120123. */
  120124. draw(): void;
  120125. /**
  120126. * renders one or more effects to a specified texture
  120127. * @param effectWrappers list of effects to renderer
  120128. * @param outputTexture texture to draw to, if null it will render to the screen
  120129. */
  120130. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  120131. /**
  120132. * Disposes of the effect renderer
  120133. */
  120134. dispose(): void;
  120135. }
  120136. /**
  120137. * Options to create an EffectWrapper
  120138. */
  120139. interface EffectWrapperCreationOptions {
  120140. /**
  120141. * Engine to use to create the effect
  120142. */
  120143. engine: Engine;
  120144. /**
  120145. * Fragment shader for the effect
  120146. */
  120147. fragmentShader: string;
  120148. /**
  120149. * Vertex shader for the effect
  120150. */
  120151. vertexShader?: string;
  120152. /**
  120153. * Attributes to use in the shader
  120154. */
  120155. attributeNames?: Array<string>;
  120156. /**
  120157. * Uniforms to use in the shader
  120158. */
  120159. uniformNames?: Array<string>;
  120160. /**
  120161. * Texture sampler names to use in the shader
  120162. */
  120163. samplerNames?: Array<string>;
  120164. /**
  120165. * The friendly name of the effect displayed in Spector.
  120166. */
  120167. name?: string;
  120168. }
  120169. /**
  120170. * Wraps an effect to be used for rendering
  120171. */
  120172. export class EffectWrapper {
  120173. /**
  120174. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  120175. */
  120176. onApplyObservable: Observable<{}>;
  120177. /**
  120178. * The underlying effect
  120179. */
  120180. effect: Effect;
  120181. /**
  120182. * Creates an effect to be renderer
  120183. * @param creationOptions options to create the effect
  120184. */
  120185. constructor(creationOptions: EffectWrapperCreationOptions);
  120186. /**
  120187. * Disposes of the effect wrapper
  120188. */
  120189. dispose(): void;
  120190. }
  120191. }
  120192. declare module BABYLON {
  120193. /**
  120194. * Helper class to push actions to a pool of workers.
  120195. */
  120196. export class WorkerPool implements IDisposable {
  120197. private _workerInfos;
  120198. private _pendingActions;
  120199. /**
  120200. * Constructor
  120201. * @param workers Array of workers to use for actions
  120202. */
  120203. constructor(workers: Array<Worker>);
  120204. /**
  120205. * Terminates all workers and clears any pending actions.
  120206. */
  120207. dispose(): void;
  120208. /**
  120209. * Pushes an action to the worker pool. If all the workers are active, the action will be
  120210. * pended until a worker has completed its action.
  120211. * @param action The action to perform. Call onComplete when the action is complete.
  120212. */
  120213. push(action: (worker: Worker, onComplete: () => void) => void): void;
  120214. private _execute;
  120215. }
  120216. }
  120217. declare module BABYLON {
  120218. /**
  120219. * Configuration for Draco compression
  120220. */
  120221. export interface IDracoCompressionConfiguration {
  120222. /**
  120223. * Configuration for the decoder.
  120224. */
  120225. decoder: {
  120226. /**
  120227. * The url to the WebAssembly module.
  120228. */
  120229. wasmUrl?: string;
  120230. /**
  120231. * The url to the WebAssembly binary.
  120232. */
  120233. wasmBinaryUrl?: string;
  120234. /**
  120235. * The url to the fallback JavaScript module.
  120236. */
  120237. fallbackUrl?: string;
  120238. };
  120239. }
  120240. /**
  120241. * Draco compression (https://google.github.io/draco/)
  120242. *
  120243. * This class wraps the Draco module.
  120244. *
  120245. * **Encoder**
  120246. *
  120247. * The encoder is not currently implemented.
  120248. *
  120249. * **Decoder**
  120250. *
  120251. * 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.
  120252. *
  120253. * To update the configuration, use the following code:
  120254. * ```javascript
  120255. * DracoCompression.Configuration = {
  120256. * decoder: {
  120257. * wasmUrl: "<url to the WebAssembly library>",
  120258. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  120259. * fallbackUrl: "<url to the fallback JavaScript library>",
  120260. * }
  120261. * };
  120262. * ```
  120263. *
  120264. * 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.
  120265. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  120266. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  120267. *
  120268. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  120269. * ```javascript
  120270. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  120271. * ```
  120272. *
  120273. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  120274. */
  120275. export class DracoCompression implements IDisposable {
  120276. private _workerPoolPromise?;
  120277. private _decoderModulePromise?;
  120278. /**
  120279. * The configuration. Defaults to the following urls:
  120280. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  120281. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  120282. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  120283. */
  120284. static Configuration: IDracoCompressionConfiguration;
  120285. /**
  120286. * Returns true if the decoder configuration is available.
  120287. */
  120288. static readonly DecoderAvailable: boolean;
  120289. /**
  120290. * Default number of workers to create when creating the draco compression object.
  120291. */
  120292. static DefaultNumWorkers: number;
  120293. private static GetDefaultNumWorkers;
  120294. private static _Default;
  120295. /**
  120296. * Default instance for the draco compression object.
  120297. */
  120298. static readonly Default: DracoCompression;
  120299. /**
  120300. * Constructor
  120301. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  120302. */
  120303. constructor(numWorkers?: number);
  120304. /**
  120305. * Stop all async operations and release resources.
  120306. */
  120307. dispose(): void;
  120308. /**
  120309. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  120310. * @returns a promise that resolves when ready
  120311. */
  120312. whenReadyAsync(): Promise<void>;
  120313. /**
  120314. * Decode Draco compressed mesh data to vertex data.
  120315. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  120316. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  120317. * @returns A promise that resolves with the decoded vertex data
  120318. */
  120319. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  120320. [kind: string]: number;
  120321. }): Promise<VertexData>;
  120322. }
  120323. }
  120324. declare module BABYLON {
  120325. /**
  120326. * Class for building Constructive Solid Geometry
  120327. */
  120328. export class CSG {
  120329. private polygons;
  120330. /**
  120331. * The world matrix
  120332. */
  120333. matrix: Matrix;
  120334. /**
  120335. * Stores the position
  120336. */
  120337. position: Vector3;
  120338. /**
  120339. * Stores the rotation
  120340. */
  120341. rotation: Vector3;
  120342. /**
  120343. * Stores the rotation quaternion
  120344. */
  120345. rotationQuaternion: Nullable<Quaternion>;
  120346. /**
  120347. * Stores the scaling vector
  120348. */
  120349. scaling: Vector3;
  120350. /**
  120351. * Convert the Mesh to CSG
  120352. * @param mesh The Mesh to convert to CSG
  120353. * @returns A new CSG from the Mesh
  120354. */
  120355. static FromMesh(mesh: Mesh): CSG;
  120356. /**
  120357. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  120358. * @param polygons Polygons used to construct a CSG solid
  120359. */
  120360. private static FromPolygons;
  120361. /**
  120362. * Clones, or makes a deep copy, of the CSG
  120363. * @returns A new CSG
  120364. */
  120365. clone(): CSG;
  120366. /**
  120367. * Unions this CSG with another CSG
  120368. * @param csg The CSG to union against this CSG
  120369. * @returns The unioned CSG
  120370. */
  120371. union(csg: CSG): CSG;
  120372. /**
  120373. * Unions this CSG with another CSG in place
  120374. * @param csg The CSG to union against this CSG
  120375. */
  120376. unionInPlace(csg: CSG): void;
  120377. /**
  120378. * Subtracts this CSG with another CSG
  120379. * @param csg The CSG to subtract against this CSG
  120380. * @returns A new CSG
  120381. */
  120382. subtract(csg: CSG): CSG;
  120383. /**
  120384. * Subtracts this CSG with another CSG in place
  120385. * @param csg The CSG to subtact against this CSG
  120386. */
  120387. subtractInPlace(csg: CSG): void;
  120388. /**
  120389. * Intersect this CSG with another CSG
  120390. * @param csg The CSG to intersect against this CSG
  120391. * @returns A new CSG
  120392. */
  120393. intersect(csg: CSG): CSG;
  120394. /**
  120395. * Intersects this CSG with another CSG in place
  120396. * @param csg The CSG to intersect against this CSG
  120397. */
  120398. intersectInPlace(csg: CSG): void;
  120399. /**
  120400. * Return a new CSG solid with solid and empty space switched. This solid is
  120401. * not modified.
  120402. * @returns A new CSG solid with solid and empty space switched
  120403. */
  120404. inverse(): CSG;
  120405. /**
  120406. * Inverses the CSG in place
  120407. */
  120408. inverseInPlace(): void;
  120409. /**
  120410. * This is used to keep meshes transformations so they can be restored
  120411. * when we build back a Babylon Mesh
  120412. * NB : All CSG operations are performed in world coordinates
  120413. * @param csg The CSG to copy the transform attributes from
  120414. * @returns This CSG
  120415. */
  120416. copyTransformAttributes(csg: CSG): CSG;
  120417. /**
  120418. * Build Raw mesh from CSG
  120419. * Coordinates here are in world space
  120420. * @param name The name of the mesh geometry
  120421. * @param scene The Scene
  120422. * @param keepSubMeshes Specifies if the submeshes should be kept
  120423. * @returns A new Mesh
  120424. */
  120425. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  120426. /**
  120427. * Build Mesh from CSG taking material and transforms into account
  120428. * @param name The name of the Mesh
  120429. * @param material The material of the Mesh
  120430. * @param scene The Scene
  120431. * @param keepSubMeshes Specifies if submeshes should be kept
  120432. * @returns The new Mesh
  120433. */
  120434. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  120435. }
  120436. }
  120437. declare module BABYLON {
  120438. /**
  120439. * Class used to create a trail following a mesh
  120440. */
  120441. export class TrailMesh extends Mesh {
  120442. private _generator;
  120443. private _autoStart;
  120444. private _running;
  120445. private _diameter;
  120446. private _length;
  120447. private _sectionPolygonPointsCount;
  120448. private _sectionVectors;
  120449. private _sectionNormalVectors;
  120450. private _beforeRenderObserver;
  120451. /**
  120452. * @constructor
  120453. * @param name The value used by scene.getMeshByName() to do a lookup.
  120454. * @param generator The mesh to generate a trail.
  120455. * @param scene The scene to add this mesh to.
  120456. * @param diameter Diameter of trailing mesh. Default is 1.
  120457. * @param length Length of trailing mesh. Default is 60.
  120458. * @param autoStart Automatically start trailing mesh. Default true.
  120459. */
  120460. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  120461. /**
  120462. * "TrailMesh"
  120463. * @returns "TrailMesh"
  120464. */
  120465. getClassName(): string;
  120466. private _createMesh;
  120467. /**
  120468. * Start trailing mesh.
  120469. */
  120470. start(): void;
  120471. /**
  120472. * Stop trailing mesh.
  120473. */
  120474. stop(): void;
  120475. /**
  120476. * Update trailing mesh geometry.
  120477. */
  120478. update(): void;
  120479. /**
  120480. * Returns a new TrailMesh object.
  120481. * @param name is a string, the name given to the new mesh
  120482. * @param newGenerator use new generator object for cloned trail mesh
  120483. * @returns a new mesh
  120484. */
  120485. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  120486. /**
  120487. * Serializes this trail mesh
  120488. * @param serializationObject object to write serialization to
  120489. */
  120490. serialize(serializationObject: any): void;
  120491. /**
  120492. * Parses a serialized trail mesh
  120493. * @param parsedMesh the serialized mesh
  120494. * @param scene the scene to create the trail mesh in
  120495. * @returns the created trail mesh
  120496. */
  120497. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  120498. }
  120499. }
  120500. declare module BABYLON {
  120501. /**
  120502. * Class containing static functions to help procedurally build meshes
  120503. */
  120504. export class TiledBoxBuilder {
  120505. /**
  120506. * Creates a box mesh
  120507. * 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)
  120508. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  120509. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120510. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120511. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120512. * @param name defines the name of the mesh
  120513. * @param options defines the options used to create the mesh
  120514. * @param scene defines the hosting scene
  120515. * @returns the box mesh
  120516. */
  120517. static CreateTiledBox(name: string, options: {
  120518. pattern?: number;
  120519. width?: number;
  120520. height?: number;
  120521. depth?: number;
  120522. tileSize?: number;
  120523. tileWidth?: number;
  120524. tileHeight?: number;
  120525. alignHorizontal?: number;
  120526. alignVertical?: number;
  120527. faceUV?: Vector4[];
  120528. faceColors?: Color4[];
  120529. sideOrientation?: number;
  120530. updatable?: boolean;
  120531. }, scene?: Nullable<Scene>): Mesh;
  120532. }
  120533. }
  120534. declare module BABYLON {
  120535. /**
  120536. * Class containing static functions to help procedurally build meshes
  120537. */
  120538. export class TorusKnotBuilder {
  120539. /**
  120540. * Creates a torus knot mesh
  120541. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  120542. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  120543. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  120544. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  120545. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120546. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120547. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  120548. * @param name defines the name of the mesh
  120549. * @param options defines the options used to create the mesh
  120550. * @param scene defines the hosting scene
  120551. * @returns the torus knot mesh
  120552. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  120553. */
  120554. static CreateTorusKnot(name: string, options: {
  120555. radius?: number;
  120556. tube?: number;
  120557. radialSegments?: number;
  120558. tubularSegments?: number;
  120559. p?: number;
  120560. q?: number;
  120561. updatable?: boolean;
  120562. sideOrientation?: number;
  120563. frontUVs?: Vector4;
  120564. backUVs?: Vector4;
  120565. }, scene: any): Mesh;
  120566. }
  120567. }
  120568. declare module BABYLON {
  120569. /**
  120570. * Polygon
  120571. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  120572. */
  120573. export class Polygon {
  120574. /**
  120575. * Creates a rectangle
  120576. * @param xmin bottom X coord
  120577. * @param ymin bottom Y coord
  120578. * @param xmax top X coord
  120579. * @param ymax top Y coord
  120580. * @returns points that make the resulting rectation
  120581. */
  120582. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  120583. /**
  120584. * Creates a circle
  120585. * @param radius radius of circle
  120586. * @param cx scale in x
  120587. * @param cy scale in y
  120588. * @param numberOfSides number of sides that make up the circle
  120589. * @returns points that make the resulting circle
  120590. */
  120591. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  120592. /**
  120593. * Creates a polygon from input string
  120594. * @param input Input polygon data
  120595. * @returns the parsed points
  120596. */
  120597. static Parse(input: string): Vector2[];
  120598. /**
  120599. * Starts building a polygon from x and y coordinates
  120600. * @param x x coordinate
  120601. * @param y y coordinate
  120602. * @returns the started path2
  120603. */
  120604. static StartingAt(x: number, y: number): Path2;
  120605. }
  120606. /**
  120607. * Builds a polygon
  120608. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  120609. */
  120610. export class PolygonMeshBuilder {
  120611. private _points;
  120612. private _outlinepoints;
  120613. private _holes;
  120614. private _name;
  120615. private _scene;
  120616. private _epoints;
  120617. private _eholes;
  120618. private _addToepoint;
  120619. /**
  120620. * Babylon reference to the earcut plugin.
  120621. */
  120622. bjsEarcut: any;
  120623. /**
  120624. * Creates a PolygonMeshBuilder
  120625. * @param name name of the builder
  120626. * @param contours Path of the polygon
  120627. * @param scene scene to add to when creating the mesh
  120628. * @param earcutInjection can be used to inject your own earcut reference
  120629. */
  120630. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  120631. /**
  120632. * Adds a whole within the polygon
  120633. * @param hole Array of points defining the hole
  120634. * @returns this
  120635. */
  120636. addHole(hole: Vector2[]): PolygonMeshBuilder;
  120637. /**
  120638. * Creates the polygon
  120639. * @param updatable If the mesh should be updatable
  120640. * @param depth The depth of the mesh created
  120641. * @returns the created mesh
  120642. */
  120643. build(updatable?: boolean, depth?: number): Mesh;
  120644. /**
  120645. * Creates the polygon
  120646. * @param depth The depth of the mesh created
  120647. * @returns the created VertexData
  120648. */
  120649. buildVertexData(depth?: number): VertexData;
  120650. /**
  120651. * Adds a side to the polygon
  120652. * @param positions points that make the polygon
  120653. * @param normals normals of the polygon
  120654. * @param uvs uvs of the polygon
  120655. * @param indices indices of the polygon
  120656. * @param bounds bounds of the polygon
  120657. * @param points points of the polygon
  120658. * @param depth depth of the polygon
  120659. * @param flip flip of the polygon
  120660. */
  120661. private addSide;
  120662. }
  120663. }
  120664. declare module BABYLON {
  120665. /**
  120666. * Class containing static functions to help procedurally build meshes
  120667. */
  120668. export class PolygonBuilder {
  120669. /**
  120670. * Creates a polygon mesh
  120671. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  120672. * * 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
  120673. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  120674. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120675. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  120676. * * Remember you can only change the shape positions, not their number when updating a polygon
  120677. * @param name defines the name of the mesh
  120678. * @param options defines the options used to create the mesh
  120679. * @param scene defines the hosting scene
  120680. * @param earcutInjection can be used to inject your own earcut reference
  120681. * @returns the polygon mesh
  120682. */
  120683. static CreatePolygon(name: string, options: {
  120684. shape: Vector3[];
  120685. holes?: Vector3[][];
  120686. depth?: number;
  120687. faceUV?: Vector4[];
  120688. faceColors?: Color4[];
  120689. updatable?: boolean;
  120690. sideOrientation?: number;
  120691. frontUVs?: Vector4;
  120692. backUVs?: Vector4;
  120693. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  120694. /**
  120695. * Creates an extruded polygon mesh, with depth in the Y direction.
  120696. * * 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)
  120697. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  120698. * @param name defines the name of the mesh
  120699. * @param options defines the options used to create the mesh
  120700. * @param scene defines the hosting scene
  120701. * @param earcutInjection can be used to inject your own earcut reference
  120702. * @returns the polygon mesh
  120703. */
  120704. static ExtrudePolygon(name: string, options: {
  120705. shape: Vector3[];
  120706. holes?: Vector3[][];
  120707. depth?: number;
  120708. faceUV?: Vector4[];
  120709. faceColors?: Color4[];
  120710. updatable?: boolean;
  120711. sideOrientation?: number;
  120712. frontUVs?: Vector4;
  120713. backUVs?: Vector4;
  120714. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  120715. }
  120716. }
  120717. declare module BABYLON {
  120718. /**
  120719. * Class containing static functions to help procedurally build meshes
  120720. */
  120721. export class LatheBuilder {
  120722. /**
  120723. * Creates lathe mesh.
  120724. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  120725. * * 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
  120726. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  120727. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  120728. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  120729. * * 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
  120730. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  120731. * * 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
  120732. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120733. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120734. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120736. * @param name defines the name of the mesh
  120737. * @param options defines the options used to create the mesh
  120738. * @param scene defines the hosting scene
  120739. * @returns the lathe mesh
  120740. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  120741. */
  120742. static CreateLathe(name: string, options: {
  120743. shape: Vector3[];
  120744. radius?: number;
  120745. tessellation?: number;
  120746. clip?: number;
  120747. arc?: number;
  120748. closed?: boolean;
  120749. updatable?: boolean;
  120750. sideOrientation?: number;
  120751. frontUVs?: Vector4;
  120752. backUVs?: Vector4;
  120753. cap?: number;
  120754. invertUV?: boolean;
  120755. }, scene?: Nullable<Scene>): Mesh;
  120756. }
  120757. }
  120758. declare module BABYLON {
  120759. /**
  120760. * Class containing static functions to help procedurally build meshes
  120761. */
  120762. export class TiledPlaneBuilder {
  120763. /**
  120764. * Creates a tiled plane mesh
  120765. * * The parameter `pattern` will, depending on value, do nothing or
  120766. * * * flip (reflect about central vertical) alternate tiles across and up
  120767. * * * flip every tile on alternate rows
  120768. * * * rotate (180 degs) alternate tiles across and up
  120769. * * * rotate every tile on alternate rows
  120770. * * * flip and rotate alternate tiles across and up
  120771. * * * flip and rotate every tile on alternate rows
  120772. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  120773. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  120774. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120775. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  120776. * * 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)
  120777. * * 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)
  120778. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  120779. * @param name defines the name of the mesh
  120780. * @param options defines the options used to create the mesh
  120781. * @param scene defines the hosting scene
  120782. * @returns the box mesh
  120783. */
  120784. static CreateTiledPlane(name: string, options: {
  120785. pattern?: number;
  120786. tileSize?: number;
  120787. tileWidth?: number;
  120788. tileHeight?: number;
  120789. size?: number;
  120790. width?: number;
  120791. height?: number;
  120792. alignHorizontal?: number;
  120793. alignVertical?: number;
  120794. sideOrientation?: number;
  120795. frontUVs?: Vector4;
  120796. backUVs?: Vector4;
  120797. updatable?: boolean;
  120798. }, scene?: Nullable<Scene>): Mesh;
  120799. }
  120800. }
  120801. declare module BABYLON {
  120802. /**
  120803. * Class containing static functions to help procedurally build meshes
  120804. */
  120805. export class TubeBuilder {
  120806. /**
  120807. * Creates a tube mesh.
  120808. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  120809. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  120810. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  120811. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  120812. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  120813. * * 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)
  120814. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  120815. * * 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
  120816. * * 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
  120817. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120818. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120819. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120820. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120821. * @param name defines the name of the mesh
  120822. * @param options defines the options used to create the mesh
  120823. * @param scene defines the hosting scene
  120824. * @returns the tube mesh
  120825. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120826. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  120827. */
  120828. static CreateTube(name: string, options: {
  120829. path: Vector3[];
  120830. radius?: number;
  120831. tessellation?: number;
  120832. radiusFunction?: {
  120833. (i: number, distance: number): number;
  120834. };
  120835. cap?: number;
  120836. arc?: number;
  120837. updatable?: boolean;
  120838. sideOrientation?: number;
  120839. frontUVs?: Vector4;
  120840. backUVs?: Vector4;
  120841. instance?: Mesh;
  120842. invertUV?: boolean;
  120843. }, scene?: Nullable<Scene>): Mesh;
  120844. }
  120845. }
  120846. declare module BABYLON {
  120847. /**
  120848. * Class containing static functions to help procedurally build meshes
  120849. */
  120850. export class IcoSphereBuilder {
  120851. /**
  120852. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  120853. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  120854. * * 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`)
  120855. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  120856. * * 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
  120857. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120858. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120859. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120860. * @param name defines the name of the mesh
  120861. * @param options defines the options used to create the mesh
  120862. * @param scene defines the hosting scene
  120863. * @returns the icosahedron mesh
  120864. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  120865. */
  120866. static CreateIcoSphere(name: string, options: {
  120867. radius?: number;
  120868. radiusX?: number;
  120869. radiusY?: number;
  120870. radiusZ?: number;
  120871. flat?: boolean;
  120872. subdivisions?: number;
  120873. sideOrientation?: number;
  120874. frontUVs?: Vector4;
  120875. backUVs?: Vector4;
  120876. updatable?: boolean;
  120877. }, scene?: Nullable<Scene>): Mesh;
  120878. }
  120879. }
  120880. declare module BABYLON {
  120881. /**
  120882. * Class containing static functions to help procedurally build meshes
  120883. */
  120884. export class DecalBuilder {
  120885. /**
  120886. * Creates a decal mesh.
  120887. * 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
  120888. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  120889. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  120890. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  120891. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  120892. * @param name defines the name of the mesh
  120893. * @param sourceMesh defines the mesh where the decal must be applied
  120894. * @param options defines the options used to create the mesh
  120895. * @param scene defines the hosting scene
  120896. * @returns the decal mesh
  120897. * @see https://doc.babylonjs.com/how_to/decals
  120898. */
  120899. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  120900. position?: Vector3;
  120901. normal?: Vector3;
  120902. size?: Vector3;
  120903. angle?: number;
  120904. }): Mesh;
  120905. }
  120906. }
  120907. declare module BABYLON {
  120908. /**
  120909. * Class containing static functions to help procedurally build meshes
  120910. */
  120911. export class MeshBuilder {
  120912. /**
  120913. * Creates a box mesh
  120914. * * The parameter `size` sets the size (float) of each box side (default 1)
  120915. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  120916. * * 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)
  120917. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  120918. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120919. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120920. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120921. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  120922. * @param name defines the name of the mesh
  120923. * @param options defines the options used to create the mesh
  120924. * @param scene defines the hosting scene
  120925. * @returns the box mesh
  120926. */
  120927. static CreateBox(name: string, options: {
  120928. size?: number;
  120929. width?: number;
  120930. height?: number;
  120931. depth?: number;
  120932. faceUV?: Vector4[];
  120933. faceColors?: Color4[];
  120934. sideOrientation?: number;
  120935. frontUVs?: Vector4;
  120936. backUVs?: Vector4;
  120937. updatable?: boolean;
  120938. }, scene?: Nullable<Scene>): Mesh;
  120939. /**
  120940. * Creates a tiled box mesh
  120941. * * faceTiles sets the pattern, tile size and number of tiles for a face
  120942. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120943. * @param name defines the name of the mesh
  120944. * @param options defines the options used to create the mesh
  120945. * @param scene defines the hosting scene
  120946. * @returns the tiled box mesh
  120947. */
  120948. static CreateTiledBox(name: string, options: {
  120949. pattern?: number;
  120950. size?: number;
  120951. width?: number;
  120952. height?: number;
  120953. depth: number;
  120954. tileSize?: number;
  120955. tileWidth?: number;
  120956. tileHeight?: number;
  120957. faceUV?: Vector4[];
  120958. faceColors?: Color4[];
  120959. alignHorizontal?: number;
  120960. alignVertical?: number;
  120961. sideOrientation?: number;
  120962. updatable?: boolean;
  120963. }, scene?: Nullable<Scene>): Mesh;
  120964. /**
  120965. * Creates a sphere mesh
  120966. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  120967. * * 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`)
  120968. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  120969. * * 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
  120970. * * 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)
  120971. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120972. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120973. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120974. * @param name defines the name of the mesh
  120975. * @param options defines the options used to create the mesh
  120976. * @param scene defines the hosting scene
  120977. * @returns the sphere mesh
  120978. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  120979. */
  120980. static CreateSphere(name: string, options: {
  120981. segments?: number;
  120982. diameter?: number;
  120983. diameterX?: number;
  120984. diameterY?: number;
  120985. diameterZ?: number;
  120986. arc?: number;
  120987. slice?: number;
  120988. sideOrientation?: number;
  120989. frontUVs?: Vector4;
  120990. backUVs?: Vector4;
  120991. updatable?: boolean;
  120992. }, scene?: Nullable<Scene>): Mesh;
  120993. /**
  120994. * Creates a plane polygonal mesh. By default, this is a disc
  120995. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  120996. * * 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
  120997. * * 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
  120998. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120999. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121000. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121001. * @param name defines the name of the mesh
  121002. * @param options defines the options used to create the mesh
  121003. * @param scene defines the hosting scene
  121004. * @returns the plane polygonal mesh
  121005. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  121006. */
  121007. static CreateDisc(name: string, options: {
  121008. radius?: number;
  121009. tessellation?: number;
  121010. arc?: number;
  121011. updatable?: boolean;
  121012. sideOrientation?: number;
  121013. frontUVs?: Vector4;
  121014. backUVs?: Vector4;
  121015. }, scene?: Nullable<Scene>): Mesh;
  121016. /**
  121017. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  121018. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  121019. * * 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`)
  121020. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  121021. * * 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
  121022. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121023. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121024. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121025. * @param name defines the name of the mesh
  121026. * @param options defines the options used to create the mesh
  121027. * @param scene defines the hosting scene
  121028. * @returns the icosahedron mesh
  121029. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  121030. */
  121031. static CreateIcoSphere(name: string, options: {
  121032. radius?: number;
  121033. radiusX?: number;
  121034. radiusY?: number;
  121035. radiusZ?: number;
  121036. flat?: boolean;
  121037. subdivisions?: number;
  121038. sideOrientation?: number;
  121039. frontUVs?: Vector4;
  121040. backUVs?: Vector4;
  121041. updatable?: boolean;
  121042. }, scene?: Nullable<Scene>): Mesh;
  121043. /**
  121044. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  121045. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  121046. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  121047. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  121048. * * 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
  121049. * * 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
  121050. * * 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
  121051. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121052. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121053. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  121054. * * 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
  121055. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  121056. * * 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
  121057. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  121058. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121059. * @param name defines the name of the mesh
  121060. * @param options defines the options used to create the mesh
  121061. * @param scene defines the hosting scene
  121062. * @returns the ribbon mesh
  121063. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  121064. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  121065. */
  121066. static CreateRibbon(name: string, options: {
  121067. pathArray: Vector3[][];
  121068. closeArray?: boolean;
  121069. closePath?: boolean;
  121070. offset?: number;
  121071. updatable?: boolean;
  121072. sideOrientation?: number;
  121073. frontUVs?: Vector4;
  121074. backUVs?: Vector4;
  121075. instance?: Mesh;
  121076. invertUV?: boolean;
  121077. uvs?: Vector2[];
  121078. colors?: Color4[];
  121079. }, scene?: Nullable<Scene>): Mesh;
  121080. /**
  121081. * Creates a cylinder or a cone mesh
  121082. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  121083. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  121084. * * 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.
  121085. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  121086. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  121087. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  121088. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  121089. * * 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).
  121090. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  121091. * * 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).
  121092. * * 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
  121093. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  121094. * * 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
  121095. * * 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.
  121096. * * If `enclose` is false, a ring surface is one element.
  121097. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  121098. * * 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
  121099. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121100. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121101. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121102. * @param name defines the name of the mesh
  121103. * @param options defines the options used to create the mesh
  121104. * @param scene defines the hosting scene
  121105. * @returns the cylinder mesh
  121106. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  121107. */
  121108. static CreateCylinder(name: string, options: {
  121109. height?: number;
  121110. diameterTop?: number;
  121111. diameterBottom?: number;
  121112. diameter?: number;
  121113. tessellation?: number;
  121114. subdivisions?: number;
  121115. arc?: number;
  121116. faceColors?: Color4[];
  121117. faceUV?: Vector4[];
  121118. updatable?: boolean;
  121119. hasRings?: boolean;
  121120. enclose?: boolean;
  121121. cap?: number;
  121122. sideOrientation?: number;
  121123. frontUVs?: Vector4;
  121124. backUVs?: Vector4;
  121125. }, scene?: Nullable<Scene>): Mesh;
  121126. /**
  121127. * Creates a torus mesh
  121128. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  121129. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  121130. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  121131. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121132. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121133. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121134. * @param name defines the name of the mesh
  121135. * @param options defines the options used to create the mesh
  121136. * @param scene defines the hosting scene
  121137. * @returns the torus mesh
  121138. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  121139. */
  121140. static CreateTorus(name: string, options: {
  121141. diameter?: number;
  121142. thickness?: number;
  121143. tessellation?: number;
  121144. updatable?: boolean;
  121145. sideOrientation?: number;
  121146. frontUVs?: Vector4;
  121147. backUVs?: Vector4;
  121148. }, scene?: Nullable<Scene>): Mesh;
  121149. /**
  121150. * Creates a torus knot mesh
  121151. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  121152. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  121153. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  121154. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  121155. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121156. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121157. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121158. * @param name defines the name of the mesh
  121159. * @param options defines the options used to create the mesh
  121160. * @param scene defines the hosting scene
  121161. * @returns the torus knot mesh
  121162. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  121163. */
  121164. static CreateTorusKnot(name: string, options: {
  121165. radius?: number;
  121166. tube?: number;
  121167. radialSegments?: number;
  121168. tubularSegments?: number;
  121169. p?: number;
  121170. q?: number;
  121171. updatable?: boolean;
  121172. sideOrientation?: number;
  121173. frontUVs?: Vector4;
  121174. backUVs?: Vector4;
  121175. }, scene?: Nullable<Scene>): Mesh;
  121176. /**
  121177. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  121178. * * 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
  121179. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  121180. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  121181. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  121182. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  121183. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  121184. * * 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
  121185. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  121186. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121187. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  121188. * @param name defines the name of the new line system
  121189. * @param options defines the options used to create the line system
  121190. * @param scene defines the hosting scene
  121191. * @returns a new line system mesh
  121192. */
  121193. static CreateLineSystem(name: string, options: {
  121194. lines: Vector3[][];
  121195. updatable?: boolean;
  121196. instance?: Nullable<LinesMesh>;
  121197. colors?: Nullable<Color4[][]>;
  121198. useVertexAlpha?: boolean;
  121199. }, scene: Nullable<Scene>): LinesMesh;
  121200. /**
  121201. * Creates a line mesh
  121202. * 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
  121203. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  121204. * * The parameter `points` is an array successive Vector3
  121205. * * 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
  121206. * * The optional parameter `colors` is an array of successive Color4, one per line point
  121207. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  121208. * * When updating an instance, remember that only point positions can change, not the number of points
  121209. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121210. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  121211. * @param name defines the name of the new line system
  121212. * @param options defines the options used to create the line system
  121213. * @param scene defines the hosting scene
  121214. * @returns a new line mesh
  121215. */
  121216. static CreateLines(name: string, options: {
  121217. points: Vector3[];
  121218. updatable?: boolean;
  121219. instance?: Nullable<LinesMesh>;
  121220. colors?: Color4[];
  121221. useVertexAlpha?: boolean;
  121222. }, scene?: Nullable<Scene>): LinesMesh;
  121223. /**
  121224. * Creates a dashed line mesh
  121225. * * 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
  121226. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  121227. * * The parameter `points` is an array successive Vector3
  121228. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  121229. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  121230. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  121231. * * 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
  121232. * * When updating an instance, remember that only point positions can change, not the number of points
  121233. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121234. * @param name defines the name of the mesh
  121235. * @param options defines the options used to create the mesh
  121236. * @param scene defines the hosting scene
  121237. * @returns the dashed line mesh
  121238. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  121239. */
  121240. static CreateDashedLines(name: string, options: {
  121241. points: Vector3[];
  121242. dashSize?: number;
  121243. gapSize?: number;
  121244. dashNb?: number;
  121245. updatable?: boolean;
  121246. instance?: LinesMesh;
  121247. }, scene?: Nullable<Scene>): LinesMesh;
  121248. /**
  121249. * 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.
  121250. * * 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.
  121251. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  121252. * * 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.
  121253. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  121254. * * 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
  121255. * * 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
  121256. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  121257. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121258. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121259. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  121260. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121261. * @param name defines the name of the mesh
  121262. * @param options defines the options used to create the mesh
  121263. * @param scene defines the hosting scene
  121264. * @returns the extruded shape mesh
  121265. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  121266. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  121267. */
  121268. static ExtrudeShape(name: string, options: {
  121269. shape: Vector3[];
  121270. path: Vector3[];
  121271. scale?: number;
  121272. rotation?: number;
  121273. cap?: number;
  121274. updatable?: boolean;
  121275. sideOrientation?: number;
  121276. frontUVs?: Vector4;
  121277. backUVs?: Vector4;
  121278. instance?: Mesh;
  121279. invertUV?: boolean;
  121280. }, scene?: Nullable<Scene>): Mesh;
  121281. /**
  121282. * Creates an custom extruded shape mesh.
  121283. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  121284. * * 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.
  121285. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  121286. * * 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
  121287. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  121288. * * 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
  121289. * * It must returns a float value that will be the scale value applied to the shape on each path point
  121290. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  121291. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  121292. * * 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
  121293. * * 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
  121294. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  121295. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121296. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121297. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  121298. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121299. * @param name defines the name of the mesh
  121300. * @param options defines the options used to create the mesh
  121301. * @param scene defines the hosting scene
  121302. * @returns the custom extruded shape mesh
  121303. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  121304. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  121305. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  121306. */
  121307. static ExtrudeShapeCustom(name: string, options: {
  121308. shape: Vector3[];
  121309. path: Vector3[];
  121310. scaleFunction?: any;
  121311. rotationFunction?: any;
  121312. ribbonCloseArray?: boolean;
  121313. ribbonClosePath?: boolean;
  121314. cap?: number;
  121315. updatable?: boolean;
  121316. sideOrientation?: number;
  121317. frontUVs?: Vector4;
  121318. backUVs?: Vector4;
  121319. instance?: Mesh;
  121320. invertUV?: boolean;
  121321. }, scene?: Nullable<Scene>): Mesh;
  121322. /**
  121323. * Creates lathe mesh.
  121324. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  121325. * * 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
  121326. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  121327. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  121328. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  121329. * * 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
  121330. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  121331. * * 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
  121332. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121333. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121334. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  121335. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121336. * @param name defines the name of the mesh
  121337. * @param options defines the options used to create the mesh
  121338. * @param scene defines the hosting scene
  121339. * @returns the lathe mesh
  121340. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  121341. */
  121342. static CreateLathe(name: string, options: {
  121343. shape: Vector3[];
  121344. radius?: number;
  121345. tessellation?: number;
  121346. clip?: number;
  121347. arc?: number;
  121348. closed?: boolean;
  121349. updatable?: boolean;
  121350. sideOrientation?: number;
  121351. frontUVs?: Vector4;
  121352. backUVs?: Vector4;
  121353. cap?: number;
  121354. invertUV?: boolean;
  121355. }, scene?: Nullable<Scene>): Mesh;
  121356. /**
  121357. * Creates a tiled plane mesh
  121358. * * You can set a limited pattern arrangement with the tiles
  121359. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121360. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121361. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121362. * @param name defines the name of the mesh
  121363. * @param options defines the options used to create the mesh
  121364. * @param scene defines the hosting scene
  121365. * @returns the plane mesh
  121366. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  121367. */
  121368. static CreateTiledPlane(name: string, options: {
  121369. pattern?: number;
  121370. tileSize?: number;
  121371. tileWidth?: number;
  121372. tileHeight?: number;
  121373. size?: number;
  121374. width?: number;
  121375. height?: number;
  121376. alignHorizontal?: number;
  121377. alignVertical?: number;
  121378. sideOrientation?: number;
  121379. frontUVs?: Vector4;
  121380. backUVs?: Vector4;
  121381. updatable?: boolean;
  121382. }, scene?: Nullable<Scene>): Mesh;
  121383. /**
  121384. * Creates a plane mesh
  121385. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  121386. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  121387. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  121388. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121389. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121390. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121391. * @param name defines the name of the mesh
  121392. * @param options defines the options used to create the mesh
  121393. * @param scene defines the hosting scene
  121394. * @returns the plane mesh
  121395. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  121396. */
  121397. static CreatePlane(name: string, options: {
  121398. size?: number;
  121399. width?: number;
  121400. height?: number;
  121401. sideOrientation?: number;
  121402. frontUVs?: Vector4;
  121403. backUVs?: Vector4;
  121404. updatable?: boolean;
  121405. sourcePlane?: Plane;
  121406. }, scene?: Nullable<Scene>): Mesh;
  121407. /**
  121408. * Creates a ground mesh
  121409. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  121410. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  121411. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121412. * @param name defines the name of the mesh
  121413. * @param options defines the options used to create the mesh
  121414. * @param scene defines the hosting scene
  121415. * @returns the ground mesh
  121416. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  121417. */
  121418. static CreateGround(name: string, options: {
  121419. width?: number;
  121420. height?: number;
  121421. subdivisions?: number;
  121422. subdivisionsX?: number;
  121423. subdivisionsY?: number;
  121424. updatable?: boolean;
  121425. }, scene?: Nullable<Scene>): Mesh;
  121426. /**
  121427. * Creates a tiled ground mesh
  121428. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  121429. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  121430. * * 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
  121431. * * 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
  121432. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121433. * @param name defines the name of the mesh
  121434. * @param options defines the options used to create the mesh
  121435. * @param scene defines the hosting scene
  121436. * @returns the tiled ground mesh
  121437. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  121438. */
  121439. static CreateTiledGround(name: string, options: {
  121440. xmin: number;
  121441. zmin: number;
  121442. xmax: number;
  121443. zmax: number;
  121444. subdivisions?: {
  121445. w: number;
  121446. h: number;
  121447. };
  121448. precision?: {
  121449. w: number;
  121450. h: number;
  121451. };
  121452. updatable?: boolean;
  121453. }, scene?: Nullable<Scene>): Mesh;
  121454. /**
  121455. * Creates a ground mesh from a height map
  121456. * * The parameter `url` sets the URL of the height map image resource.
  121457. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  121458. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  121459. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  121460. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  121461. * * 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.
  121462. * * 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).
  121463. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  121464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  121465. * @param name defines the name of the mesh
  121466. * @param url defines the url to the height map
  121467. * @param options defines the options used to create the mesh
  121468. * @param scene defines the hosting scene
  121469. * @returns the ground mesh
  121470. * @see https://doc.babylonjs.com/babylon101/height_map
  121471. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  121472. */
  121473. static CreateGroundFromHeightMap(name: string, url: string, options: {
  121474. width?: number;
  121475. height?: number;
  121476. subdivisions?: number;
  121477. minHeight?: number;
  121478. maxHeight?: number;
  121479. colorFilter?: Color3;
  121480. alphaFilter?: number;
  121481. updatable?: boolean;
  121482. onReady?: (mesh: GroundMesh) => void;
  121483. }, scene?: Nullable<Scene>): GroundMesh;
  121484. /**
  121485. * Creates a polygon mesh
  121486. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  121487. * * 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
  121488. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  121489. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121490. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  121491. * * Remember you can only change the shape positions, not their number when updating a polygon
  121492. * @param name defines the name of the mesh
  121493. * @param options defines the options used to create the mesh
  121494. * @param scene defines the hosting scene
  121495. * @param earcutInjection can be used to inject your own earcut reference
  121496. * @returns the polygon mesh
  121497. */
  121498. static CreatePolygon(name: string, options: {
  121499. shape: Vector3[];
  121500. holes?: Vector3[][];
  121501. depth?: number;
  121502. faceUV?: Vector4[];
  121503. faceColors?: Color4[];
  121504. updatable?: boolean;
  121505. sideOrientation?: number;
  121506. frontUVs?: Vector4;
  121507. backUVs?: Vector4;
  121508. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  121509. /**
  121510. * Creates an extruded polygon mesh, with depth in the Y direction.
  121511. * * 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)
  121512. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  121513. * @param name defines the name of the mesh
  121514. * @param options defines the options used to create the mesh
  121515. * @param scene defines the hosting scene
  121516. * @param earcutInjection can be used to inject your own earcut reference
  121517. * @returns the polygon mesh
  121518. */
  121519. static ExtrudePolygon(name: string, options: {
  121520. shape: Vector3[];
  121521. holes?: Vector3[][];
  121522. depth?: number;
  121523. faceUV?: Vector4[];
  121524. faceColors?: Color4[];
  121525. updatable?: boolean;
  121526. sideOrientation?: number;
  121527. frontUVs?: Vector4;
  121528. backUVs?: Vector4;
  121529. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  121530. /**
  121531. * Creates a tube mesh.
  121532. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  121533. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  121534. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  121535. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  121536. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  121537. * * 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)
  121538. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  121539. * * 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
  121540. * * 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
  121541. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121542. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121543. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  121544. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121545. * @param name defines the name of the mesh
  121546. * @param options defines the options used to create the mesh
  121547. * @param scene defines the hosting scene
  121548. * @returns the tube mesh
  121549. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  121550. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  121551. */
  121552. static CreateTube(name: string, options: {
  121553. path: Vector3[];
  121554. radius?: number;
  121555. tessellation?: number;
  121556. radiusFunction?: {
  121557. (i: number, distance: number): number;
  121558. };
  121559. cap?: number;
  121560. arc?: number;
  121561. updatable?: boolean;
  121562. sideOrientation?: number;
  121563. frontUVs?: Vector4;
  121564. backUVs?: Vector4;
  121565. instance?: Mesh;
  121566. invertUV?: boolean;
  121567. }, scene?: Nullable<Scene>): Mesh;
  121568. /**
  121569. * Creates a polyhedron mesh
  121570. * * 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
  121571. * * The parameter `size` (positive float, default 1) sets the polygon size
  121572. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  121573. * * 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`
  121574. * * 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
  121575. * * 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)`)
  121576. * * 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
  121577. * * 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
  121578. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121579. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121581. * @param name defines the name of the mesh
  121582. * @param options defines the options used to create the mesh
  121583. * @param scene defines the hosting scene
  121584. * @returns the polyhedron mesh
  121585. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  121586. */
  121587. static CreatePolyhedron(name: string, options: {
  121588. type?: number;
  121589. size?: number;
  121590. sizeX?: number;
  121591. sizeY?: number;
  121592. sizeZ?: number;
  121593. custom?: any;
  121594. faceUV?: Vector4[];
  121595. faceColors?: Color4[];
  121596. flat?: boolean;
  121597. updatable?: boolean;
  121598. sideOrientation?: number;
  121599. frontUVs?: Vector4;
  121600. backUVs?: Vector4;
  121601. }, scene?: Nullable<Scene>): Mesh;
  121602. /**
  121603. * Creates a decal mesh.
  121604. * 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
  121605. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  121606. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  121607. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  121608. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  121609. * @param name defines the name of the mesh
  121610. * @param sourceMesh defines the mesh where the decal must be applied
  121611. * @param options defines the options used to create the mesh
  121612. * @param scene defines the hosting scene
  121613. * @returns the decal mesh
  121614. * @see https://doc.babylonjs.com/how_to/decals
  121615. */
  121616. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  121617. position?: Vector3;
  121618. normal?: Vector3;
  121619. size?: Vector3;
  121620. angle?: number;
  121621. }): Mesh;
  121622. }
  121623. }
  121624. declare module BABYLON {
  121625. /**
  121626. * A simplifier interface for future simplification implementations
  121627. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121628. */
  121629. export interface ISimplifier {
  121630. /**
  121631. * Simplification of a given mesh according to the given settings.
  121632. * Since this requires computation, it is assumed that the function runs async.
  121633. * @param settings The settings of the simplification, including quality and distance
  121634. * @param successCallback A callback that will be called after the mesh was simplified.
  121635. * @param errorCallback in case of an error, this callback will be called. optional.
  121636. */
  121637. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  121638. }
  121639. /**
  121640. * Expected simplification settings.
  121641. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  121642. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121643. */
  121644. export interface ISimplificationSettings {
  121645. /**
  121646. * Gets or sets the expected quality
  121647. */
  121648. quality: number;
  121649. /**
  121650. * Gets or sets the distance when this optimized version should be used
  121651. */
  121652. distance: number;
  121653. /**
  121654. * Gets an already optimized mesh
  121655. */
  121656. optimizeMesh?: boolean;
  121657. }
  121658. /**
  121659. * Class used to specify simplification options
  121660. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121661. */
  121662. export class SimplificationSettings implements ISimplificationSettings {
  121663. /** expected quality */
  121664. quality: number;
  121665. /** distance when this optimized version should be used */
  121666. distance: number;
  121667. /** already optimized mesh */
  121668. optimizeMesh?: boolean | undefined;
  121669. /**
  121670. * Creates a SimplificationSettings
  121671. * @param quality expected quality
  121672. * @param distance distance when this optimized version should be used
  121673. * @param optimizeMesh already optimized mesh
  121674. */
  121675. constructor(
  121676. /** expected quality */
  121677. quality: number,
  121678. /** distance when this optimized version should be used */
  121679. distance: number,
  121680. /** already optimized mesh */
  121681. optimizeMesh?: boolean | undefined);
  121682. }
  121683. /**
  121684. * Interface used to define a simplification task
  121685. */
  121686. export interface ISimplificationTask {
  121687. /**
  121688. * Array of settings
  121689. */
  121690. settings: Array<ISimplificationSettings>;
  121691. /**
  121692. * Simplification type
  121693. */
  121694. simplificationType: SimplificationType;
  121695. /**
  121696. * Mesh to simplify
  121697. */
  121698. mesh: Mesh;
  121699. /**
  121700. * Callback called on success
  121701. */
  121702. successCallback?: () => void;
  121703. /**
  121704. * Defines if parallel processing can be used
  121705. */
  121706. parallelProcessing: boolean;
  121707. }
  121708. /**
  121709. * Queue used to order the simplification tasks
  121710. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121711. */
  121712. export class SimplificationQueue {
  121713. private _simplificationArray;
  121714. /**
  121715. * Gets a boolean indicating that the process is still running
  121716. */
  121717. running: boolean;
  121718. /**
  121719. * Creates a new queue
  121720. */
  121721. constructor();
  121722. /**
  121723. * Adds a new simplification task
  121724. * @param task defines a task to add
  121725. */
  121726. addTask(task: ISimplificationTask): void;
  121727. /**
  121728. * Execute next task
  121729. */
  121730. executeNext(): void;
  121731. /**
  121732. * Execute a simplification task
  121733. * @param task defines the task to run
  121734. */
  121735. runSimplification(task: ISimplificationTask): void;
  121736. private getSimplifier;
  121737. }
  121738. /**
  121739. * The implemented types of simplification
  121740. * At the moment only Quadratic Error Decimation is implemented
  121741. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121742. */
  121743. export enum SimplificationType {
  121744. /** Quadratic error decimation */
  121745. QUADRATIC = 0
  121746. }
  121747. }
  121748. declare module BABYLON {
  121749. interface Scene {
  121750. /** @hidden (Backing field) */
  121751. _simplificationQueue: SimplificationQueue;
  121752. /**
  121753. * Gets or sets the simplification queue attached to the scene
  121754. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  121755. */
  121756. simplificationQueue: SimplificationQueue;
  121757. }
  121758. interface Mesh {
  121759. /**
  121760. * Simplify the mesh according to the given array of settings.
  121761. * Function will return immediately and will simplify async
  121762. * @param settings a collection of simplification settings
  121763. * @param parallelProcessing should all levels calculate parallel or one after the other
  121764. * @param simplificationType the type of simplification to run
  121765. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  121766. * @returns the current mesh
  121767. */
  121768. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  121769. }
  121770. /**
  121771. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  121772. * created in a scene
  121773. */
  121774. export class SimplicationQueueSceneComponent implements ISceneComponent {
  121775. /**
  121776. * The component name helpfull to identify the component in the list of scene components.
  121777. */
  121778. readonly name: string;
  121779. /**
  121780. * The scene the component belongs to.
  121781. */
  121782. scene: Scene;
  121783. /**
  121784. * Creates a new instance of the component for the given scene
  121785. * @param scene Defines the scene to register the component in
  121786. */
  121787. constructor(scene: Scene);
  121788. /**
  121789. * Registers the component in a given scene
  121790. */
  121791. register(): void;
  121792. /**
  121793. * Rebuilds the elements related to this component in case of
  121794. * context lost for instance.
  121795. */
  121796. rebuild(): void;
  121797. /**
  121798. * Disposes the component and the associated ressources
  121799. */
  121800. dispose(): void;
  121801. private _beforeCameraUpdate;
  121802. }
  121803. }
  121804. declare module BABYLON {
  121805. /**
  121806. * Navigation plugin interface to add navigation constrained by a navigation mesh
  121807. */
  121808. export interface INavigationEnginePlugin {
  121809. /**
  121810. * plugin name
  121811. */
  121812. name: string;
  121813. /**
  121814. * Creates a navigation mesh
  121815. * @param meshes array of all the geometry used to compute the navigatio mesh
  121816. * @param parameters bunch of parameters used to filter geometry
  121817. */
  121818. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  121819. /**
  121820. * Create a navigation mesh debug mesh
  121821. * @param scene is where the mesh will be added
  121822. * @returns debug display mesh
  121823. */
  121824. createDebugNavMesh(scene: Scene): Mesh;
  121825. /**
  121826. * Get a navigation mesh constrained position, closest to the parameter position
  121827. * @param position world position
  121828. * @returns the closest point to position constrained by the navigation mesh
  121829. */
  121830. getClosestPoint(position: Vector3): Vector3;
  121831. /**
  121832. * Get a navigation mesh constrained position, within a particular radius
  121833. * @param position world position
  121834. * @param maxRadius the maximum distance to the constrained world position
  121835. * @returns the closest point to position constrained by the navigation mesh
  121836. */
  121837. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  121838. /**
  121839. * Compute the final position from a segment made of destination-position
  121840. * @param position world position
  121841. * @param destination world position
  121842. * @returns the resulting point along the navmesh
  121843. */
  121844. moveAlong(position: Vector3, destination: Vector3): Vector3;
  121845. /**
  121846. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  121847. * @param start world position
  121848. * @param end world position
  121849. * @returns array containing world position composing the path
  121850. */
  121851. computePath(start: Vector3, end: Vector3): Vector3[];
  121852. /**
  121853. * If this plugin is supported
  121854. * @returns true if plugin is supported
  121855. */
  121856. isSupported(): boolean;
  121857. /**
  121858. * Create a new Crowd so you can add agents
  121859. * @param maxAgents the maximum agent count in the crowd
  121860. * @param maxAgentRadius the maximum radius an agent can have
  121861. * @param scene to attach the crowd to
  121862. * @returns the crowd you can add agents to
  121863. */
  121864. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  121865. /**
  121866. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  121867. * The queries will try to find a solution within those bounds
  121868. * default is (1,1,1)
  121869. * @param extent x,y,z value that define the extent around the queries point of reference
  121870. */
  121871. setDefaultQueryExtent(extent: Vector3): void;
  121872. /**
  121873. * Get the Bounding box extent specified by setDefaultQueryExtent
  121874. * @returns the box extent values
  121875. */
  121876. getDefaultQueryExtent(): Vector3;
  121877. /**
  121878. * Release all resources
  121879. */
  121880. dispose(): void;
  121881. }
  121882. /**
  121883. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  121884. */
  121885. export interface ICrowd {
  121886. /**
  121887. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  121888. * You can attach anything to that node. The node position is updated in the scene update tick.
  121889. * @param pos world position that will be constrained by the navigation mesh
  121890. * @param parameters agent parameters
  121891. * @param transform hooked to the agent that will be update by the scene
  121892. * @returns agent index
  121893. */
  121894. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  121895. /**
  121896. * Returns the agent position in world space
  121897. * @param index agent index returned by addAgent
  121898. * @returns world space position
  121899. */
  121900. getAgentPosition(index: number): Vector3;
  121901. /**
  121902. * Gets the agent velocity in world space
  121903. * @param index agent index returned by addAgent
  121904. * @returns world space velocity
  121905. */
  121906. getAgentVelocity(index: number): Vector3;
  121907. /**
  121908. * remove a particular agent previously created
  121909. * @param index agent index returned by addAgent
  121910. */
  121911. removeAgent(index: number): void;
  121912. /**
  121913. * get the list of all agents attached to this crowd
  121914. * @returns list of agent indices
  121915. */
  121916. getAgents(): number[];
  121917. /**
  121918. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  121919. * @param deltaTime in seconds
  121920. */
  121921. update(deltaTime: number): void;
  121922. /**
  121923. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  121924. * @param index agent index returned by addAgent
  121925. * @param destination targeted world position
  121926. */
  121927. agentGoto(index: number, destination: Vector3): void;
  121928. /**
  121929. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  121930. * The queries will try to find a solution within those bounds
  121931. * default is (1,1,1)
  121932. * @param extent x,y,z value that define the extent around the queries point of reference
  121933. */
  121934. setDefaultQueryExtent(extent: Vector3): void;
  121935. /**
  121936. * Get the Bounding box extent specified by setDefaultQueryExtent
  121937. * @returns the box extent values
  121938. */
  121939. getDefaultQueryExtent(): Vector3;
  121940. /**
  121941. * Release all resources
  121942. */
  121943. dispose(): void;
  121944. }
  121945. /**
  121946. * Configures an agent
  121947. */
  121948. export interface IAgentParameters {
  121949. /**
  121950. * Agent radius. [Limit: >= 0]
  121951. */
  121952. radius: number;
  121953. /**
  121954. * Agent height. [Limit: > 0]
  121955. */
  121956. height: number;
  121957. /**
  121958. * Maximum allowed acceleration. [Limit: >= 0]
  121959. */
  121960. maxAcceleration: number;
  121961. /**
  121962. * Maximum allowed speed. [Limit: >= 0]
  121963. */
  121964. maxSpeed: number;
  121965. /**
  121966. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  121967. */
  121968. collisionQueryRange: number;
  121969. /**
  121970. * The path visibility optimization range. [Limit: > 0]
  121971. */
  121972. pathOptimizationRange: number;
  121973. /**
  121974. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  121975. */
  121976. separationWeight: number;
  121977. }
  121978. /**
  121979. * Configures the navigation mesh creation
  121980. */
  121981. export interface INavMeshParameters {
  121982. /**
  121983. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  121984. */
  121985. cs: number;
  121986. /**
  121987. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  121988. */
  121989. ch: number;
  121990. /**
  121991. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  121992. */
  121993. walkableSlopeAngle: number;
  121994. /**
  121995. * Minimum floor to 'ceiling' height that will still allow the floor area to
  121996. * be considered walkable. [Limit: >= 3] [Units: vx]
  121997. */
  121998. walkableHeight: number;
  121999. /**
  122000. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  122001. */
  122002. walkableClimb: number;
  122003. /**
  122004. * The distance to erode/shrink the walkable area of the heightfield away from
  122005. * obstructions. [Limit: >=0] [Units: vx]
  122006. */
  122007. walkableRadius: number;
  122008. /**
  122009. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  122010. */
  122011. maxEdgeLen: number;
  122012. /**
  122013. * The maximum distance a simplfied contour's border edges should deviate
  122014. * the original raw contour. [Limit: >=0] [Units: vx]
  122015. */
  122016. maxSimplificationError: number;
  122017. /**
  122018. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  122019. */
  122020. minRegionArea: number;
  122021. /**
  122022. * Any regions with a span count smaller than this value will, if possible,
  122023. * be merged with larger regions. [Limit: >=0] [Units: vx]
  122024. */
  122025. mergeRegionArea: number;
  122026. /**
  122027. * The maximum number of vertices allowed for polygons generated during the
  122028. * contour to polygon conversion process. [Limit: >= 3]
  122029. */
  122030. maxVertsPerPoly: number;
  122031. /**
  122032. * Sets the sampling distance to use when generating the detail mesh.
  122033. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  122034. */
  122035. detailSampleDist: number;
  122036. /**
  122037. * The maximum distance the detail mesh surface should deviate from heightfield
  122038. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  122039. */
  122040. detailSampleMaxError: number;
  122041. }
  122042. }
  122043. declare module BABYLON {
  122044. /**
  122045. * RecastJS navigation plugin
  122046. */
  122047. export class RecastJSPlugin implements INavigationEnginePlugin {
  122048. /**
  122049. * Reference to the Recast library
  122050. */
  122051. bjsRECAST: any;
  122052. /**
  122053. * plugin name
  122054. */
  122055. name: string;
  122056. /**
  122057. * the first navmesh created. We might extend this to support multiple navmeshes
  122058. */
  122059. navMesh: any;
  122060. /**
  122061. * Initializes the recastJS plugin
  122062. * @param recastInjection can be used to inject your own recast reference
  122063. */
  122064. constructor(recastInjection?: any);
  122065. /**
  122066. * Creates a navigation mesh
  122067. * @param meshes array of all the geometry used to compute the navigatio mesh
  122068. * @param parameters bunch of parameters used to filter geometry
  122069. */
  122070. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  122071. /**
  122072. * Create a navigation mesh debug mesh
  122073. * @param scene is where the mesh will be added
  122074. * @returns debug display mesh
  122075. */
  122076. createDebugNavMesh(scene: Scene): Mesh;
  122077. /**
  122078. * Get a navigation mesh constrained position, closest to the parameter position
  122079. * @param position world position
  122080. * @returns the closest point to position constrained by the navigation mesh
  122081. */
  122082. getClosestPoint(position: Vector3): Vector3;
  122083. /**
  122084. * Get a navigation mesh constrained position, within a particular radius
  122085. * @param position world position
  122086. * @param maxRadius the maximum distance to the constrained world position
  122087. * @returns the closest point to position constrained by the navigation mesh
  122088. */
  122089. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  122090. /**
  122091. * Compute the final position from a segment made of destination-position
  122092. * @param position world position
  122093. * @param destination world position
  122094. * @returns the resulting point along the navmesh
  122095. */
  122096. moveAlong(position: Vector3, destination: Vector3): Vector3;
  122097. /**
  122098. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  122099. * @param start world position
  122100. * @param end world position
  122101. * @returns array containing world position composing the path
  122102. */
  122103. computePath(start: Vector3, end: Vector3): Vector3[];
  122104. /**
  122105. * Create a new Crowd so you can add agents
  122106. * @param maxAgents the maximum agent count in the crowd
  122107. * @param maxAgentRadius the maximum radius an agent can have
  122108. * @param scene to attach the crowd to
  122109. * @returns the crowd you can add agents to
  122110. */
  122111. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  122112. /**
  122113. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  122114. * The queries will try to find a solution within those bounds
  122115. * default is (1,1,1)
  122116. * @param extent x,y,z value that define the extent around the queries point of reference
  122117. */
  122118. setDefaultQueryExtent(extent: Vector3): void;
  122119. /**
  122120. * Get the Bounding box extent specified by setDefaultQueryExtent
  122121. * @returns the box extent values
  122122. */
  122123. getDefaultQueryExtent(): Vector3;
  122124. /**
  122125. * Disposes
  122126. */
  122127. dispose(): void;
  122128. /**
  122129. * If this plugin is supported
  122130. * @returns true if plugin is supported
  122131. */
  122132. isSupported(): boolean;
  122133. }
  122134. /**
  122135. * Recast detour crowd implementation
  122136. */
  122137. export class RecastJSCrowd implements ICrowd {
  122138. /**
  122139. * Recast/detour plugin
  122140. */
  122141. bjsRECASTPlugin: RecastJSPlugin;
  122142. /**
  122143. * Link to the detour crowd
  122144. */
  122145. recastCrowd: any;
  122146. /**
  122147. * One transform per agent
  122148. */
  122149. transforms: TransformNode[];
  122150. /**
  122151. * All agents created
  122152. */
  122153. agents: number[];
  122154. /**
  122155. * Link to the scene is kept to unregister the crowd from the scene
  122156. */
  122157. private _scene;
  122158. /**
  122159. * Observer for crowd updates
  122160. */
  122161. private _onBeforeAnimationsObserver;
  122162. /**
  122163. * Constructor
  122164. * @param plugin recastJS plugin
  122165. * @param maxAgents the maximum agent count in the crowd
  122166. * @param maxAgentRadius the maximum radius an agent can have
  122167. * @param scene to attach the crowd to
  122168. * @returns the crowd you can add agents to
  122169. */
  122170. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  122171. /**
  122172. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  122173. * You can attach anything to that node. The node position is updated in the scene update tick.
  122174. * @param pos world position that will be constrained by the navigation mesh
  122175. * @param parameters agent parameters
  122176. * @param transform hooked to the agent that will be update by the scene
  122177. * @returns agent index
  122178. */
  122179. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  122180. /**
  122181. * Returns the agent position in world space
  122182. * @param index agent index returned by addAgent
  122183. * @returns world space position
  122184. */
  122185. getAgentPosition(index: number): Vector3;
  122186. /**
  122187. * Returns the agent velocity in world space
  122188. * @param index agent index returned by addAgent
  122189. * @returns world space velocity
  122190. */
  122191. getAgentVelocity(index: number): Vector3;
  122192. /**
  122193. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  122194. * @param index agent index returned by addAgent
  122195. * @param destination targeted world position
  122196. */
  122197. agentGoto(index: number, destination: Vector3): void;
  122198. /**
  122199. * remove a particular agent previously created
  122200. * @param index agent index returned by addAgent
  122201. */
  122202. removeAgent(index: number): void;
  122203. /**
  122204. * get the list of all agents attached to this crowd
  122205. * @returns list of agent indices
  122206. */
  122207. getAgents(): number[];
  122208. /**
  122209. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  122210. * @param deltaTime in seconds
  122211. */
  122212. update(deltaTime: number): void;
  122213. /**
  122214. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  122215. * The queries will try to find a solution within those bounds
  122216. * default is (1,1,1)
  122217. * @param extent x,y,z value that define the extent around the queries point of reference
  122218. */
  122219. setDefaultQueryExtent(extent: Vector3): void;
  122220. /**
  122221. * Get the Bounding box extent specified by setDefaultQueryExtent
  122222. * @returns the box extent values
  122223. */
  122224. getDefaultQueryExtent(): Vector3;
  122225. /**
  122226. * Release all resources
  122227. */
  122228. dispose(): void;
  122229. }
  122230. }
  122231. declare module BABYLON {
  122232. /**
  122233. * Class used to enable access to IndexedDB
  122234. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  122235. */
  122236. export class Database implements IOfflineProvider {
  122237. private _callbackManifestChecked;
  122238. private _currentSceneUrl;
  122239. private _db;
  122240. private _enableSceneOffline;
  122241. private _enableTexturesOffline;
  122242. private _manifestVersionFound;
  122243. private _mustUpdateRessources;
  122244. private _hasReachedQuota;
  122245. private _isSupported;
  122246. private _idbFactory;
  122247. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  122248. private static IsUASupportingBlobStorage;
  122249. /**
  122250. * Gets a boolean indicating if Database storate is enabled (off by default)
  122251. */
  122252. static IDBStorageEnabled: boolean;
  122253. /**
  122254. * Gets a boolean indicating if scene must be saved in the database
  122255. */
  122256. readonly enableSceneOffline: boolean;
  122257. /**
  122258. * Gets a boolean indicating if textures must be saved in the database
  122259. */
  122260. readonly enableTexturesOffline: boolean;
  122261. /**
  122262. * Creates a new Database
  122263. * @param urlToScene defines the url to load the scene
  122264. * @param callbackManifestChecked defines the callback to use when manifest is checked
  122265. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  122266. */
  122267. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  122268. private static _ParseURL;
  122269. private static _ReturnFullUrlLocation;
  122270. private _checkManifestFile;
  122271. /**
  122272. * Open the database and make it available
  122273. * @param successCallback defines the callback to call on success
  122274. * @param errorCallback defines the callback to call on error
  122275. */
  122276. open(successCallback: () => void, errorCallback: () => void): void;
  122277. /**
  122278. * Loads an image from the database
  122279. * @param url defines the url to load from
  122280. * @param image defines the target DOM image
  122281. */
  122282. loadImage(url: string, image: HTMLImageElement): void;
  122283. private _loadImageFromDBAsync;
  122284. private _saveImageIntoDBAsync;
  122285. private _checkVersionFromDB;
  122286. private _loadVersionFromDBAsync;
  122287. private _saveVersionIntoDBAsync;
  122288. /**
  122289. * Loads a file from database
  122290. * @param url defines the URL to load from
  122291. * @param sceneLoaded defines a callback to call on success
  122292. * @param progressCallBack defines a callback to call when progress changed
  122293. * @param errorCallback defines a callback to call on error
  122294. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  122295. */
  122296. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  122297. private _loadFileAsync;
  122298. private _saveFileAsync;
  122299. /**
  122300. * Validates if xhr data is correct
  122301. * @param xhr defines the request to validate
  122302. * @param dataType defines the expected data type
  122303. * @returns true if data is correct
  122304. */
  122305. private static _ValidateXHRData;
  122306. }
  122307. }
  122308. declare module BABYLON {
  122309. /** @hidden */
  122310. export var gpuUpdateParticlesPixelShader: {
  122311. name: string;
  122312. shader: string;
  122313. };
  122314. }
  122315. declare module BABYLON {
  122316. /** @hidden */
  122317. export var gpuUpdateParticlesVertexShader: {
  122318. name: string;
  122319. shader: string;
  122320. };
  122321. }
  122322. declare module BABYLON {
  122323. /** @hidden */
  122324. export var clipPlaneFragmentDeclaration2: {
  122325. name: string;
  122326. shader: string;
  122327. };
  122328. }
  122329. declare module BABYLON {
  122330. /** @hidden */
  122331. export var gpuRenderParticlesPixelShader: {
  122332. name: string;
  122333. shader: string;
  122334. };
  122335. }
  122336. declare module BABYLON {
  122337. /** @hidden */
  122338. export var clipPlaneVertexDeclaration2: {
  122339. name: string;
  122340. shader: string;
  122341. };
  122342. }
  122343. declare module BABYLON {
  122344. /** @hidden */
  122345. export var gpuRenderParticlesVertexShader: {
  122346. name: string;
  122347. shader: string;
  122348. };
  122349. }
  122350. declare module BABYLON {
  122351. /**
  122352. * This represents a GPU particle system in Babylon
  122353. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  122354. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  122355. */
  122356. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  122357. /**
  122358. * The layer mask we are rendering the particles through.
  122359. */
  122360. layerMask: number;
  122361. private _capacity;
  122362. private _activeCount;
  122363. private _currentActiveCount;
  122364. private _accumulatedCount;
  122365. private _renderEffect;
  122366. private _updateEffect;
  122367. private _buffer0;
  122368. private _buffer1;
  122369. private _spriteBuffer;
  122370. private _updateVAO;
  122371. private _renderVAO;
  122372. private _targetIndex;
  122373. private _sourceBuffer;
  122374. private _targetBuffer;
  122375. private _engine;
  122376. private _currentRenderId;
  122377. private _started;
  122378. private _stopped;
  122379. private _timeDelta;
  122380. private _randomTexture;
  122381. private _randomTexture2;
  122382. private _attributesStrideSize;
  122383. private _updateEffectOptions;
  122384. private _randomTextureSize;
  122385. private _actualFrame;
  122386. private readonly _rawTextureWidth;
  122387. /**
  122388. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  122389. */
  122390. static readonly IsSupported: boolean;
  122391. /**
  122392. * An event triggered when the system is disposed.
  122393. */
  122394. onDisposeObservable: Observable<GPUParticleSystem>;
  122395. /**
  122396. * Gets the maximum number of particles active at the same time.
  122397. * @returns The max number of active particles.
  122398. */
  122399. getCapacity(): number;
  122400. /**
  122401. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  122402. * to override the particles.
  122403. */
  122404. forceDepthWrite: boolean;
  122405. /**
  122406. * Gets or set the number of active particles
  122407. */
  122408. activeParticleCount: number;
  122409. private _preWarmDone;
  122410. /**
  122411. * Is this system ready to be used/rendered
  122412. * @return true if the system is ready
  122413. */
  122414. isReady(): boolean;
  122415. /**
  122416. * Gets if the system has been started. (Note: this will still be true after stop is called)
  122417. * @returns True if it has been started, otherwise false.
  122418. */
  122419. isStarted(): boolean;
  122420. /**
  122421. * Starts the particle system and begins to emit
  122422. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  122423. */
  122424. start(delay?: number): void;
  122425. /**
  122426. * Stops the particle system.
  122427. */
  122428. stop(): void;
  122429. /**
  122430. * Remove all active particles
  122431. */
  122432. reset(): void;
  122433. /**
  122434. * Returns the string "GPUParticleSystem"
  122435. * @returns a string containing the class name
  122436. */
  122437. getClassName(): string;
  122438. private _colorGradientsTexture;
  122439. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  122440. /**
  122441. * Adds a new color gradient
  122442. * @param gradient defines the gradient to use (between 0 and 1)
  122443. * @param color1 defines the color to affect to the specified gradient
  122444. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  122445. * @returns the current particle system
  122446. */
  122447. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  122448. /**
  122449. * Remove a specific color gradient
  122450. * @param gradient defines the gradient to remove
  122451. * @returns the current particle system
  122452. */
  122453. removeColorGradient(gradient: number): GPUParticleSystem;
  122454. private _angularSpeedGradientsTexture;
  122455. private _sizeGradientsTexture;
  122456. private _velocityGradientsTexture;
  122457. private _limitVelocityGradientsTexture;
  122458. private _dragGradientsTexture;
  122459. private _addFactorGradient;
  122460. /**
  122461. * Adds a new size gradient
  122462. * @param gradient defines the gradient to use (between 0 and 1)
  122463. * @param factor defines the size factor to affect to the specified gradient
  122464. * @returns the current particle system
  122465. */
  122466. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  122467. /**
  122468. * Remove a specific size gradient
  122469. * @param gradient defines the gradient to remove
  122470. * @returns the current particle system
  122471. */
  122472. removeSizeGradient(gradient: number): GPUParticleSystem;
  122473. /**
  122474. * Adds a new angular speed gradient
  122475. * @param gradient defines the gradient to use (between 0 and 1)
  122476. * @param factor defines the angular speed to affect to the specified gradient
  122477. * @returns the current particle system
  122478. */
  122479. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  122480. /**
  122481. * Remove a specific angular speed gradient
  122482. * @param gradient defines the gradient to remove
  122483. * @returns the current particle system
  122484. */
  122485. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  122486. /**
  122487. * Adds a new velocity gradient
  122488. * @param gradient defines the gradient to use (between 0 and 1)
  122489. * @param factor defines the velocity to affect to the specified gradient
  122490. * @returns the current particle system
  122491. */
  122492. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  122493. /**
  122494. * Remove a specific velocity gradient
  122495. * @param gradient defines the gradient to remove
  122496. * @returns the current particle system
  122497. */
  122498. removeVelocityGradient(gradient: number): GPUParticleSystem;
  122499. /**
  122500. * Adds a new limit velocity gradient
  122501. * @param gradient defines the gradient to use (between 0 and 1)
  122502. * @param factor defines the limit velocity value to affect to the specified gradient
  122503. * @returns the current particle system
  122504. */
  122505. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  122506. /**
  122507. * Remove a specific limit velocity gradient
  122508. * @param gradient defines the gradient to remove
  122509. * @returns the current particle system
  122510. */
  122511. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  122512. /**
  122513. * Adds a new drag gradient
  122514. * @param gradient defines the gradient to use (between 0 and 1)
  122515. * @param factor defines the drag value to affect to the specified gradient
  122516. * @returns the current particle system
  122517. */
  122518. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  122519. /**
  122520. * Remove a specific drag gradient
  122521. * @param gradient defines the gradient to remove
  122522. * @returns the current particle system
  122523. */
  122524. removeDragGradient(gradient: number): GPUParticleSystem;
  122525. /**
  122526. * Not supported by GPUParticleSystem
  122527. * @param gradient defines the gradient to use (between 0 and 1)
  122528. * @param factor defines the emit rate value to affect to the specified gradient
  122529. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  122530. * @returns the current particle system
  122531. */
  122532. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  122533. /**
  122534. * Not supported by GPUParticleSystem
  122535. * @param gradient defines the gradient to remove
  122536. * @returns the current particle system
  122537. */
  122538. removeEmitRateGradient(gradient: number): IParticleSystem;
  122539. /**
  122540. * Not supported by GPUParticleSystem
  122541. * @param gradient defines the gradient to use (between 0 and 1)
  122542. * @param factor defines the start size value to affect to the specified gradient
  122543. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  122544. * @returns the current particle system
  122545. */
  122546. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  122547. /**
  122548. * Not supported by GPUParticleSystem
  122549. * @param gradient defines the gradient to remove
  122550. * @returns the current particle system
  122551. */
  122552. removeStartSizeGradient(gradient: number): IParticleSystem;
  122553. /**
  122554. * Not supported by GPUParticleSystem
  122555. * @param gradient defines the gradient to use (between 0 and 1)
  122556. * @param min defines the color remap minimal range
  122557. * @param max defines the color remap maximal range
  122558. * @returns the current particle system
  122559. */
  122560. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  122561. /**
  122562. * Not supported by GPUParticleSystem
  122563. * @param gradient defines the gradient to remove
  122564. * @returns the current particle system
  122565. */
  122566. removeColorRemapGradient(): IParticleSystem;
  122567. /**
  122568. * Not supported by GPUParticleSystem
  122569. * @param gradient defines the gradient to use (between 0 and 1)
  122570. * @param min defines the alpha remap minimal range
  122571. * @param max defines the alpha remap maximal range
  122572. * @returns the current particle system
  122573. */
  122574. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  122575. /**
  122576. * Not supported by GPUParticleSystem
  122577. * @param gradient defines the gradient to remove
  122578. * @returns the current particle system
  122579. */
  122580. removeAlphaRemapGradient(): IParticleSystem;
  122581. /**
  122582. * Not supported by GPUParticleSystem
  122583. * @param gradient defines the gradient to use (between 0 and 1)
  122584. * @param color defines the color to affect to the specified gradient
  122585. * @returns the current particle system
  122586. */
  122587. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  122588. /**
  122589. * Not supported by GPUParticleSystem
  122590. * @param gradient defines the gradient to remove
  122591. * @returns the current particle system
  122592. */
  122593. removeRampGradient(): IParticleSystem;
  122594. /**
  122595. * Not supported by GPUParticleSystem
  122596. * @returns the list of ramp gradients
  122597. */
  122598. getRampGradients(): Nullable<Array<Color3Gradient>>;
  122599. /**
  122600. * Not supported by GPUParticleSystem
  122601. * Gets or sets a boolean indicating that ramp gradients must be used
  122602. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  122603. */
  122604. useRampGradients: boolean;
  122605. /**
  122606. * Not supported by GPUParticleSystem
  122607. * @param gradient defines the gradient to use (between 0 and 1)
  122608. * @param factor defines the life time factor to affect to the specified gradient
  122609. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  122610. * @returns the current particle system
  122611. */
  122612. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  122613. /**
  122614. * Not supported by GPUParticleSystem
  122615. * @param gradient defines the gradient to remove
  122616. * @returns the current particle system
  122617. */
  122618. removeLifeTimeGradient(gradient: number): IParticleSystem;
  122619. /**
  122620. * Instantiates a GPU particle system.
  122621. * 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.
  122622. * @param name The name of the particle system
  122623. * @param options The options used to create the system
  122624. * @param scene The scene the particle system belongs to
  122625. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  122626. */
  122627. constructor(name: string, options: Partial<{
  122628. capacity: number;
  122629. randomTextureSize: number;
  122630. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  122631. protected _reset(): void;
  122632. private _createUpdateVAO;
  122633. private _createRenderVAO;
  122634. private _initialize;
  122635. /** @hidden */
  122636. _recreateUpdateEffect(): void;
  122637. /** @hidden */
  122638. _recreateRenderEffect(): void;
  122639. /**
  122640. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  122641. * @param preWarm defines if we are in the pre-warmimg phase
  122642. */
  122643. animate(preWarm?: boolean): void;
  122644. private _createFactorGradientTexture;
  122645. private _createSizeGradientTexture;
  122646. private _createAngularSpeedGradientTexture;
  122647. private _createVelocityGradientTexture;
  122648. private _createLimitVelocityGradientTexture;
  122649. private _createDragGradientTexture;
  122650. private _createColorGradientTexture;
  122651. /**
  122652. * Renders the particle system in its current state
  122653. * @param preWarm defines if the system should only update the particles but not render them
  122654. * @returns the current number of particles
  122655. */
  122656. render(preWarm?: boolean): number;
  122657. /**
  122658. * Rebuilds the particle system
  122659. */
  122660. rebuild(): void;
  122661. private _releaseBuffers;
  122662. private _releaseVAOs;
  122663. /**
  122664. * Disposes the particle system and free the associated resources
  122665. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  122666. */
  122667. dispose(disposeTexture?: boolean): void;
  122668. /**
  122669. * Clones the particle system.
  122670. * @param name The name of the cloned object
  122671. * @param newEmitter The new emitter to use
  122672. * @returns the cloned particle system
  122673. */
  122674. clone(name: string, newEmitter: any): GPUParticleSystem;
  122675. /**
  122676. * Serializes the particle system to a JSON object.
  122677. * @returns the JSON object
  122678. */
  122679. serialize(): any;
  122680. /**
  122681. * Parses a JSON object to create a GPU particle system.
  122682. * @param parsedParticleSystem The JSON object to parse
  122683. * @param scene The scene to create the particle system in
  122684. * @param rootUrl The root url to use to load external dependencies like texture
  122685. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  122686. * @returns the parsed GPU particle system
  122687. */
  122688. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  122689. }
  122690. }
  122691. declare module BABYLON {
  122692. /**
  122693. * Represents a set of particle systems working together to create a specific effect
  122694. */
  122695. export class ParticleSystemSet implements IDisposable {
  122696. private _emitterCreationOptions;
  122697. private _emitterNode;
  122698. /**
  122699. * Gets the particle system list
  122700. */
  122701. systems: IParticleSystem[];
  122702. /**
  122703. * Gets the emitter node used with this set
  122704. */
  122705. readonly emitterNode: Nullable<TransformNode>;
  122706. /**
  122707. * Creates a new emitter mesh as a sphere
  122708. * @param options defines the options used to create the sphere
  122709. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  122710. * @param scene defines the hosting scene
  122711. */
  122712. setEmitterAsSphere(options: {
  122713. diameter: number;
  122714. segments: number;
  122715. color: Color3;
  122716. }, renderingGroupId: number, scene: Scene): void;
  122717. /**
  122718. * Starts all particle systems of the set
  122719. * @param emitter defines an optional mesh to use as emitter for the particle systems
  122720. */
  122721. start(emitter?: AbstractMesh): void;
  122722. /**
  122723. * Release all associated resources
  122724. */
  122725. dispose(): void;
  122726. /**
  122727. * Serialize the set into a JSON compatible object
  122728. * @returns a JSON compatible representation of the set
  122729. */
  122730. serialize(): any;
  122731. /**
  122732. * Parse a new ParticleSystemSet from a serialized source
  122733. * @param data defines a JSON compatible representation of the set
  122734. * @param scene defines the hosting scene
  122735. * @param gpu defines if we want GPU particles or CPU particles
  122736. * @returns a new ParticleSystemSet
  122737. */
  122738. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  122739. }
  122740. }
  122741. declare module BABYLON {
  122742. /**
  122743. * This class is made for on one-liner static method to help creating particle system set.
  122744. */
  122745. export class ParticleHelper {
  122746. /**
  122747. * Gets or sets base Assets URL
  122748. */
  122749. static BaseAssetsUrl: string;
  122750. /**
  122751. * Create a default particle system that you can tweak
  122752. * @param emitter defines the emitter to use
  122753. * @param capacity defines the system capacity (default is 500 particles)
  122754. * @param scene defines the hosting scene
  122755. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  122756. * @returns the new Particle system
  122757. */
  122758. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  122759. /**
  122760. * This is the main static method (one-liner) of this helper to create different particle systems
  122761. * @param type This string represents the type to the particle system to create
  122762. * @param scene The scene where the particle system should live
  122763. * @param gpu If the system will use gpu
  122764. * @returns the ParticleSystemSet created
  122765. */
  122766. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  122767. /**
  122768. * Static function used to export a particle system to a ParticleSystemSet variable.
  122769. * Please note that the emitter shape is not exported
  122770. * @param systems defines the particle systems to export
  122771. * @returns the created particle system set
  122772. */
  122773. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  122774. }
  122775. }
  122776. declare module BABYLON {
  122777. interface Engine {
  122778. /**
  122779. * Create an effect to use with particle systems.
  122780. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  122781. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  122782. * @param uniformsNames defines a list of attribute names
  122783. * @param samplers defines an array of string used to represent textures
  122784. * @param defines defines the string containing the defines to use to compile the shaders
  122785. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  122786. * @param onCompiled defines a function to call when the effect creation is successful
  122787. * @param onError defines a function to call when the effect creation has failed
  122788. * @returns the new Effect
  122789. */
  122790. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  122791. }
  122792. interface Mesh {
  122793. /**
  122794. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  122795. * @returns an array of IParticleSystem
  122796. */
  122797. getEmittedParticleSystems(): IParticleSystem[];
  122798. /**
  122799. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  122800. * @returns an array of IParticleSystem
  122801. */
  122802. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  122803. }
  122804. /**
  122805. * @hidden
  122806. */
  122807. export var _IDoNeedToBeInTheBuild: number;
  122808. }
  122809. declare module BABYLON {
  122810. interface Scene {
  122811. /** @hidden (Backing field) */
  122812. _physicsEngine: Nullable<IPhysicsEngine>;
  122813. /**
  122814. * Gets the current physics engine
  122815. * @returns a IPhysicsEngine or null if none attached
  122816. */
  122817. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  122818. /**
  122819. * Enables physics to the current scene
  122820. * @param gravity defines the scene's gravity for the physics engine
  122821. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  122822. * @return a boolean indicating if the physics engine was initialized
  122823. */
  122824. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  122825. /**
  122826. * Disables and disposes the physics engine associated with the scene
  122827. */
  122828. disablePhysicsEngine(): void;
  122829. /**
  122830. * Gets a boolean indicating if there is an active physics engine
  122831. * @returns a boolean indicating if there is an active physics engine
  122832. */
  122833. isPhysicsEnabled(): boolean;
  122834. /**
  122835. * Deletes a physics compound impostor
  122836. * @param compound defines the compound to delete
  122837. */
  122838. deleteCompoundImpostor(compound: any): void;
  122839. /**
  122840. * An event triggered when physic simulation is about to be run
  122841. */
  122842. onBeforePhysicsObservable: Observable<Scene>;
  122843. /**
  122844. * An event triggered when physic simulation has been done
  122845. */
  122846. onAfterPhysicsObservable: Observable<Scene>;
  122847. }
  122848. interface AbstractMesh {
  122849. /** @hidden */
  122850. _physicsImpostor: Nullable<PhysicsImpostor>;
  122851. /**
  122852. * Gets or sets impostor used for physic simulation
  122853. * @see http://doc.babylonjs.com/features/physics_engine
  122854. */
  122855. physicsImpostor: Nullable<PhysicsImpostor>;
  122856. /**
  122857. * Gets the current physics impostor
  122858. * @see http://doc.babylonjs.com/features/physics_engine
  122859. * @returns a physics impostor or null
  122860. */
  122861. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  122862. /** Apply a physic impulse to the mesh
  122863. * @param force defines the force to apply
  122864. * @param contactPoint defines where to apply the force
  122865. * @returns the current mesh
  122866. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  122867. */
  122868. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  122869. /**
  122870. * Creates a physic joint between two meshes
  122871. * @param otherMesh defines the other mesh to use
  122872. * @param pivot1 defines the pivot to use on this mesh
  122873. * @param pivot2 defines the pivot to use on the other mesh
  122874. * @param options defines additional options (can be plugin dependent)
  122875. * @returns the current mesh
  122876. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  122877. */
  122878. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  122879. /** @hidden */
  122880. _disposePhysicsObserver: Nullable<Observer<Node>>;
  122881. }
  122882. /**
  122883. * Defines the physics engine scene component responsible to manage a physics engine
  122884. */
  122885. export class PhysicsEngineSceneComponent implements ISceneComponent {
  122886. /**
  122887. * The component name helpful to identify the component in the list of scene components.
  122888. */
  122889. readonly name: string;
  122890. /**
  122891. * The scene the component belongs to.
  122892. */
  122893. scene: Scene;
  122894. /**
  122895. * Creates a new instance of the component for the given scene
  122896. * @param scene Defines the scene to register the component in
  122897. */
  122898. constructor(scene: Scene);
  122899. /**
  122900. * Registers the component in a given scene
  122901. */
  122902. register(): void;
  122903. /**
  122904. * Rebuilds the elements related to this component in case of
  122905. * context lost for instance.
  122906. */
  122907. rebuild(): void;
  122908. /**
  122909. * Disposes the component and the associated ressources
  122910. */
  122911. dispose(): void;
  122912. }
  122913. }
  122914. declare module BABYLON {
  122915. /**
  122916. * A helper for physics simulations
  122917. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  122918. */
  122919. export class PhysicsHelper {
  122920. private _scene;
  122921. private _physicsEngine;
  122922. /**
  122923. * Initializes the Physics helper
  122924. * @param scene Babylon.js scene
  122925. */
  122926. constructor(scene: Scene);
  122927. /**
  122928. * Applies a radial explosion impulse
  122929. * @param origin the origin of the explosion
  122930. * @param radiusOrEventOptions the radius or the options of radial explosion
  122931. * @param strength the explosion strength
  122932. * @param falloff possible options: Constant & Linear. Defaults to Constant
  122933. * @returns A physics radial explosion event, or null
  122934. */
  122935. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  122936. /**
  122937. * Applies a radial explosion force
  122938. * @param origin the origin of the explosion
  122939. * @param radiusOrEventOptions the radius or the options of radial explosion
  122940. * @param strength the explosion strength
  122941. * @param falloff possible options: Constant & Linear. Defaults to Constant
  122942. * @returns A physics radial explosion event, or null
  122943. */
  122944. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  122945. /**
  122946. * Creates a gravitational field
  122947. * @param origin the origin of the explosion
  122948. * @param radiusOrEventOptions the radius or the options of radial explosion
  122949. * @param strength the explosion strength
  122950. * @param falloff possible options: Constant & Linear. Defaults to Constant
  122951. * @returns A physics gravitational field event, or null
  122952. */
  122953. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  122954. /**
  122955. * Creates a physics updraft event
  122956. * @param origin the origin of the updraft
  122957. * @param radiusOrEventOptions the radius or the options of the updraft
  122958. * @param strength the strength of the updraft
  122959. * @param height the height of the updraft
  122960. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  122961. * @returns A physics updraft event, or null
  122962. */
  122963. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  122964. /**
  122965. * Creates a physics vortex event
  122966. * @param origin the of the vortex
  122967. * @param radiusOrEventOptions the radius or the options of the vortex
  122968. * @param strength the strength of the vortex
  122969. * @param height the height of the vortex
  122970. * @returns a Physics vortex event, or null
  122971. * A physics vortex event or null
  122972. */
  122973. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  122974. }
  122975. /**
  122976. * Represents a physics radial explosion event
  122977. */
  122978. class PhysicsRadialExplosionEvent {
  122979. private _scene;
  122980. private _options;
  122981. private _sphere;
  122982. private _dataFetched;
  122983. /**
  122984. * Initializes a radial explosioin event
  122985. * @param _scene BabylonJS scene
  122986. * @param _options The options for the vortex event
  122987. */
  122988. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  122989. /**
  122990. * Returns the data related to the radial explosion event (sphere).
  122991. * @returns The radial explosion event data
  122992. */
  122993. getData(): PhysicsRadialExplosionEventData;
  122994. /**
  122995. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  122996. * @param impostor A physics imposter
  122997. * @param origin the origin of the explosion
  122998. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  122999. */
  123000. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  123001. /**
  123002. * Triggers affecterd impostors callbacks
  123003. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  123004. */
  123005. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  123006. /**
  123007. * Disposes the sphere.
  123008. * @param force Specifies if the sphere should be disposed by force
  123009. */
  123010. dispose(force?: boolean): void;
  123011. /*** Helpers ***/
  123012. private _prepareSphere;
  123013. private _intersectsWithSphere;
  123014. }
  123015. /**
  123016. * Represents a gravitational field event
  123017. */
  123018. class PhysicsGravitationalFieldEvent {
  123019. private _physicsHelper;
  123020. private _scene;
  123021. private _origin;
  123022. private _options;
  123023. private _tickCallback;
  123024. private _sphere;
  123025. private _dataFetched;
  123026. /**
  123027. * Initializes the physics gravitational field event
  123028. * @param _physicsHelper A physics helper
  123029. * @param _scene BabylonJS scene
  123030. * @param _origin The origin position of the gravitational field event
  123031. * @param _options The options for the vortex event
  123032. */
  123033. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  123034. /**
  123035. * Returns the data related to the gravitational field event (sphere).
  123036. * @returns A gravitational field event
  123037. */
  123038. getData(): PhysicsGravitationalFieldEventData;
  123039. /**
  123040. * Enables the gravitational field.
  123041. */
  123042. enable(): void;
  123043. /**
  123044. * Disables the gravitational field.
  123045. */
  123046. disable(): void;
  123047. /**
  123048. * Disposes the sphere.
  123049. * @param force The force to dispose from the gravitational field event
  123050. */
  123051. dispose(force?: boolean): void;
  123052. private _tick;
  123053. }
  123054. /**
  123055. * Represents a physics updraft event
  123056. */
  123057. class PhysicsUpdraftEvent {
  123058. private _scene;
  123059. private _origin;
  123060. private _options;
  123061. private _physicsEngine;
  123062. private _originTop;
  123063. private _originDirection;
  123064. private _tickCallback;
  123065. private _cylinder;
  123066. private _cylinderPosition;
  123067. private _dataFetched;
  123068. /**
  123069. * Initializes the physics updraft event
  123070. * @param _scene BabylonJS scene
  123071. * @param _origin The origin position of the updraft
  123072. * @param _options The options for the updraft event
  123073. */
  123074. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  123075. /**
  123076. * Returns the data related to the updraft event (cylinder).
  123077. * @returns A physics updraft event
  123078. */
  123079. getData(): PhysicsUpdraftEventData;
  123080. /**
  123081. * Enables the updraft.
  123082. */
  123083. enable(): void;
  123084. /**
  123085. * Disables the updraft.
  123086. */
  123087. disable(): void;
  123088. /**
  123089. * Disposes the cylinder.
  123090. * @param force Specifies if the updraft should be disposed by force
  123091. */
  123092. dispose(force?: boolean): void;
  123093. private getImpostorHitData;
  123094. private _tick;
  123095. /*** Helpers ***/
  123096. private _prepareCylinder;
  123097. private _intersectsWithCylinder;
  123098. }
  123099. /**
  123100. * Represents a physics vortex event
  123101. */
  123102. class PhysicsVortexEvent {
  123103. private _scene;
  123104. private _origin;
  123105. private _options;
  123106. private _physicsEngine;
  123107. private _originTop;
  123108. private _tickCallback;
  123109. private _cylinder;
  123110. private _cylinderPosition;
  123111. private _dataFetched;
  123112. /**
  123113. * Initializes the physics vortex event
  123114. * @param _scene The BabylonJS scene
  123115. * @param _origin The origin position of the vortex
  123116. * @param _options The options for the vortex event
  123117. */
  123118. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  123119. /**
  123120. * Returns the data related to the vortex event (cylinder).
  123121. * @returns The physics vortex event data
  123122. */
  123123. getData(): PhysicsVortexEventData;
  123124. /**
  123125. * Enables the vortex.
  123126. */
  123127. enable(): void;
  123128. /**
  123129. * Disables the cortex.
  123130. */
  123131. disable(): void;
  123132. /**
  123133. * Disposes the sphere.
  123134. * @param force
  123135. */
  123136. dispose(force?: boolean): void;
  123137. private getImpostorHitData;
  123138. private _tick;
  123139. /*** Helpers ***/
  123140. private _prepareCylinder;
  123141. private _intersectsWithCylinder;
  123142. }
  123143. /**
  123144. * Options fot the radial explosion event
  123145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123146. */
  123147. export class PhysicsRadialExplosionEventOptions {
  123148. /**
  123149. * The radius of the sphere for the radial explosion.
  123150. */
  123151. radius: number;
  123152. /**
  123153. * The strenth of the explosion.
  123154. */
  123155. strength: number;
  123156. /**
  123157. * The strenght of the force in correspondence to the distance of the affected object
  123158. */
  123159. falloff: PhysicsRadialImpulseFalloff;
  123160. /**
  123161. * Sphere options for the radial explosion.
  123162. */
  123163. sphere: {
  123164. segments: number;
  123165. diameter: number;
  123166. };
  123167. /**
  123168. * Sphere options for the radial explosion.
  123169. */
  123170. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  123171. }
  123172. /**
  123173. * Options fot the updraft event
  123174. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123175. */
  123176. export class PhysicsUpdraftEventOptions {
  123177. /**
  123178. * The radius of the cylinder for the vortex
  123179. */
  123180. radius: number;
  123181. /**
  123182. * The strenth of the updraft.
  123183. */
  123184. strength: number;
  123185. /**
  123186. * The height of the cylinder for the updraft.
  123187. */
  123188. height: number;
  123189. /**
  123190. * The mode for the the updraft.
  123191. */
  123192. updraftMode: PhysicsUpdraftMode;
  123193. }
  123194. /**
  123195. * Options fot the vortex event
  123196. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123197. */
  123198. export class PhysicsVortexEventOptions {
  123199. /**
  123200. * The radius of the cylinder for the vortex
  123201. */
  123202. radius: number;
  123203. /**
  123204. * The strenth of the vortex.
  123205. */
  123206. strength: number;
  123207. /**
  123208. * The height of the cylinder for the vortex.
  123209. */
  123210. height: number;
  123211. /**
  123212. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  123213. */
  123214. centripetalForceThreshold: number;
  123215. /**
  123216. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  123217. */
  123218. centripetalForceMultiplier: number;
  123219. /**
  123220. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  123221. */
  123222. centrifugalForceMultiplier: number;
  123223. /**
  123224. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  123225. */
  123226. updraftForceMultiplier: number;
  123227. }
  123228. /**
  123229. * The strenght of the force in correspondence to the distance of the affected object
  123230. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123231. */
  123232. export enum PhysicsRadialImpulseFalloff {
  123233. /** Defines that impulse is constant in strength across it's whole radius */
  123234. Constant = 0,
  123235. /** Defines that impulse gets weaker if it's further from the origin */
  123236. Linear = 1
  123237. }
  123238. /**
  123239. * The strength of the force in correspondence to the distance of the affected object
  123240. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123241. */
  123242. export enum PhysicsUpdraftMode {
  123243. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  123244. Center = 0,
  123245. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  123246. Perpendicular = 1
  123247. }
  123248. /**
  123249. * Interface for a physics hit data
  123250. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123251. */
  123252. export interface PhysicsHitData {
  123253. /**
  123254. * The force applied at the contact point
  123255. */
  123256. force: Vector3;
  123257. /**
  123258. * The contact point
  123259. */
  123260. contactPoint: Vector3;
  123261. /**
  123262. * The distance from the origin to the contact point
  123263. */
  123264. distanceFromOrigin: number;
  123265. }
  123266. /**
  123267. * Interface for radial explosion event data
  123268. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123269. */
  123270. export interface PhysicsRadialExplosionEventData {
  123271. /**
  123272. * A sphere used for the radial explosion event
  123273. */
  123274. sphere: Mesh;
  123275. }
  123276. /**
  123277. * Interface for gravitational field event data
  123278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123279. */
  123280. export interface PhysicsGravitationalFieldEventData {
  123281. /**
  123282. * A sphere mesh used for the gravitational field event
  123283. */
  123284. sphere: Mesh;
  123285. }
  123286. /**
  123287. * Interface for updraft event data
  123288. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123289. */
  123290. export interface PhysicsUpdraftEventData {
  123291. /**
  123292. * A cylinder used for the updraft event
  123293. */
  123294. cylinder: Mesh;
  123295. }
  123296. /**
  123297. * Interface for vortex event data
  123298. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123299. */
  123300. export interface PhysicsVortexEventData {
  123301. /**
  123302. * A cylinder used for the vortex event
  123303. */
  123304. cylinder: Mesh;
  123305. }
  123306. /**
  123307. * Interface for an affected physics impostor
  123308. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  123309. */
  123310. export interface PhysicsAffectedImpostorWithData {
  123311. /**
  123312. * The impostor affected by the effect
  123313. */
  123314. impostor: PhysicsImpostor;
  123315. /**
  123316. * The data about the hit/horce from the explosion
  123317. */
  123318. hitData: PhysicsHitData;
  123319. }
  123320. }
  123321. declare module BABYLON {
  123322. /** @hidden */
  123323. export var blackAndWhitePixelShader: {
  123324. name: string;
  123325. shader: string;
  123326. };
  123327. }
  123328. declare module BABYLON {
  123329. /**
  123330. * Post process used to render in black and white
  123331. */
  123332. export class BlackAndWhitePostProcess extends PostProcess {
  123333. /**
  123334. * Linear about to convert he result to black and white (default: 1)
  123335. */
  123336. degree: number;
  123337. /**
  123338. * Creates a black and white post process
  123339. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  123340. * @param name The name of the effect.
  123341. * @param options The required width/height ratio to downsize to before computing the render pass.
  123342. * @param camera The camera to apply the render pass to.
  123343. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123344. * @param engine The engine which the post process will be applied. (default: current engine)
  123345. * @param reusable If the post process can be reused on the same frame. (default: false)
  123346. */
  123347. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  123348. }
  123349. }
  123350. declare module BABYLON {
  123351. /**
  123352. * This represents a set of one or more post processes in Babylon.
  123353. * A post process can be used to apply a shader to a texture after it is rendered.
  123354. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  123355. */
  123356. export class PostProcessRenderEffect {
  123357. private _postProcesses;
  123358. private _getPostProcesses;
  123359. private _singleInstance;
  123360. private _cameras;
  123361. private _indicesForCamera;
  123362. /**
  123363. * Name of the effect
  123364. * @hidden
  123365. */
  123366. _name: string;
  123367. /**
  123368. * Instantiates a post process render effect.
  123369. * A post process can be used to apply a shader to a texture after it is rendered.
  123370. * @param engine The engine the effect is tied to
  123371. * @param name The name of the effect
  123372. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  123373. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  123374. */
  123375. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  123376. /**
  123377. * Checks if all the post processes in the effect are supported.
  123378. */
  123379. readonly isSupported: boolean;
  123380. /**
  123381. * Updates the current state of the effect
  123382. * @hidden
  123383. */
  123384. _update(): void;
  123385. /**
  123386. * Attaches the effect on cameras
  123387. * @param cameras The camera to attach to.
  123388. * @hidden
  123389. */
  123390. _attachCameras(cameras: Camera): void;
  123391. /**
  123392. * Attaches the effect on cameras
  123393. * @param cameras The camera to attach to.
  123394. * @hidden
  123395. */
  123396. _attachCameras(cameras: Camera[]): void;
  123397. /**
  123398. * Detaches the effect on cameras
  123399. * @param cameras The camera to detatch from.
  123400. * @hidden
  123401. */
  123402. _detachCameras(cameras: Camera): void;
  123403. /**
  123404. * Detatches the effect on cameras
  123405. * @param cameras The camera to detatch from.
  123406. * @hidden
  123407. */
  123408. _detachCameras(cameras: Camera[]): void;
  123409. /**
  123410. * Enables the effect on given cameras
  123411. * @param cameras The camera to enable.
  123412. * @hidden
  123413. */
  123414. _enable(cameras: Camera): void;
  123415. /**
  123416. * Enables the effect on given cameras
  123417. * @param cameras The camera to enable.
  123418. * @hidden
  123419. */
  123420. _enable(cameras: Nullable<Camera[]>): void;
  123421. /**
  123422. * Disables the effect on the given cameras
  123423. * @param cameras The camera to disable.
  123424. * @hidden
  123425. */
  123426. _disable(cameras: Camera): void;
  123427. /**
  123428. * Disables the effect on the given cameras
  123429. * @param cameras The camera to disable.
  123430. * @hidden
  123431. */
  123432. _disable(cameras: Nullable<Camera[]>): void;
  123433. /**
  123434. * Gets a list of the post processes contained in the effect.
  123435. * @param camera The camera to get the post processes on.
  123436. * @returns The list of the post processes in the effect.
  123437. */
  123438. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  123439. }
  123440. }
  123441. declare module BABYLON {
  123442. /** @hidden */
  123443. export var extractHighlightsPixelShader: {
  123444. name: string;
  123445. shader: string;
  123446. };
  123447. }
  123448. declare module BABYLON {
  123449. /**
  123450. * 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.
  123451. */
  123452. export class ExtractHighlightsPostProcess extends PostProcess {
  123453. /**
  123454. * The luminance threshold, pixels below this value will be set to black.
  123455. */
  123456. threshold: number;
  123457. /** @hidden */
  123458. _exposure: number;
  123459. /**
  123460. * Post process which has the input texture to be used when performing highlight extraction
  123461. * @hidden
  123462. */
  123463. _inputPostProcess: Nullable<PostProcess>;
  123464. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  123465. }
  123466. }
  123467. declare module BABYLON {
  123468. /** @hidden */
  123469. export var bloomMergePixelShader: {
  123470. name: string;
  123471. shader: string;
  123472. };
  123473. }
  123474. declare module BABYLON {
  123475. /**
  123476. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  123477. */
  123478. export class BloomMergePostProcess extends PostProcess {
  123479. /** Weight of the bloom to be added to the original input. */
  123480. weight: number;
  123481. /**
  123482. * Creates a new instance of @see BloomMergePostProcess
  123483. * @param name The name of the effect.
  123484. * @param originalFromInput Post process which's input will be used for the merge.
  123485. * @param blurred Blurred highlights post process which's output will be used.
  123486. * @param weight Weight of the bloom to be added to the original input.
  123487. * @param options The required width/height ratio to downsize to before computing the render pass.
  123488. * @param camera The camera to apply the render pass to.
  123489. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123490. * @param engine The engine which the post process will be applied. (default: current engine)
  123491. * @param reusable If the post process can be reused on the same frame. (default: false)
  123492. * @param textureType Type of textures used when performing the post process. (default: 0)
  123493. * @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)
  123494. */
  123495. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  123496. /** Weight of the bloom to be added to the original input. */
  123497. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  123498. }
  123499. }
  123500. declare module BABYLON {
  123501. /**
  123502. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  123503. */
  123504. export class BloomEffect extends PostProcessRenderEffect {
  123505. private bloomScale;
  123506. /**
  123507. * @hidden Internal
  123508. */
  123509. _effects: Array<PostProcess>;
  123510. /**
  123511. * @hidden Internal
  123512. */
  123513. _downscale: ExtractHighlightsPostProcess;
  123514. private _blurX;
  123515. private _blurY;
  123516. private _merge;
  123517. /**
  123518. * The luminance threshold to find bright areas of the image to bloom.
  123519. */
  123520. threshold: number;
  123521. /**
  123522. * The strength of the bloom.
  123523. */
  123524. weight: number;
  123525. /**
  123526. * Specifies the size of the bloom blur kernel, relative to the final output size
  123527. */
  123528. kernel: number;
  123529. /**
  123530. * Creates a new instance of @see BloomEffect
  123531. * @param scene The scene the effect belongs to.
  123532. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  123533. * @param bloomKernel The size of the kernel to be used when applying the blur.
  123534. * @param bloomWeight The the strength of bloom.
  123535. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  123536. * @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)
  123537. */
  123538. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  123539. /**
  123540. * Disposes each of the internal effects for a given camera.
  123541. * @param camera The camera to dispose the effect on.
  123542. */
  123543. disposeEffects(camera: Camera): void;
  123544. /**
  123545. * @hidden Internal
  123546. */
  123547. _updateEffects(): void;
  123548. /**
  123549. * Internal
  123550. * @returns if all the contained post processes are ready.
  123551. * @hidden
  123552. */
  123553. _isReady(): boolean;
  123554. }
  123555. }
  123556. declare module BABYLON {
  123557. /** @hidden */
  123558. export var chromaticAberrationPixelShader: {
  123559. name: string;
  123560. shader: string;
  123561. };
  123562. }
  123563. declare module BABYLON {
  123564. /**
  123565. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  123566. */
  123567. export class ChromaticAberrationPostProcess extends PostProcess {
  123568. /**
  123569. * The amount of seperation of rgb channels (default: 30)
  123570. */
  123571. aberrationAmount: number;
  123572. /**
  123573. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  123574. */
  123575. radialIntensity: number;
  123576. /**
  123577. * 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))
  123578. */
  123579. direction: Vector2;
  123580. /**
  123581. * 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))
  123582. */
  123583. centerPosition: Vector2;
  123584. /**
  123585. * Creates a new instance ChromaticAberrationPostProcess
  123586. * @param name The name of the effect.
  123587. * @param screenWidth The width of the screen to apply the effect on.
  123588. * @param screenHeight The height of the screen to apply the effect on.
  123589. * @param options The required width/height ratio to downsize to before computing the render pass.
  123590. * @param camera The camera to apply the render pass to.
  123591. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123592. * @param engine The engine which the post process will be applied. (default: current engine)
  123593. * @param reusable If the post process can be reused on the same frame. (default: false)
  123594. * @param textureType Type of textures used when performing the post process. (default: 0)
  123595. * @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)
  123596. */
  123597. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  123598. }
  123599. }
  123600. declare module BABYLON {
  123601. /** @hidden */
  123602. export var circleOfConfusionPixelShader: {
  123603. name: string;
  123604. shader: string;
  123605. };
  123606. }
  123607. declare module BABYLON {
  123608. /**
  123609. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  123610. */
  123611. export class CircleOfConfusionPostProcess extends PostProcess {
  123612. /**
  123613. * 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.
  123614. */
  123615. lensSize: number;
  123616. /**
  123617. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  123618. */
  123619. fStop: number;
  123620. /**
  123621. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  123622. */
  123623. focusDistance: number;
  123624. /**
  123625. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  123626. */
  123627. focalLength: number;
  123628. private _depthTexture;
  123629. /**
  123630. * Creates a new instance CircleOfConfusionPostProcess
  123631. * @param name The name of the effect.
  123632. * @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.
  123633. * @param options The required width/height ratio to downsize to before computing the render pass.
  123634. * @param camera The camera to apply the render pass to.
  123635. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123636. * @param engine The engine which the post process will be applied. (default: current engine)
  123637. * @param reusable If the post process can be reused on the same frame. (default: false)
  123638. * @param textureType Type of textures used when performing the post process. (default: 0)
  123639. * @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)
  123640. */
  123641. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  123642. /**
  123643. * 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.
  123644. */
  123645. depthTexture: RenderTargetTexture;
  123646. }
  123647. }
  123648. declare module BABYLON {
  123649. /** @hidden */
  123650. export var colorCorrectionPixelShader: {
  123651. name: string;
  123652. shader: string;
  123653. };
  123654. }
  123655. declare module BABYLON {
  123656. /**
  123657. *
  123658. * This post-process allows the modification of rendered colors by using
  123659. * a 'look-up table' (LUT). This effect is also called Color Grading.
  123660. *
  123661. * The object needs to be provided an url to a texture containing the color
  123662. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  123663. * Use an image editing software to tweak the LUT to match your needs.
  123664. *
  123665. * For an example of a color LUT, see here:
  123666. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  123667. * For explanations on color grading, see here:
  123668. * @see http://udn.epicgames.com/Three/ColorGrading.html
  123669. *
  123670. */
  123671. export class ColorCorrectionPostProcess extends PostProcess {
  123672. private _colorTableTexture;
  123673. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  123674. }
  123675. }
  123676. declare module BABYLON {
  123677. /** @hidden */
  123678. export var convolutionPixelShader: {
  123679. name: string;
  123680. shader: string;
  123681. };
  123682. }
  123683. declare module BABYLON {
  123684. /**
  123685. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  123686. * input texture to perform effects such as edge detection or sharpening
  123687. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  123688. */
  123689. export class ConvolutionPostProcess extends PostProcess {
  123690. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  123691. kernel: number[];
  123692. /**
  123693. * Creates a new instance ConvolutionPostProcess
  123694. * @param name The name of the effect.
  123695. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  123696. * @param options The required width/height ratio to downsize to before computing the render pass.
  123697. * @param camera The camera to apply the render pass to.
  123698. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123699. * @param engine The engine which the post process will be applied. (default: current engine)
  123700. * @param reusable If the post process can be reused on the same frame. (default: false)
  123701. * @param textureType Type of textures used when performing the post process. (default: 0)
  123702. */
  123703. constructor(name: string,
  123704. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  123705. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  123706. /**
  123707. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123708. */
  123709. static EdgeDetect0Kernel: number[];
  123710. /**
  123711. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123712. */
  123713. static EdgeDetect1Kernel: number[];
  123714. /**
  123715. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123716. */
  123717. static EdgeDetect2Kernel: number[];
  123718. /**
  123719. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123720. */
  123721. static SharpenKernel: number[];
  123722. /**
  123723. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123724. */
  123725. static EmbossKernel: number[];
  123726. /**
  123727. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  123728. */
  123729. static GaussianKernel: number[];
  123730. }
  123731. }
  123732. declare module BABYLON {
  123733. /**
  123734. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  123735. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  123736. * based on samples that have a large difference in distance than the center pixel.
  123737. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  123738. */
  123739. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  123740. direction: Vector2;
  123741. /**
  123742. * Creates a new instance CircleOfConfusionPostProcess
  123743. * @param name The name of the effect.
  123744. * @param scene The scene the effect belongs to.
  123745. * @param direction The direction the blur should be applied.
  123746. * @param kernel The size of the kernel used to blur.
  123747. * @param options The required width/height ratio to downsize to before computing the render pass.
  123748. * @param camera The camera to apply the render pass to.
  123749. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  123750. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  123751. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123752. * @param engine The engine which the post process will be applied. (default: current engine)
  123753. * @param reusable If the post process can be reused on the same frame. (default: false)
  123754. * @param textureType Type of textures used when performing the post process. (default: 0)
  123755. * @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)
  123756. */
  123757. 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);
  123758. }
  123759. }
  123760. declare module BABYLON {
  123761. /** @hidden */
  123762. export var depthOfFieldMergePixelShader: {
  123763. name: string;
  123764. shader: string;
  123765. };
  123766. }
  123767. declare module BABYLON {
  123768. /**
  123769. * Options to be set when merging outputs from the default pipeline.
  123770. */
  123771. export class DepthOfFieldMergePostProcessOptions {
  123772. /**
  123773. * The original image to merge on top of
  123774. */
  123775. originalFromInput: PostProcess;
  123776. /**
  123777. * Parameters to perform the merge of the depth of field effect
  123778. */
  123779. depthOfField?: {
  123780. circleOfConfusion: PostProcess;
  123781. blurSteps: Array<PostProcess>;
  123782. };
  123783. /**
  123784. * Parameters to perform the merge of bloom effect
  123785. */
  123786. bloom?: {
  123787. blurred: PostProcess;
  123788. weight: number;
  123789. };
  123790. }
  123791. /**
  123792. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  123793. */
  123794. export class DepthOfFieldMergePostProcess extends PostProcess {
  123795. private blurSteps;
  123796. /**
  123797. * Creates a new instance of DepthOfFieldMergePostProcess
  123798. * @param name The name of the effect.
  123799. * @param originalFromInput Post process which's input will be used for the merge.
  123800. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  123801. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  123802. * @param options The required width/height ratio to downsize to before computing the render pass.
  123803. * @param camera The camera to apply the render pass to.
  123804. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123805. * @param engine The engine which the post process will be applied. (default: current engine)
  123806. * @param reusable If the post process can be reused on the same frame. (default: false)
  123807. * @param textureType Type of textures used when performing the post process. (default: 0)
  123808. * @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)
  123809. */
  123810. 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);
  123811. /**
  123812. * Updates the effect with the current post process compile time values and recompiles the shader.
  123813. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  123814. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  123815. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  123816. * @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
  123817. * @param onCompiled Called when the shader has been compiled.
  123818. * @param onError Called if there is an error when compiling a shader.
  123819. */
  123820. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  123821. }
  123822. }
  123823. declare module BABYLON {
  123824. /**
  123825. * Specifies the level of max blur that should be applied when using the depth of field effect
  123826. */
  123827. export enum DepthOfFieldEffectBlurLevel {
  123828. /**
  123829. * Subtle blur
  123830. */
  123831. Low = 0,
  123832. /**
  123833. * Medium blur
  123834. */
  123835. Medium = 1,
  123836. /**
  123837. * Large blur
  123838. */
  123839. High = 2
  123840. }
  123841. /**
  123842. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  123843. */
  123844. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  123845. private _circleOfConfusion;
  123846. /**
  123847. * @hidden Internal, blurs from high to low
  123848. */
  123849. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  123850. private _depthOfFieldBlurY;
  123851. private _dofMerge;
  123852. /**
  123853. * @hidden Internal post processes in depth of field effect
  123854. */
  123855. _effects: Array<PostProcess>;
  123856. /**
  123857. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  123858. */
  123859. focalLength: number;
  123860. /**
  123861. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  123862. */
  123863. fStop: number;
  123864. /**
  123865. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  123866. */
  123867. focusDistance: number;
  123868. /**
  123869. * 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.
  123870. */
  123871. lensSize: number;
  123872. /**
  123873. * Creates a new instance DepthOfFieldEffect
  123874. * @param scene The scene the effect belongs to.
  123875. * @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.
  123876. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  123877. * @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)
  123878. */
  123879. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  123880. /**
  123881. * Get the current class name of the current effet
  123882. * @returns "DepthOfFieldEffect"
  123883. */
  123884. getClassName(): string;
  123885. /**
  123886. * 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.
  123887. */
  123888. depthTexture: RenderTargetTexture;
  123889. /**
  123890. * Disposes each of the internal effects for a given camera.
  123891. * @param camera The camera to dispose the effect on.
  123892. */
  123893. disposeEffects(camera: Camera): void;
  123894. /**
  123895. * @hidden Internal
  123896. */
  123897. _updateEffects(): void;
  123898. /**
  123899. * Internal
  123900. * @returns if all the contained post processes are ready.
  123901. * @hidden
  123902. */
  123903. _isReady(): boolean;
  123904. }
  123905. }
  123906. declare module BABYLON {
  123907. /** @hidden */
  123908. export var displayPassPixelShader: {
  123909. name: string;
  123910. shader: string;
  123911. };
  123912. }
  123913. declare module BABYLON {
  123914. /**
  123915. * DisplayPassPostProcess which produces an output the same as it's input
  123916. */
  123917. export class DisplayPassPostProcess extends PostProcess {
  123918. /**
  123919. * Creates the DisplayPassPostProcess
  123920. * @param name The name of the effect.
  123921. * @param options The required width/height ratio to downsize to before computing the render pass.
  123922. * @param camera The camera to apply the render pass to.
  123923. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123924. * @param engine The engine which the post process will be applied. (default: current engine)
  123925. * @param reusable If the post process can be reused on the same frame. (default: false)
  123926. */
  123927. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  123928. }
  123929. }
  123930. declare module BABYLON {
  123931. /** @hidden */
  123932. export var filterPixelShader: {
  123933. name: string;
  123934. shader: string;
  123935. };
  123936. }
  123937. declare module BABYLON {
  123938. /**
  123939. * Applies a kernel filter to the image
  123940. */
  123941. export class FilterPostProcess extends PostProcess {
  123942. /** The matrix to be applied to the image */
  123943. kernelMatrix: Matrix;
  123944. /**
  123945. *
  123946. * @param name The name of the effect.
  123947. * @param kernelMatrix The matrix to be applied to the image
  123948. * @param options The required width/height ratio to downsize to before computing the render pass.
  123949. * @param camera The camera to apply the render pass to.
  123950. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  123951. * @param engine The engine which the post process will be applied. (default: current engine)
  123952. * @param reusable If the post process can be reused on the same frame. (default: false)
  123953. */
  123954. constructor(name: string,
  123955. /** The matrix to be applied to the image */
  123956. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  123957. }
  123958. }
  123959. declare module BABYLON {
  123960. /** @hidden */
  123961. export var fxaaPixelShader: {
  123962. name: string;
  123963. shader: string;
  123964. };
  123965. }
  123966. declare module BABYLON {
  123967. /** @hidden */
  123968. export var fxaaVertexShader: {
  123969. name: string;
  123970. shader: string;
  123971. };
  123972. }
  123973. declare module BABYLON {
  123974. /**
  123975. * Fxaa post process
  123976. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  123977. */
  123978. export class FxaaPostProcess extends PostProcess {
  123979. /** @hidden */
  123980. texelWidth: number;
  123981. /** @hidden */
  123982. texelHeight: number;
  123983. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  123984. private _getDefines;
  123985. }
  123986. }
  123987. declare module BABYLON {
  123988. /** @hidden */
  123989. export var grainPixelShader: {
  123990. name: string;
  123991. shader: string;
  123992. };
  123993. }
  123994. declare module BABYLON {
  123995. /**
  123996. * The GrainPostProcess adds noise to the image at mid luminance levels
  123997. */
  123998. export class GrainPostProcess extends PostProcess {
  123999. /**
  124000. * The intensity of the grain added (default: 30)
  124001. */
  124002. intensity: number;
  124003. /**
  124004. * If the grain should be randomized on every frame
  124005. */
  124006. animated: boolean;
  124007. /**
  124008. * Creates a new instance of @see GrainPostProcess
  124009. * @param name The name of the effect.
  124010. * @param options The required width/height ratio to downsize to before computing the render pass.
  124011. * @param camera The camera to apply the render pass to.
  124012. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124013. * @param engine The engine which the post process will be applied. (default: current engine)
  124014. * @param reusable If the post process can be reused on the same frame. (default: false)
  124015. * @param textureType Type of textures used when performing the post process. (default: 0)
  124016. * @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)
  124017. */
  124018. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124019. }
  124020. }
  124021. declare module BABYLON {
  124022. /** @hidden */
  124023. export var highlightsPixelShader: {
  124024. name: string;
  124025. shader: string;
  124026. };
  124027. }
  124028. declare module BABYLON {
  124029. /**
  124030. * Extracts highlights from the image
  124031. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  124032. */
  124033. export class HighlightsPostProcess extends PostProcess {
  124034. /**
  124035. * Extracts highlights from the image
  124036. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  124037. * @param name The name of the effect.
  124038. * @param options The required width/height ratio to downsize to before computing the render pass.
  124039. * @param camera The camera to apply the render pass to.
  124040. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124041. * @param engine The engine which the post process will be applied. (default: current engine)
  124042. * @param reusable If the post process can be reused on the same frame. (default: false)
  124043. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  124044. */
  124045. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  124046. }
  124047. }
  124048. declare module BABYLON {
  124049. /** @hidden */
  124050. export var mrtFragmentDeclaration: {
  124051. name: string;
  124052. shader: string;
  124053. };
  124054. }
  124055. declare module BABYLON {
  124056. /** @hidden */
  124057. export var geometryPixelShader: {
  124058. name: string;
  124059. shader: string;
  124060. };
  124061. }
  124062. declare module BABYLON {
  124063. /** @hidden */
  124064. export var geometryVertexShader: {
  124065. name: string;
  124066. shader: string;
  124067. };
  124068. }
  124069. declare module BABYLON {
  124070. /** @hidden */
  124071. interface ISavedTransformationMatrix {
  124072. world: Matrix;
  124073. viewProjection: Matrix;
  124074. }
  124075. /**
  124076. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  124077. */
  124078. export class GeometryBufferRenderer {
  124079. /**
  124080. * Constant used to retrieve the position texture index in the G-Buffer textures array
  124081. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  124082. */
  124083. static readonly POSITION_TEXTURE_TYPE: number;
  124084. /**
  124085. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  124086. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  124087. */
  124088. static readonly VELOCITY_TEXTURE_TYPE: number;
  124089. /**
  124090. * Dictionary used to store the previous transformation matrices of each rendered mesh
  124091. * in order to compute objects velocities when enableVelocity is set to "true"
  124092. * @hidden
  124093. */
  124094. _previousTransformationMatrices: {
  124095. [index: number]: ISavedTransformationMatrix;
  124096. };
  124097. /**
  124098. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  124099. * in order to compute objects velocities when enableVelocity is set to "true"
  124100. * @hidden
  124101. */
  124102. _previousBonesTransformationMatrices: {
  124103. [index: number]: Float32Array;
  124104. };
  124105. /**
  124106. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  124107. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  124108. */
  124109. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  124110. private _scene;
  124111. private _multiRenderTarget;
  124112. private _ratio;
  124113. private _enablePosition;
  124114. private _enableVelocity;
  124115. private _positionIndex;
  124116. private _velocityIndex;
  124117. protected _effect: Effect;
  124118. protected _cachedDefines: string;
  124119. /**
  124120. * Set the render list (meshes to be rendered) used in the G buffer.
  124121. */
  124122. renderList: Mesh[];
  124123. /**
  124124. * Gets wether or not G buffer are supported by the running hardware.
  124125. * This requires draw buffer supports
  124126. */
  124127. readonly isSupported: boolean;
  124128. /**
  124129. * Returns the index of the given texture type in the G-Buffer textures array
  124130. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  124131. * @returns the index of the given texture type in the G-Buffer textures array
  124132. */
  124133. getTextureIndex(textureType: number): number;
  124134. /**
  124135. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  124136. */
  124137. /**
  124138. * Sets whether or not objects positions are enabled for the G buffer.
  124139. */
  124140. enablePosition: boolean;
  124141. /**
  124142. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  124143. */
  124144. /**
  124145. * Sets wether or not objects velocities are enabled for the G buffer.
  124146. */
  124147. enableVelocity: boolean;
  124148. /**
  124149. * Gets the scene associated with the buffer.
  124150. */
  124151. readonly scene: Scene;
  124152. /**
  124153. * Gets the ratio used by the buffer during its creation.
  124154. * How big is the buffer related to the main canvas.
  124155. */
  124156. readonly ratio: number;
  124157. /** @hidden */
  124158. static _SceneComponentInitialization: (scene: Scene) => void;
  124159. /**
  124160. * Creates a new G Buffer for the scene
  124161. * @param scene The scene the buffer belongs to
  124162. * @param ratio How big is the buffer related to the main canvas.
  124163. */
  124164. constructor(scene: Scene, ratio?: number);
  124165. /**
  124166. * Checks wether everything is ready to render a submesh to the G buffer.
  124167. * @param subMesh the submesh to check readiness for
  124168. * @param useInstances is the mesh drawn using instance or not
  124169. * @returns true if ready otherwise false
  124170. */
  124171. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  124172. /**
  124173. * Gets the current underlying G Buffer.
  124174. * @returns the buffer
  124175. */
  124176. getGBuffer(): MultiRenderTarget;
  124177. /**
  124178. * Gets the number of samples used to render the buffer (anti aliasing).
  124179. */
  124180. /**
  124181. * Sets the number of samples used to render the buffer (anti aliasing).
  124182. */
  124183. samples: number;
  124184. /**
  124185. * Disposes the renderer and frees up associated resources.
  124186. */
  124187. dispose(): void;
  124188. protected _createRenderTargets(): void;
  124189. private _copyBonesTransformationMatrices;
  124190. }
  124191. }
  124192. declare module BABYLON {
  124193. interface Scene {
  124194. /** @hidden (Backing field) */
  124195. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  124196. /**
  124197. * Gets or Sets the current geometry buffer associated to the scene.
  124198. */
  124199. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  124200. /**
  124201. * Enables a GeometryBufferRender and associates it with the scene
  124202. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  124203. * @returns the GeometryBufferRenderer
  124204. */
  124205. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  124206. /**
  124207. * Disables the GeometryBufferRender associated with the scene
  124208. */
  124209. disableGeometryBufferRenderer(): void;
  124210. }
  124211. /**
  124212. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  124213. * in several rendering techniques.
  124214. */
  124215. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  124216. /**
  124217. * The component name helpful to identify the component in the list of scene components.
  124218. */
  124219. readonly name: string;
  124220. /**
  124221. * The scene the component belongs to.
  124222. */
  124223. scene: Scene;
  124224. /**
  124225. * Creates a new instance of the component for the given scene
  124226. * @param scene Defines the scene to register the component in
  124227. */
  124228. constructor(scene: Scene);
  124229. /**
  124230. * Registers the component in a given scene
  124231. */
  124232. register(): void;
  124233. /**
  124234. * Rebuilds the elements related to this component in case of
  124235. * context lost for instance.
  124236. */
  124237. rebuild(): void;
  124238. /**
  124239. * Disposes the component and the associated ressources
  124240. */
  124241. dispose(): void;
  124242. private _gatherRenderTargets;
  124243. }
  124244. }
  124245. declare module BABYLON {
  124246. /** @hidden */
  124247. export var motionBlurPixelShader: {
  124248. name: string;
  124249. shader: string;
  124250. };
  124251. }
  124252. declare module BABYLON {
  124253. /**
  124254. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  124255. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  124256. * As an example, all you have to do is to create the post-process:
  124257. * var mb = new BABYLON.MotionBlurPostProcess(
  124258. * 'mb', // The name of the effect.
  124259. * scene, // The scene containing the objects to blur according to their velocity.
  124260. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  124261. * camera // The camera to apply the render pass to.
  124262. * );
  124263. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  124264. */
  124265. export class MotionBlurPostProcess extends PostProcess {
  124266. /**
  124267. * Defines how much the image is blurred by the movement. Default value is equal to 1
  124268. */
  124269. motionStrength: number;
  124270. /**
  124271. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  124272. */
  124273. /**
  124274. * Sets the number of iterations to be used for motion blur quality
  124275. */
  124276. motionBlurSamples: number;
  124277. private _motionBlurSamples;
  124278. private _geometryBufferRenderer;
  124279. /**
  124280. * Creates a new instance MotionBlurPostProcess
  124281. * @param name The name of the effect.
  124282. * @param scene The scene containing the objects to blur according to their velocity.
  124283. * @param options The required width/height ratio to downsize to before computing the render pass.
  124284. * @param camera The camera to apply the render pass to.
  124285. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124286. * @param engine The engine which the post process will be applied. (default: current engine)
  124287. * @param reusable If the post process can be reused on the same frame. (default: false)
  124288. * @param textureType Type of textures used when performing the post process. (default: 0)
  124289. * @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)
  124290. */
  124291. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124292. /**
  124293. * Excludes the given skinned mesh from computing bones velocities.
  124294. * 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.
  124295. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  124296. */
  124297. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  124298. /**
  124299. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  124300. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  124301. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  124302. */
  124303. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  124304. /**
  124305. * Disposes the post process.
  124306. * @param camera The camera to dispose the post process on.
  124307. */
  124308. dispose(camera?: Camera): void;
  124309. }
  124310. }
  124311. declare module BABYLON {
  124312. /** @hidden */
  124313. export var refractionPixelShader: {
  124314. name: string;
  124315. shader: string;
  124316. };
  124317. }
  124318. declare module BABYLON {
  124319. /**
  124320. * Post process which applies a refractin texture
  124321. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  124322. */
  124323. export class RefractionPostProcess extends PostProcess {
  124324. /** the base color of the refraction (used to taint the rendering) */
  124325. color: Color3;
  124326. /** simulated refraction depth */
  124327. depth: number;
  124328. /** the coefficient of the base color (0 to remove base color tainting) */
  124329. colorLevel: number;
  124330. private _refTexture;
  124331. private _ownRefractionTexture;
  124332. /**
  124333. * Gets or sets the refraction texture
  124334. * Please note that you are responsible for disposing the texture if you set it manually
  124335. */
  124336. refractionTexture: Texture;
  124337. /**
  124338. * Initializes the RefractionPostProcess
  124339. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  124340. * @param name The name of the effect.
  124341. * @param refractionTextureUrl Url of the refraction texture to use
  124342. * @param color the base color of the refraction (used to taint the rendering)
  124343. * @param depth simulated refraction depth
  124344. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  124345. * @param camera The camera to apply the render pass to.
  124346. * @param options The required width/height ratio to downsize to before computing the render pass.
  124347. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124348. * @param engine The engine which the post process will be applied. (default: current engine)
  124349. * @param reusable If the post process can be reused on the same frame. (default: false)
  124350. */
  124351. constructor(name: string, refractionTextureUrl: string,
  124352. /** the base color of the refraction (used to taint the rendering) */
  124353. color: Color3,
  124354. /** simulated refraction depth */
  124355. depth: number,
  124356. /** the coefficient of the base color (0 to remove base color tainting) */
  124357. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  124358. /**
  124359. * Disposes of the post process
  124360. * @param camera Camera to dispose post process on
  124361. */
  124362. dispose(camera: Camera): void;
  124363. }
  124364. }
  124365. declare module BABYLON {
  124366. /** @hidden */
  124367. export var sharpenPixelShader: {
  124368. name: string;
  124369. shader: string;
  124370. };
  124371. }
  124372. declare module BABYLON {
  124373. /**
  124374. * The SharpenPostProcess applies a sharpen kernel to every pixel
  124375. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  124376. */
  124377. export class SharpenPostProcess extends PostProcess {
  124378. /**
  124379. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  124380. */
  124381. colorAmount: number;
  124382. /**
  124383. * How much sharpness should be applied (default: 0.3)
  124384. */
  124385. edgeAmount: number;
  124386. /**
  124387. * Creates a new instance ConvolutionPostProcess
  124388. * @param name The name of the effect.
  124389. * @param options The required width/height ratio to downsize to before computing the render pass.
  124390. * @param camera The camera to apply the render pass to.
  124391. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124392. * @param engine The engine which the post process will be applied. (default: current engine)
  124393. * @param reusable If the post process can be reused on the same frame. (default: false)
  124394. * @param textureType Type of textures used when performing the post process. (default: 0)
  124395. * @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)
  124396. */
  124397. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124398. }
  124399. }
  124400. declare module BABYLON {
  124401. /**
  124402. * PostProcessRenderPipeline
  124403. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  124404. */
  124405. export class PostProcessRenderPipeline {
  124406. private engine;
  124407. private _renderEffects;
  124408. private _renderEffectsForIsolatedPass;
  124409. /**
  124410. * List of inspectable custom properties (used by the Inspector)
  124411. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  124412. */
  124413. inspectableCustomProperties: IInspectable[];
  124414. /**
  124415. * @hidden
  124416. */
  124417. protected _cameras: Camera[];
  124418. /** @hidden */
  124419. _name: string;
  124420. /**
  124421. * Gets pipeline name
  124422. */
  124423. readonly name: string;
  124424. /**
  124425. * Initializes a PostProcessRenderPipeline
  124426. * @param engine engine to add the pipeline to
  124427. * @param name name of the pipeline
  124428. */
  124429. constructor(engine: Engine, name: string);
  124430. /**
  124431. * Gets the class name
  124432. * @returns "PostProcessRenderPipeline"
  124433. */
  124434. getClassName(): string;
  124435. /**
  124436. * If all the render effects in the pipeline are supported
  124437. */
  124438. readonly isSupported: boolean;
  124439. /**
  124440. * Adds an effect to the pipeline
  124441. * @param renderEffect the effect to add
  124442. */
  124443. addEffect(renderEffect: PostProcessRenderEffect): void;
  124444. /** @hidden */
  124445. _rebuild(): void;
  124446. /** @hidden */
  124447. _enableEffect(renderEffectName: string, cameras: Camera): void;
  124448. /** @hidden */
  124449. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  124450. /** @hidden */
  124451. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  124452. /** @hidden */
  124453. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  124454. /** @hidden */
  124455. _attachCameras(cameras: Camera, unique: boolean): void;
  124456. /** @hidden */
  124457. _attachCameras(cameras: Camera[], unique: boolean): void;
  124458. /** @hidden */
  124459. _detachCameras(cameras: Camera): void;
  124460. /** @hidden */
  124461. _detachCameras(cameras: Nullable<Camera[]>): void;
  124462. /** @hidden */
  124463. _update(): void;
  124464. /** @hidden */
  124465. _reset(): void;
  124466. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  124467. /**
  124468. * Disposes of the pipeline
  124469. */
  124470. dispose(): void;
  124471. }
  124472. }
  124473. declare module BABYLON {
  124474. /**
  124475. * PostProcessRenderPipelineManager class
  124476. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  124477. */
  124478. export class PostProcessRenderPipelineManager {
  124479. private _renderPipelines;
  124480. /**
  124481. * Initializes a PostProcessRenderPipelineManager
  124482. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  124483. */
  124484. constructor();
  124485. /**
  124486. * Gets the list of supported render pipelines
  124487. */
  124488. readonly supportedPipelines: PostProcessRenderPipeline[];
  124489. /**
  124490. * Adds a pipeline to the manager
  124491. * @param renderPipeline The pipeline to add
  124492. */
  124493. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  124494. /**
  124495. * Attaches a camera to the pipeline
  124496. * @param renderPipelineName The name of the pipeline to attach to
  124497. * @param cameras the camera to attach
  124498. * @param unique if the camera can be attached multiple times to the pipeline
  124499. */
  124500. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  124501. /**
  124502. * Detaches a camera from the pipeline
  124503. * @param renderPipelineName The name of the pipeline to detach from
  124504. * @param cameras the camera to detach
  124505. */
  124506. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  124507. /**
  124508. * Enables an effect by name on a pipeline
  124509. * @param renderPipelineName the name of the pipeline to enable the effect in
  124510. * @param renderEffectName the name of the effect to enable
  124511. * @param cameras the cameras that the effect should be enabled on
  124512. */
  124513. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  124514. /**
  124515. * Disables an effect by name on a pipeline
  124516. * @param renderPipelineName the name of the pipeline to disable the effect in
  124517. * @param renderEffectName the name of the effect to disable
  124518. * @param cameras the cameras that the effect should be disabled on
  124519. */
  124520. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  124521. /**
  124522. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  124523. */
  124524. update(): void;
  124525. /** @hidden */
  124526. _rebuild(): void;
  124527. /**
  124528. * Disposes of the manager and pipelines
  124529. */
  124530. dispose(): void;
  124531. }
  124532. }
  124533. declare module BABYLON {
  124534. interface Scene {
  124535. /** @hidden (Backing field) */
  124536. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  124537. /**
  124538. * Gets the postprocess render pipeline manager
  124539. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  124540. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  124541. */
  124542. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  124543. }
  124544. /**
  124545. * Defines the Render Pipeline scene component responsible to rendering pipelines
  124546. */
  124547. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  124548. /**
  124549. * The component name helpfull to identify the component in the list of scene components.
  124550. */
  124551. readonly name: string;
  124552. /**
  124553. * The scene the component belongs to.
  124554. */
  124555. scene: Scene;
  124556. /**
  124557. * Creates a new instance of the component for the given scene
  124558. * @param scene Defines the scene to register the component in
  124559. */
  124560. constructor(scene: Scene);
  124561. /**
  124562. * Registers the component in a given scene
  124563. */
  124564. register(): void;
  124565. /**
  124566. * Rebuilds the elements related to this component in case of
  124567. * context lost for instance.
  124568. */
  124569. rebuild(): void;
  124570. /**
  124571. * Disposes the component and the associated ressources
  124572. */
  124573. dispose(): void;
  124574. private _gatherRenderTargets;
  124575. }
  124576. }
  124577. declare module BABYLON {
  124578. /**
  124579. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  124580. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  124581. */
  124582. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  124583. private _scene;
  124584. private _camerasToBeAttached;
  124585. /**
  124586. * ID of the sharpen post process,
  124587. */
  124588. private readonly SharpenPostProcessId;
  124589. /**
  124590. * @ignore
  124591. * ID of the image processing post process;
  124592. */
  124593. readonly ImageProcessingPostProcessId: string;
  124594. /**
  124595. * @ignore
  124596. * ID of the Fast Approximate Anti-Aliasing post process;
  124597. */
  124598. readonly FxaaPostProcessId: string;
  124599. /**
  124600. * ID of the chromatic aberration post process,
  124601. */
  124602. private readonly ChromaticAberrationPostProcessId;
  124603. /**
  124604. * ID of the grain post process
  124605. */
  124606. private readonly GrainPostProcessId;
  124607. /**
  124608. * Sharpen post process which will apply a sharpen convolution to enhance edges
  124609. */
  124610. sharpen: SharpenPostProcess;
  124611. private _sharpenEffect;
  124612. private bloom;
  124613. /**
  124614. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  124615. */
  124616. depthOfField: DepthOfFieldEffect;
  124617. /**
  124618. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  124619. */
  124620. fxaa: FxaaPostProcess;
  124621. /**
  124622. * Image post processing pass used to perform operations such as tone mapping or color grading.
  124623. */
  124624. imageProcessing: ImageProcessingPostProcess;
  124625. /**
  124626. * Chromatic aberration post process which will shift rgb colors in the image
  124627. */
  124628. chromaticAberration: ChromaticAberrationPostProcess;
  124629. private _chromaticAberrationEffect;
  124630. /**
  124631. * Grain post process which add noise to the image
  124632. */
  124633. grain: GrainPostProcess;
  124634. private _grainEffect;
  124635. /**
  124636. * Glow post process which adds a glow to emissive areas of the image
  124637. */
  124638. private _glowLayer;
  124639. /**
  124640. * Animations which can be used to tweak settings over a period of time
  124641. */
  124642. animations: Animation[];
  124643. private _imageProcessingConfigurationObserver;
  124644. private _sharpenEnabled;
  124645. private _bloomEnabled;
  124646. private _depthOfFieldEnabled;
  124647. private _depthOfFieldBlurLevel;
  124648. private _fxaaEnabled;
  124649. private _imageProcessingEnabled;
  124650. private _defaultPipelineTextureType;
  124651. private _bloomScale;
  124652. private _chromaticAberrationEnabled;
  124653. private _grainEnabled;
  124654. private _buildAllowed;
  124655. /**
  124656. * Gets active scene
  124657. */
  124658. readonly scene: Scene;
  124659. /**
  124660. * Enable or disable the sharpen process from the pipeline
  124661. */
  124662. sharpenEnabled: boolean;
  124663. private _resizeObserver;
  124664. private _hardwareScaleLevel;
  124665. private _bloomKernel;
  124666. /**
  124667. * Specifies the size of the bloom blur kernel, relative to the final output size
  124668. */
  124669. bloomKernel: number;
  124670. /**
  124671. * Specifies the weight of the bloom in the final rendering
  124672. */
  124673. private _bloomWeight;
  124674. /**
  124675. * Specifies the luma threshold for the area that will be blurred by the bloom
  124676. */
  124677. private _bloomThreshold;
  124678. private _hdr;
  124679. /**
  124680. * The strength of the bloom.
  124681. */
  124682. bloomWeight: number;
  124683. /**
  124684. * The strength of the bloom.
  124685. */
  124686. bloomThreshold: number;
  124687. /**
  124688. * The scale of the bloom, lower value will provide better performance.
  124689. */
  124690. bloomScale: number;
  124691. /**
  124692. * Enable or disable the bloom from the pipeline
  124693. */
  124694. bloomEnabled: boolean;
  124695. private _rebuildBloom;
  124696. /**
  124697. * If the depth of field is enabled.
  124698. */
  124699. depthOfFieldEnabled: boolean;
  124700. /**
  124701. * Blur level of the depth of field effect. (Higher blur will effect performance)
  124702. */
  124703. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  124704. /**
  124705. * If the anti aliasing is enabled.
  124706. */
  124707. fxaaEnabled: boolean;
  124708. private _samples;
  124709. /**
  124710. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  124711. */
  124712. samples: number;
  124713. /**
  124714. * If image processing is enabled.
  124715. */
  124716. imageProcessingEnabled: boolean;
  124717. /**
  124718. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  124719. */
  124720. glowLayerEnabled: boolean;
  124721. /**
  124722. * Gets the glow layer (or null if not defined)
  124723. */
  124724. readonly glowLayer: Nullable<GlowLayer>;
  124725. /**
  124726. * Enable or disable the chromaticAberration process from the pipeline
  124727. */
  124728. chromaticAberrationEnabled: boolean;
  124729. /**
  124730. * Enable or disable the grain process from the pipeline
  124731. */
  124732. grainEnabled: boolean;
  124733. /**
  124734. * @constructor
  124735. * @param name - The rendering pipeline name (default: "")
  124736. * @param hdr - If high dynamic range textures should be used (default: true)
  124737. * @param scene - The scene linked to this pipeline (default: the last created scene)
  124738. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  124739. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  124740. */
  124741. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  124742. /**
  124743. * Get the class name
  124744. * @returns "DefaultRenderingPipeline"
  124745. */
  124746. getClassName(): string;
  124747. /**
  124748. * Force the compilation of the entire pipeline.
  124749. */
  124750. prepare(): void;
  124751. private _hasCleared;
  124752. private _prevPostProcess;
  124753. private _prevPrevPostProcess;
  124754. private _setAutoClearAndTextureSharing;
  124755. private _depthOfFieldSceneObserver;
  124756. private _buildPipeline;
  124757. private _disposePostProcesses;
  124758. /**
  124759. * Adds a camera to the pipeline
  124760. * @param camera the camera to be added
  124761. */
  124762. addCamera(camera: Camera): void;
  124763. /**
  124764. * Removes a camera from the pipeline
  124765. * @param camera the camera to remove
  124766. */
  124767. removeCamera(camera: Camera): void;
  124768. /**
  124769. * Dispose of the pipeline and stop all post processes
  124770. */
  124771. dispose(): void;
  124772. /**
  124773. * Serialize the rendering pipeline (Used when exporting)
  124774. * @returns the serialized object
  124775. */
  124776. serialize(): any;
  124777. /**
  124778. * Parse the serialized pipeline
  124779. * @param source Source pipeline.
  124780. * @param scene The scene to load the pipeline to.
  124781. * @param rootUrl The URL of the serialized pipeline.
  124782. * @returns An instantiated pipeline from the serialized object.
  124783. */
  124784. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  124785. }
  124786. }
  124787. declare module BABYLON {
  124788. /** @hidden */
  124789. export var lensHighlightsPixelShader: {
  124790. name: string;
  124791. shader: string;
  124792. };
  124793. }
  124794. declare module BABYLON {
  124795. /** @hidden */
  124796. export var depthOfFieldPixelShader: {
  124797. name: string;
  124798. shader: string;
  124799. };
  124800. }
  124801. declare module BABYLON {
  124802. /**
  124803. * BABYLON.JS Chromatic Aberration GLSL Shader
  124804. * Author: Olivier Guyot
  124805. * Separates very slightly R, G and B colors on the edges of the screen
  124806. * Inspired by Francois Tarlier & Martins Upitis
  124807. */
  124808. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  124809. /**
  124810. * @ignore
  124811. * The chromatic aberration PostProcess id in the pipeline
  124812. */
  124813. LensChromaticAberrationEffect: string;
  124814. /**
  124815. * @ignore
  124816. * The highlights enhancing PostProcess id in the pipeline
  124817. */
  124818. HighlightsEnhancingEffect: string;
  124819. /**
  124820. * @ignore
  124821. * The depth-of-field PostProcess id in the pipeline
  124822. */
  124823. LensDepthOfFieldEffect: string;
  124824. private _scene;
  124825. private _depthTexture;
  124826. private _grainTexture;
  124827. private _chromaticAberrationPostProcess;
  124828. private _highlightsPostProcess;
  124829. private _depthOfFieldPostProcess;
  124830. private _edgeBlur;
  124831. private _grainAmount;
  124832. private _chromaticAberration;
  124833. private _distortion;
  124834. private _highlightsGain;
  124835. private _highlightsThreshold;
  124836. private _dofDistance;
  124837. private _dofAperture;
  124838. private _dofDarken;
  124839. private _dofPentagon;
  124840. private _blurNoise;
  124841. /**
  124842. * @constructor
  124843. *
  124844. * Effect parameters are as follow:
  124845. * {
  124846. * chromatic_aberration: number; // from 0 to x (1 for realism)
  124847. * edge_blur: number; // from 0 to x (1 for realism)
  124848. * distortion: number; // from 0 to x (1 for realism)
  124849. * grain_amount: number; // from 0 to 1
  124850. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  124851. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  124852. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  124853. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  124854. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  124855. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  124856. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  124857. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  124858. * }
  124859. * Note: if an effect parameter is unset, effect is disabled
  124860. *
  124861. * @param name The rendering pipeline name
  124862. * @param parameters - An object containing all parameters (see above)
  124863. * @param scene The scene linked to this pipeline
  124864. * @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)
  124865. * @param cameras The array of cameras that the rendering pipeline will be attached to
  124866. */
  124867. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  124868. /**
  124869. * Get the class name
  124870. * @returns "LensRenderingPipeline"
  124871. */
  124872. getClassName(): string;
  124873. /**
  124874. * Gets associated scene
  124875. */
  124876. readonly scene: Scene;
  124877. /**
  124878. * Gets or sets the edge blur
  124879. */
  124880. edgeBlur: number;
  124881. /**
  124882. * Gets or sets the grain amount
  124883. */
  124884. grainAmount: number;
  124885. /**
  124886. * Gets or sets the chromatic aberration amount
  124887. */
  124888. chromaticAberration: number;
  124889. /**
  124890. * Gets or sets the depth of field aperture
  124891. */
  124892. dofAperture: number;
  124893. /**
  124894. * Gets or sets the edge distortion
  124895. */
  124896. edgeDistortion: number;
  124897. /**
  124898. * Gets or sets the depth of field distortion
  124899. */
  124900. dofDistortion: number;
  124901. /**
  124902. * Gets or sets the darken out of focus amount
  124903. */
  124904. darkenOutOfFocus: number;
  124905. /**
  124906. * Gets or sets a boolean indicating if blur noise is enabled
  124907. */
  124908. blurNoise: boolean;
  124909. /**
  124910. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  124911. */
  124912. pentagonBokeh: boolean;
  124913. /**
  124914. * Gets or sets the highlight grain amount
  124915. */
  124916. highlightsGain: number;
  124917. /**
  124918. * Gets or sets the highlight threshold
  124919. */
  124920. highlightsThreshold: number;
  124921. /**
  124922. * Sets the amount of blur at the edges
  124923. * @param amount blur amount
  124924. */
  124925. setEdgeBlur(amount: number): void;
  124926. /**
  124927. * Sets edge blur to 0
  124928. */
  124929. disableEdgeBlur(): void;
  124930. /**
  124931. * Sets the amout of grain
  124932. * @param amount Amount of grain
  124933. */
  124934. setGrainAmount(amount: number): void;
  124935. /**
  124936. * Set grain amount to 0
  124937. */
  124938. disableGrain(): void;
  124939. /**
  124940. * Sets the chromatic aberration amount
  124941. * @param amount amount of chromatic aberration
  124942. */
  124943. setChromaticAberration(amount: number): void;
  124944. /**
  124945. * Sets chromatic aberration amount to 0
  124946. */
  124947. disableChromaticAberration(): void;
  124948. /**
  124949. * Sets the EdgeDistortion amount
  124950. * @param amount amount of EdgeDistortion
  124951. */
  124952. setEdgeDistortion(amount: number): void;
  124953. /**
  124954. * Sets edge distortion to 0
  124955. */
  124956. disableEdgeDistortion(): void;
  124957. /**
  124958. * Sets the FocusDistance amount
  124959. * @param amount amount of FocusDistance
  124960. */
  124961. setFocusDistance(amount: number): void;
  124962. /**
  124963. * Disables depth of field
  124964. */
  124965. disableDepthOfField(): void;
  124966. /**
  124967. * Sets the Aperture amount
  124968. * @param amount amount of Aperture
  124969. */
  124970. setAperture(amount: number): void;
  124971. /**
  124972. * Sets the DarkenOutOfFocus amount
  124973. * @param amount amount of DarkenOutOfFocus
  124974. */
  124975. setDarkenOutOfFocus(amount: number): void;
  124976. private _pentagonBokehIsEnabled;
  124977. /**
  124978. * Creates a pentagon bokeh effect
  124979. */
  124980. enablePentagonBokeh(): void;
  124981. /**
  124982. * Disables the pentagon bokeh effect
  124983. */
  124984. disablePentagonBokeh(): void;
  124985. /**
  124986. * Enables noise blur
  124987. */
  124988. enableNoiseBlur(): void;
  124989. /**
  124990. * Disables noise blur
  124991. */
  124992. disableNoiseBlur(): void;
  124993. /**
  124994. * Sets the HighlightsGain amount
  124995. * @param amount amount of HighlightsGain
  124996. */
  124997. setHighlightsGain(amount: number): void;
  124998. /**
  124999. * Sets the HighlightsThreshold amount
  125000. * @param amount amount of HighlightsThreshold
  125001. */
  125002. setHighlightsThreshold(amount: number): void;
  125003. /**
  125004. * Disables highlights
  125005. */
  125006. disableHighlights(): void;
  125007. /**
  125008. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  125009. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  125010. */
  125011. dispose(disableDepthRender?: boolean): void;
  125012. private _createChromaticAberrationPostProcess;
  125013. private _createHighlightsPostProcess;
  125014. private _createDepthOfFieldPostProcess;
  125015. private _createGrainTexture;
  125016. }
  125017. }
  125018. declare module BABYLON {
  125019. /** @hidden */
  125020. export var ssao2PixelShader: {
  125021. name: string;
  125022. shader: string;
  125023. };
  125024. }
  125025. declare module BABYLON {
  125026. /** @hidden */
  125027. export var ssaoCombinePixelShader: {
  125028. name: string;
  125029. shader: string;
  125030. };
  125031. }
  125032. declare module BABYLON {
  125033. /**
  125034. * Render pipeline to produce ssao effect
  125035. */
  125036. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  125037. /**
  125038. * @ignore
  125039. * The PassPostProcess id in the pipeline that contains the original scene color
  125040. */
  125041. SSAOOriginalSceneColorEffect: string;
  125042. /**
  125043. * @ignore
  125044. * The SSAO PostProcess id in the pipeline
  125045. */
  125046. SSAORenderEffect: string;
  125047. /**
  125048. * @ignore
  125049. * The horizontal blur PostProcess id in the pipeline
  125050. */
  125051. SSAOBlurHRenderEffect: string;
  125052. /**
  125053. * @ignore
  125054. * The vertical blur PostProcess id in the pipeline
  125055. */
  125056. SSAOBlurVRenderEffect: string;
  125057. /**
  125058. * @ignore
  125059. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  125060. */
  125061. SSAOCombineRenderEffect: string;
  125062. /**
  125063. * The output strength of the SSAO post-process. Default value is 1.0.
  125064. */
  125065. totalStrength: number;
  125066. /**
  125067. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  125068. */
  125069. maxZ: number;
  125070. /**
  125071. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  125072. */
  125073. minZAspect: number;
  125074. private _samples;
  125075. /**
  125076. * Number of samples used for the SSAO calculations. Default value is 8
  125077. */
  125078. samples: number;
  125079. private _textureSamples;
  125080. /**
  125081. * Number of samples to use for antialiasing
  125082. */
  125083. textureSamples: number;
  125084. /**
  125085. * Ratio object used for SSAO ratio and blur ratio
  125086. */
  125087. private _ratio;
  125088. /**
  125089. * Dynamically generated sphere sampler.
  125090. */
  125091. private _sampleSphere;
  125092. /**
  125093. * Blur filter offsets
  125094. */
  125095. private _samplerOffsets;
  125096. private _expensiveBlur;
  125097. /**
  125098. * If bilateral blur should be used
  125099. */
  125100. expensiveBlur: boolean;
  125101. /**
  125102. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  125103. */
  125104. radius: number;
  125105. /**
  125106. * The base color of the SSAO post-process
  125107. * The final result is "base + ssao" between [0, 1]
  125108. */
  125109. base: number;
  125110. /**
  125111. * Support test.
  125112. */
  125113. static readonly IsSupported: boolean;
  125114. private _scene;
  125115. private _depthTexture;
  125116. private _normalTexture;
  125117. private _randomTexture;
  125118. private _originalColorPostProcess;
  125119. private _ssaoPostProcess;
  125120. private _blurHPostProcess;
  125121. private _blurVPostProcess;
  125122. private _ssaoCombinePostProcess;
  125123. private _firstUpdate;
  125124. /**
  125125. * Gets active scene
  125126. */
  125127. readonly scene: Scene;
  125128. /**
  125129. * @constructor
  125130. * @param name The rendering pipeline name
  125131. * @param scene The scene linked to this pipeline
  125132. * @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 }
  125133. * @param cameras The array of cameras that the rendering pipeline will be attached to
  125134. */
  125135. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  125136. /**
  125137. * Get the class name
  125138. * @returns "SSAO2RenderingPipeline"
  125139. */
  125140. getClassName(): string;
  125141. /**
  125142. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  125143. */
  125144. dispose(disableGeometryBufferRenderer?: boolean): void;
  125145. private _createBlurPostProcess;
  125146. /** @hidden */
  125147. _rebuild(): void;
  125148. private _bits;
  125149. private _radicalInverse_VdC;
  125150. private _hammersley;
  125151. private _hemisphereSample_uniform;
  125152. private _generateHemisphere;
  125153. private _createSSAOPostProcess;
  125154. private _createSSAOCombinePostProcess;
  125155. private _createRandomTexture;
  125156. /**
  125157. * Serialize the rendering pipeline (Used when exporting)
  125158. * @returns the serialized object
  125159. */
  125160. serialize(): any;
  125161. /**
  125162. * Parse the serialized pipeline
  125163. * @param source Source pipeline.
  125164. * @param scene The scene to load the pipeline to.
  125165. * @param rootUrl The URL of the serialized pipeline.
  125166. * @returns An instantiated pipeline from the serialized object.
  125167. */
  125168. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  125169. }
  125170. }
  125171. declare module BABYLON {
  125172. /** @hidden */
  125173. export var ssaoPixelShader: {
  125174. name: string;
  125175. shader: string;
  125176. };
  125177. }
  125178. declare module BABYLON {
  125179. /**
  125180. * Render pipeline to produce ssao effect
  125181. */
  125182. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  125183. /**
  125184. * @ignore
  125185. * The PassPostProcess id in the pipeline that contains the original scene color
  125186. */
  125187. SSAOOriginalSceneColorEffect: string;
  125188. /**
  125189. * @ignore
  125190. * The SSAO PostProcess id in the pipeline
  125191. */
  125192. SSAORenderEffect: string;
  125193. /**
  125194. * @ignore
  125195. * The horizontal blur PostProcess id in the pipeline
  125196. */
  125197. SSAOBlurHRenderEffect: string;
  125198. /**
  125199. * @ignore
  125200. * The vertical blur PostProcess id in the pipeline
  125201. */
  125202. SSAOBlurVRenderEffect: string;
  125203. /**
  125204. * @ignore
  125205. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  125206. */
  125207. SSAOCombineRenderEffect: string;
  125208. /**
  125209. * The output strength of the SSAO post-process. Default value is 1.0.
  125210. */
  125211. totalStrength: number;
  125212. /**
  125213. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  125214. */
  125215. radius: number;
  125216. /**
  125217. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  125218. * Must not be equal to fallOff and superior to fallOff.
  125219. * Default value is 0.0075
  125220. */
  125221. area: number;
  125222. /**
  125223. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  125224. * Must not be equal to area and inferior to area.
  125225. * Default value is 0.000001
  125226. */
  125227. fallOff: number;
  125228. /**
  125229. * The base color of the SSAO post-process
  125230. * The final result is "base + ssao" between [0, 1]
  125231. */
  125232. base: number;
  125233. private _scene;
  125234. private _depthTexture;
  125235. private _randomTexture;
  125236. private _originalColorPostProcess;
  125237. private _ssaoPostProcess;
  125238. private _blurHPostProcess;
  125239. private _blurVPostProcess;
  125240. private _ssaoCombinePostProcess;
  125241. private _firstUpdate;
  125242. /**
  125243. * Gets active scene
  125244. */
  125245. readonly scene: Scene;
  125246. /**
  125247. * @constructor
  125248. * @param name - The rendering pipeline name
  125249. * @param scene - The scene linked to this pipeline
  125250. * @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 }
  125251. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  125252. */
  125253. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  125254. /**
  125255. * Get the class name
  125256. * @returns "SSAORenderingPipeline"
  125257. */
  125258. getClassName(): string;
  125259. /**
  125260. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  125261. */
  125262. dispose(disableDepthRender?: boolean): void;
  125263. private _createBlurPostProcess;
  125264. /** @hidden */
  125265. _rebuild(): void;
  125266. private _createSSAOPostProcess;
  125267. private _createSSAOCombinePostProcess;
  125268. private _createRandomTexture;
  125269. }
  125270. }
  125271. declare module BABYLON {
  125272. /** @hidden */
  125273. export var standardPixelShader: {
  125274. name: string;
  125275. shader: string;
  125276. };
  125277. }
  125278. declare module BABYLON {
  125279. /**
  125280. * Standard rendering pipeline
  125281. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  125282. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  125283. */
  125284. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  125285. /**
  125286. * Public members
  125287. */
  125288. /**
  125289. * Post-process which contains the original scene color before the pipeline applies all the effects
  125290. */
  125291. originalPostProcess: Nullable<PostProcess>;
  125292. /**
  125293. * Post-process used to down scale an image x4
  125294. */
  125295. downSampleX4PostProcess: Nullable<PostProcess>;
  125296. /**
  125297. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  125298. */
  125299. brightPassPostProcess: Nullable<PostProcess>;
  125300. /**
  125301. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  125302. */
  125303. blurHPostProcesses: PostProcess[];
  125304. /**
  125305. * Post-process array storing all the vertical blur post-processes used by the pipeline
  125306. */
  125307. blurVPostProcesses: PostProcess[];
  125308. /**
  125309. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  125310. */
  125311. textureAdderPostProcess: Nullable<PostProcess>;
  125312. /**
  125313. * Post-process used to create volumetric lighting effect
  125314. */
  125315. volumetricLightPostProcess: Nullable<PostProcess>;
  125316. /**
  125317. * Post-process used to smooth the previous volumetric light post-process on the X axis
  125318. */
  125319. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  125320. /**
  125321. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  125322. */
  125323. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  125324. /**
  125325. * Post-process used to merge the volumetric light effect and the real scene color
  125326. */
  125327. volumetricLightMergePostProces: Nullable<PostProcess>;
  125328. /**
  125329. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  125330. */
  125331. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  125332. /**
  125333. * Base post-process used to calculate the average luminance of the final image for HDR
  125334. */
  125335. luminancePostProcess: Nullable<PostProcess>;
  125336. /**
  125337. * Post-processes used to create down sample post-processes in order to get
  125338. * the average luminance of the final image for HDR
  125339. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  125340. */
  125341. luminanceDownSamplePostProcesses: PostProcess[];
  125342. /**
  125343. * Post-process used to create a HDR effect (light adaptation)
  125344. */
  125345. hdrPostProcess: Nullable<PostProcess>;
  125346. /**
  125347. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  125348. */
  125349. textureAdderFinalPostProcess: Nullable<PostProcess>;
  125350. /**
  125351. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  125352. */
  125353. lensFlareFinalPostProcess: Nullable<PostProcess>;
  125354. /**
  125355. * Post-process used to merge the final HDR post-process and the real scene color
  125356. */
  125357. hdrFinalPostProcess: Nullable<PostProcess>;
  125358. /**
  125359. * Post-process used to create a lens flare effect
  125360. */
  125361. lensFlarePostProcess: Nullable<PostProcess>;
  125362. /**
  125363. * Post-process that merges the result of the lens flare post-process and the real scene color
  125364. */
  125365. lensFlareComposePostProcess: Nullable<PostProcess>;
  125366. /**
  125367. * Post-process used to create a motion blur effect
  125368. */
  125369. motionBlurPostProcess: Nullable<PostProcess>;
  125370. /**
  125371. * Post-process used to create a depth of field effect
  125372. */
  125373. depthOfFieldPostProcess: Nullable<PostProcess>;
  125374. /**
  125375. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  125376. */
  125377. fxaaPostProcess: Nullable<FxaaPostProcess>;
  125378. /**
  125379. * Represents the brightness threshold in order to configure the illuminated surfaces
  125380. */
  125381. brightThreshold: number;
  125382. /**
  125383. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  125384. */
  125385. blurWidth: number;
  125386. /**
  125387. * Sets if the blur for highlighted surfaces must be only horizontal
  125388. */
  125389. horizontalBlur: boolean;
  125390. /**
  125391. * Gets the overall exposure used by the pipeline
  125392. */
  125393. /**
  125394. * Sets the overall exposure used by the pipeline
  125395. */
  125396. exposure: number;
  125397. /**
  125398. * Texture used typically to simulate "dirty" on camera lens
  125399. */
  125400. lensTexture: Nullable<Texture>;
  125401. /**
  125402. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  125403. */
  125404. volumetricLightCoefficient: number;
  125405. /**
  125406. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  125407. */
  125408. volumetricLightPower: number;
  125409. /**
  125410. * Used the set the blur intensity to smooth the volumetric lights
  125411. */
  125412. volumetricLightBlurScale: number;
  125413. /**
  125414. * Light (spot or directional) used to generate the volumetric lights rays
  125415. * The source light must have a shadow generate so the pipeline can get its
  125416. * depth map
  125417. */
  125418. sourceLight: Nullable<SpotLight | DirectionalLight>;
  125419. /**
  125420. * For eye adaptation, represents the minimum luminance the eye can see
  125421. */
  125422. hdrMinimumLuminance: number;
  125423. /**
  125424. * For eye adaptation, represents the decrease luminance speed
  125425. */
  125426. hdrDecreaseRate: number;
  125427. /**
  125428. * For eye adaptation, represents the increase luminance speed
  125429. */
  125430. hdrIncreaseRate: number;
  125431. /**
  125432. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  125433. */
  125434. /**
  125435. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  125436. */
  125437. hdrAutoExposure: boolean;
  125438. /**
  125439. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  125440. */
  125441. lensColorTexture: Nullable<Texture>;
  125442. /**
  125443. * The overall strengh for the lens flare effect
  125444. */
  125445. lensFlareStrength: number;
  125446. /**
  125447. * Dispersion coefficient for lens flare ghosts
  125448. */
  125449. lensFlareGhostDispersal: number;
  125450. /**
  125451. * Main lens flare halo width
  125452. */
  125453. lensFlareHaloWidth: number;
  125454. /**
  125455. * Based on the lens distortion effect, defines how much the lens flare result
  125456. * is distorted
  125457. */
  125458. lensFlareDistortionStrength: number;
  125459. /**
  125460. * Configures the blur intensity used for for lens flare (halo)
  125461. */
  125462. lensFlareBlurWidth: number;
  125463. /**
  125464. * Lens star texture must be used to simulate rays on the flares and is available
  125465. * in the documentation
  125466. */
  125467. lensStarTexture: Nullable<Texture>;
  125468. /**
  125469. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  125470. * flare effect by taking account of the dirt texture
  125471. */
  125472. lensFlareDirtTexture: Nullable<Texture>;
  125473. /**
  125474. * Represents the focal length for the depth of field effect
  125475. */
  125476. depthOfFieldDistance: number;
  125477. /**
  125478. * Represents the blur intensity for the blurred part of the depth of field effect
  125479. */
  125480. depthOfFieldBlurWidth: number;
  125481. /**
  125482. * Gets how much the image is blurred by the movement while using the motion blur post-process
  125483. */
  125484. /**
  125485. * Sets how much the image is blurred by the movement while using the motion blur post-process
  125486. */
  125487. motionStrength: number;
  125488. /**
  125489. * Gets wether or not the motion blur post-process is object based or screen based.
  125490. */
  125491. /**
  125492. * Sets wether or not the motion blur post-process should be object based or screen based
  125493. */
  125494. objectBasedMotionBlur: boolean;
  125495. /**
  125496. * List of animations for the pipeline (IAnimatable implementation)
  125497. */
  125498. animations: Animation[];
  125499. /**
  125500. * Private members
  125501. */
  125502. private _scene;
  125503. private _currentDepthOfFieldSource;
  125504. private _basePostProcess;
  125505. private _fixedExposure;
  125506. private _currentExposure;
  125507. private _hdrAutoExposure;
  125508. private _hdrCurrentLuminance;
  125509. private _motionStrength;
  125510. private _isObjectBasedMotionBlur;
  125511. private _floatTextureType;
  125512. private _camerasToBeAttached;
  125513. private _ratio;
  125514. private _bloomEnabled;
  125515. private _depthOfFieldEnabled;
  125516. private _vlsEnabled;
  125517. private _lensFlareEnabled;
  125518. private _hdrEnabled;
  125519. private _motionBlurEnabled;
  125520. private _fxaaEnabled;
  125521. private _motionBlurSamples;
  125522. private _volumetricLightStepsCount;
  125523. private _samples;
  125524. /**
  125525. * @ignore
  125526. * Specifies if the bloom pipeline is enabled
  125527. */
  125528. BloomEnabled: boolean;
  125529. /**
  125530. * @ignore
  125531. * Specifies if the depth of field pipeline is enabed
  125532. */
  125533. DepthOfFieldEnabled: boolean;
  125534. /**
  125535. * @ignore
  125536. * Specifies if the lens flare pipeline is enabed
  125537. */
  125538. LensFlareEnabled: boolean;
  125539. /**
  125540. * @ignore
  125541. * Specifies if the HDR pipeline is enabled
  125542. */
  125543. HDREnabled: boolean;
  125544. /**
  125545. * @ignore
  125546. * Specifies if the volumetric lights scattering effect is enabled
  125547. */
  125548. VLSEnabled: boolean;
  125549. /**
  125550. * @ignore
  125551. * Specifies if the motion blur effect is enabled
  125552. */
  125553. MotionBlurEnabled: boolean;
  125554. /**
  125555. * Specifies if anti-aliasing is enabled
  125556. */
  125557. fxaaEnabled: boolean;
  125558. /**
  125559. * Specifies the number of steps used to calculate the volumetric lights
  125560. * Typically in interval [50, 200]
  125561. */
  125562. volumetricLightStepsCount: number;
  125563. /**
  125564. * Specifies the number of samples used for the motion blur effect
  125565. * Typically in interval [16, 64]
  125566. */
  125567. motionBlurSamples: number;
  125568. /**
  125569. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  125570. */
  125571. samples: number;
  125572. /**
  125573. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  125574. * @constructor
  125575. * @param name The rendering pipeline name
  125576. * @param scene The scene linked to this pipeline
  125577. * @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)
  125578. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  125579. * @param cameras The array of cameras that the rendering pipeline will be attached to
  125580. */
  125581. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  125582. private _buildPipeline;
  125583. private _createDownSampleX4PostProcess;
  125584. private _createBrightPassPostProcess;
  125585. private _createBlurPostProcesses;
  125586. private _createTextureAdderPostProcess;
  125587. private _createVolumetricLightPostProcess;
  125588. private _createLuminancePostProcesses;
  125589. private _createHdrPostProcess;
  125590. private _createLensFlarePostProcess;
  125591. private _createDepthOfFieldPostProcess;
  125592. private _createMotionBlurPostProcess;
  125593. private _getDepthTexture;
  125594. private _disposePostProcesses;
  125595. /**
  125596. * Dispose of the pipeline and stop all post processes
  125597. */
  125598. dispose(): void;
  125599. /**
  125600. * Serialize the rendering pipeline (Used when exporting)
  125601. * @returns the serialized object
  125602. */
  125603. serialize(): any;
  125604. /**
  125605. * Parse the serialized pipeline
  125606. * @param source Source pipeline.
  125607. * @param scene The scene to load the pipeline to.
  125608. * @param rootUrl The URL of the serialized pipeline.
  125609. * @returns An instantiated pipeline from the serialized object.
  125610. */
  125611. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  125612. /**
  125613. * Luminance steps
  125614. */
  125615. static LuminanceSteps: number;
  125616. }
  125617. }
  125618. declare module BABYLON {
  125619. /** @hidden */
  125620. export var tonemapPixelShader: {
  125621. name: string;
  125622. shader: string;
  125623. };
  125624. }
  125625. declare module BABYLON {
  125626. /** Defines operator used for tonemapping */
  125627. export enum TonemappingOperator {
  125628. /** Hable */
  125629. Hable = 0,
  125630. /** Reinhard */
  125631. Reinhard = 1,
  125632. /** HejiDawson */
  125633. HejiDawson = 2,
  125634. /** Photographic */
  125635. Photographic = 3
  125636. }
  125637. /**
  125638. * Defines a post process to apply tone mapping
  125639. */
  125640. export class TonemapPostProcess extends PostProcess {
  125641. private _operator;
  125642. /** Defines the required exposure adjustement */
  125643. exposureAdjustment: number;
  125644. /**
  125645. * Creates a new TonemapPostProcess
  125646. * @param name defines the name of the postprocess
  125647. * @param _operator defines the operator to use
  125648. * @param exposureAdjustment defines the required exposure adjustement
  125649. * @param camera defines the camera to use (can be null)
  125650. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  125651. * @param engine defines the hosting engine (can be ignore if camera is set)
  125652. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  125653. */
  125654. constructor(name: string, _operator: TonemappingOperator,
  125655. /** Defines the required exposure adjustement */
  125656. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  125657. }
  125658. }
  125659. declare module BABYLON {
  125660. /** @hidden */
  125661. export var depthVertexShader: {
  125662. name: string;
  125663. shader: string;
  125664. };
  125665. }
  125666. declare module BABYLON {
  125667. /** @hidden */
  125668. export var volumetricLightScatteringPixelShader: {
  125669. name: string;
  125670. shader: string;
  125671. };
  125672. }
  125673. declare module BABYLON {
  125674. /** @hidden */
  125675. export var volumetricLightScatteringPassVertexShader: {
  125676. name: string;
  125677. shader: string;
  125678. };
  125679. }
  125680. declare module BABYLON {
  125681. /** @hidden */
  125682. export var volumetricLightScatteringPassPixelShader: {
  125683. name: string;
  125684. shader: string;
  125685. };
  125686. }
  125687. declare module BABYLON {
  125688. /**
  125689. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  125690. */
  125691. export class VolumetricLightScatteringPostProcess extends PostProcess {
  125692. private _volumetricLightScatteringPass;
  125693. private _volumetricLightScatteringRTT;
  125694. private _viewPort;
  125695. private _screenCoordinates;
  125696. private _cachedDefines;
  125697. /**
  125698. * If not undefined, the mesh position is computed from the attached node position
  125699. */
  125700. attachedNode: {
  125701. position: Vector3;
  125702. };
  125703. /**
  125704. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  125705. */
  125706. customMeshPosition: Vector3;
  125707. /**
  125708. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  125709. */
  125710. useCustomMeshPosition: boolean;
  125711. /**
  125712. * If the post-process should inverse the light scattering direction
  125713. */
  125714. invert: boolean;
  125715. /**
  125716. * The internal mesh used by the post-process
  125717. */
  125718. mesh: Mesh;
  125719. /**
  125720. * @hidden
  125721. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  125722. */
  125723. useDiffuseColor: boolean;
  125724. /**
  125725. * Array containing the excluded meshes not rendered in the internal pass
  125726. */
  125727. excludedMeshes: AbstractMesh[];
  125728. /**
  125729. * Controls the overall intensity of the post-process
  125730. */
  125731. exposure: number;
  125732. /**
  125733. * Dissipates each sample's contribution in range [0, 1]
  125734. */
  125735. decay: number;
  125736. /**
  125737. * Controls the overall intensity of each sample
  125738. */
  125739. weight: number;
  125740. /**
  125741. * Controls the density of each sample
  125742. */
  125743. density: number;
  125744. /**
  125745. * @constructor
  125746. * @param name The post-process name
  125747. * @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)
  125748. * @param camera The camera that the post-process will be attached to
  125749. * @param mesh The mesh used to create the light scattering
  125750. * @param samples The post-process quality, default 100
  125751. * @param samplingModeThe post-process filtering mode
  125752. * @param engine The babylon engine
  125753. * @param reusable If the post-process is reusable
  125754. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  125755. */
  125756. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  125757. /**
  125758. * Returns the string "VolumetricLightScatteringPostProcess"
  125759. * @returns "VolumetricLightScatteringPostProcess"
  125760. */
  125761. getClassName(): string;
  125762. private _isReady;
  125763. /**
  125764. * Sets the new light position for light scattering effect
  125765. * @param position The new custom light position
  125766. */
  125767. setCustomMeshPosition(position: Vector3): void;
  125768. /**
  125769. * Returns the light position for light scattering effect
  125770. * @return Vector3 The custom light position
  125771. */
  125772. getCustomMeshPosition(): Vector3;
  125773. /**
  125774. * Disposes the internal assets and detaches the post-process from the camera
  125775. */
  125776. dispose(camera: Camera): void;
  125777. /**
  125778. * Returns the render target texture used by the post-process
  125779. * @return the render target texture used by the post-process
  125780. */
  125781. getPass(): RenderTargetTexture;
  125782. private _meshExcluded;
  125783. private _createPass;
  125784. private _updateMeshScreenCoordinates;
  125785. /**
  125786. * Creates a default mesh for the Volumeric Light Scattering post-process
  125787. * @param name The mesh name
  125788. * @param scene The scene where to create the mesh
  125789. * @return the default mesh
  125790. */
  125791. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  125792. }
  125793. }
  125794. declare module BABYLON {
  125795. interface Scene {
  125796. /** @hidden (Backing field) */
  125797. _boundingBoxRenderer: BoundingBoxRenderer;
  125798. /** @hidden (Backing field) */
  125799. _forceShowBoundingBoxes: boolean;
  125800. /**
  125801. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  125802. */
  125803. forceShowBoundingBoxes: boolean;
  125804. /**
  125805. * Gets the bounding box renderer associated with the scene
  125806. * @returns a BoundingBoxRenderer
  125807. */
  125808. getBoundingBoxRenderer(): BoundingBoxRenderer;
  125809. }
  125810. interface AbstractMesh {
  125811. /** @hidden (Backing field) */
  125812. _showBoundingBox: boolean;
  125813. /**
  125814. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  125815. */
  125816. showBoundingBox: boolean;
  125817. }
  125818. /**
  125819. * Component responsible of rendering the bounding box of the meshes in a scene.
  125820. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  125821. */
  125822. export class BoundingBoxRenderer implements ISceneComponent {
  125823. /**
  125824. * The component name helpfull to identify the component in the list of scene components.
  125825. */
  125826. readonly name: string;
  125827. /**
  125828. * The scene the component belongs to.
  125829. */
  125830. scene: Scene;
  125831. /**
  125832. * Color of the bounding box lines placed in front of an object
  125833. */
  125834. frontColor: Color3;
  125835. /**
  125836. * Color of the bounding box lines placed behind an object
  125837. */
  125838. backColor: Color3;
  125839. /**
  125840. * Defines if the renderer should show the back lines or not
  125841. */
  125842. showBackLines: boolean;
  125843. /**
  125844. * @hidden
  125845. */
  125846. renderList: SmartArray<BoundingBox>;
  125847. private _colorShader;
  125848. private _vertexBuffers;
  125849. private _indexBuffer;
  125850. private _fillIndexBuffer;
  125851. private _fillIndexData;
  125852. /**
  125853. * Instantiates a new bounding box renderer in a scene.
  125854. * @param scene the scene the renderer renders in
  125855. */
  125856. constructor(scene: Scene);
  125857. /**
  125858. * Registers the component in a given scene
  125859. */
  125860. register(): void;
  125861. private _evaluateSubMesh;
  125862. private _activeMesh;
  125863. private _prepareRessources;
  125864. private _createIndexBuffer;
  125865. /**
  125866. * Rebuilds the elements related to this component in case of
  125867. * context lost for instance.
  125868. */
  125869. rebuild(): void;
  125870. /**
  125871. * @hidden
  125872. */
  125873. reset(): void;
  125874. /**
  125875. * Render the bounding boxes of a specific rendering group
  125876. * @param renderingGroupId defines the rendering group to render
  125877. */
  125878. render(renderingGroupId: number): void;
  125879. /**
  125880. * In case of occlusion queries, we can render the occlusion bounding box through this method
  125881. * @param mesh Define the mesh to render the occlusion bounding box for
  125882. */
  125883. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  125884. /**
  125885. * Dispose and release the resources attached to this renderer.
  125886. */
  125887. dispose(): void;
  125888. }
  125889. }
  125890. declare module BABYLON {
  125891. /** @hidden */
  125892. export var depthPixelShader: {
  125893. name: string;
  125894. shader: string;
  125895. };
  125896. }
  125897. declare module BABYLON {
  125898. /**
  125899. * This represents a depth renderer in Babylon.
  125900. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  125901. */
  125902. export class DepthRenderer {
  125903. private _scene;
  125904. private _depthMap;
  125905. private _effect;
  125906. private readonly _storeNonLinearDepth;
  125907. private readonly _clearColor;
  125908. /** Get if the depth renderer is using packed depth or not */
  125909. readonly isPacked: boolean;
  125910. private _cachedDefines;
  125911. private _camera;
  125912. /**
  125913. * Specifiess that the depth renderer will only be used within
  125914. * the camera it is created for.
  125915. * This can help forcing its rendering during the camera processing.
  125916. */
  125917. useOnlyInActiveCamera: boolean;
  125918. /** @hidden */
  125919. static _SceneComponentInitialization: (scene: Scene) => void;
  125920. /**
  125921. * Instantiates a depth renderer
  125922. * @param scene The scene the renderer belongs to
  125923. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  125924. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  125925. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  125926. */
  125927. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  125928. /**
  125929. * Creates the depth rendering effect and checks if the effect is ready.
  125930. * @param subMesh The submesh to be used to render the depth map of
  125931. * @param useInstances If multiple world instances should be used
  125932. * @returns if the depth renderer is ready to render the depth map
  125933. */
  125934. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  125935. /**
  125936. * Gets the texture which the depth map will be written to.
  125937. * @returns The depth map texture
  125938. */
  125939. getDepthMap(): RenderTargetTexture;
  125940. /**
  125941. * Disposes of the depth renderer.
  125942. */
  125943. dispose(): void;
  125944. }
  125945. }
  125946. declare module BABYLON {
  125947. interface Scene {
  125948. /** @hidden (Backing field) */
  125949. _depthRenderer: {
  125950. [id: string]: DepthRenderer;
  125951. };
  125952. /**
  125953. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  125954. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  125955. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  125956. * @returns the created depth renderer
  125957. */
  125958. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  125959. /**
  125960. * Disables a depth renderer for a given camera
  125961. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  125962. */
  125963. disableDepthRenderer(camera?: Nullable<Camera>): void;
  125964. }
  125965. /**
  125966. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  125967. * in several rendering techniques.
  125968. */
  125969. export class DepthRendererSceneComponent implements ISceneComponent {
  125970. /**
  125971. * The component name helpfull to identify the component in the list of scene components.
  125972. */
  125973. readonly name: string;
  125974. /**
  125975. * The scene the component belongs to.
  125976. */
  125977. scene: Scene;
  125978. /**
  125979. * Creates a new instance of the component for the given scene
  125980. * @param scene Defines the scene to register the component in
  125981. */
  125982. constructor(scene: Scene);
  125983. /**
  125984. * Registers the component in a given scene
  125985. */
  125986. register(): void;
  125987. /**
  125988. * Rebuilds the elements related to this component in case of
  125989. * context lost for instance.
  125990. */
  125991. rebuild(): void;
  125992. /**
  125993. * Disposes the component and the associated ressources
  125994. */
  125995. dispose(): void;
  125996. private _gatherRenderTargets;
  125997. private _gatherActiveCameraRenderTargets;
  125998. }
  125999. }
  126000. declare module BABYLON {
  126001. /** @hidden */
  126002. export var outlinePixelShader: {
  126003. name: string;
  126004. shader: string;
  126005. };
  126006. }
  126007. declare module BABYLON {
  126008. /** @hidden */
  126009. export var outlineVertexShader: {
  126010. name: string;
  126011. shader: string;
  126012. };
  126013. }
  126014. declare module BABYLON {
  126015. interface Scene {
  126016. /** @hidden */
  126017. _outlineRenderer: OutlineRenderer;
  126018. /**
  126019. * Gets the outline renderer associated with the scene
  126020. * @returns a OutlineRenderer
  126021. */
  126022. getOutlineRenderer(): OutlineRenderer;
  126023. }
  126024. interface AbstractMesh {
  126025. /** @hidden (Backing field) */
  126026. _renderOutline: boolean;
  126027. /**
  126028. * Gets or sets a boolean indicating if the outline must be rendered as well
  126029. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  126030. */
  126031. renderOutline: boolean;
  126032. /** @hidden (Backing field) */
  126033. _renderOverlay: boolean;
  126034. /**
  126035. * Gets or sets a boolean indicating if the overlay must be rendered as well
  126036. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  126037. */
  126038. renderOverlay: boolean;
  126039. }
  126040. /**
  126041. * This class is responsible to draw bothe outline/overlay of meshes.
  126042. * It should not be used directly but through the available method on mesh.
  126043. */
  126044. export class OutlineRenderer implements ISceneComponent {
  126045. /**
  126046. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  126047. */
  126048. private static _StencilReference;
  126049. /**
  126050. * The name of the component. Each component must have a unique name.
  126051. */
  126052. name: string;
  126053. /**
  126054. * The scene the component belongs to.
  126055. */
  126056. scene: Scene;
  126057. /**
  126058. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  126059. */
  126060. zOffset: number;
  126061. private _engine;
  126062. private _effect;
  126063. private _cachedDefines;
  126064. private _savedDepthWrite;
  126065. /**
  126066. * Instantiates a new outline renderer. (There could be only one per scene).
  126067. * @param scene Defines the scene it belongs to
  126068. */
  126069. constructor(scene: Scene);
  126070. /**
  126071. * Register the component to one instance of a scene.
  126072. */
  126073. register(): void;
  126074. /**
  126075. * Rebuilds the elements related to this component in case of
  126076. * context lost for instance.
  126077. */
  126078. rebuild(): void;
  126079. /**
  126080. * Disposes the component and the associated ressources.
  126081. */
  126082. dispose(): void;
  126083. /**
  126084. * Renders the outline in the canvas.
  126085. * @param subMesh Defines the sumesh to render
  126086. * @param batch Defines the batch of meshes in case of instances
  126087. * @param useOverlay Defines if the rendering is for the overlay or the outline
  126088. */
  126089. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  126090. /**
  126091. * Returns whether or not the outline renderer is ready for a given submesh.
  126092. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  126093. * @param subMesh Defines the submesh to check readyness for
  126094. * @param useInstances Defines wheter wee are trying to render instances or not
  126095. * @returns true if ready otherwise false
  126096. */
  126097. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  126098. private _beforeRenderingMesh;
  126099. private _afterRenderingMesh;
  126100. }
  126101. }
  126102. declare module BABYLON {
  126103. /**
  126104. * Class used to manage multiple sprites of different sizes on the same spritesheet
  126105. * @see http://doc.babylonjs.com/babylon101/sprites
  126106. */
  126107. export class SpritePackedManager extends SpriteManager {
  126108. /** defines the packed manager's name */
  126109. name: string;
  126110. /**
  126111. * Creates a new sprite manager from a packed sprite sheet
  126112. * @param name defines the manager's name
  126113. * @param imgUrl defines the sprite sheet url
  126114. * @param capacity defines the maximum allowed number of sprites
  126115. * @param scene defines the hosting scene
  126116. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  126117. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  126118. * @param samplingMode defines the smapling mode to use with spritesheet
  126119. * @param fromPacked set to true; do not alter
  126120. */
  126121. constructor(
  126122. /** defines the packed manager's name */
  126123. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  126124. }
  126125. }
  126126. declare module BABYLON {
  126127. /**
  126128. * Defines the list of states available for a task inside a AssetsManager
  126129. */
  126130. export enum AssetTaskState {
  126131. /**
  126132. * Initialization
  126133. */
  126134. INIT = 0,
  126135. /**
  126136. * Running
  126137. */
  126138. RUNNING = 1,
  126139. /**
  126140. * Done
  126141. */
  126142. DONE = 2,
  126143. /**
  126144. * Error
  126145. */
  126146. ERROR = 3
  126147. }
  126148. /**
  126149. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  126150. */
  126151. export abstract class AbstractAssetTask {
  126152. /**
  126153. * Task name
  126154. */ name: string;
  126155. /**
  126156. * Callback called when the task is successful
  126157. */
  126158. onSuccess: (task: any) => void;
  126159. /**
  126160. * Callback called when the task is not successful
  126161. */
  126162. onError: (task: any, message?: string, exception?: any) => void;
  126163. /**
  126164. * Creates a new AssetsManager
  126165. * @param name defines the name of the task
  126166. */
  126167. constructor(
  126168. /**
  126169. * Task name
  126170. */ name: string);
  126171. private _isCompleted;
  126172. private _taskState;
  126173. private _errorObject;
  126174. /**
  126175. * Get if the task is completed
  126176. */
  126177. readonly isCompleted: boolean;
  126178. /**
  126179. * Gets the current state of the task
  126180. */
  126181. readonly taskState: AssetTaskState;
  126182. /**
  126183. * Gets the current error object (if task is in error)
  126184. */
  126185. readonly errorObject: {
  126186. message?: string;
  126187. exception?: any;
  126188. };
  126189. /**
  126190. * Internal only
  126191. * @hidden
  126192. */
  126193. _setErrorObject(message?: string, exception?: any): void;
  126194. /**
  126195. * Execute the current task
  126196. * @param scene defines the scene where you want your assets to be loaded
  126197. * @param onSuccess is a callback called when the task is successfully executed
  126198. * @param onError is a callback called if an error occurs
  126199. */
  126200. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126201. /**
  126202. * Execute the current task
  126203. * @param scene defines the scene where you want your assets to be loaded
  126204. * @param onSuccess is a callback called when the task is successfully executed
  126205. * @param onError is a callback called if an error occurs
  126206. */
  126207. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126208. /**
  126209. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  126210. * This can be used with failed tasks that have the reason for failure fixed.
  126211. */
  126212. reset(): void;
  126213. private onErrorCallback;
  126214. private onDoneCallback;
  126215. }
  126216. /**
  126217. * Define the interface used by progress events raised during assets loading
  126218. */
  126219. export interface IAssetsProgressEvent {
  126220. /**
  126221. * Defines the number of remaining tasks to process
  126222. */
  126223. remainingCount: number;
  126224. /**
  126225. * Defines the total number of tasks
  126226. */
  126227. totalCount: number;
  126228. /**
  126229. * Defines the task that was just processed
  126230. */
  126231. task: AbstractAssetTask;
  126232. }
  126233. /**
  126234. * Class used to share progress information about assets loading
  126235. */
  126236. export class AssetsProgressEvent implements IAssetsProgressEvent {
  126237. /**
  126238. * Defines the number of remaining tasks to process
  126239. */
  126240. remainingCount: number;
  126241. /**
  126242. * Defines the total number of tasks
  126243. */
  126244. totalCount: number;
  126245. /**
  126246. * Defines the task that was just processed
  126247. */
  126248. task: AbstractAssetTask;
  126249. /**
  126250. * Creates a AssetsProgressEvent
  126251. * @param remainingCount defines the number of remaining tasks to process
  126252. * @param totalCount defines the total number of tasks
  126253. * @param task defines the task that was just processed
  126254. */
  126255. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  126256. }
  126257. /**
  126258. * Define a task used by AssetsManager to load meshes
  126259. */
  126260. export class MeshAssetTask extends AbstractAssetTask {
  126261. /**
  126262. * Defines the name of the task
  126263. */
  126264. name: string;
  126265. /**
  126266. * Defines the list of mesh's names you want to load
  126267. */
  126268. meshesNames: any;
  126269. /**
  126270. * Defines the root url to use as a base to load your meshes and associated resources
  126271. */
  126272. rootUrl: string;
  126273. /**
  126274. * Defines the filename of the scene to load from
  126275. */
  126276. sceneFilename: string;
  126277. /**
  126278. * Gets the list of loaded meshes
  126279. */
  126280. loadedMeshes: Array<AbstractMesh>;
  126281. /**
  126282. * Gets the list of loaded particle systems
  126283. */
  126284. loadedParticleSystems: Array<IParticleSystem>;
  126285. /**
  126286. * Gets the list of loaded skeletons
  126287. */
  126288. loadedSkeletons: Array<Skeleton>;
  126289. /**
  126290. * Gets the list of loaded animation groups
  126291. */
  126292. loadedAnimationGroups: Array<AnimationGroup>;
  126293. /**
  126294. * Callback called when the task is successful
  126295. */
  126296. onSuccess: (task: MeshAssetTask) => void;
  126297. /**
  126298. * Callback called when the task is successful
  126299. */
  126300. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  126301. /**
  126302. * Creates a new MeshAssetTask
  126303. * @param name defines the name of the task
  126304. * @param meshesNames defines the list of mesh's names you want to load
  126305. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  126306. * @param sceneFilename defines the filename of the scene to load from
  126307. */
  126308. constructor(
  126309. /**
  126310. * Defines the name of the task
  126311. */
  126312. name: string,
  126313. /**
  126314. * Defines the list of mesh's names you want to load
  126315. */
  126316. meshesNames: any,
  126317. /**
  126318. * Defines the root url to use as a base to load your meshes and associated resources
  126319. */
  126320. rootUrl: string,
  126321. /**
  126322. * Defines the filename of the scene to load from
  126323. */
  126324. sceneFilename: string);
  126325. /**
  126326. * Execute the current task
  126327. * @param scene defines the scene where you want your assets to be loaded
  126328. * @param onSuccess is a callback called when the task is successfully executed
  126329. * @param onError is a callback called if an error occurs
  126330. */
  126331. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126332. }
  126333. /**
  126334. * Define a task used by AssetsManager to load text content
  126335. */
  126336. export class TextFileAssetTask extends AbstractAssetTask {
  126337. /**
  126338. * Defines the name of the task
  126339. */
  126340. name: string;
  126341. /**
  126342. * Defines the location of the file to load
  126343. */
  126344. url: string;
  126345. /**
  126346. * Gets the loaded text string
  126347. */
  126348. text: string;
  126349. /**
  126350. * Callback called when the task is successful
  126351. */
  126352. onSuccess: (task: TextFileAssetTask) => void;
  126353. /**
  126354. * Callback called when the task is successful
  126355. */
  126356. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  126357. /**
  126358. * Creates a new TextFileAssetTask object
  126359. * @param name defines the name of the task
  126360. * @param url defines the location of the file to load
  126361. */
  126362. constructor(
  126363. /**
  126364. * Defines the name of the task
  126365. */
  126366. name: string,
  126367. /**
  126368. * Defines the location of the file to load
  126369. */
  126370. url: string);
  126371. /**
  126372. * Execute the current task
  126373. * @param scene defines the scene where you want your assets to be loaded
  126374. * @param onSuccess is a callback called when the task is successfully executed
  126375. * @param onError is a callback called if an error occurs
  126376. */
  126377. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126378. }
  126379. /**
  126380. * Define a task used by AssetsManager to load binary data
  126381. */
  126382. export class BinaryFileAssetTask extends AbstractAssetTask {
  126383. /**
  126384. * Defines the name of the task
  126385. */
  126386. name: string;
  126387. /**
  126388. * Defines the location of the file to load
  126389. */
  126390. url: string;
  126391. /**
  126392. * Gets the lodaded data (as an array buffer)
  126393. */
  126394. data: ArrayBuffer;
  126395. /**
  126396. * Callback called when the task is successful
  126397. */
  126398. onSuccess: (task: BinaryFileAssetTask) => void;
  126399. /**
  126400. * Callback called when the task is successful
  126401. */
  126402. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  126403. /**
  126404. * Creates a new BinaryFileAssetTask object
  126405. * @param name defines the name of the new task
  126406. * @param url defines the location of the file to load
  126407. */
  126408. constructor(
  126409. /**
  126410. * Defines the name of the task
  126411. */
  126412. name: string,
  126413. /**
  126414. * Defines the location of the file to load
  126415. */
  126416. url: string);
  126417. /**
  126418. * Execute the current task
  126419. * @param scene defines the scene where you want your assets to be loaded
  126420. * @param onSuccess is a callback called when the task is successfully executed
  126421. * @param onError is a callback called if an error occurs
  126422. */
  126423. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126424. }
  126425. /**
  126426. * Define a task used by AssetsManager to load images
  126427. */
  126428. export class ImageAssetTask extends AbstractAssetTask {
  126429. /**
  126430. * Defines the name of the task
  126431. */
  126432. name: string;
  126433. /**
  126434. * Defines the location of the image to load
  126435. */
  126436. url: string;
  126437. /**
  126438. * Gets the loaded images
  126439. */
  126440. image: HTMLImageElement;
  126441. /**
  126442. * Callback called when the task is successful
  126443. */
  126444. onSuccess: (task: ImageAssetTask) => void;
  126445. /**
  126446. * Callback called when the task is successful
  126447. */
  126448. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  126449. /**
  126450. * Creates a new ImageAssetTask
  126451. * @param name defines the name of the task
  126452. * @param url defines the location of the image to load
  126453. */
  126454. constructor(
  126455. /**
  126456. * Defines the name of the task
  126457. */
  126458. name: string,
  126459. /**
  126460. * Defines the location of the image to load
  126461. */
  126462. url: string);
  126463. /**
  126464. * Execute the current task
  126465. * @param scene defines the scene where you want your assets to be loaded
  126466. * @param onSuccess is a callback called when the task is successfully executed
  126467. * @param onError is a callback called if an error occurs
  126468. */
  126469. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126470. }
  126471. /**
  126472. * Defines the interface used by texture loading tasks
  126473. */
  126474. export interface ITextureAssetTask<TEX extends BaseTexture> {
  126475. /**
  126476. * Gets the loaded texture
  126477. */
  126478. texture: TEX;
  126479. }
  126480. /**
  126481. * Define a task used by AssetsManager to load 2D textures
  126482. */
  126483. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  126484. /**
  126485. * Defines the name of the task
  126486. */
  126487. name: string;
  126488. /**
  126489. * Defines the location of the file to load
  126490. */
  126491. url: string;
  126492. /**
  126493. * Defines if mipmap should not be generated (default is false)
  126494. */
  126495. noMipmap?: boolean | undefined;
  126496. /**
  126497. * Defines if texture must be inverted on Y axis (default is false)
  126498. */
  126499. invertY?: boolean | undefined;
  126500. /**
  126501. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126502. */
  126503. samplingMode: number;
  126504. /**
  126505. * Gets the loaded texture
  126506. */
  126507. texture: Texture;
  126508. /**
  126509. * Callback called when the task is successful
  126510. */
  126511. onSuccess: (task: TextureAssetTask) => void;
  126512. /**
  126513. * Callback called when the task is successful
  126514. */
  126515. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  126516. /**
  126517. * Creates a new TextureAssetTask object
  126518. * @param name defines the name of the task
  126519. * @param url defines the location of the file to load
  126520. * @param noMipmap defines if mipmap should not be generated (default is false)
  126521. * @param invertY defines if texture must be inverted on Y axis (default is false)
  126522. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126523. */
  126524. constructor(
  126525. /**
  126526. * Defines the name of the task
  126527. */
  126528. name: string,
  126529. /**
  126530. * Defines the location of the file to load
  126531. */
  126532. url: string,
  126533. /**
  126534. * Defines if mipmap should not be generated (default is false)
  126535. */
  126536. noMipmap?: boolean | undefined,
  126537. /**
  126538. * Defines if texture must be inverted on Y axis (default is false)
  126539. */
  126540. invertY?: boolean | undefined,
  126541. /**
  126542. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126543. */
  126544. samplingMode?: number);
  126545. /**
  126546. * Execute the current task
  126547. * @param scene defines the scene where you want your assets to be loaded
  126548. * @param onSuccess is a callback called when the task is successfully executed
  126549. * @param onError is a callback called if an error occurs
  126550. */
  126551. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126552. }
  126553. /**
  126554. * Define a task used by AssetsManager to load cube textures
  126555. */
  126556. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  126557. /**
  126558. * Defines the name of the task
  126559. */
  126560. name: string;
  126561. /**
  126562. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  126563. */
  126564. url: string;
  126565. /**
  126566. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  126567. */
  126568. extensions?: string[] | undefined;
  126569. /**
  126570. * Defines if mipmaps should not be generated (default is false)
  126571. */
  126572. noMipmap?: boolean | undefined;
  126573. /**
  126574. * Defines the explicit list of files (undefined by default)
  126575. */
  126576. files?: string[] | undefined;
  126577. /**
  126578. * Gets the loaded texture
  126579. */
  126580. texture: CubeTexture;
  126581. /**
  126582. * Callback called when the task is successful
  126583. */
  126584. onSuccess: (task: CubeTextureAssetTask) => void;
  126585. /**
  126586. * Callback called when the task is successful
  126587. */
  126588. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  126589. /**
  126590. * Creates a new CubeTextureAssetTask
  126591. * @param name defines the name of the task
  126592. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  126593. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  126594. * @param noMipmap defines if mipmaps should not be generated (default is false)
  126595. * @param files defines the explicit list of files (undefined by default)
  126596. */
  126597. constructor(
  126598. /**
  126599. * Defines the name of the task
  126600. */
  126601. name: string,
  126602. /**
  126603. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  126604. */
  126605. url: string,
  126606. /**
  126607. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  126608. */
  126609. extensions?: string[] | undefined,
  126610. /**
  126611. * Defines if mipmaps should not be generated (default is false)
  126612. */
  126613. noMipmap?: boolean | undefined,
  126614. /**
  126615. * Defines the explicit list of files (undefined by default)
  126616. */
  126617. files?: string[] | undefined);
  126618. /**
  126619. * Execute the current task
  126620. * @param scene defines the scene where you want your assets to be loaded
  126621. * @param onSuccess is a callback called when the task is successfully executed
  126622. * @param onError is a callback called if an error occurs
  126623. */
  126624. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126625. }
  126626. /**
  126627. * Define a task used by AssetsManager to load HDR cube textures
  126628. */
  126629. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  126630. /**
  126631. * Defines the name of the task
  126632. */
  126633. name: string;
  126634. /**
  126635. * Defines the location of the file to load
  126636. */
  126637. url: string;
  126638. /**
  126639. * Defines the desired size (the more it increases the longer the generation will be)
  126640. */
  126641. size: number;
  126642. /**
  126643. * Defines if mipmaps should not be generated (default is false)
  126644. */
  126645. noMipmap: boolean;
  126646. /**
  126647. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  126648. */
  126649. generateHarmonics: boolean;
  126650. /**
  126651. * 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)
  126652. */
  126653. gammaSpace: boolean;
  126654. /**
  126655. * Internal Use Only
  126656. */
  126657. reserved: boolean;
  126658. /**
  126659. * Gets the loaded texture
  126660. */
  126661. texture: HDRCubeTexture;
  126662. /**
  126663. * Callback called when the task is successful
  126664. */
  126665. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  126666. /**
  126667. * Callback called when the task is successful
  126668. */
  126669. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  126670. /**
  126671. * Creates a new HDRCubeTextureAssetTask object
  126672. * @param name defines the name of the task
  126673. * @param url defines the location of the file to load
  126674. * @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.
  126675. * @param noMipmap defines if mipmaps should not be generated (default is false)
  126676. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  126677. * @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)
  126678. * @param reserved Internal use only
  126679. */
  126680. constructor(
  126681. /**
  126682. * Defines the name of the task
  126683. */
  126684. name: string,
  126685. /**
  126686. * Defines the location of the file to load
  126687. */
  126688. url: string,
  126689. /**
  126690. * Defines the desired size (the more it increases the longer the generation will be)
  126691. */
  126692. size: number,
  126693. /**
  126694. * Defines if mipmaps should not be generated (default is false)
  126695. */
  126696. noMipmap?: boolean,
  126697. /**
  126698. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  126699. */
  126700. generateHarmonics?: boolean,
  126701. /**
  126702. * 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)
  126703. */
  126704. gammaSpace?: boolean,
  126705. /**
  126706. * Internal Use Only
  126707. */
  126708. reserved?: boolean);
  126709. /**
  126710. * Execute the current task
  126711. * @param scene defines the scene where you want your assets to be loaded
  126712. * @param onSuccess is a callback called when the task is successfully executed
  126713. * @param onError is a callback called if an error occurs
  126714. */
  126715. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126716. }
  126717. /**
  126718. * Define a task used by AssetsManager to load Equirectangular cube textures
  126719. */
  126720. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  126721. /**
  126722. * Defines the name of the task
  126723. */
  126724. name: string;
  126725. /**
  126726. * Defines the location of the file to load
  126727. */
  126728. url: string;
  126729. /**
  126730. * Defines the desired size (the more it increases the longer the generation will be)
  126731. */
  126732. size: number;
  126733. /**
  126734. * Defines if mipmaps should not be generated (default is false)
  126735. */
  126736. noMipmap: boolean;
  126737. /**
  126738. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  126739. * but the standard material would require them in Gamma space) (default is true)
  126740. */
  126741. gammaSpace: boolean;
  126742. /**
  126743. * Gets the loaded texture
  126744. */
  126745. texture: EquiRectangularCubeTexture;
  126746. /**
  126747. * Callback called when the task is successful
  126748. */
  126749. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  126750. /**
  126751. * Callback called when the task is successful
  126752. */
  126753. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  126754. /**
  126755. * Creates a new EquiRectangularCubeTextureAssetTask object
  126756. * @param name defines the name of the task
  126757. * @param url defines the location of the file to load
  126758. * @param size defines the desired size (the more it increases the longer the generation will be)
  126759. * If the size is omitted this implies you are using a preprocessed cubemap.
  126760. * @param noMipmap defines if mipmaps should not be generated (default is false)
  126761. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  126762. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  126763. * (default is true)
  126764. */
  126765. constructor(
  126766. /**
  126767. * Defines the name of the task
  126768. */
  126769. name: string,
  126770. /**
  126771. * Defines the location of the file to load
  126772. */
  126773. url: string,
  126774. /**
  126775. * Defines the desired size (the more it increases the longer the generation will be)
  126776. */
  126777. size: number,
  126778. /**
  126779. * Defines if mipmaps should not be generated (default is false)
  126780. */
  126781. noMipmap?: boolean,
  126782. /**
  126783. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  126784. * but the standard material would require them in Gamma space) (default is true)
  126785. */
  126786. gammaSpace?: boolean);
  126787. /**
  126788. * Execute the current task
  126789. * @param scene defines the scene where you want your assets to be loaded
  126790. * @param onSuccess is a callback called when the task is successfully executed
  126791. * @param onError is a callback called if an error occurs
  126792. */
  126793. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  126794. }
  126795. /**
  126796. * This class can be used to easily import assets into a scene
  126797. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  126798. */
  126799. export class AssetsManager {
  126800. private _scene;
  126801. private _isLoading;
  126802. protected _tasks: AbstractAssetTask[];
  126803. protected _waitingTasksCount: number;
  126804. protected _totalTasksCount: number;
  126805. /**
  126806. * Callback called when all tasks are processed
  126807. */
  126808. onFinish: (tasks: AbstractAssetTask[]) => void;
  126809. /**
  126810. * Callback called when a task is successful
  126811. */
  126812. onTaskSuccess: (task: AbstractAssetTask) => void;
  126813. /**
  126814. * Callback called when a task had an error
  126815. */
  126816. onTaskError: (task: AbstractAssetTask) => void;
  126817. /**
  126818. * Callback called when a task is done (whatever the result is)
  126819. */
  126820. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  126821. /**
  126822. * Observable called when all tasks are processed
  126823. */
  126824. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  126825. /**
  126826. * Observable called when a task had an error
  126827. */
  126828. onTaskErrorObservable: Observable<AbstractAssetTask>;
  126829. /**
  126830. * Observable called when all tasks were executed
  126831. */
  126832. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  126833. /**
  126834. * Observable called when a task is done (whatever the result is)
  126835. */
  126836. onProgressObservable: Observable<IAssetsProgressEvent>;
  126837. /**
  126838. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  126839. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  126840. */
  126841. useDefaultLoadingScreen: boolean;
  126842. /**
  126843. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  126844. * when all assets have been downloaded.
  126845. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  126846. */
  126847. autoHideLoadingUI: boolean;
  126848. /**
  126849. * Creates a new AssetsManager
  126850. * @param scene defines the scene to work on
  126851. */
  126852. constructor(scene: Scene);
  126853. /**
  126854. * Add a MeshAssetTask to the list of active tasks
  126855. * @param taskName defines the name of the new task
  126856. * @param meshesNames defines the name of meshes to load
  126857. * @param rootUrl defines the root url to use to locate files
  126858. * @param sceneFilename defines the filename of the scene file
  126859. * @returns a new MeshAssetTask object
  126860. */
  126861. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  126862. /**
  126863. * Add a TextFileAssetTask to the list of active tasks
  126864. * @param taskName defines the name of the new task
  126865. * @param url defines the url of the file to load
  126866. * @returns a new TextFileAssetTask object
  126867. */
  126868. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  126869. /**
  126870. * Add a BinaryFileAssetTask to the list of active tasks
  126871. * @param taskName defines the name of the new task
  126872. * @param url defines the url of the file to load
  126873. * @returns a new BinaryFileAssetTask object
  126874. */
  126875. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  126876. /**
  126877. * Add a ImageAssetTask to the list of active tasks
  126878. * @param taskName defines the name of the new task
  126879. * @param url defines the url of the file to load
  126880. * @returns a new ImageAssetTask object
  126881. */
  126882. addImageTask(taskName: string, url: string): ImageAssetTask;
  126883. /**
  126884. * Add a TextureAssetTask to the list of active tasks
  126885. * @param taskName defines the name of the new task
  126886. * @param url defines the url of the file to load
  126887. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  126888. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  126889. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  126890. * @returns a new TextureAssetTask object
  126891. */
  126892. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  126893. /**
  126894. * Add a CubeTextureAssetTask to the list of active tasks
  126895. * @param taskName defines the name of the new task
  126896. * @param url defines the url of the file to load
  126897. * @param extensions defines the extension to use to load the cube map (can be null)
  126898. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  126899. * @param files defines the list of files to load (can be null)
  126900. * @returns a new CubeTextureAssetTask object
  126901. */
  126902. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  126903. /**
  126904. *
  126905. * Add a HDRCubeTextureAssetTask to the list of active tasks
  126906. * @param taskName defines the name of the new task
  126907. * @param url defines the url of the file to load
  126908. * @param size defines the size you want for the cubemap (can be null)
  126909. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  126910. * @param generateHarmonics defines if you want to automatically generate (true by default)
  126911. * @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)
  126912. * @param reserved Internal use only
  126913. * @returns a new HDRCubeTextureAssetTask object
  126914. */
  126915. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  126916. /**
  126917. *
  126918. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  126919. * @param taskName defines the name of the new task
  126920. * @param url defines the url of the file to load
  126921. * @param size defines the size you want for the cubemap (can be null)
  126922. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  126923. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  126924. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  126925. * @returns a new EquiRectangularCubeTextureAssetTask object
  126926. */
  126927. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  126928. /**
  126929. * Remove a task from the assets manager.
  126930. * @param task the task to remove
  126931. */
  126932. removeTask(task: AbstractAssetTask): void;
  126933. private _decreaseWaitingTasksCount;
  126934. private _runTask;
  126935. /**
  126936. * Reset the AssetsManager and remove all tasks
  126937. * @return the current instance of the AssetsManager
  126938. */
  126939. reset(): AssetsManager;
  126940. /**
  126941. * Start the loading process
  126942. * @return the current instance of the AssetsManager
  126943. */
  126944. load(): AssetsManager;
  126945. /**
  126946. * Start the loading process as an async operation
  126947. * @return a promise returning the list of failed tasks
  126948. */
  126949. loadAsync(): Promise<void>;
  126950. }
  126951. }
  126952. declare module BABYLON {
  126953. /**
  126954. * Wrapper class for promise with external resolve and reject.
  126955. */
  126956. export class Deferred<T> {
  126957. /**
  126958. * The promise associated with this deferred object.
  126959. */
  126960. readonly promise: Promise<T>;
  126961. private _resolve;
  126962. private _reject;
  126963. /**
  126964. * The resolve method of the promise associated with this deferred object.
  126965. */
  126966. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  126967. /**
  126968. * The reject method of the promise associated with this deferred object.
  126969. */
  126970. readonly reject: (reason?: any) => void;
  126971. /**
  126972. * Constructor for this deferred object.
  126973. */
  126974. constructor();
  126975. }
  126976. }
  126977. declare module BABYLON {
  126978. /**
  126979. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  126980. */
  126981. export class MeshExploder {
  126982. private _centerMesh;
  126983. private _meshes;
  126984. private _meshesOrigins;
  126985. private _toCenterVectors;
  126986. private _scaledDirection;
  126987. private _newPosition;
  126988. private _centerPosition;
  126989. /**
  126990. * Explodes meshes from a center mesh.
  126991. * @param meshes The meshes to explode.
  126992. * @param centerMesh The mesh to be center of explosion.
  126993. */
  126994. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  126995. private _setCenterMesh;
  126996. /**
  126997. * Get class name
  126998. * @returns "MeshExploder"
  126999. */
  127000. getClassName(): string;
  127001. /**
  127002. * "Exploded meshes"
  127003. * @returns Array of meshes with the centerMesh at index 0.
  127004. */
  127005. getMeshes(): Array<Mesh>;
  127006. /**
  127007. * Explodes meshes giving a specific direction
  127008. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  127009. */
  127010. explode(direction?: number): void;
  127011. }
  127012. }
  127013. declare module BABYLON {
  127014. /**
  127015. * Class used to help managing file picking and drag'n'drop
  127016. */
  127017. export class FilesInput {
  127018. /**
  127019. * List of files ready to be loaded
  127020. */
  127021. static readonly FilesToLoad: {
  127022. [key: string]: File;
  127023. };
  127024. /**
  127025. * Callback called when a file is processed
  127026. */
  127027. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  127028. private _engine;
  127029. private _currentScene;
  127030. private _sceneLoadedCallback;
  127031. private _progressCallback;
  127032. private _additionalRenderLoopLogicCallback;
  127033. private _textureLoadingCallback;
  127034. private _startingProcessingFilesCallback;
  127035. private _onReloadCallback;
  127036. private _errorCallback;
  127037. private _elementToMonitor;
  127038. private _sceneFileToLoad;
  127039. private _filesToLoad;
  127040. /**
  127041. * Creates a new FilesInput
  127042. * @param engine defines the rendering engine
  127043. * @param scene defines the hosting scene
  127044. * @param sceneLoadedCallback callback called when scene is loaded
  127045. * @param progressCallback callback called to track progress
  127046. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  127047. * @param textureLoadingCallback callback called when a texture is loading
  127048. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  127049. * @param onReloadCallback callback called when a reload is requested
  127050. * @param errorCallback callback call if an error occurs
  127051. */
  127052. 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);
  127053. private _dragEnterHandler;
  127054. private _dragOverHandler;
  127055. private _dropHandler;
  127056. /**
  127057. * Calls this function to listen to drag'n'drop events on a specific DOM element
  127058. * @param elementToMonitor defines the DOM element to track
  127059. */
  127060. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  127061. /**
  127062. * Release all associated resources
  127063. */
  127064. dispose(): void;
  127065. private renderFunction;
  127066. private drag;
  127067. private drop;
  127068. private _traverseFolder;
  127069. private _processFiles;
  127070. /**
  127071. * Load files from a drop event
  127072. * @param event defines the drop event to use as source
  127073. */
  127074. loadFiles(event: any): void;
  127075. private _processReload;
  127076. /**
  127077. * Reload the current scene from the loaded files
  127078. */
  127079. reload(): void;
  127080. }
  127081. }
  127082. declare module BABYLON {
  127083. /**
  127084. * Defines the root class used to create scene optimization to use with SceneOptimizer
  127085. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127086. */
  127087. export class SceneOptimization {
  127088. /**
  127089. * Defines the priority of this optimization (0 by default which means first in the list)
  127090. */
  127091. priority: number;
  127092. /**
  127093. * Gets a string describing the action executed by the current optimization
  127094. * @returns description string
  127095. */
  127096. getDescription(): string;
  127097. /**
  127098. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127099. * @param scene defines the current scene where to apply this optimization
  127100. * @param optimizer defines the current optimizer
  127101. * @returns true if everything that can be done was applied
  127102. */
  127103. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127104. /**
  127105. * Creates the SceneOptimization object
  127106. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  127107. * @param desc defines the description associated with the optimization
  127108. */
  127109. constructor(
  127110. /**
  127111. * Defines the priority of this optimization (0 by default which means first in the list)
  127112. */
  127113. priority?: number);
  127114. }
  127115. /**
  127116. * Defines an optimization used to reduce the size of render target textures
  127117. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127118. */
  127119. export class TextureOptimization extends SceneOptimization {
  127120. /**
  127121. * Defines the priority of this optimization (0 by default which means first in the list)
  127122. */
  127123. priority: number;
  127124. /**
  127125. * 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
  127126. */
  127127. maximumSize: number;
  127128. /**
  127129. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  127130. */
  127131. step: number;
  127132. /**
  127133. * Gets a string describing the action executed by the current optimization
  127134. * @returns description string
  127135. */
  127136. getDescription(): string;
  127137. /**
  127138. * Creates the TextureOptimization object
  127139. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  127140. * @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
  127141. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  127142. */
  127143. constructor(
  127144. /**
  127145. * Defines the priority of this optimization (0 by default which means first in the list)
  127146. */
  127147. priority?: number,
  127148. /**
  127149. * 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
  127150. */
  127151. maximumSize?: number,
  127152. /**
  127153. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  127154. */
  127155. step?: number);
  127156. /**
  127157. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127158. * @param scene defines the current scene where to apply this optimization
  127159. * @param optimizer defines the current optimizer
  127160. * @returns true if everything that can be done was applied
  127161. */
  127162. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127163. }
  127164. /**
  127165. * Defines an optimization used to increase or decrease the rendering resolution
  127166. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127167. */
  127168. export class HardwareScalingOptimization extends SceneOptimization {
  127169. /**
  127170. * Defines the priority of this optimization (0 by default which means first in the list)
  127171. */
  127172. priority: number;
  127173. /**
  127174. * Defines the maximum scale to use (2 by default)
  127175. */
  127176. maximumScale: number;
  127177. /**
  127178. * Defines the step to use between two passes (0.5 by default)
  127179. */
  127180. step: number;
  127181. private _currentScale;
  127182. private _directionOffset;
  127183. /**
  127184. * Gets a string describing the action executed by the current optimization
  127185. * @return description string
  127186. */
  127187. getDescription(): string;
  127188. /**
  127189. * Creates the HardwareScalingOptimization object
  127190. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  127191. * @param maximumScale defines the maximum scale to use (2 by default)
  127192. * @param step defines the step to use between two passes (0.5 by default)
  127193. */
  127194. constructor(
  127195. /**
  127196. * Defines the priority of this optimization (0 by default which means first in the list)
  127197. */
  127198. priority?: number,
  127199. /**
  127200. * Defines the maximum scale to use (2 by default)
  127201. */
  127202. maximumScale?: number,
  127203. /**
  127204. * Defines the step to use between two passes (0.5 by default)
  127205. */
  127206. step?: number);
  127207. /**
  127208. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127209. * @param scene defines the current scene where to apply this optimization
  127210. * @param optimizer defines the current optimizer
  127211. * @returns true if everything that can be done was applied
  127212. */
  127213. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127214. }
  127215. /**
  127216. * Defines an optimization used to remove shadows
  127217. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127218. */
  127219. export class ShadowsOptimization extends SceneOptimization {
  127220. /**
  127221. * Gets a string describing the action executed by the current optimization
  127222. * @return description string
  127223. */
  127224. getDescription(): string;
  127225. /**
  127226. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127227. * @param scene defines the current scene where to apply this optimization
  127228. * @param optimizer defines the current optimizer
  127229. * @returns true if everything that can be done was applied
  127230. */
  127231. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127232. }
  127233. /**
  127234. * Defines an optimization used to turn post-processes off
  127235. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127236. */
  127237. export class PostProcessesOptimization extends SceneOptimization {
  127238. /**
  127239. * Gets a string describing the action executed by the current optimization
  127240. * @return description string
  127241. */
  127242. getDescription(): string;
  127243. /**
  127244. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127245. * @param scene defines the current scene where to apply this optimization
  127246. * @param optimizer defines the current optimizer
  127247. * @returns true if everything that can be done was applied
  127248. */
  127249. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127250. }
  127251. /**
  127252. * Defines an optimization used to turn lens flares off
  127253. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127254. */
  127255. export class LensFlaresOptimization extends SceneOptimization {
  127256. /**
  127257. * Gets a string describing the action executed by the current optimization
  127258. * @return description string
  127259. */
  127260. getDescription(): string;
  127261. /**
  127262. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127263. * @param scene defines the current scene where to apply this optimization
  127264. * @param optimizer defines the current optimizer
  127265. * @returns true if everything that can be done was applied
  127266. */
  127267. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127268. }
  127269. /**
  127270. * Defines an optimization based on user defined callback.
  127271. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127272. */
  127273. export class CustomOptimization extends SceneOptimization {
  127274. /**
  127275. * Callback called to apply the custom optimization.
  127276. */
  127277. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  127278. /**
  127279. * Callback called to get custom description
  127280. */
  127281. onGetDescription: () => string;
  127282. /**
  127283. * Gets a string describing the action executed by the current optimization
  127284. * @returns description string
  127285. */
  127286. getDescription(): string;
  127287. /**
  127288. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127289. * @param scene defines the current scene where to apply this optimization
  127290. * @param optimizer defines the current optimizer
  127291. * @returns true if everything that can be done was applied
  127292. */
  127293. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127294. }
  127295. /**
  127296. * Defines an optimization used to turn particles off
  127297. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127298. */
  127299. export class ParticlesOptimization extends SceneOptimization {
  127300. /**
  127301. * Gets a string describing the action executed by the current optimization
  127302. * @return description string
  127303. */
  127304. getDescription(): string;
  127305. /**
  127306. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127307. * @param scene defines the current scene where to apply this optimization
  127308. * @param optimizer defines the current optimizer
  127309. * @returns true if everything that can be done was applied
  127310. */
  127311. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127312. }
  127313. /**
  127314. * Defines an optimization used to turn render targets off
  127315. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127316. */
  127317. export class RenderTargetsOptimization extends SceneOptimization {
  127318. /**
  127319. * Gets a string describing the action executed by the current optimization
  127320. * @return description string
  127321. */
  127322. getDescription(): string;
  127323. /**
  127324. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127325. * @param scene defines the current scene where to apply this optimization
  127326. * @param optimizer defines the current optimizer
  127327. * @returns true if everything that can be done was applied
  127328. */
  127329. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  127330. }
  127331. /**
  127332. * Defines an optimization used to merge meshes with compatible materials
  127333. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127334. */
  127335. export class MergeMeshesOptimization extends SceneOptimization {
  127336. private static _UpdateSelectionTree;
  127337. /**
  127338. * Gets or sets a boolean which defines if optimization octree has to be updated
  127339. */
  127340. /**
  127341. * Gets or sets a boolean which defines if optimization octree has to be updated
  127342. */
  127343. static UpdateSelectionTree: boolean;
  127344. /**
  127345. * Gets a string describing the action executed by the current optimization
  127346. * @return description string
  127347. */
  127348. getDescription(): string;
  127349. private _canBeMerged;
  127350. /**
  127351. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  127352. * @param scene defines the current scene where to apply this optimization
  127353. * @param optimizer defines the current optimizer
  127354. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  127355. * @returns true if everything that can be done was applied
  127356. */
  127357. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  127358. }
  127359. /**
  127360. * Defines a list of options used by SceneOptimizer
  127361. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127362. */
  127363. export class SceneOptimizerOptions {
  127364. /**
  127365. * Defines the target frame rate to reach (60 by default)
  127366. */
  127367. targetFrameRate: number;
  127368. /**
  127369. * Defines the interval between two checkes (2000ms by default)
  127370. */
  127371. trackerDuration: number;
  127372. /**
  127373. * Gets the list of optimizations to apply
  127374. */
  127375. optimizations: SceneOptimization[];
  127376. /**
  127377. * Creates a new list of options used by SceneOptimizer
  127378. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  127379. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  127380. */
  127381. constructor(
  127382. /**
  127383. * Defines the target frame rate to reach (60 by default)
  127384. */
  127385. targetFrameRate?: number,
  127386. /**
  127387. * Defines the interval between two checkes (2000ms by default)
  127388. */
  127389. trackerDuration?: number);
  127390. /**
  127391. * Add a new optimization
  127392. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  127393. * @returns the current SceneOptimizerOptions
  127394. */
  127395. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  127396. /**
  127397. * Add a new custom optimization
  127398. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  127399. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  127400. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  127401. * @returns the current SceneOptimizerOptions
  127402. */
  127403. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  127404. /**
  127405. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  127406. * @param targetFrameRate defines the target frame rate (60 by default)
  127407. * @returns a SceneOptimizerOptions object
  127408. */
  127409. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  127410. /**
  127411. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  127412. * @param targetFrameRate defines the target frame rate (60 by default)
  127413. * @returns a SceneOptimizerOptions object
  127414. */
  127415. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  127416. /**
  127417. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  127418. * @param targetFrameRate defines the target frame rate (60 by default)
  127419. * @returns a SceneOptimizerOptions object
  127420. */
  127421. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  127422. }
  127423. /**
  127424. * Class used to run optimizations in order to reach a target frame rate
  127425. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  127426. */
  127427. export class SceneOptimizer implements IDisposable {
  127428. private _isRunning;
  127429. private _options;
  127430. private _scene;
  127431. private _currentPriorityLevel;
  127432. private _targetFrameRate;
  127433. private _trackerDuration;
  127434. private _currentFrameRate;
  127435. private _sceneDisposeObserver;
  127436. private _improvementMode;
  127437. /**
  127438. * Defines an observable called when the optimizer reaches the target frame rate
  127439. */
  127440. onSuccessObservable: Observable<SceneOptimizer>;
  127441. /**
  127442. * Defines an observable called when the optimizer enables an optimization
  127443. */
  127444. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  127445. /**
  127446. * Defines an observable called when the optimizer is not able to reach the target frame rate
  127447. */
  127448. onFailureObservable: Observable<SceneOptimizer>;
  127449. /**
  127450. * Gets a boolean indicating if the optimizer is in improvement mode
  127451. */
  127452. readonly isInImprovementMode: boolean;
  127453. /**
  127454. * Gets the current priority level (0 at start)
  127455. */
  127456. readonly currentPriorityLevel: number;
  127457. /**
  127458. * Gets the current frame rate checked by the SceneOptimizer
  127459. */
  127460. readonly currentFrameRate: number;
  127461. /**
  127462. * Gets or sets the current target frame rate (60 by default)
  127463. */
  127464. /**
  127465. * Gets or sets the current target frame rate (60 by default)
  127466. */
  127467. targetFrameRate: number;
  127468. /**
  127469. * Gets or sets the current interval between two checks (every 2000ms by default)
  127470. */
  127471. /**
  127472. * Gets or sets the current interval between two checks (every 2000ms by default)
  127473. */
  127474. trackerDuration: number;
  127475. /**
  127476. * Gets the list of active optimizations
  127477. */
  127478. readonly optimizations: SceneOptimization[];
  127479. /**
  127480. * Creates a new SceneOptimizer
  127481. * @param scene defines the scene to work on
  127482. * @param options defines the options to use with the SceneOptimizer
  127483. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  127484. * @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)
  127485. */
  127486. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  127487. /**
  127488. * Stops the current optimizer
  127489. */
  127490. stop(): void;
  127491. /**
  127492. * Reset the optimizer to initial step (current priority level = 0)
  127493. */
  127494. reset(): void;
  127495. /**
  127496. * Start the optimizer. By default it will try to reach a specific framerate
  127497. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  127498. */
  127499. start(): void;
  127500. private _checkCurrentState;
  127501. /**
  127502. * Release all resources
  127503. */
  127504. dispose(): void;
  127505. /**
  127506. * Helper function to create a SceneOptimizer with one single line of code
  127507. * @param scene defines the scene to work on
  127508. * @param options defines the options to use with the SceneOptimizer
  127509. * @param onSuccess defines a callback to call on success
  127510. * @param onFailure defines a callback to call on failure
  127511. * @returns the new SceneOptimizer object
  127512. */
  127513. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  127514. }
  127515. }
  127516. declare module BABYLON {
  127517. /**
  127518. * Class used to serialize a scene into a string
  127519. */
  127520. export class SceneSerializer {
  127521. /**
  127522. * Clear cache used by a previous serialization
  127523. */
  127524. static ClearCache(): void;
  127525. /**
  127526. * Serialize a scene into a JSON compatible object
  127527. * @param scene defines the scene to serialize
  127528. * @returns a JSON compatible object
  127529. */
  127530. static Serialize(scene: Scene): any;
  127531. /**
  127532. * Serialize a mesh into a JSON compatible object
  127533. * @param toSerialize defines the mesh to serialize
  127534. * @param withParents defines if parents must be serialized as well
  127535. * @param withChildren defines if children must be serialized as well
  127536. * @returns a JSON compatible object
  127537. */
  127538. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  127539. }
  127540. }
  127541. declare module BABYLON {
  127542. /**
  127543. * Class used to host texture specific utilities
  127544. */
  127545. export class TextureTools {
  127546. /**
  127547. * Uses the GPU to create a copy texture rescaled at a given size
  127548. * @param texture Texture to copy from
  127549. * @param width defines the desired width
  127550. * @param height defines the desired height
  127551. * @param useBilinearMode defines if bilinear mode has to be used
  127552. * @return the generated texture
  127553. */
  127554. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  127555. }
  127556. }
  127557. declare module BABYLON {
  127558. /**
  127559. * This represents the different options available for the video capture.
  127560. */
  127561. export interface VideoRecorderOptions {
  127562. /** Defines the mime type of the video. */
  127563. mimeType: string;
  127564. /** Defines the FPS the video should be recorded at. */
  127565. fps: number;
  127566. /** Defines the chunk size for the recording data. */
  127567. recordChunckSize: number;
  127568. /** The audio tracks to attach to the recording. */
  127569. audioTracks?: MediaStreamTrack[];
  127570. }
  127571. /**
  127572. * This can help with recording videos from BabylonJS.
  127573. * This is based on the available WebRTC functionalities of the browser.
  127574. *
  127575. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  127576. */
  127577. export class VideoRecorder {
  127578. private static readonly _defaultOptions;
  127579. /**
  127580. * Returns whether or not the VideoRecorder is available in your browser.
  127581. * @param engine Defines the Babylon Engine.
  127582. * @returns true if supported otherwise false.
  127583. */
  127584. static IsSupported(engine: Engine): boolean;
  127585. private readonly _options;
  127586. private _canvas;
  127587. private _mediaRecorder;
  127588. private _recordedChunks;
  127589. private _fileName;
  127590. private _resolve;
  127591. private _reject;
  127592. /**
  127593. * True when a recording is already in progress.
  127594. */
  127595. readonly isRecording: boolean;
  127596. /**
  127597. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  127598. * @param engine Defines the BabylonJS Engine you wish to record.
  127599. * @param options Defines options that can be used to customize the capture.
  127600. */
  127601. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  127602. /**
  127603. * Stops the current recording before the default capture timeout passed in the startRecording function.
  127604. */
  127605. stopRecording(): void;
  127606. /**
  127607. * Starts recording the canvas for a max duration specified in parameters.
  127608. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  127609. * If null no automatic download will start and you can rely on the promise to get the data back.
  127610. * @param maxDuration Defines the maximum recording time in seconds.
  127611. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  127612. * @return A promise callback at the end of the recording with the video data in Blob.
  127613. */
  127614. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  127615. /**
  127616. * Releases internal resources used during the recording.
  127617. */
  127618. dispose(): void;
  127619. private _handleDataAvailable;
  127620. private _handleError;
  127621. private _handleStop;
  127622. }
  127623. }
  127624. declare module BABYLON {
  127625. /**
  127626. * Class containing a set of static utilities functions for screenshots
  127627. */
  127628. export class ScreenshotTools {
  127629. /**
  127630. * Captures a screenshot of the current rendering
  127631. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  127632. * @param engine defines the rendering engine
  127633. * @param camera defines the source camera
  127634. * @param size This parameter can be set to a single number or to an object with the
  127635. * following (optional) properties: precision, width, height. If a single number is passed,
  127636. * it will be used for both width and height. If an object is passed, the screenshot size
  127637. * will be derived from the parameters. The precision property is a multiplier allowing
  127638. * rendering at a higher or lower resolution
  127639. * @param successCallback defines the callback receives a single parameter which contains the
  127640. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  127641. * src parameter of an <img> to display it
  127642. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  127643. * Check your browser for supported MIME types
  127644. */
  127645. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  127646. /**
  127647. * Captures a screenshot of the current rendering
  127648. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  127649. * @param engine defines the rendering engine
  127650. * @param camera defines the source camera
  127651. * @param size This parameter can be set to a single number or to an object with the
  127652. * following (optional) properties: precision, width, height. If a single number is passed,
  127653. * it will be used for both width and height. If an object is passed, the screenshot size
  127654. * will be derived from the parameters. The precision property is a multiplier allowing
  127655. * rendering at a higher or lower resolution
  127656. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  127657. * Check your browser for supported MIME types
  127658. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  127659. * to the src parameter of an <img> to display it
  127660. */
  127661. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  127662. /**
  127663. * Generates an image screenshot from the specified camera.
  127664. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  127665. * @param engine The engine to use for rendering
  127666. * @param camera The camera to use for rendering
  127667. * @param size This parameter can be set to a single number or to an object with the
  127668. * following (optional) properties: precision, width, height. If a single number is passed,
  127669. * it will be used for both width and height. If an object is passed, the screenshot size
  127670. * will be derived from the parameters. The precision property is a multiplier allowing
  127671. * rendering at a higher or lower resolution
  127672. * @param successCallback The callback receives a single parameter which contains the
  127673. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  127674. * src parameter of an <img> to display it
  127675. * @param mimeType The MIME type of the screenshot image (default: image/png).
  127676. * Check your browser for supported MIME types
  127677. * @param samples Texture samples (default: 1)
  127678. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  127679. * @param fileName A name for for the downloaded file.
  127680. */
  127681. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  127682. /**
  127683. * Generates an image screenshot from the specified camera.
  127684. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  127685. * @param engine The engine to use for rendering
  127686. * @param camera The camera to use for rendering
  127687. * @param size This parameter can be set to a single number or to an object with the
  127688. * following (optional) properties: precision, width, height. If a single number is passed,
  127689. * it will be used for both width and height. If an object is passed, the screenshot size
  127690. * will be derived from the parameters. The precision property is a multiplier allowing
  127691. * rendering at a higher or lower resolution
  127692. * @param mimeType The MIME type of the screenshot image (default: image/png).
  127693. * Check your browser for supported MIME types
  127694. * @param samples Texture samples (default: 1)
  127695. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  127696. * @param fileName A name for for the downloaded file.
  127697. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  127698. * to the src parameter of an <img> to display it
  127699. */
  127700. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  127701. /**
  127702. * Gets height and width for screenshot size
  127703. * @private
  127704. */
  127705. private static _getScreenshotSize;
  127706. }
  127707. }
  127708. declare module BABYLON {
  127709. /**
  127710. * A cursor which tracks a point on a path
  127711. */
  127712. export class PathCursor {
  127713. private path;
  127714. /**
  127715. * Stores path cursor callbacks for when an onchange event is triggered
  127716. */
  127717. private _onchange;
  127718. /**
  127719. * The value of the path cursor
  127720. */
  127721. value: number;
  127722. /**
  127723. * The animation array of the path cursor
  127724. */
  127725. animations: Animation[];
  127726. /**
  127727. * Initializes the path cursor
  127728. * @param path The path to track
  127729. */
  127730. constructor(path: Path2);
  127731. /**
  127732. * Gets the cursor point on the path
  127733. * @returns A point on the path cursor at the cursor location
  127734. */
  127735. getPoint(): Vector3;
  127736. /**
  127737. * Moves the cursor ahead by the step amount
  127738. * @param step The amount to move the cursor forward
  127739. * @returns This path cursor
  127740. */
  127741. moveAhead(step?: number): PathCursor;
  127742. /**
  127743. * Moves the cursor behind by the step amount
  127744. * @param step The amount to move the cursor back
  127745. * @returns This path cursor
  127746. */
  127747. moveBack(step?: number): PathCursor;
  127748. /**
  127749. * Moves the cursor by the step amount
  127750. * If the step amount is greater than one, an exception is thrown
  127751. * @param step The amount to move the cursor
  127752. * @returns This path cursor
  127753. */
  127754. move(step: number): PathCursor;
  127755. /**
  127756. * Ensures that the value is limited between zero and one
  127757. * @returns This path cursor
  127758. */
  127759. private ensureLimits;
  127760. /**
  127761. * Runs onchange callbacks on change (used by the animation engine)
  127762. * @returns This path cursor
  127763. */
  127764. private raiseOnChange;
  127765. /**
  127766. * Executes a function on change
  127767. * @param f A path cursor onchange callback
  127768. * @returns This path cursor
  127769. */
  127770. onchange(f: (cursor: PathCursor) => void): PathCursor;
  127771. }
  127772. }
  127773. declare module BABYLON {
  127774. /** @hidden */
  127775. export var blurPixelShader: {
  127776. name: string;
  127777. shader: string;
  127778. };
  127779. }
  127780. declare module BABYLON {
  127781. /** @hidden */
  127782. export var pointCloudVertexDeclaration: {
  127783. name: string;
  127784. shader: string;
  127785. };
  127786. }
  127787. // Mixins
  127788. interface Window {
  127789. mozIndexedDB: IDBFactory;
  127790. webkitIndexedDB: IDBFactory;
  127791. msIndexedDB: IDBFactory;
  127792. webkitURL: typeof URL;
  127793. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  127794. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  127795. WebGLRenderingContext: WebGLRenderingContext;
  127796. MSGesture: MSGesture;
  127797. CANNON: any;
  127798. AudioContext: AudioContext;
  127799. webkitAudioContext: AudioContext;
  127800. PointerEvent: any;
  127801. Math: Math;
  127802. Uint8Array: Uint8ArrayConstructor;
  127803. Float32Array: Float32ArrayConstructor;
  127804. mozURL: typeof URL;
  127805. msURL: typeof URL;
  127806. VRFrameData: any; // WebVR, from specs 1.1
  127807. DracoDecoderModule: any;
  127808. setImmediate(handler: (...args: any[]) => void): number;
  127809. }
  127810. interface HTMLCanvasElement {
  127811. requestPointerLock(): void;
  127812. msRequestPointerLock?(): void;
  127813. mozRequestPointerLock?(): void;
  127814. webkitRequestPointerLock?(): void;
  127815. /** Track wether a record is in progress */
  127816. isRecording: boolean;
  127817. /** Capture Stream method defined by some browsers */
  127818. captureStream(fps?: number): MediaStream;
  127819. }
  127820. interface CanvasRenderingContext2D {
  127821. msImageSmoothingEnabled: boolean;
  127822. }
  127823. interface MouseEvent {
  127824. mozMovementX: number;
  127825. mozMovementY: number;
  127826. webkitMovementX: number;
  127827. webkitMovementY: number;
  127828. msMovementX: number;
  127829. msMovementY: number;
  127830. }
  127831. interface Navigator {
  127832. mozGetVRDevices: (any: any) => any;
  127833. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  127834. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  127835. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  127836. webkitGetGamepads(): Gamepad[];
  127837. msGetGamepads(): Gamepad[];
  127838. webkitGamepads(): Gamepad[];
  127839. }
  127840. interface HTMLVideoElement {
  127841. mozSrcObject: any;
  127842. }
  127843. interface Math {
  127844. fround(x: number): number;
  127845. imul(a: number, b: number): number;
  127846. }
  127847. interface WebGLRenderingContext {
  127848. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  127849. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  127850. vertexAttribDivisor(index: number, divisor: number): void;
  127851. createVertexArray(): any;
  127852. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  127853. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  127854. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  127855. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  127856. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  127857. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  127858. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  127859. // Queries
  127860. createQuery(): WebGLQuery;
  127861. deleteQuery(query: WebGLQuery): void;
  127862. beginQuery(target: number, query: WebGLQuery): void;
  127863. endQuery(target: number): void;
  127864. getQueryParameter(query: WebGLQuery, pname: number): any;
  127865. getQuery(target: number, pname: number): any;
  127866. MAX_SAMPLES: number;
  127867. RGBA8: number;
  127868. READ_FRAMEBUFFER: number;
  127869. DRAW_FRAMEBUFFER: number;
  127870. UNIFORM_BUFFER: number;
  127871. HALF_FLOAT_OES: number;
  127872. RGBA16F: number;
  127873. RGBA32F: number;
  127874. R32F: number;
  127875. RG32F: number;
  127876. RGB32F: number;
  127877. R16F: number;
  127878. RG16F: number;
  127879. RGB16F: number;
  127880. RED: number;
  127881. RG: number;
  127882. R8: number;
  127883. RG8: number;
  127884. UNSIGNED_INT_24_8: number;
  127885. DEPTH24_STENCIL8: number;
  127886. /* Multiple Render Targets */
  127887. drawBuffers(buffers: number[]): void;
  127888. readBuffer(src: number): void;
  127889. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  127890. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  127891. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  127892. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  127893. // Occlusion Query
  127894. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  127895. ANY_SAMPLES_PASSED: number;
  127896. QUERY_RESULT_AVAILABLE: number;
  127897. QUERY_RESULT: number;
  127898. }
  127899. interface WebGLProgram {
  127900. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  127901. }
  127902. interface EXT_disjoint_timer_query {
  127903. QUERY_COUNTER_BITS_EXT: number;
  127904. TIME_ELAPSED_EXT: number;
  127905. TIMESTAMP_EXT: number;
  127906. GPU_DISJOINT_EXT: number;
  127907. QUERY_RESULT_EXT: number;
  127908. QUERY_RESULT_AVAILABLE_EXT: number;
  127909. queryCounterEXT(query: WebGLQuery, target: number): void;
  127910. createQueryEXT(): WebGLQuery;
  127911. beginQueryEXT(target: number, query: WebGLQuery): void;
  127912. endQueryEXT(target: number): void;
  127913. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  127914. deleteQueryEXT(query: WebGLQuery): void;
  127915. }
  127916. interface WebGLUniformLocation {
  127917. _currentState: any;
  127918. }
  127919. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  127920. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  127921. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  127922. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  127923. interface WebGLRenderingContext {
  127924. readonly RASTERIZER_DISCARD: number;
  127925. readonly DEPTH_COMPONENT24: number;
  127926. readonly TEXTURE_3D: number;
  127927. readonly TEXTURE_2D_ARRAY: number;
  127928. readonly TEXTURE_COMPARE_FUNC: number;
  127929. readonly TEXTURE_COMPARE_MODE: number;
  127930. readonly COMPARE_REF_TO_TEXTURE: number;
  127931. readonly TEXTURE_WRAP_R: number;
  127932. readonly HALF_FLOAT: number;
  127933. readonly RGB8: number;
  127934. readonly RED_INTEGER: number;
  127935. readonly RG_INTEGER: number;
  127936. readonly RGB_INTEGER: number;
  127937. readonly RGBA_INTEGER: number;
  127938. readonly R8_SNORM: number;
  127939. readonly RG8_SNORM: number;
  127940. readonly RGB8_SNORM: number;
  127941. readonly RGBA8_SNORM: number;
  127942. readonly R8I: number;
  127943. readonly RG8I: number;
  127944. readonly RGB8I: number;
  127945. readonly RGBA8I: number;
  127946. readonly R8UI: number;
  127947. readonly RG8UI: number;
  127948. readonly RGB8UI: number;
  127949. readonly RGBA8UI: number;
  127950. readonly R16I: number;
  127951. readonly RG16I: number;
  127952. readonly RGB16I: number;
  127953. readonly RGBA16I: number;
  127954. readonly R16UI: number;
  127955. readonly RG16UI: number;
  127956. readonly RGB16UI: number;
  127957. readonly RGBA16UI: number;
  127958. readonly R32I: number;
  127959. readonly RG32I: number;
  127960. readonly RGB32I: number;
  127961. readonly RGBA32I: number;
  127962. readonly R32UI: number;
  127963. readonly RG32UI: number;
  127964. readonly RGB32UI: number;
  127965. readonly RGBA32UI: number;
  127966. readonly RGB10_A2UI: number;
  127967. readonly R11F_G11F_B10F: number;
  127968. readonly RGB9_E5: number;
  127969. readonly RGB10_A2: number;
  127970. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  127971. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  127972. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  127973. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  127974. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  127975. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  127976. 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;
  127977. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  127978. readonly TRANSFORM_FEEDBACK: number;
  127979. readonly INTERLEAVED_ATTRIBS: number;
  127980. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  127981. createTransformFeedback(): WebGLTransformFeedback;
  127982. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  127983. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  127984. beginTransformFeedback(primitiveMode: number): void;
  127985. endTransformFeedback(): void;
  127986. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  127987. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  127988. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  127989. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  127990. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  127991. }
  127992. interface ImageBitmap {
  127993. readonly width: number;
  127994. readonly height: number;
  127995. close(): void;
  127996. }
  127997. interface WebGLQuery extends WebGLObject {
  127998. }
  127999. declare var WebGLQuery: {
  128000. prototype: WebGLQuery;
  128001. new(): WebGLQuery;
  128002. };
  128003. interface WebGLSampler extends WebGLObject {
  128004. }
  128005. declare var WebGLSampler: {
  128006. prototype: WebGLSampler;
  128007. new(): WebGLSampler;
  128008. };
  128009. interface WebGLSync extends WebGLObject {
  128010. }
  128011. declare var WebGLSync: {
  128012. prototype: WebGLSync;
  128013. new(): WebGLSync;
  128014. };
  128015. interface WebGLTransformFeedback extends WebGLObject {
  128016. }
  128017. declare var WebGLTransformFeedback: {
  128018. prototype: WebGLTransformFeedback;
  128019. new(): WebGLTransformFeedback;
  128020. };
  128021. interface WebGLVertexArrayObject extends WebGLObject {
  128022. }
  128023. declare var WebGLVertexArrayObject: {
  128024. prototype: WebGLVertexArrayObject;
  128025. new(): WebGLVertexArrayObject;
  128026. };
  128027. // Type definitions for WebVR API
  128028. // Project: https://w3c.github.io/webvr/
  128029. // Definitions by: six a <https://github.com/lostfictions>
  128030. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  128031. interface VRDisplay extends EventTarget {
  128032. /**
  128033. * Dictionary of capabilities describing the VRDisplay.
  128034. */
  128035. readonly capabilities: VRDisplayCapabilities;
  128036. /**
  128037. * z-depth defining the far plane of the eye view frustum
  128038. * enables mapping of values in the render target depth
  128039. * attachment to scene coordinates. Initially set to 10000.0.
  128040. */
  128041. depthFar: number;
  128042. /**
  128043. * z-depth defining the near plane of the eye view frustum
  128044. * enables mapping of values in the render target depth
  128045. * attachment to scene coordinates. Initially set to 0.01.
  128046. */
  128047. depthNear: number;
  128048. /**
  128049. * An identifier for this distinct VRDisplay. Used as an
  128050. * association point in the Gamepad API.
  128051. */
  128052. readonly displayId: number;
  128053. /**
  128054. * A display name, a user-readable name identifying it.
  128055. */
  128056. readonly displayName: string;
  128057. readonly isConnected: boolean;
  128058. readonly isPresenting: boolean;
  128059. /**
  128060. * If this VRDisplay supports room-scale experiences, the optional
  128061. * stage attribute contains details on the room-scale parameters.
  128062. */
  128063. readonly stageParameters: VRStageParameters | null;
  128064. /**
  128065. * Passing the value returned by `requestAnimationFrame` to
  128066. * `cancelAnimationFrame` will unregister the callback.
  128067. * @param handle Define the hanle of the request to cancel
  128068. */
  128069. cancelAnimationFrame(handle: number): void;
  128070. /**
  128071. * Stops presenting to the VRDisplay.
  128072. * @returns a promise to know when it stopped
  128073. */
  128074. exitPresent(): Promise<void>;
  128075. /**
  128076. * Return the current VREyeParameters for the given eye.
  128077. * @param whichEye Define the eye we want the parameter for
  128078. * @returns the eye parameters
  128079. */
  128080. getEyeParameters(whichEye: string): VREyeParameters;
  128081. /**
  128082. * Populates the passed VRFrameData with the information required to render
  128083. * the current frame.
  128084. * @param frameData Define the data structure to populate
  128085. * @returns true if ok otherwise false
  128086. */
  128087. getFrameData(frameData: VRFrameData): boolean;
  128088. /**
  128089. * Get the layers currently being presented.
  128090. * @returns the list of VR layers
  128091. */
  128092. getLayers(): VRLayer[];
  128093. /**
  128094. * Return a VRPose containing the future predicted pose of the VRDisplay
  128095. * when the current frame will be presented. The value returned will not
  128096. * change until JavaScript has returned control to the browser.
  128097. *
  128098. * The VRPose will contain the position, orientation, velocity,
  128099. * and acceleration of each of these properties.
  128100. * @returns the pose object
  128101. */
  128102. getPose(): VRPose;
  128103. /**
  128104. * Return the current instantaneous pose of the VRDisplay, with no
  128105. * prediction applied.
  128106. * @returns the current instantaneous pose
  128107. */
  128108. getImmediatePose(): VRPose;
  128109. /**
  128110. * The callback passed to `requestAnimationFrame` will be called
  128111. * any time a new frame should be rendered. When the VRDisplay is
  128112. * presenting the callback will be called at the native refresh
  128113. * rate of the HMD. When not presenting this function acts
  128114. * identically to how window.requestAnimationFrame acts. Content should
  128115. * make no assumptions of frame rate or vsync behavior as the HMD runs
  128116. * asynchronously from other displays and at differing refresh rates.
  128117. * @param callback Define the eaction to run next frame
  128118. * @returns the request handle it
  128119. */
  128120. requestAnimationFrame(callback: FrameRequestCallback): number;
  128121. /**
  128122. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  128123. * Repeat calls while already presenting will update the VRLayers being displayed.
  128124. * @param layers Define the list of layer to present
  128125. * @returns a promise to know when the request has been fulfilled
  128126. */
  128127. requestPresent(layers: VRLayer[]): Promise<void>;
  128128. /**
  128129. * Reset the pose for this display, treating its current position and
  128130. * orientation as the "origin/zero" values. VRPose.position,
  128131. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  128132. * updated when calling resetPose(). This should be called in only
  128133. * sitting-space experiences.
  128134. */
  128135. resetPose(): void;
  128136. /**
  128137. * The VRLayer provided to the VRDisplay will be captured and presented
  128138. * in the HMD. Calling this function has the same effect on the source
  128139. * canvas as any other operation that uses its source image, and canvases
  128140. * created without preserveDrawingBuffer set to true will be cleared.
  128141. * @param pose Define the pose to submit
  128142. */
  128143. submitFrame(pose?: VRPose): void;
  128144. }
  128145. declare var VRDisplay: {
  128146. prototype: VRDisplay;
  128147. new(): VRDisplay;
  128148. };
  128149. interface VRLayer {
  128150. leftBounds?: number[] | Float32Array | null;
  128151. rightBounds?: number[] | Float32Array | null;
  128152. source?: HTMLCanvasElement | null;
  128153. }
  128154. interface VRDisplayCapabilities {
  128155. readonly canPresent: boolean;
  128156. readonly hasExternalDisplay: boolean;
  128157. readonly hasOrientation: boolean;
  128158. readonly hasPosition: boolean;
  128159. readonly maxLayers: number;
  128160. }
  128161. interface VREyeParameters {
  128162. /** @deprecated */
  128163. readonly fieldOfView: VRFieldOfView;
  128164. readonly offset: Float32Array;
  128165. readonly renderHeight: number;
  128166. readonly renderWidth: number;
  128167. }
  128168. interface VRFieldOfView {
  128169. readonly downDegrees: number;
  128170. readonly leftDegrees: number;
  128171. readonly rightDegrees: number;
  128172. readonly upDegrees: number;
  128173. }
  128174. interface VRFrameData {
  128175. readonly leftProjectionMatrix: Float32Array;
  128176. readonly leftViewMatrix: Float32Array;
  128177. readonly pose: VRPose;
  128178. readonly rightProjectionMatrix: Float32Array;
  128179. readonly rightViewMatrix: Float32Array;
  128180. readonly timestamp: number;
  128181. }
  128182. interface VRPose {
  128183. readonly angularAcceleration: Float32Array | null;
  128184. readonly angularVelocity: Float32Array | null;
  128185. readonly linearAcceleration: Float32Array | null;
  128186. readonly linearVelocity: Float32Array | null;
  128187. readonly orientation: Float32Array | null;
  128188. readonly position: Float32Array | null;
  128189. readonly timestamp: number;
  128190. }
  128191. interface VRStageParameters {
  128192. sittingToStandingTransform?: Float32Array;
  128193. sizeX?: number;
  128194. sizeY?: number;
  128195. }
  128196. interface Navigator {
  128197. getVRDisplays(): Promise<VRDisplay[]>;
  128198. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  128199. }
  128200. interface Window {
  128201. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  128202. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  128203. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  128204. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  128205. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  128206. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  128207. }
  128208. interface Gamepad {
  128209. readonly displayId: number;
  128210. }
  128211. type XRSessionMode =
  128212. | "inline"
  128213. | "immersive-vr"
  128214. | "immersive-ar";
  128215. type XRReferenceSpaceType =
  128216. | "viewer"
  128217. | "local"
  128218. | "local-floor"
  128219. | "bounded-floor"
  128220. | "unbounded";
  128221. type XREnvironmentBlendMode =
  128222. | "opaque"
  128223. | "additive"
  128224. | "alpha-blend";
  128225. type XRVisibilityState =
  128226. | "visible"
  128227. | "visible-blurred"
  128228. | "hidden";
  128229. type XRHandedness =
  128230. | "none"
  128231. | "left"
  128232. | "right";
  128233. type XRTargetRayMode =
  128234. | "gaze"
  128235. | "tracked-pointer"
  128236. | "screen";
  128237. type XREye =
  128238. | "none"
  128239. | "left"
  128240. | "right";
  128241. interface XRSpace extends EventTarget {
  128242. }
  128243. interface XRRenderState {
  128244. depthNear?: number;
  128245. depthFar?: number;
  128246. inlineVerticalFieldOfView?: number;
  128247. baseLayer?: XRWebGLLayer;
  128248. }
  128249. interface XRInputSource {
  128250. handedness: XRHandedness;
  128251. targetRayMode: XRTargetRayMode;
  128252. targetRaySpace: XRSpace;
  128253. gripSpace: XRSpace | undefined;
  128254. gamepad: Gamepad | undefined;
  128255. profiles: Array<string>;
  128256. }
  128257. interface XRSession {
  128258. addEventListener: Function;
  128259. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  128260. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  128261. requestAnimationFrame: Function;
  128262. end(): Promise<void>;
  128263. renderState: XRRenderState;
  128264. inputSources: Array<XRInputSource>;
  128265. }
  128266. interface XRReferenceSpace extends XRSpace {
  128267. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  128268. onreset: any;
  128269. }
  128270. interface XRFrame {
  128271. session: XRSession;
  128272. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  128273. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  128274. }
  128275. interface XRViewerPose extends XRPose {
  128276. views: Array<XRView>;
  128277. }
  128278. interface XRPose {
  128279. transform: XRRigidTransform;
  128280. emulatedPosition: boolean;
  128281. }
  128282. declare var XRWebGLLayer: {
  128283. prototype: XRWebGLLayer;
  128284. new(session: XRSession, context: WebGLRenderingContext | undefined): XRWebGLLayer;
  128285. };
  128286. interface XRWebGLLayer {
  128287. framebuffer: WebGLFramebuffer;
  128288. framebufferWidth: number;
  128289. framebufferHeight: number;
  128290. getViewport: Function;
  128291. }
  128292. interface XRRigidTransform {
  128293. position: DOMPointReadOnly;
  128294. orientation: DOMPointReadOnly;
  128295. matrix: Float32Array;
  128296. inverse: XRRigidTransform;
  128297. }
  128298. interface XRView {
  128299. eye: XREye;
  128300. projectionMatrix: Float32Array;
  128301. transform: XRRigidTransform;
  128302. }
  128303. interface XRInputSourceChangeEvent {
  128304. session: XRSession;
  128305. removed: Array<XRInputSource>;
  128306. added: Array<XRInputSource>;
  128307. }